Docs for new default PodTopologySpread functionality and gate
Signed-off-by: Aldo Culquicondor <acondor@google.com>
This commit is contained in:
@@ -186,7 +186,7 @@ There are some implicit conventions worth noting here:
|
|||||||
|
|
||||||
### Cluster-level default constraints
|
### Cluster-level default constraints
|
||||||
|
|
||||||
{{< feature-state for_k8s_version="v1.18" state="alpha" >}}
|
{{< feature-state for_k8s_version="v1.19" state="beta" >}}
|
||||||
|
|
||||||
It is possible to set default topology spread constraints for a cluster. Default
|
It is possible to set default topology spread constraints for a cluster. Default
|
||||||
topology spread constraints are applied to a Pod if, and only if:
|
topology spread constraints are applied to a Pod if, and only if:
|
||||||
@@ -203,7 +203,7 @@ replication controllers, replica sets or stateful sets that the Pod belongs to.
|
|||||||
An example configuration might look like follows:
|
An example configuration might look like follows:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
apiVersion: kubescheduler.config.k8s.io/v1alpha2
|
apiVersion: kubescheduler.config.k8s.io/v1beta1
|
||||||
kind: KubeSchedulerConfiguration
|
kind: KubeSchedulerConfiguration
|
||||||
|
|
||||||
profiles:
|
profiles:
|
||||||
@@ -212,18 +212,48 @@ profiles:
|
|||||||
args:
|
args:
|
||||||
defaultConstraints:
|
defaultConstraints:
|
||||||
- maxSkew: 1
|
- maxSkew: 1
|
||||||
topologyKey: failure-domain.beta.kubernetes.io/zone
|
topologyKey: topology.kubernetes.io/zone
|
||||||
whenUnsatisfiable: ScheduleAnyway
|
whenUnsatisfiable: ScheduleAnyway
|
||||||
```
|
```
|
||||||
|
|
||||||
{{< note >}}
|
{{< note >}}
|
||||||
The score produced by default scheduling constraints might conflict with the
|
The score produced by default scheduling constraints might conflict with the
|
||||||
score produced by the
|
score produced by the
|
||||||
[`DefaultPodTopologySpread` plugin](/docs/reference/scheduling/config/#scheduling-plugins).
|
[`SelectorSpread` plugin](/docs/reference/scheduling/config/#scheduling-plugins).
|
||||||
It is recommended that you disable this plugin in the scheduling profile when
|
It is recommended that you disable this plugin in the scheduling profile when
|
||||||
using default constraints for `PodTopologySpread`.
|
using default constraints for `PodTopologySpread`.
|
||||||
{{< /note >}}
|
{{< /note >}}
|
||||||
|
|
||||||
|
#### Internal default constraints
|
||||||
|
|
||||||
|
{{< feature-state for_k8s_version="v1.19" state="alpha" >}}
|
||||||
|
|
||||||
|
When the feature gate `DefaultPodTopologySpread` is enabled,
|
||||||
|
kube-scheduler uses the following default topology constraints for the
|
||||||
|
`PodTopologySpread` plugin configuration:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
defaultConstraints:
|
||||||
|
- maxSkew: 3
|
||||||
|
topologyKey: "kubernetes.io/hostname"
|
||||||
|
whenUnsatisfiable: ScheduleAnyway
|
||||||
|
- maxSkew: 5
|
||||||
|
topologyKey: "topology.kubernetes.io/zone"
|
||||||
|
whenUnsatisfiable: ScheduleAnyway
|
||||||
|
```
|
||||||
|
|
||||||
|
Also, the legacy `SelectorSpread` plugin, which provides an equivalent behavior,
|
||||||
|
is disabled.
|
||||||
|
|
||||||
|
{{< note >}}
|
||||||
|
If your nodes are not expected to have **both** `kubernetes.io/hostname` and
|
||||||
|
`topology.kubernetes.io/zone` labels set, you should define your own constraints
|
||||||
|
instead of using the Kubernetes default.
|
||||||
|
|
||||||
|
The `PodTopologySpread` plugin ignores from scoring the nodes that don't have
|
||||||
|
both topologies.
|
||||||
|
{{< /note >}}
|
||||||
|
|
||||||
## Comparison with PodAffinity/PodAntiAffinity
|
## Comparison with PodAffinity/PodAntiAffinity
|
||||||
|
|
||||||
In Kubernetes, directives related to "Affinity" control how Pods are
|
In Kubernetes, directives related to "Affinity" control how Pods are
|
||||||
@@ -240,8 +270,6 @@ workloads and scaling out replicas smoothly. See [Motivation](https://github.com
|
|||||||
|
|
||||||
## Known Limitations
|
## Known Limitations
|
||||||
|
|
||||||
As of 1.18, at which this feature is Beta, there are some known limitations:
|
|
||||||
|
|
||||||
- Scaling down a Deployment may result in imbalanced Pods distribution.
|
- Scaling down a Deployment may result in imbalanced Pods distribution.
|
||||||
- Pods matched on tainted nodes are respected. See [Issue 80921](https://github.com/kubernetes/kubernetes/issues/80921)
|
- Pods matched on tainted nodes are respected. See [Issue 80921](https://github.com/kubernetes/kubernetes/issues/80921)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user