v1alpha1

type Aggregator string

type Allocation struct {
	Consumer string `json:"consumer"`
	// +optional
	Requests *v1.ResourceList `json:"requests,omitempty"`
}

type Attribute struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type CNRCondition struct {
	// Type is the type of the condition.
	Type CNRConditionType `json:"type"`
	// Status of the condition, one of True, False, Unknown.
	Status v1.ConditionStatus `json:"status" `
	// Last time we got an update on a given condition.
	// +optional
	LastHeartbeatTime metav1.Time `json:"lastHeartbeatTime,omitempty"`
	// (brief) reason for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty"`
	// Human-readable message indicating details about last transition.
	// +optional
	Message string `json:"message,omitempty"`
}

type CNRConditionType string

type CustomNodeResource struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the behavior of a CustomNodeResource.
	// +optional
	Spec CustomNodeResourceSpec `json:"spec,omitempty"`

	// Status represents the current information about a CustomNodeResource.
	// This data may not be up-to-date.
	// +optional
	Status CustomNodeResourceStatus `json:"status,omitempty"`
}

type CustomNodeResourceList struct {
	metav1.TypeMeta `json:",inline"`

	// Standard list metadata
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`

	// items is the list of CNRs
	Items []CustomNodeResource `json:"items"`
}

type CustomNodeResourceSpec struct {
	// +optional
	NodeResourceProperties []*Property `json:"nodeResourceProperties,omitempty"`

	// Taints customized taint for katalyst, which affect pod scheduling
	// based on their QoS levels and the specified taint's QoS level.
	// +optional
	Taints []Taint `json:"taints,omitempty"`
}

type CustomNodeResourceStatus struct {
	// Resources defines the numeric quantities in this node; for instance reclaimed resources for this node
	// +optional
	Resources Resources `json:"resources"`

	// +optional
	TopologyZone []*TopologyZone `json:"topologyZone,omitempty"`

	// TopologyPolicy indicates placement policy for scheduler or other centralized components to follow.
	// this policy (including topology scope) is defined in topology-manager, katalyst is
	// responsible to parse the policy, and transform to TopologyPolicy here.
	// +kubebuilder:default:=none
	TopologyPolicy TopologyPolicy `json:"topologyPolicy"`

	// Conditions is an array of current observed cnr conditions.
	// +optional
	Conditions []CNRCondition `json:"conditions,omitempty"`

	// NodeMetricStatus report node real-time metrics
	// +optional
	NodeMetricStatus *NodeMetricStatus `json:"nodeMetricStatus,omitempty"`
}

type GroupMetricInfo struct {
	// +kubebuilder:validation:Enum=reclaimed_cores;shared_cores;dedicated_cores;system_cores
	QoSLevel      string `json:"QoSLevel"`
	ResourceUsage `json:",inline"`
	// PodList indicates the pods belongs to this qos group, in format of {namespace}/{name}.
	// Pods that have been scheduled but are not listed in the PodList need to be estimated by the scheduler.
	PodList []string `json:"podList,omitempty"`
}

type MetricValue struct {
	// the name of the metric
	// +optional
	MetricName string `json:"metricName,omitempty"`

	// a set of labels that identify a single time series for the metric
	// +optional
	MetricLabels map[string]string `json:"metricLabels,omitempty"`

	// indicates the time at which the metrics were produced
	// +optional
	Timestamp metav1.Time `json:"timestamp,omitempty"`

	// the aggregator of the metric
	// +optional
	Aggregator *Aggregator `json:"aggregator,omitempty"`

	// indicates the window ([Timestamp-Window, Timestamp]) from
	// which these metrics were calculated, when returning rate
	// metrics calculated from cumulative metrics (or zero for
	// non-calculated instantaneous metrics).
	// +optional
	Window *metav1.Duration `json:"window,omitempty"`

	// the value of the metric
	// +optional
	Value resource.Quantity `json:"value,omitempty"`
}

type NUMAMetricInfo struct {
	NUMAId int `json:"numaId"`
	// Usage contains the real-time resource usage for this NUMA node
	Usage v1.ResourceList `json:"usage"`
}

type NodeMetricInfo struct {
	ResourceUsage `json:",inline"`
}

type NodeMetricStatus struct {
	// UpdateTime is the last time this NodeMetricStatus was updated.
	UpdateTime metav1.Time `json:"updateTime"`

	// NodeMetric contains the metrics for this node.
	NodeMetric *NodeMetricInfo `json:"nodeMetric,omitempty"`

	// GroupMetric contains the metrics aggregated by QoS level groups
	GroupMetric []GroupMetricInfo `json:"groupMetric,omitempty"`
}

type NodeProfileDescriptor struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec defines the behavior of a NodeProfileDescriptor.
	// +optional
	Spec NodeProfileDescriptorSpec `json:"spec,omitempty"`

	// Status represents the current information about a NodeProfileDescriptor.
	// This data may not be up-to-date.
	// +optional
	Status NodeProfileDescriptorStatus `json:"status,omitempty"`
}

type NodeProfileDescriptorList struct {
	metav1.TypeMeta `json:",inline"`

	// Standard list metadata
	// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`

	// items is the list of CNRs
	Items []NodeProfileDescriptor `json:"items"`
}

