Skip to content

Preserve deployment and its template labels and annotations #16199

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Preserve deployment and its template labels and annotations #16199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion pkg/reconciler/revision/cruds.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,13 @@ func (c *Reconciler) checkAndUpdateDeployment(ctx context.Context, rev *v1.Revis
desiredDeployment := have.DeepCopy()
desiredDeployment.Spec = deployment.Spec

// Carry over new labels.
// Carry over new labels and annotations at deployment level.
desiredDeployment.Labels = kmeta.UnionMaps(deployment.Labels, desiredDeployment.Labels)
desiredDeployment.Annotations = kmeta.UnionMaps(deployment.Annotations, desiredDeployment.Annotations)

// Carry over template-level labels and annotations (e.g., kubectl.kubernetes.io/restartedAt from rollout restart).
desiredDeployment.Spec.Template.Labels = kmeta.UnionMaps(deployment.Spec.Template.Labels, have.Spec.Template.Labels)
desiredDeployment.Spec.Template.Annotations = kmeta.UnionMaps(deployment.Spec.Template.Annotations, have.Spec.Template.Annotations)

d, err := c.kubeclient.AppsV1().Deployments(deployment.Namespace).Update(ctx, desiredDeployment, metav1.UpdateOptions{})
if err != nil {
Expand Down
39 changes: 39 additions & 0 deletions pkg/reconciler/revision/table_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,19 @@ func TestReconcile(t *testing.T) {
Object: deploy(t, "foo", "fix-containers"),
}},
Key: "foo/fix-containers",
}, {
Name: "preserve external deployment and template annotations and labels",
Objects: []runtime.Object{
Revision("foo", "preserve-annotations",
WithLogURL, allUnknownConditions, withDefaultContainerStatuses(), WithRevisionObservedGeneration(1)),
pa("foo", "preserve-annotations", WithReachabilityUnknown),
addExternalMetadata(deploy(t, "foo", "preserve-annotations")),
image("foo", "preserve-annotations"),
},
WantUpdates: []clientgotesting.UpdateActionImpl{{
Object: addExternalMetadata(deploy(t, "foo", "preserve-annotations")),
}},
Key: "foo/preserve-annotations",
}, {
Name: "failure updating deployment",
// Test that we handle an error updating the deployment properly.
Expand Down Expand Up @@ -878,6 +891,32 @@ func changeContainers(deploy *appsv1.Deployment) *appsv1.Deployment {
return deploy
}

func addExternalMetadata(deploy *appsv1.Deployment) *appsv1.Deployment {
// Deployment-level metadata
if deploy.Annotations == nil {
deploy.Annotations = make(map[string]string)
}
deploy.Annotations["external.io/annotation"] = "external-annotation"

if deploy.Labels == nil {
deploy.Labels = make(map[string]string)
}
deploy.Labels["external.io/label"] = "external-label"

// Template-level metadata (e.g. from kubectl restart)
if deploy.Spec.Template.ObjectMeta.Annotations == nil {
deploy.Spec.Template.ObjectMeta.Annotations = make(map[string]string)
}
deploy.Spec.Template.ObjectMeta.Annotations["external.io/template-annotation"] = "external-annotation"

if deploy.Spec.Template.ObjectMeta.Labels == nil {
deploy.Spec.Template.ObjectMeta.Labels = make(map[string]string)
}
deploy.Spec.Template.ObjectMeta.Labels["external.io/template-label"] = "external-label"

return deploy
}

func withDefaultContainerStatuses() RevisionOption {
return func(r *v1.Revision) {
r.Status.ContainerStatuses = []v1.ContainerStatus{{
Expand Down
Loading