Workload scheduling.k8s.io/v1alpha2
Workload allows for expressing scheduling constraints that should be used when managing the lifecycle of workloads from the scheduling perspective, including scheduling, preemption, eviction and other phases. Workload API enablement is toggled by the GenericWorkload feature gate.
Fields
- apiVersion:
scheduling.k8s.io/v1alpha2 - kind:
Workload - metadata (ObjectMeta)
-
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- spec (WorkloadSpec)
-
Spec defines the desired behavior of a Workload.
WorkloadSpec
WorkloadSpec defines the desired state of a Workload.
- podGroupTemplates ([]PodGroupTemplate)
-
PodGroupTemplates is the list of templates that make up the Workload. The maximum number of templates is 8. This field is immutable.
- controllerRef (TypedLocalObjectReference)
-
ControllerRef is an optional reference to the controlling object, such as a Deployment or Job. This field is intended for use by tools like CLIs to provide a link back to the original workload definition. This field is immutable.
PodGroupTemplate
PodGroupTemplate represents a template for a set of pods with a scheduling policy.
- name (string)
-
Name is a unique identifier for the PodGroupTemplate within the Workload. It must be a DNS label. This field is immutable.
- schedulingPolicy (PodGroupSchedulingPolicy)
-
SchedulingPolicy defines the scheduling policy for this PodGroupTemplate.
- disruptionMode (string)
-
DisruptionMode defines the mode in which a given PodGroup can be disrupted. One of Pod, PodGroup. This field is available only when the WorkloadAwarePreemption feature gate is enabled.
- priority (integer)
-
Priority is the value of priority of pod groups created from this template. Various system components use this field to find the priority of the pod group. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. This field is available only when the WorkloadAwarePreemption feature gate is enabled.
- priorityClassName (string)
-
PriorityClassName indicates the priority that should be considered when scheduling a pod group created from this template. If no priority class is specified, admission control can set this to the global default priority class if it exists. Otherwise, pod groups created from this template will have the priority set to zero. This field is available only when the WorkloadAwarePreemption feature gate is enabled.
- resourceClaims ([]PodGroupResourceClaim)
-
ResourceClaims defines which ResourceClaims may be shared among Pods in the group. Pods consume the devices allocated to a PodGroup's claim by defining a claim in its own Spec.ResourceClaims that matches the PodGroup's claim exactly. The claim must have the same name and refer to the same ResourceClaim or ResourceClaimTemplate.
This is an alpha-level field and requires that the DRAWorkloadResourceClaims feature gate is enabled.
This field is immutable.
PodGroupResourceClaim references exactly one ResourceClaim, either directly or by naming a ResourceClaimTemplate which is then turned into a ResourceClaim for the PodGroup.
It adds a name to it that uniquely identifies the ResourceClaim inside the PodGroup. Pods that need access to the ResourceClaim define a matching reference in its own Spec.ResourceClaims. The Pod's claim must match all fields of the PodGroup's claim exactly.
- resourceClaims.name (string)
Name uniquely identifies this resource claim inside the PodGroup. This must be a DNS_LABEL.
- resourceClaims.resourceClaimName (string)
ResourceClaimName is the name of a ResourceClaim object in the same namespace as this PodGroup. The ResourceClaim will be reserved for the PodGroup instead of its individual pods.
Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set.
- resourceClaims.resourceClaimTemplateName (string)
ResourceClaimTemplateName is the name of a ResourceClaimTemplate object in the same namespace as this PodGroup.
The template will be used to create a new ResourceClaim, which will be bound to this PodGroup. When this PodGroup is deleted, the ResourceClaim will also be deleted. The PodGroup name and resource name, along with a generated component, will be used to form a unique name for the ResourceClaim, which will be recorded in podgroup.status.resourceClaimStatuses.
This field is immutable and no changes will be made to the corresponding ResourceClaim by the control plane after creating the ResourceClaim.
Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set.
- schedulingConstraints (PodGroupSchedulingConstraints)
-
SchedulingConstraints defines optional scheduling constraints (e.g. topology) for this PodGroupTemplate. This field is only available when the TopologyAwareWorkloadScheduling feature gate is enabled.
PodGroupSchedulingPolicy
PodGroupSchedulingPolicy defines the scheduling configuration for a PodGroup. Exactly one policy must be set.
- basic (BasicSchedulingPolicy)
-
Basic specifies that the pods in this group should be scheduled using standard Kubernetes scheduling behavior.
BasicSchedulingPolicy indicates that standard Kubernetes scheduling behavior should be used.
- gang (GangSchedulingPolicy)
-
Gang specifies that the pods in this group should be scheduled using all-or-nothing semantics.
GangSchedulingPolicy defines the parameters for gang scheduling.
- gang.minCount (integer)
MinCount is the minimum number of pods that must be schedulable or scheduled at the same time for the scheduler to admit the entire group. It must be a positive integer.
PodGroupSchedulingConstraints
PodGroupSchedulingConstraints defines scheduling constraints (e.g. topology) for a PodGroup.
- topology ([]TopologyConstraint)
-
Topology defines the topology constraints for the pod group. Currently only a single topology constraint can be specified. This may change in the future.
TopologyConstraint defines a topology constraint for a PodGroup.
- topology.key (string)
Key specifies the key of the node label representing the topology domain. All pods within the PodGroup must be colocated within the same domain instance. Different PodGroups can land on different domain instances even if they derive from the same PodGroupTemplate. Examples: "topology.kubernetes.io/rack"
WorkloadList
WorkloadList contains a list of Workload resources.