Skip to content

scheduling.v1alpha3.podGroupSpec

"PodGroupSpec defines the desired state of a PodGroup."

Index

Fields

fn withParentCompositePodGroupName

withParentCompositePodGroupName(parentCompositePodGroupName)

"parentCompositePodGroupName contains the name of the parent composite pod group within the same namespace as this pod group. If it's nil, then this pod group is a root of a workload's hierarchy. This field is used only when the CompositePodGroup feature gate is enabled. This field is immutable."

fn withPreemptionPolicy

withPreemptionPolicy(preemptionPolicy)

"preemptionPolicy is the Policy for preempting pods/podgroups with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. When Priority Admission Controller is enabled, it populates this field from PriorityClassName, and defaults to PreemptLowerPriority if value is unset in PriorityClass. This field is immutable. This field is available only when the PodGroupPreemptionPolicy feature gate is enabled."

fn withPriority

withPriority(priority)

"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."

fn withPriorityClassName

withPriorityClassName(priorityClassName)

"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."

fn withResourceClaims

withResourceClaims(resourceClaims)

"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.\n\nThis is a beta-level field and requires that the DRAWorkloadResourceClaims feature gate is enabled.\n\nThis field is immutable."

fn withResourceClaimsMixin

withResourceClaimsMixin(resourceClaims)

"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.\n\nThis is a beta-level field and requires that the DRAWorkloadResourceClaims feature gate is enabled.\n\nThis field is immutable."

Note: This function appends passed data to existing values

obj disruptionMode

"DisruptionMode defines how individual entities within a group can be disrupted. Exactly one mode can be set."

fn disruptionMode.withAll

withAll(all)

"AllDisruptionMode specifies that children can only be disrupted together."

fn disruptionMode.withAllMixin

withAllMixin(all)

"AllDisruptionMode specifies that children can only be disrupted together."

Note: This function appends passed data to existing values

fn disruptionMode.withSingle

withSingle(single)

"SingleDisruptionMode specifies that children can be disrupted independently."

fn disruptionMode.withSingleMixin

withSingleMixin(single)

"SingleDisruptionMode specifies that children can be disrupted independently."

Note: This function appends passed data to existing values

obj schedulingConstraints

"PodGroupSchedulingConstraints defines scheduling constraints (e.g. topology) for a PodGroup."

fn schedulingConstraints.withTopology

withTopology(topology)

"topology defines the topology constraints for the pod group. Currently only a single topology constraint can be specified. This may change in the future."

fn schedulingConstraints.withTopologyMixin

withTopologyMixin(topology)

"topology defines the topology constraints for the pod group. Currently only a single topology constraint can be specified. This may change in the future."

Note: This function appends passed data to existing values

obj schedulingPolicy

"PodGroupSchedulingPolicy defines the scheduling configuration for a PodGroup. Exactly one policy must be set. The policy is chosen at creation time by setting either the Basic or Gang field. The PodGroup may not change policy after creation. Fields within chosen policy may be updated after creation when their individual fields allow it."

fn schedulingPolicy.withBasic

withBasic(basic)

"BasicSchedulingPolicy indicates that standard Kubernetes scheduling behavior should be used."

fn schedulingPolicy.withBasicMixin

withBasicMixin(basic)

"BasicSchedulingPolicy indicates that standard Kubernetes scheduling behavior should be used."

Note: This function appends passed data to existing values

obj schedulingPolicy.gang

"GangSchedulingPolicy defines the parameters for gang scheduling."

fn schedulingPolicy.gang.withMinCount

withMinCount(minCount)

"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. This field is mutable to support workload scaling.\n\nNote that the scheduler operates on an eventually consistent model. Updates to minCount may not be immediately reflected in scheduling decisions due to propagation delays. If minCount is updated while a scheduling cycle is in progress for that group, the new value may not take effect until the next cycle. Moreover, minCount is only enforced during scheduling, meaning that modifications to this field do not affect already-scheduled pods, applying only to those evaluated in future cycles."

obj workloadRef

"WorkloadReference references the Workload object together with the template that was used to create a particular PodGroup."

fn workloadRef.withTemplateName

withTemplateName(templateName)

"templateName is the name of a template within the Workload object that was used to create a pod group. It must be a DNS label. This field is required."

fn workloadRef.withWorkloadName

withWorkloadName(workloadName)

"workloadName is the name of the Workload object that contains a template that was used when creating a pod group. It must be a DNS name. This field is required."