-
Notifications
You must be signed in to change notification settings - Fork 15.3k
Add deprecation notices related to PodAffinity's matchLabelKeys/mismatchLabelKeys #49602
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.
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
kubernetes:main
from
mochizuki875:add_deprecation_rel_matchlabelkeys_and_mismatchlabelkeys
Feb 16, 2025
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -378,6 +378,12 @@ The keys are used to look up values from the pod labels; those key-value labels | |
| (using `AND`) with the match restrictions defined using the `labelSelector` field. The combined | ||
| filtering selects the set of existing pods that will be taken into Pod (anti)affinity calculation. | ||
|
|
||
| {{< caution >}} | ||
| It's not recommended to use `matchLabelKeys` with labels that might be updated directly on pods. | ||
| Even if you edit the pod's label that is specified at `matchLabelKeys` **directly**, (that is, not via a deployment), | ||
| kube-apiserver doesn't reflect the label update onto the merged `labelSelector`. | ||
| {{< /caution >}} | ||
|
|
||
| A common use case is to use `matchLabelKeys` with `pod-template-hash` (set on Pods | ||
| managed as part of a Deployment, where the value is unique for each revision). | ||
| Using `pod-template-hash` in `matchLabelKeys` allows you to target the Pods that belong | ||
|
|
@@ -425,6 +431,12 @@ Kubernetes includes an optional `mismatchLabelKeys` field for Pod affinity | |
| or anti-affinity. The field specifies keys for the labels that should **not** match with the incoming Pod's labels, | ||
| when satisfying the Pod (anti)affinity. | ||
|
|
||
| {{< caution >}} | ||
| It's not recommended to use `mismatchLabelKeys` with labels that might be updated directly on pods. | ||
| Even if you edit the pod's label that is specified at `mismatchLabelKeys` **directly**, (that is, not via a deployment), | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: Deployment should have a capital D; also, we have more than one API for workload management (eg StatefulSet is a thing). |
||
| kube-apiserver doesn't reflect the label update onto the merged `labelSelector`. | ||
| {{< /caution >}} | ||
|
|
||
| One example use case is to ensure Pods go to the topology domain (node, zone, etc) where only Pods from the same tenant or team are scheduled in. | ||
| In other words, you want to avoid running Pods from two different tenants on the same topology domain at the same time. | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Deployment should have a capital D; also, we have more than one API for workload management (eg StatefulSet is a thing).