Skip to content

scheduling.v1alpha2.podGroupSpec

"PodGroupSpec defines the desired state of a PodGroup."

Index

Fields

fn withDisruptionMode

withDisruptionMode(disruptionMode)

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

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. This field is available only when the WorkloadAwarePreemption feature gate is enabled."

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. This field is available only when the WorkloadAwarePreemption feature gate is enabled."

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 an alpha-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 an alpha-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 podGroupTemplateRef

"PodGroupTemplateReference references a PodGroup template defined in some object (e.g. Workload). Exactly one reference must be set."

obj podGroupTemplateRef.workload

"WorkloadPodGroupTemplateReference references the PodGroupTemplate within the Workload object."

fn podGroupTemplateRef.workload.withPodGroupTemplateName

withPodGroupTemplateName(podGroupTemplateName)

"PodGroupTemplateName defines the PodGroupTemplate name within the Workload object."

fn podGroupTemplateRef.workload.withWorkloadName

withWorkloadName(workloadName)

"WorkloadName defines the name of the Workload object."

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

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