Package k8s.io.api.core.v1

Interface Generated.TopologySpreadConstraintOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Generated.LabelSelector getLabelSelector()
      LabelSelector is used to find matching pods.
      Generated.LabelSelectorOrBuilder getLabelSelectorOrBuilder()
      LabelSelector is used to find matching pods.
      String getMatchLabelKeys​(int index)
      MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated.
      com.google.protobuf.ByteString getMatchLabelKeysBytes​(int index)
      MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated.
      int getMatchLabelKeysCount()
      MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated.
      List<String> getMatchLabelKeysList()
      MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated.
      int getMaxSkew()
      MaxSkew describes the degree to which pods may be unevenly distributed.
      int getMinDomains()
      MinDomains indicates a minimum number of eligible domains.
      String getNodeAffinityPolicy()
      NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew.
      com.google.protobuf.ByteString getNodeAffinityPolicyBytes()
      NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew.
      String getNodeTaintsPolicy()
      NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew.
      com.google.protobuf.ByteString getNodeTaintsPolicyBytes()
      NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew.
      String getTopologyKey()
      TopologyKey is the key of node labels.
      com.google.protobuf.ByteString getTopologyKeyBytes()
      TopologyKey is the key of node labels.
      String getWhenUnsatisfiable()
      WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint.
      com.google.protobuf.ByteString getWhenUnsatisfiableBytes()
      WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint.
      boolean hasLabelSelector()
      LabelSelector is used to find matching pods.
      boolean hasMaxSkew()
      MaxSkew describes the degree to which pods may be unevenly distributed.
      boolean hasMinDomains()
      MinDomains indicates a minimum number of eligible domains.
      boolean hasNodeAffinityPolicy()
      NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew.
      boolean hasNodeTaintsPolicy()
      NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew.
      boolean hasTopologyKey()
      TopologyKey is the key of node labels.
      boolean hasWhenUnsatisfiable()
      WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasMaxSkew

        boolean hasMaxSkew()
         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.
        optional int32 maxSkew = 1;
        Returns:
        Whether the maxSkew field is set.

      • getMaxSkew

        int 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.
        optional int32 maxSkew = 1;
        Returns:
        The maxSkew.

      • hasTopologyKey

        boolean hasTopologyKey()
         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.
        optional string topologyKey = 2;
        Returns:
        Whether the topologyKey field is set.

      • getTopologyKey

        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.
        optional string topologyKey = 2;
        Returns:
        The topologyKey.

      • getTopologyKeyBytes

        com.google.protobuf.ByteString getTopologyKeyBytes()
         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.
        optional string topologyKey = 2;
        Returns:
        The bytes for topologyKey.

      • hasWhenUnsatisfiable

        boolean hasWhenUnsatisfiable()
         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.
        optional string whenUnsatisfiable = 3;
        Returns:
        Whether the whenUnsatisfiable field is set.

      • getWhenUnsatisfiable

        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.
        optional string whenUnsatisfiable = 3;
        Returns:
        The whenUnsatisfiable.

      • getWhenUnsatisfiableBytes

        com.google.protobuf.ByteString getWhenUnsatisfiableBytes()
         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.
        optional string whenUnsatisfiable = 3;
        Returns:
        The bytes for whenUnsatisfiable.

      • hasLabelSelector

        boolean hasLabelSelector()
         LabelSelector is used to find matching pods.
 Pods that match this label selector are counted to determine the number of pods
 in their corresponding topology domain.
 +optional
        optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector labelSelector = 4;
        Returns:
        Whether the labelSelector field is set.

      • getLabelSelector

        Generated.LabelSelector getLabelSelector()
         LabelSelector is used to find matching pods.
 Pods that match this label selector are counted to determine the number of pods
 in their corresponding topology domain.
 +optional
        optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector labelSelector = 4;
        Returns:
        The labelSelector.

      • getLabelSelectorOrBuilder

        Generated.LabelSelectorOrBuilder getLabelSelectorOrBuilder()
         LabelSelector is used to find matching pods.
 Pods that match this label selector are counted to determine the number of pods
 in their corresponding topology domain.
 +optional
        optional .k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector labelSelector = 4;

      • hasMinDomains

        boolean hasMinDomains()
         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.
 +optional
        optional int32 minDomains = 5;
        Returns:
        Whether the minDomains field is set.

      • getMinDomains

        int 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.
 +optional
        optional int32 minDomains = 5;
        Returns:
        The minDomains.

      • hasNodeAffinityPolicy

        boolean hasNodeAffinityPolicy()
         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.
 +optional
        optional string nodeAffinityPolicy = 6;
        Returns:
        Whether the nodeAffinityPolicy field is set.

      • getNodeAffinityPolicy

        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.
 +optional
        optional string nodeAffinityPolicy = 6;
        Returns:
        The nodeAffinityPolicy.

      • getNodeAffinityPolicyBytes

        com.google.protobuf.ByteString getNodeAffinityPolicyBytes()
         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.
 +optional
        optional string nodeAffinityPolicy = 6;
        Returns:
        The bytes for nodeAffinityPolicy.

      • hasNodeTaintsPolicy

        boolean hasNodeTaintsPolicy()
         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.
 +optional
        optional string nodeTaintsPolicy = 7;
        Returns:
        Whether the nodeTaintsPolicy field is set.

      • getNodeTaintsPolicy

        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.
 +optional
        optional string nodeTaintsPolicy = 7;
        Returns:
        The nodeTaintsPolicy.

      • getNodeTaintsPolicyBytes

        com.google.protobuf.ByteString getNodeTaintsPolicyBytes()
         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.
 +optional
        optional string nodeTaintsPolicy = 7;
        Returns:
        The bytes for nodeTaintsPolicy.

      • getMatchLabelKeysList

        List<String> getMatchLabelKeysList()
         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).
 +listType=atomic
 +optional
        repeated string matchLabelKeys = 8;
        Returns:
        A list containing the matchLabelKeys.

      • getMatchLabelKeysCount

        int getMatchLabelKeysCount()
         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).
 +listType=atomic
 +optional
        repeated string matchLabelKeys = 8;
        Returns:
        The count of matchLabelKeys.

      • getMatchLabelKeys

        String getMatchLabelKeys​(int index)
         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).
 +listType=atomic
 +optional
        repeated string matchLabelKeys = 8;
        Parameters:
        index - The index of the element to return.
        Returns:
        The matchLabelKeys at the given index.

      • getMatchLabelKeysBytes

        com.google.protobuf.ByteString getMatchLabelKeysBytes​(int index)
         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).
 +listType=atomic
 +optional
        repeated string matchLabelKeys = 8;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the matchLabelKeys at the given index.