type NodeProfileDescriptorSpec struct {
}

type NodeProfileDescriptorStatus struct {
	// NodeMetrics contains the node-related metrics
	// +optional
	NodeMetrics []ScopedNodeMetrics `json:"nodeMetrics,omitempty"`

	// PodMetrics contains the pod-related metrics
	// +optional
	PodMetrics []ScopedPodMetrics `json:"podMetrics,omitempty"`
}

type PodMetric struct {
	// +optional
	Namespace string `json:"namespace,omitempty"`

	// +optional
	Name string `json:"name,omitempty"`

	// +optional
	Metrics []MetricValue `json:"metrics,omitempty"`
}

type Property struct {
	// property name
	PropertyName string `json:"propertyName"`

	// values of the specific property
	// +optional
	PropertyValues []string `json:"propertyValues,omitempty"`

	// values of the quantity-types property
	// +optional
	PropertyQuantity *resource.Quantity `json:"propertyQuantity,omitempty"`
}

type ResourcePackage struct {
	// PackageName is the identifier for this package, e.g. "x2", "x8".
	// Rules:
	// - Names like "default" or "default-N" (N = integer) are reserved identifiers
	//   for the default package(s), which represent resources not explicitly
	//   subdivided into other named packages.
	// - Other names are user-defined and may follow any convention
	//   (e.g., "x2", "x8").
	PackageName string `json:"packageName"`

	// Allocatable defines the total resources available for this package.
	// Keys usually include "cpu" and "memory" (e.g. cpu: "64", memory: "128Gi").
	Allocatable *v1.ResourceList `json:"allocatable,omitempty"`

	// +optional
	// +patchMergeKey=name
	// +patchStrategy=merge
	Attributes []Attribute `json:"attributes,omitempty" patchStrategy:"merge" patchMergeKey:"name"`
}

type ResourcePool struct {
	// PoolName is the unique identifier of the resource pool.
	PoolName string `json:"poolName"`

	// MinAllocatable defines the minimum amount of resources *guaranteed* or reserved
	// for this pool. This is the lower bound that the pool can always access.
	// Interpretation:
	//   - Acts like a reservation or guaranteed quota.
	//   - Ensures workloads in this pool always get at least these resources.
	MinAllocatable *v1.ResourceList `json:"minAllocatable,omitempty"`

	// MaxAllocatable defines the maximum amount of resources this pool
	// can consume, including any resources it may opportunistically
	// borrowed from other pools.
	// Interpretation:
	//   - Acts like an upper bound / quota ceiling.
	//   - Workloads in this pool cannot exceed this allocation, even if more
	//     resources are available on the node.
	//   - Supports resource sharing between pools, but with clear limits.
	MaxAllocatable *v1.ResourceList `json:"maxAllocatable,omitempty"`

	// +optional
	// +patchMergeKey=name
	// +patchStrategy=merge
	Attributes []Attribute `json:"attributes,omitempty" patchStrategy:"merge" patchMergeKey:"name"`
}

type ResourceUsage struct {
	// NUMAUsage contains the real-time resource usage for each NUMA
	NUMAUsage []NUMAMetricInfo `json:"numaUsage,omitempty"`

	// GenericUsage contains the real-time resource usage
	GenericUsage v1.ResourceList `json:"genericUsage,omitempty"`
}

type Resources struct {
	// +optional
	Allocatable *v1.ResourceList `json:"allocatable,omitempty"`

	// +optional
	Capacity *v1.ResourceList `json:"capacity,omitempty"`

	// ResourcePackages defines compute packages available on the node/numa.
	// Concept:
	//   - ResourcePackages are node/numa-oriented.
	//   - A ResourcePackage represents a subdivision of the total node/numa resources into
	//     standardized units. Each unit may define one or more resource dimensions
	//     (e.g., CPU, memory, disk, network).
	//   - Pods associated with a package must consume resources following the
	//     same ratio. If a Pod is not bound to a package, it falls back to
	//     the "default" package (or its variants: "default-1", "default-2").
	// Difference vs ResourcePools:
	//   - ResourcePackages: split all node/numa resources into standard shapes (abstracting
	//     physical resources into units).
	//   - ResourcePools: reserve/limit resources for a particular workload type.
	// +optional
	// +listMapKey=packageName
	// +listType=map
	ResourcePackages []ResourcePackage `json:"resourcePackages,omitempty"`

	// ResourcePools defines pools of resources reserved for specific workloads.
	// Concept:
	//   - ResourcePools are workload-oriented.
	//   - They allow a workload type (e.g. GPU jobs, latency-sensitive tasks) to
	//     reserve a guaranteed amount of resources (via MinAllocatable) while
	//     also optionally borrowing up to a maximum limit (via MaxAllocatable).
	// Difference vs ResourcePackages:
	//   - ResourcePools are for *workload reservations* (claiming resources for
	//     certain job types).
	//   - ResourcePackages are for *node subdivisions* (splitting all node resources into
	//     standard allocation units).
	// +optional
	// +listMapKey=poolName
	// +listType=map
	ResourcePools []ResourcePool `json:"resourcePools,omitempty"`
}

