Package com.marcnuri.yakc.model.io.k8s.api.core.v1

Class TopologySpreadConstraint

  • All Implemented Interfaces:
    com.marcnuri.yakc.model.Model
    public class TopologySpreadConstraint
extends java.lang.Object
implements com.marcnuri.yakc.model.Model
    TopologySpreadConstraint specifies how to spread matching pods among the given topology.

    • Constructor Summary

      Constructors 
      Constructor Description
      TopologySpreadConstraint()  
      TopologySpreadConstraint​(LabelSelector labelSelector, java.util.List<java.lang.String> matchLabelKeys, @NonNull java.lang.Number maxSkew, java.lang.Number minDomains, java.lang.String nodeAffinityPolicy, java.lang.String nodeTaintsPolicy, @NonNull java.lang.String topologyKey, @NonNull java.lang.String whenUnsatisfiable)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static TopologySpreadConstraint.Builder builder()  
      protected boolean canEqual​(java.lang.Object other)  
      boolean equals​(java.lang.Object o)  
      LabelSelector getLabelSelector()  
      java.util.List<java.lang.String> getMatchLabelKeys()
      MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated.
      @NonNull java.lang.Number getMaxSkew()
      MaxSkew describes the degree to which pods may be unevenly distributed.
      java.lang.Number getMinDomains()
      MinDomains indicates a minimum number of eligible domains.
      java.lang.String getNodeAffinityPolicy()
      NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew.
      java.lang.String getNodeTaintsPolicy()
      NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew.
      @NonNull java.lang.String getTopologyKey()
      TopologyKey is the key of node labels.
      @NonNull java.lang.String getWhenUnsatisfiable()
      WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint.
      int hashCode()  
      void setLabelSelector​(LabelSelector labelSelector)  
      void setMatchLabelKeys​(java.util.List<java.lang.String> matchLabelKeys)
      MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated.
      void setMaxSkew​(@NonNull java.lang.Number maxSkew)
      MaxSkew describes the degree to which pods may be unevenly distributed.
      void setMinDomains​(java.lang.Number minDomains)
      MinDomains indicates a minimum number of eligible domains.
      void setNodeAffinityPolicy​(java.lang.String nodeAffinityPolicy)
      NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew.
      void setNodeTaintsPolicy​(java.lang.String nodeTaintsPolicy)
      NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew.
      void setTopologyKey​(@NonNull java.lang.String topologyKey)
      TopologyKey is the key of node labels.
      void setWhenUnsatisfiable​(@NonNull java.lang.String whenUnsatisfiable)
      WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint.
      TopologySpreadConstraint.Builder toBuilder()  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • TopologySpreadConstraint

        public TopologySpreadConstraint​(LabelSelector labelSelector,
                                java.util.List<java.lang.String> matchLabelKeys,
                                @NonNull
                                @NonNull java.lang.Number maxSkew,
                                java.lang.Number minDomains,
                                java.lang.String nodeAffinityPolicy,
                                java.lang.String nodeTaintsPolicy,
                                @NonNull
                                @NonNull java.lang.String topologyKey,
                                @NonNull
                                @NonNull java.lang.String whenUnsatisfiable)

      • TopologySpreadConstraint

        public TopologySpreadConstraint()

    • Method Detail

      • getMatchLabelKeys

        public java.util.List<java.lang.String> 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).

      • getMaxSkew

        @NonNull
public @NonNull java.lang.Number 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.

      • getMinDomains

        public java.lang.Number 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).

      • getNodeAffinityPolicy

        public java.lang.String 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.

      • getNodeTaintsPolicy

        public java.lang.String 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.

      • getTopologyKey

        @NonNull
public @NonNull java.lang.String 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.

      • getWhenUnsatisfiable

        @NonNull
public @NonNull java.lang.String 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.

      • setLabelSelector

        public void setLabelSelector​(LabelSelector labelSelector)

      • setMatchLabelKeys

        public void setMatchLabelKeys​(java.util.List<java.lang.String> matchLabelKeys)
        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).

      • setMaxSkew

        public void setMaxSkew​(@NonNull
                       @NonNull java.lang.Number maxSkew)
        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.

      • setMinDomains

        public void setMinDomains​(java.lang.Number minDomains)
        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).

      • setNodeAffinityPolicy

        public void setNodeAffinityPolicy​(java.lang.String nodeAffinityPolicy)
        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.

      • setNodeTaintsPolicy

        public void setNodeTaintsPolicy​(java.lang.String nodeTaintsPolicy)
        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.

      • setTopologyKey

        public void setTopologyKey​(@NonNull
                           @NonNull java.lang.String topologyKey)
        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.

      • setWhenUnsatisfiable

        public void setWhenUnsatisfiable​(@NonNull
                                 @NonNull java.lang.String whenUnsatisfiable)
        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.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • canEqual

        protected boolean canEqual​(java.lang.Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object