io.kubernetes.client.openapi.models

Class V1TopologySpreadConstraint

java.lang.Object

io.kubernetes.client.openapi.models.V1TopologySpreadConstraint

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-12-10T19:11:23.904Z[Etc/UTC]")
public class V1TopologySpreadConstraint
extends Object

TopologySpreadConstraint specifies how to spread matching pods among the given topology.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	V1TopologySpreadConstraint.WhenUnsatisfiableEnum WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_LABEL_SELECTOR
static String	SERIALIZED_NAME_MAX_SKEW
static String	SERIALIZED_NAME_TOPOLOGY_KEY
static String	SERIALIZED_NAME_WHEN_UNSATISFIABLE

Constructor Summary

Constructors

Constructor and Description
V1TopologySpreadConstraint()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
V1LabelSelector	getLabelSelector() Get labelSelector
Integer	getMaxSkew() MaxSkew describes the degree to which pods may be unevenly distributed.
String	getTopologyKey() TopologyKey is the key of node labels.
V1TopologySpreadConstraint.WhenUnsatisfiableEnum	getWhenUnsatisfiable() WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint.
int	hashCode()
V1TopologySpreadConstraint	labelSelector(V1LabelSelector labelSelector)
V1TopologySpreadConstraint	maxSkew(Integer maxSkew)
void	setLabelSelector(V1LabelSelector labelSelector)
void	setMaxSkew(Integer maxSkew)
void	setTopologyKey(String topologyKey)
void	setWhenUnsatisfiable(V1TopologySpreadConstraint.WhenUnsatisfiableEnum whenUnsatisfiable)
V1TopologySpreadConstraint	topologyKey(String topologyKey)
String	toString()
V1TopologySpreadConstraint	whenUnsatisfiable(V1TopologySpreadConstraint.WhenUnsatisfiableEnum whenUnsatisfiable)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_LABEL_SELECTOR

public static final String SERIALIZED_NAME_LABEL_SELECTOR

See Also:

Constant Field Values

SERIALIZED_NAME_MAX_SKEW

public static final String SERIALIZED_NAME_MAX_SKEW

See Also:

Constant Field Values

SERIALIZED_NAME_TOPOLOGY_KEY

public static final String SERIALIZED_NAME_TOPOLOGY_KEY

See Also:

Constant Field Values

SERIALIZED_NAME_WHEN_UNSATISFIABLE

public static final String SERIALIZED_NAME_WHEN_UNSATISFIABLE

See Also:

Constant Field Values

Constructor Detail

V1TopologySpreadConstraint

public V1TopologySpreadConstraint()

Method Detail

labelSelector

public V1TopologySpreadConstraint labelSelector(V1LabelSelector labelSelector)

getLabelSelector

@Nullable
public V1LabelSelector getLabelSelector()

Get labelSelector

Returns:

labelSelector

setLabelSelector

public void setLabelSelector(V1LabelSelector labelSelector)

maxSkew

public V1TopologySpreadConstraint maxSkew(Integer maxSkew)

getMaxSkew

public Integer 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. For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; scheduling it onto zone1(zone2) would make the ActualSkew(2-0) 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:

maxSkew

setMaxSkew

public void setMaxSkew(Integer maxSkew)

topologyKey

public V1TopologySpreadConstraint topologyKey(String topologyKey)

getTopologyKey

public 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. It's a required field.

Returns:

topologyKey

setTopologyKey

public void setTopologyKey(String topologyKey)

whenUnsatisfiable

public V1TopologySpreadConstraint whenUnsatisfiable(V1TopologySpreadConstraint.WhenUnsatisfiableEnum whenUnsatisfiable)

getWhenUnsatisfiable

public V1TopologySpreadConstraint.WhenUnsatisfiableEnum 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. Possible enum values: - `\"DoNotSchedule\"` instructs the scheduler not to schedule the pod when constraints are not satisfied. - `\"ScheduleAnyway\"` instructs the scheduler to schedule the pod even if constraints are not satisfied.

Returns:

whenUnsatisfiable

setWhenUnsatisfiable

public void setWhenUnsatisfiable(V1TopologySpreadConstraint.WhenUnsatisfiableEnum whenUnsatisfiable)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object