type ScopedNodeMetrics struct {
	// +optional
	Scope string `json:"scope,omitempty"`

	// +optional
	Metrics []MetricValue `json:"metrics,omitempty"`
}

type ScopedPodMetrics struct {
	// +optional
	Scope string `json:"scope,omitempty"`

	// +optional
	PodMetrics []PodMetric `json:"podMetrics,omitempty"`
}

type Sibling struct {
	// Type represents the type of this Sibling.
	// For instance, Socket, Numa, GPU, NIC, Disk and so on.
	Type TopologyType `json:"type"`

	// Name represents the name of this Sibling.
	Name string `json:"name"`

	// Attributes are the attributes of the relationship between two Zones.
	// For instance, the distance between tow NUMA nodes, the connection type between two GPUs, etc.
	// +patchMergeKey=name
	// +patchStrategy=merge
	Attributes []Attribute `json:"attributes,omitempty" patchStrategy:"merge" patchMergeKey:"name"`
}

type Taint struct {
	// Taint is standard Kubernetes Taint
	v1.Taint `json:",inline"`

	// QoSLevel specifies the QoS level of pods that this taint applies to.
	// +kubebuilder:validation:Enum=reclaimed_cores;shared_cores;dedicated_cores;system_cores
	QoSLevel consts.QoSLevel `json:"qosLevel"`
}

type TopologyAllocation map[TopologyType]map[string]ZoneAllocation

type TopologyPolicy string

type TopologyType string

type TopologyZone struct {
	// Type represents which kind of resource this TopologyZone is for;
	// for instance, Socket, Numa, GPU, NIC, Disk and so on.
	Type TopologyType `json:"type"`

	// Name represents the name for the given type for resource; for instance,
	// - disk-for-log, disk-for-storage may have different usage or attributes, so we
	//   need separate structure to distinguish them.
	Name string `json:"name"`

	// Resources defines the numeric quantities in this TopologyZone; for instance,
	// - a TopologyZone with type TopologyTypeGPU may have both gpu and gpu-memory
	// - a TopologyZone with type TopologyTypeNIC may have both ingress and egress bandwidth
	// +optional
	Resources Resources `json:"resources"`

	// +optional
	// +patchMergeKey=name
	// +patchStrategy=merge
	Attributes []Attribute `json:"attributes,omitempty" patchStrategy:"merge" patchMergeKey:"name"`

	// +optional
	// +patchMergeKey=consumer
	// +patchStrategy=merge
	Allocations []*Allocation `json:"allocations,omitempty" patchStrategy:"merge" patchMergeKey:"consumer"`

	// Children represents the ownerships between multiple TopologyZone; for instance,
	// - a TopologyZone with type TopologyTypeSocket may have multiple childed TopologyZone
	//   with type TopologyTypeNuma to reflect the physical connections for a node
	// - a TopologyZone with type `nic` may have multiple childed TopologyZone with type `vf`
	//   to reflect the `physical and virtual` relations between devices
	// todo: in order to bypass the lacked functionality of recursive structure definition,
	//  we need to skip validation of this field for now; will re-add this validation logic
	//  if the community supports $ref, for more information, please
	//  refer to https://github.com/kubernetes/kubernetes/issues/62872
	// +optional
	// +kubebuilder:validation:Schemaless
	// +kubebuilder:pruning:PreserveUnknownFields
	Children []*TopologyZone `json:"children,omitempty"`

	// Siblings represents the relationship between TopologyZones at the same level; for instance,
	// the distance between NUMA nodes.
	// +optional
	// +patchMergeKey=name
	// +patchStrategy=merge
	Siblings []Sibling `json:"siblings,omitempty" patchStrategy:"merge" patchMergeKey:"name"`
}

type ZoneAllocation struct {
	// Allocated indicates the resources that are allocated to the pod.
	Allocated v1.ResourceList `json:"allocated,omitempty"`

	// Attributes store additional attributes specific to the device.
	Attributes map[string]string `json:"attributes,omitempty"`
}