Class V1TopologySpreadConstraint
java.lang.Object
io.micronaut.kubernetes.client.openapi.model.V1TopologySpreadConstraint
@Generated("io.micronaut.openapi.generator.JavaMicronautClientCodegen")
public class V1TopologySpreadConstraint
extends Object
TopologySpreadConstraint specifies how to spread matching pods among the given topology.
-
Field Summary
-
Constructor Summary
ConstructorDescriptionV1TopologySpreadConstraint
(Integer maxSkew, String topologyKey, String whenUnsatisfiable) -
Method Summary
Modifier and TypeMethodDescriptionaddmatchLabelKeysItem
(String matchLabelKeysItem) Add an item to the matchLabelKeys property in a chainable fashion.boolean
MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated.MaxSkew describes the degree to which pods may be unevenly distributed.MinDomains indicates a minimum number of eligible domains.NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew.NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew.TopologyKey is the key of node labels.WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint.int
hashCode()
labelSelector
(V1LabelSelector labelSelector) Set labelSelector in a chainable fashion.matchLabelKeys
(List<String> matchLabelKeys) Set matchLabelKeys in a chainable fashion.Set maxSkew in a chainable fashion.minDomains
(Integer minDomains) Set minDomains in a chainable fashion.nodeAffinityPolicy
(String nodeAffinityPolicy) Set nodeAffinityPolicy in a chainable fashion.nodeTaintsPolicy
(String nodeTaintsPolicy) Set nodeTaintsPolicy in a chainable fashion.void
setLabelSelector
(V1LabelSelector labelSelector) Set the labelSelector property valuevoid
setMatchLabelKeys
(List<String> matchLabelKeys) Set the matchLabelKeys property valuevoid
setMaxSkew
(Integer maxSkew) Set the maxSkew property valuevoid
setMinDomains
(Integer minDomains) Set the minDomains property valuevoid
setNodeAffinityPolicy
(String nodeAffinityPolicy) Set the nodeAffinityPolicy property valuevoid
setNodeTaintsPolicy
(String nodeTaintsPolicy) Set the nodeTaintsPolicy property valuevoid
setTopologyKey
(String topologyKey) Set the topologyKey property valuevoid
setWhenUnsatisfiable
(String whenUnsatisfiable) Set the whenUnsatisfiable property valuetopologyKey
(String topologyKey) Set topologyKey in a chainable fashion.toString()
whenUnsatisfiable
(String whenUnsatisfiable) Set whenUnsatisfiable in a chainable fashion.
-
Field Details
-
JSON_PROPERTY_LABEL_SELECTOR
- See Also:
-
JSON_PROPERTY_MATCH_LABEL_KEYS
- See Also:
-
JSON_PROPERTY_MAX_SKEW
- See Also:
-
JSON_PROPERTY_MIN_DOMAINS
- See Also:
-
JSON_PROPERTY_NODE_AFFINITY_POLICY
- See Also:
-
JSON_PROPERTY_NODE_TAINTS_POLICY
- See Also:
-
JSON_PROPERTY_TOPOLOGY_KEY
- See Also:
-
JSON_PROPERTY_WHEN_UNSATISFIABLE
- See Also:
-
-
Constructor Details
-
V1TopologySpreadConstraint
-
-
Method Details
-
getLabelSelector
- Returns:
- the labelSelector property value
-
setLabelSelector
Set the labelSelector property value -
labelSelector
Set labelSelector in a chainable fashion.- Returns:
- The same instance of V1TopologySpreadConstraint for chaining.
-
getMatchLabelKeys
MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed with labelSelector to select the group of existing pods over which spreading will be calculated for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector. MatchLabelKeys cannot be set when LabelSelector isn't set. Keys that don't exist in the incoming pod labels will be ignored. A null or empty list means only match against labelSelector. This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).- Returns:
- the matchLabelKeys property value
-
setMatchLabelKeys
Set the matchLabelKeys property value -
matchLabelKeys
Set matchLabelKeys in a chainable fashion.- Returns:
- The same instance of V1TopologySpreadConstraint for chaining.
-
addmatchLabelKeysItem
Add an item to the matchLabelKeys property in a chainable fashion.- Returns:
- The same instance of V1TopologySpreadConstraint for chaining.
-
getMaxSkew
MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the target topology and the global minimum. The global minimum is the minimum number of matching pods in an eligible domain or zero if the number of eligible domains is less than MinDomains. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 2/2/1: In this case, the global minimum is 1. | zone1 | zone2 | zone3 | | P P | P P | P | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2; scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2) violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto any zone. When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence to topologies that satisfy it. It's a required field. Default value is 1 and 0 is not allowed.- Returns:
- the maxSkew property value
-
setMaxSkew
Set the maxSkew property value -
maxSkew
Set maxSkew in a chainable fashion.- Returns:
- The same instance of V1TopologySpreadConstraint for chaining.
-
getMinDomains
MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats \"global minimum\" as 0, and then the calculation of Skew is performed. And when the number of eligible domains with matching topology keys equals or greater than minDomains, this value has no effect on scheduling. As a result, when the number of eligible domains is less than minDomains, scheduler won't schedule more than maxSkew Pods to those domains. If value is nil, the constraint behaves as if MinDomains is equal to 1. Valid values are integers greater than 0. When value is not nil, WhenUnsatisfiable must be DoNotSchedule. For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same labelSelector spread as 2/2/2: | zone1 | zone2 | zone3 | | P P | P P | P P | The number of domains is less than 5(MinDomains), so \"global minimum\" is treated as 0. In this situation, new pod with the same labelSelector cannot be scheduled, because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones, it will violate MaxSkew. This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).- Returns:
- the minDomains property value
-
setMinDomains
Set the minDomains property value -
minDomains
Set minDomains in a chainable fashion.- Returns:
- The same instance of V1TopologySpreadConstraint for chaining.
-
getNodeAffinityPolicy
NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. If this value is nil, the behavior is equivalent to the Honor policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.- Returns:
- the nodeAffinityPolicy property value
-
setNodeAffinityPolicy
Set the nodeAffinityPolicy property value -
nodeAffinityPolicy
Set nodeAffinityPolicy in a chainable fashion.- Returns:
- The same instance of V1TopologySpreadConstraint for chaining.
-
getNodeTaintsPolicy
NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included. If this value is nil, the behavior is equivalent to the Ignore policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.- Returns:
- the nodeTaintsPolicy property value
-
setNodeTaintsPolicy
Set the nodeTaintsPolicy property value -
nodeTaintsPolicy
Set nodeTaintsPolicy in a chainable fashion.- Returns:
- The same instance of V1TopologySpreadConstraint for chaining.
-
getTopologyKey
TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a \"bucket\", and try to put balanced number of pods into each bucket. We define a domain as a particular instance of a topology. Also, we define an eligible domain as a domain whose nodes meet the requirements of nodeAffinityPolicy and nodeTaintsPolicy. e.g. If TopologyKey is \"kubernetes.io/hostname\", each Node is a domain of that topology. And, if TopologyKey is \"topology.kubernetes.io/zone\", each zone is a domain of that topology. It's a required field.- Returns:
- the topologyKey property value
-
setTopologyKey
Set the topologyKey property value -
topologyKey
Set topologyKey in a chainable fashion.- Returns:
- The same instance of V1TopologySpreadConstraint for chaining.
-
getWhenUnsatisfiable
WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler to schedule the pod in any location, but giving higher precedence to topologies that would help reduce the skew. A constraint is considered \"Unsatisfiable\" for an incoming pod if and only if every possible node assignment for that pod would violate \"MaxSkew\" on some topology. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler won't make it *more* imbalanced. It's a required field.- Returns:
- the whenUnsatisfiable property value
-
setWhenUnsatisfiable
Set the whenUnsatisfiable property value -
whenUnsatisfiable
Set whenUnsatisfiable in a chainable fashion.- Returns:
- The same instance of V1TopologySpreadConstraint for chaining.
-
equals
-
hashCode
public int hashCode() -
toString
-