CompositePodGroupSpec
io.k8s.api.scheduling.v1alpha3.CompositePodGroupSpec
source ↗
CompositePodGroupSpec defines the desired state of CompositePodGroup.
disruptionModeCompositeDisruptionModedisruptionMode defines the mode in which a given CompositePodGroup can be disrupted. Controllers are expected to fill this field by copying it from a CompositePodGroupTemplate. One of Single, All. Defaults to Single if unset. This field is immutable.
allAllCompositeDisruptionModeall specifies that all children groups can only be disrupted together.singleSingleCompositeDisruptionModesingle specifies that children groups can be disrupted independently from each other.parentCompositePodGroupNamestringparentCompositePodGroupName 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.preemptionPolicystringpreemptionPolicy 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.priorityinteger (int32)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.priorityClassNamestringpriorityClassName 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.schedulingConstraintsCompositePodGroupSchedulingConstraintsschedulingConstraints defines optional scheduling constraints (e.g. topology) for this CompositePodGroup. Controllers are expected to fill this field by copying it from a CompositePodGroupTemplate. This field is immutable.
topology[]TopologyConstrainttopology defines the topology constraints for the composite pod group. Currently only a single topology constraint can be specified. This may change in the future.
keystring requiredkey 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"schedulingPolicyCompositePodGroupSchedulingPolicy requiredschedulingPolicy defines the scheduling policy for this instance of the CompositePodGroup. Controllers are expected to fill this field by copying it from a CompositePodGroupTemplate. This field is immutable.
basicCompositeBasicSchedulingPolicybasic specifies that the groups of this composite group should be scheduled independently. This field is immutable.gangCompositeGangSchedulingPolicygang specifies that the groups of this composite group should be scheduled using all-or-nothing semantics.
minGroupCountinteger (int32) requiredminGroupCount 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.workloadRefWorkloadReference requiredworkloadRef references an optional CompositePodGroup template within the Workload object that was used to create the CompositePodGroup. This field is required. This field is immutable.
templateNamestring requiredtemplateName 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.workloadNamestring requiredworkloadName 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.