PodGroup scheduling.k8s.io/v1alpha2
PodGroup represents a runtime instance of pods grouped together. PodGroups are created by workload controllers (Job, LWS, JobSet, etc...) from Workload.podGroupTemplates. PodGroup API enablement is toggled by the GenericWorkload feature gate.
Fields
- apiVersion:
scheduling.k8s.io/v1alpha2 - kind:
PodGroup - metadata (ObjectMeta)
-
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
- spec (PodGroupSpec)
-
Spec defines the desired state of the PodGroup.
- status (PodGroupStatus)
-
Status represents the current observed state of the PodGroup.
PodGroupSpec
PodGroupSpec defines the desired state of a PodGroup.
- schedulingPolicy (PodGroupSchedulingPolicy)
-
SchedulingPolicy defines the scheduling policy for this instance of the PodGroup. Controllers are expected to fill this field by copying it from a PodGroupTemplate. This field is immutable.
- disruptionMode (string)
-
DisruptionMode defines the mode in which a given PodGroup can be disrupted. Controllers are expected to fill this field by copying it from a PodGroupTemplate. One of Pod, PodGroup. Defaults to Pod if unset. This field is immutable. This field is available only when the WorkloadAwarePreemption feature gate is enabled.
- podGroupTemplateRef (PodGroupTemplateReference)
-
PodGroupTemplateRef references an optional PodGroup template within other object (e.g. Workload) that was used to create the PodGroup. This field is immutable.
- priority (integer)
-
Priority is the value of priority of this pod group. 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 immutable. This field is available only when the WorkloadAwarePreemption feature gate is enabled.
- priorityClassName (string)
-
PriorityClassName defines the priority that should be considered when scheduling this pod group. Controllers are expected to fill this field by copying it from a PodGroupTemplate. Otherwise, it is validated and resolved similarly to the PriorityClassName on PodGroupTemplate (i.e. if no priority class is specified, admission control can set this to the global default priority class if it exists. Otherwise, the pod group's priority will be zero). This field is immutable. 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 PodGroup. Controllers are expected to fill this field by copying it from a PodGroupTemplate. This field is immutable. 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.
PodGroupTemplateReference
PodGroupTemplateReference references a PodGroup template defined in some object (e.g. Workload). Exactly one reference must be set.
- workload (WorkloadPodGroupTemplateReference)
-
Workload references the PodGroupTemplate within the Workload object that was used to create the PodGroup.
WorkloadPodGroupTemplateReference references the PodGroupTemplate within the Workload object.
- workload.podGroupTemplateName (string)
PodGroupTemplateName defines the PodGroupTemplate name within the Workload object.
- workload.workloadName (string)
WorkloadName defines the name of the Workload object.
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"
PodGroupStatus
PodGroupStatus represents information about the status of a pod group.
- conditions ([]Condition)
-
Conditions represent the latest observations of the PodGroup's state.
Known condition types: - "PodGroupScheduled": Indicates whether the scheduling requirement has been satisfied. - "DisruptionTarget": Indicates whether the PodGroup is about to be terminated due to disruption such as preemption.
Known reasons for the PodGroupScheduled condition: - "Unschedulable": The PodGroup cannot be scheduled due to resource constraints, affinity/anti-affinity rules, or insufficient capacity for the gang.
- "SchedulerError": The PodGroup cannot be scheduled due to some internal error that happened during scheduling, for example due to nodeAffinity parsing errors.
Known reasons for the DisruptionTarget condition: - "PreemptionByScheduler": The PodGroup was preempted by the scheduler to make room for higher-priority PodGroups or Pods.
- resourceClaimStatuses ([]PodGroupResourceClaimStatus)
-
Status of resource claims.
PodGroupResourceClaimStatus is stored in the PodGroupStatus for each PodGroupResourceClaim which references a ResourceClaimTemplate. It stores the generated name for the corresponding ResourceClaim.
- resourceClaimStatuses.name (string)
Name uniquely identifies this resource claim inside the PodGroup. This must match the name of an entry in podgroup.spec.resourceClaims, which implies that the string must be a DNS_LABEL.
- resourceClaimStatuses.resourceClaimName (string)
ResourceClaimName is the name of the ResourceClaim that was generated for the PodGroup in the namespace of the PodGroup. If this is unset, then generating a ResourceClaim was not necessary. The podgroup.spec.resourceClaims entry can be ignored in this case.
PodGroupList
PodGroupList contains a list of PodGroup resources.