Skip to content

Update the description of TopologySpreadConstraints's matchLabelKeys to align with the design change #49607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
k8s-ci-robot merged 4 commits into from
Feb 1, 2025
Merged

Update the description of TopologySpreadConstraints's matchLabelKeys to align with the design change #49607

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7a4fbbc
Update the description of matchLabelKeys to align with the design change
mochizuki875 Jan 31, 2025
bf53e4f
fix1
mochizuki875 Jan 31, 2025
ea2bd42
fix2
mochizuki875 Jan 31, 2025
3c587f3
fix3
mochizuki875 Feb 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 14 additions & 9 deletions content/en/docs/concepts/scheduling-eviction/topology-spread-constraints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,18 +131,23 @@ your cluster. Those fields are:
See [Label Selectors](/docs/concepts/overview/working-with-objects/labels/#label-selectors)
for more details.

- **matchLabelKeys** is a list of pod label keys to select the pods over which
spreading will be calculated. The keys are used to lookup values from the 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 pod labels will be
ignored. A null or empty list means only match against the `labelSelector`.
- **matchLabelKeys** is a list of pod label keys to select the group of pods over which
the spreading skew will be calculated. At a pod creation,
apiserver will use those keys to lookup values from the incoming pod labels,
and those key-value labels will be merged with existing `labelSelector`.
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 pod labels will be ignored.
A null or empty list means only match against the `labelSelector`.

{{< warning >}}
It's not recommended to use `matchLabelKeys` with labels that might be updated
because the update of the label isn't reflected onto the merged `labelSelector`.
{{< /warning >}}

With `matchLabelKeys`, you don't need to update the `pod.spec` between different revisions.
The controller/operator just needs to set different values to the same label key for different
revisions. The scheduler will assume the values automatically based on `matchLabelKeys`. For
example, if you are configuring a Deployment, you can use the label keyed with
revisions. For example, if you are configuring a Deployment, you can use the label keyed with
[pod-template-hash](/docs/concepts/workloads/controllers/deployment/#pod-template-hash-label), which
is added automatically by the Deployment controller, to distinguish between different revisions
in a single Deployment.
Expand Down