Skip to content
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

fix: update logic to preserve k8s specific labels & annotations #1616

Merged
merged 5 commits into from
Dec 5, 2024
Merged

fix: update logic to preserve k8s specific labels & annotations #1616

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5072e7c
Fix update logic to preserve k8s specific labels & annotations
svghadi Dec 5, 2024
a59f4a8
refactor: remove return
svghadi Dec 5, 2024
933ecc3
remove edge case check
svghadi Dec 5, 2024
7667f06
Revert "remove edge case check"
svghadi Dec 5, 2024
2b1b233
Rephrase the comment
svghadi Dec 5, 2024
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
8 changes: 7 additions & 1 deletion controllers/argocd/applicationset.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,9 @@ func (r *ReconcileArgoCD) reconcileApplicationSetDeployment(cr *argoproj.ArgoCD,
}

if cr.Spec.ApplicationSet.Annotations != nil {
deploy.Spec.Template.Annotations = cr.Spec.ApplicationSet.Annotations
for key, value := range cr.Spec.ApplicationSet.Annotations {
deploy.Spec.Template.Annotations[key] = value
}
}

if cr.Spec.ApplicationSet.Labels != nil {
Expand All @@ -270,6 +272,10 @@ func (r *ReconcileArgoCD) reconcileApplicationSetDeployment(cr *argoproj.ArgoCD,

existingSpec := existing.Spec.Template.Spec

// Add Kubernetes-specific labels/annotations from the live object in the source to preserve metadata.
addKubernetesData(deploy.Spec.Template.Labels, existing.Spec.Template.Labels)
addKubernetesData(deploy.Spec.Template.Annotations, existing.Spec.Template.Annotations)

deploymentsDifferent := !reflect.DeepEqual(existingSpec.Containers[0], podSpec.Containers) ||
!reflect.DeepEqual(existingSpec.Volumes, podSpec.Volumes) ||
existingSpec.ServiceAccountName != podSpec.ServiceAccountName ||
Expand Down
24 changes: 14 additions & 10 deletions controllers/argocd/deployment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,6 +395,7 @@ func newDeploymentWithName(name string, component string, cr *argoproj.ArgoCD) *
Labels: map[string]string{
common.ArgoCDKeyName: name,
},
Annotations: make(map[string]string),
},
Spec: corev1.PodSpec{
NodeSelector: common.DefaultNodeSelector(),
Expand Down Expand Up @@ -1110,7 +1111,9 @@ func (r *ReconcileArgoCD) reconcileRepoDeployment(cr *argoproj.ArgoCD, useTLSFor
}

if cr.Spec.Repo.Annotations != nil {
deploy.Spec.Template.Annotations = cr.Spec.Repo.Annotations
for key, value := range cr.Spec.Repo.Annotations {
deploy.Spec.Template.Annotations[key] = value
}
}

if cr.Spec.Repo.Labels != nil {
Expand Down Expand Up @@ -1197,15 +1200,15 @@ func (r *ReconcileArgoCD) reconcileRepoDeployment(cr *argoproj.ArgoCD, useTLSFor
changed = true
}

deploy.Spec.Template.Annotations = cr.Spec.Repo.Annotations
// Add Kubernetes-specific labels/annotations from the live object in the source to preserve metadata.
addKubernetesData(deploy.Spec.Template.Labels, existing.Spec.Template.Labels)
addKubernetesData(deploy.Spec.Template.Annotations, existing.Spec.Template.Annotations)

if !reflect.DeepEqual(deploy.Spec.Template.Annotations, existing.Spec.Template.Annotations) {
existing.Spec.Template.Annotations = deploy.Spec.Template.Annotations
changed = true
}

for key, value := range cr.Spec.Repo.Labels {
deploy.Spec.Template.Labels[key] = value
}
if !reflect.DeepEqual(deploy.Spec.Template.Labels, existing.Spec.Template.Labels) {
existing.Spec.Template.Labels = deploy.Spec.Template.Labels
changed = true
Expand Down Expand Up @@ -1405,7 +1408,9 @@ func (r *ReconcileArgoCD) reconcileServerDeployment(cr *argoproj.ArgoCD, useTLSF
}

if cr.Spec.Server.Annotations != nil {
deploy.Spec.Template.Annotations = cr.Spec.Server.Annotations
for key, value := range cr.Spec.Server.Annotations {
deploy.Spec.Template.Annotations[key] = value
}
}

if cr.Spec.Server.Labels != nil {
Expand Down Expand Up @@ -1479,11 +1484,10 @@ func (r *ReconcileArgoCD) reconcileServerDeployment(cr *argoproj.ArgoCD, useTLSF
}
}

deploy.Spec.Template.Annotations = cr.Spec.Server.Annotations
// Add Kubernetes-specific labels/annotations from the live object in the source to preserve metadata.
addKubernetesData(deploy.Spec.Template.Labels, existing.Spec.Template.Labels)
addKubernetesData(deploy.Spec.Template.Annotations, existing.Spec.Template.Annotations)

for key, value := range cr.Spec.Server.Labels {
deploy.Spec.Template.Labels[key] = value
}
if !reflect.DeepEqual(deploy.Spec.Template.Annotations, existing.Spec.Template.Annotations) {
existing.Spec.Template.Annotations = deploy.Spec.Template.Annotations
changed = true
Expand Down
13 changes: 8 additions & 5 deletions controllers/argocd/statefulset.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ func newStatefulSetWithName(name string, component string, cr *argoproj.ArgoCD)
Labels: map[string]string{
common.ArgoCDKeyName: name,
},
Annotations: make(map[string]string),
},
Spec: corev1.PodSpec{
NodeSelector: common.DefaultNodeSelector(),
Expand Down Expand Up @@ -743,7 +744,9 @@ func (r *ReconcileArgoCD) reconcileApplicationControllerStatefulSet(cr *argoproj
}

if cr.Spec.Controller.Annotations != nil {
ss.Spec.Template.Annotations = cr.Spec.Controller.Annotations
for key, value := range cr.Spec.Controller.Annotations {
ss.Spec.Template.Annotations[key] = value
}
}

if cr.Spec.Controller.Labels != nil {
Expand Down Expand Up @@ -814,15 +817,15 @@ func (r *ReconcileArgoCD) reconcileApplicationControllerStatefulSet(cr *argoproj
changed = true
}

ss.Spec.Template.Annotations = cr.Spec.Controller.Annotations
// Add Kubernetes-specific labels/annotations from the live object in the source to preserve metadata.
addKubernetesData(ss.Spec.Template.Labels, existing.Spec.Template.Labels)
addKubernetesData(ss.Spec.Template.Annotations, existing.Spec.Template.Annotations)

if !reflect.DeepEqual(ss.Spec.Template.Annotations, existing.Spec.Template.Annotations) {
existing.Spec.Template.Annotations = ss.Spec.Template.Annotations
changed = true
}

for key, value := range cr.Spec.Controller.Labels {
ss.Spec.Template.Labels[key] = value
}
if !reflect.DeepEqual(ss.Spec.Template.Labels, existing.Spec.Template.Labels) {
existing.Spec.Template.Labels = ss.Spec.Template.Labels
changed = true
Expand Down
21 changes: 21 additions & 0 deletions controllers/argocd/util.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1688,3 +1688,24 @@ func UseServer(name string, cr *argoproj.ArgoCD) bool {
}
return true
}

// addKubernetesData checks for any Kubernetes-specific labels or annotations
// in the live object and updates the source object to ensure critical metadata
// (like scheduling, topology, or lifecycle information) is retained.
// This helps avoid loss of important Kubernetes-managed metadata during updates.
func addKubernetesData(source map[string]string, live map[string]string) {

// List of Kubernetes-specific substrings (wildcard match)
patterns := []string{
"*kubernetes.io*",
"*k8s.io*",
"*openshift.io*",
}

for key, value := range live {
found := glob.MatchStringInList(patterns, key, glob.GLOB)
if found {
source[key] = value
}
}
}
67 changes: 67 additions & 0 deletions controllers/argocd/util_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1094,3 +1094,70 @@ func TestReconcileArgoCD_reconcileDexOAuthClientSecret(t *testing.T) {
}
assert.True(t, tokenExists, "Dex is enabled but unable to create oauth client secret")
}

func TestRetainKubernetesData(t *testing.T) {
tests := []struct {
name string
source map[string]string
live map[string]string
expected map[string]string
}{
{
name: "Add Kubernetes-specific keys not in source",
source: map[string]string{
"custom-label": "custom-value",
},
live: map[string]string{
"node.kubernetes.io/pod": "true",
"kubectl.kubernetes.io/restartedAt": "2024-12-05T09:46:46+05:30",
"openshift.openshift.io/restartedAt": "2024-12-05T09:46:46+05:30",
},
expected: map[string]string{
"custom-label": "custom-value", // unchanged
"node.kubernetes.io/pod": "true", // added
"kubectl.kubernetes.io/restartedAt": "2024-12-05T09:46:46+05:30", // added
"openshift.openshift.io/restartedAt": "2024-12-05T09:46:46+05:30", // added
},
},
{
name: "Ignores non-Kubernetes-specific keys",
source: map[string]string{
"custom-label": "custom-value",
},
live: map[string]string{
"non-k8s-key": "non-k8s-value",
"custom-label": "live-value",
},
expected: map[string]string{
"custom-label": "custom-value", // unchanged
},
},
{
name: "Handles empty live map",
source: map[string]string{
"custom-label": "custom-value",
},
live: map[string]string{},
expected: map[string]string{
"custom-label": "custom-value", // unchanged
},
},
{
name: "Handles empty source map",
source: map[string]string{},
live: map[string]string{
"openshift.io/resource": "value",
},
expected: map[string]string{
"openshift.io/resource": "value", // added from live
},
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
addKubernetesData(tt.source, tt.live)
assert.Equal(t, tt.expected, tt.source)
})
}
}
Loading