Skip to content

scheduling.v1alpha3.compositePodGroupSpec

"CompositePodGroupSpec defines the desired state of CompositePodGroup."

Index

Fields

fn withParentCompositePodGroupName

withParentCompositePodGroupName(parentCompositePodGroupName)

"parentCompositePodGroupName contains the name of the parent composite pod group within the same namespace as this composite pod group. It must be a DNS name. If it's nil, then this composite pod group is a root of a workload's hierarchy. 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 composite pod group. Various system components use this field to find the priority of the composite 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 CompositePodGroup. Controllers are expected to fill this field by copying it from a CompositePodGroupTemplate. If left unspecified, it is validated and resolved similarly to the PriorityClassName field in Pods (i.e. if no priority class is specified, admission control can set this to the global default priority class if it exists. Otherwise, the composite pod group's priority will be zero). This field is immutable."

obj disruptionMode

"CompositeDisruptionMode defines how individual entities within a composite pod group can be disrupted. Exactly one mode must be set."

fn disruptionMode.withAll

withAll(all)

"AllCompositeDisruptionMode means that children of a CompositePodGroup can only be disrupted or preempted together."

fn disruptionMode.withAllMixin

withAllMixin(all)

"AllCompositeDisruptionMode means that children of a CompositePodGroup can only be disrupted or preempted together."

Note: This function appends passed data to existing values

fn disruptionMode.withSingle

withSingle(single)

"SingleCompositeDisruptionMode means that individual children of a CompositePodGroup can be disrupted or preempted independently."

fn disruptionMode.withSingleMixin

withSingleMixin(single)

"SingleCompositeDisruptionMode means that individual children of a CompositePodGroup can be disrupted or preempted independently."

Note: This function appends passed data to existing values

obj schedulingConstraints

"CompositePodGroupSchedulingConstraints defines scheduling constraints (e.g. topology) for a CompositePodGroup."

fn schedulingConstraints.withTopology

withTopology(topology)

"topology defines the topology constraints for the composite 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 composite 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

"CompositePodGroupSchedulingPolicy defines the scheduling configuration for a CompositePodGroup. Exactly one policy must be set."

fn schedulingPolicy.withBasic

withBasic(basic)

"CompositeBasicSchedulingPolicy indicates that the groups belonging to the composite group should be scheduled independently."

fn schedulingPolicy.withBasicMixin

withBasicMixin(basic)

"CompositeBasicSchedulingPolicy indicates that the groups belonging to the composite group should be scheduled independently."

Note: This function appends passed data to existing values

obj schedulingPolicy.gang

"CompositeGangSchedulingPolicy indicates that the groups belonging to the composite group should be scheduled using all-or-nothing semantics."

fn schedulingPolicy.gang.withMinGroupCount

withMinGroupCount(minGroupCount)

"minGroupCount is the minimum number of child groups that must be schedulable or scheduled at the same time for the scheduler to admit the entire group. It must be a positive integer."

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