Preserve deployment and its template labels and annotations #16199
Conversation
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
knative-prow
bot
added
kind/bug
When running `kubectl rollout restart deployment`, Kubernetes adds the `kubectl.kubernetes.io/restartedAt` annotation to the deployment's pod template to trigger a rolling restart. However, Knative's reconciler was removing this annotation by completely replacing the deployment spec, causing new pods to be immediately terminated instead of completing the rollout. This change preserves externally-added metadata at both the deployment level and template level during reconciliation: - Deployment-level labels (was already the case) and annotations (new) - Pod template labels and annotations (e.g., kubectl.kubernetes.io/restartedAt) The fix uses kmeta.UnionMaps to merge desired state with existing state, allowing external annotations/labels to take precedence while still permitting Knative to manage its own metadata. Changes: - cruds.go: Added preservation of deployment and template-level metadata - table_test.go: Added test case to verify external metadata preservation
linkvt
force-pushed
the
preserve-deployment-metadata
branch
from
f079377 to
7632241
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #16199 +/- ##
==========================================
- Coverage 80.11% 80.08% -0.03%
==========================================
Files 214 214
Lines 16940 16945 +5
==========================================
Hits 13571 13571
- Misses 3011 3014 +3
- Partials 358 360 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
|
LGTM, but I'd like @dprotaso to take a look as well. |
Author
|
/remove-approve Was added automatically as I'm co-release lead. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
knative-prow
bot
removed
the
approved
Author
|
/ok-to-test |
knative-prow
bot
added
the
ok-to-test
Member
|
/hold Will revisit after the release next Tuesday |
knative-prow
bot
added
the
do-not-merge/hold
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Hi,
when running
kubectl rollout restart deployment, Kubernetes adds thekubectl.kubernetes.io/restartedAtannotation to the deployment's pod template to trigger a rolling restart. However, Knative's reconciler was removing this annotation by completely replacing the deployment spec, causing new pods to be immediately terminated instead of completing the rollout.This change preserves externally-added metadata at both the deployment level and template level during reconciliation:
The fix uses kmeta.UnionMaps to merge desired state with existing state, allowing external annotations/labels to take precedence while still permitting Knative to manage its own metadata.
Changes:
Fixes #14705
Proposed Changes
Release Note
/kind bug
Thanks for the review!