Skip to content

OCPBUGS-120842: Fix GitopsService controller wiping admin NodePlacement on default ArgoCD CR #1276

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
Pratik-Redhat-Tech wants to merge 2 commits into
base: master
Choose a base branch
from
+206 −6
Open

OCPBUGS-120842: Fix GitopsService controller wiping admin NodePlacement on default ArgoCD CR #1276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8aeb97
Fix GitopsService controller wiping admin NodePlacement on default Ar…
Pratik-Redhat-Tech Sep 7, 2026
bc936c6
Mark GitopsService-managed NodePlacement on ArgoCD create path
Pratik-Redhat-Tech Sep 7, 2026
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
4 changes: 4 additions & 0 deletions common/common.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@ const (
InfraNodeSelectorAnnotation = "openshift.io/node-selector"
// InfraNodeSelectorAnnotationValue is the value for the infra node selector annotation
InfraNodeSelectorAnnotationValue = "node-role.kubernetes.io/infra="
// NodePlacementManagedByGitopsServiceAnnotation marks NodePlacement on the default ArgoCD CR
// that was applied by the GitopsService controller. Used to distinguish GitopsService-managed
// placement from admin edits on the ArgoCD CR directly.
NodePlacementManagedByGitopsServiceAnnotation = "gitops.openshift.io/node-placement-managed-by-gitopsservice"
)

// InfraNodeSelector returns openshift label for infrastructure nodes
Expand Down
37 changes: 31 additions & 6 deletions controllers/gitopsservice_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -495,6 +495,14 @@ func (r *ReconcileGitopsService) reconcileDefaultArgoCDInstance(instance *pipeli
}
}

gitopsServiceConfiguresNodePlacement := len(instance.Spec.NodeSelector) > 0 || len(instance.Spec.Tolerations) > 0
if gitopsServiceConfiguresNodePlacement {
if defaultArgoCDInstance.Annotations == nil {
defaultArgoCDInstance.Annotations = map[string]string{}
}
defaultArgoCDInstance.Annotations[common.NodePlacementManagedByGitopsServiceAnnotation] = "true"
}

// Get or create ArgoCD instance in default namespace
existingArgoCD := &argoapp.ArgoCD{}
err = r.Client.Get(context.TODO(), types.NamespacedName{Name: defaultArgoCDInstance.Name, Namespace: defaultArgoCDInstance.Namespace}, existingArgoCD)
Expand Down Expand Up @@ -560,15 +568,32 @@ func (r *ReconcileGitopsService) reconcileDefaultArgoCDInstance(instance *pipeli
changed = true
}

// if user is patching nodePlacement through GitopsService CR, then existingArgoCD NodePlacement is updated.
if defaultArgoCDInstance.Spec.NodePlacement != nil {
if !reflect.DeepEqual(existingArgoCD.Spec.NodePlacement, defaultArgoCDInstance.Spec.NodePlacement) {
// Sync NodePlacement when GitopsService configures placement fields. Do not wipe NodePlacement
// that admins set directly on the ArgoCD CR when GitopsService placement fields are empty.
if gitopsServiceConfiguresNodePlacement {
if defaultArgoCDInstance.Spec.NodePlacement != nil {
if !reflect.DeepEqual(existingArgoCD.Spec.NodePlacement, defaultArgoCDInstance.Spec.NodePlacement) {
existingArgoCD.Spec.NodePlacement = defaultArgoCDInstance.Spec.NodePlacement
changed = true
}
} else if existingArgoCD.Spec.NodePlacement != nil {
existingArgoCD.Spec.NodePlacement = defaultArgoCDInstance.Spec.NodePlacement
changed = true
}
// Handle the case where NodePlacement should be removed
} else if existingArgoCD.Spec.NodePlacement != nil {
existingArgoCD.Spec.NodePlacement = defaultArgoCDInstance.Spec.NodePlacement
if existingArgoCD.Annotations == nil {
existingArgoCD.Annotations = map[string]string{}
}
if existingArgoCD.Annotations[common.NodePlacementManagedByGitopsServiceAnnotation] != "true" {
existingArgoCD.Annotations[common.NodePlacementManagedByGitopsServiceAnnotation] = "true"
changed = true
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}
} else if existingArgoCD.Annotations != nil &&
existingArgoCD.Annotations[common.NodePlacementManagedByGitopsServiceAnnotation] == "true" {
if existingArgoCD.Spec.NodePlacement != nil {
existingArgoCD.Spec.NodePlacement = nil
changed = true
}
delete(existingArgoCD.Annotations, common.NodePlacementManagedByGitopsServiceAnnotation)
changed = true
}

Expand Down
171 changes: 171 additions & 0 deletions controllers/gitopsservice_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,177 @@ func TestReconcileDefaultForArgoCDNodeplacement(t *testing.T) {
assertNoError(t, err)
assert.Check(t, existingArgoCD.Spec.NodePlacement != nil)
assert.DeepEqual(t, existingArgoCD.Spec.NodePlacement.NodeSelector, gitopsService.Spec.NodeSelector)
assert.Equal(t, existingArgoCD.Annotations[common.NodePlacementManagedByGitopsServiceAnnotation], "true")
}

func TestReconcileDefaultArgoCDNodePlacementPreservesDirectEdit(t *testing.T) {
logf.SetLogger(argocd.ZapLogger(true))
s := scheme.Scheme
addKnownTypesToScheme(s)

gitopsService := &pipelinesv1alpha1.GitopsService{
ObjectMeta: v1.ObjectMeta{
Name: serviceName,
},
}

directNodePlacement := &argoapp.ArgoCDNodePlacementSpec{
NodeSelector: map[string]string{
"machine.openshift.io/cluster-api-machineset": "cl01-infra-0",
},
Tolerations: []corev1.Toleration{{
Effect: corev1.TaintEffectNoSchedule,
Key: "infra",
Value: "reserved",
}},
}

fakeClient := fake.NewFakeClient(gitopsService)
reconciler := newReconcileGitOpsService(fakeClient, s)

existingArgoCD := &argoapp.ArgoCD{
ObjectMeta: v1.ObjectMeta{
Name: serviceNamespace,
Namespace: serviceNamespace,
},
Spec: argoapp.ArgoCDSpec{
NodePlacement: directNodePlacement,
Server: argoapp.ArgoCDServerSpec{
Route: argoapp.ArgoCDRouteSpec{
Enabled: true,
},
},
ApplicationSet: &argoapp.ArgoCDApplicationSet{},
SSO: &argoapp.ArgoCDSSOSpec{
Provider: "dex",
Dex: &argoapp.ArgoCDDexSpec{
Config: "test-config",
},
},
},
}

err := fakeClient.Create(context.TODO(), existingArgoCD)
assertNoError(t, err)

_, err = reconciler.Reconcile(context.TODO(), newRequest("test", "test"))
assertNoError(t, err)

err = fakeClient.Get(context.TODO(), types.NamespacedName{Name: common.ArgoCDInstanceName, Namespace: serviceNamespace},
existingArgoCD)
assertNoError(t, err)
assert.DeepEqual(t, existingArgoCD.Spec.NodePlacement, directNodePlacement)
_, hasManagedAnnotation := existingArgoCD.Annotations[common.NodePlacementManagedByGitopsServiceAnnotation]
assert.Assert(t, !hasManagedAnnotation)
}

func TestReconcileDefaultArgoCDNodePlacementClearsWhenGitopsServiceCleared(t *testing.T) {
logf.SetLogger(argocd.ZapLogger(true))
s := scheme.Scheme
addKnownTypesToScheme(s)

gitopsService := &pipelinesv1alpha1.GitopsService{
ObjectMeta: v1.ObjectMeta{
Name: serviceName,
},
Spec: pipelinesv1alpha1.GitopsServiceSpec{
NodeSelector: map[string]string{
"key1": "value1",
},
},
}

fakeClient := fake.NewFakeClient(gitopsService)
reconciler := newReconcileGitOpsService(fakeClient, s)

existingArgoCD := &argoapp.ArgoCD{
ObjectMeta: v1.ObjectMeta{
Name: serviceNamespace,
Namespace: serviceNamespace,
},
Spec: argoapp.ArgoCDSpec{
Server: argoapp.ArgoCDServerSpec{
Route: argoapp.ArgoCDRouteSpec{
Enabled: true,
},
},
ApplicationSet: &argoapp.ArgoCDApplicationSet{},
SSO: &argoapp.ArgoCDSSOSpec{
Provider: "dex",
Dex: &argoapp.ArgoCDDexSpec{
Config: "test-config",
},
},
},
}

err := fakeClient.Create(context.TODO(), existingArgoCD)
assertNoError(t, err)

_, err = reconciler.Reconcile(context.TODO(), newRequest("test", "test"))
assertNoError(t, err)

err = fakeClient.Get(context.TODO(), types.NamespacedName{Name: serviceName}, gitopsService)
assertNoError(t, err)
gitopsService.Spec.NodeSelector = nil
err = fakeClient.Update(context.TODO(), gitopsService)
assertNoError(t, err)

_, err = reconciler.Reconcile(context.TODO(), newRequest("test", "test"))
assertNoError(t, err)

err = fakeClient.Get(context.TODO(), types.NamespacedName{Name: common.ArgoCDInstanceName, Namespace: serviceNamespace},
existingArgoCD)
assertNoError(t, err)
assert.Assert(t, existingArgoCD.Spec.NodePlacement == nil)
_, hasManagedAnnotation := existingArgoCD.Annotations[common.NodePlacementManagedByGitopsServiceAnnotation]
assert.Assert(t, !hasManagedAnnotation)
}

func TestReconcileDefaultArgoCDNodePlacementClearsWhenCreatedByReconcile(t *testing.T) {
logf.SetLogger(argocd.ZapLogger(true))
s := scheme.Scheme
addKnownTypesToScheme(s)

gitopsService := &pipelinesv1alpha1.GitopsService{
ObjectMeta: v1.ObjectMeta{
Name: serviceName,
},
Spec: pipelinesv1alpha1.GitopsServiceSpec{
NodeSelector: map[string]string{
"key1": "value1",
},
},
}

fakeClient := fake.NewFakeClient(gitopsService)
reconciler := newReconcileGitOpsService(fakeClient, s)

_, err := reconciler.Reconcile(context.TODO(), newRequest("test", "test"))
assertNoError(t, err)

existingArgoCD := &argoapp.ArgoCD{}
err = fakeClient.Get(context.TODO(), types.NamespacedName{Name: common.ArgoCDInstanceName, Namespace: serviceNamespace},
existingArgoCD)
assertNoError(t, err)
assert.Check(t, existingArgoCD.Spec.NodePlacement != nil)
assert.Equal(t, existingArgoCD.Annotations[common.NodePlacementManagedByGitopsServiceAnnotation], "true")

err = fakeClient.Get(context.TODO(), types.NamespacedName{Name: serviceName}, gitopsService)
assertNoError(t, err)
gitopsService.Spec.NodeSelector = nil
err = fakeClient.Update(context.TODO(), gitopsService)
assertNoError(t, err)

_, err = reconciler.Reconcile(context.TODO(), newRequest("test", "test"))
assertNoError(t, err)

err = fakeClient.Get(context.TODO(), types.NamespacedName{Name: common.ArgoCDInstanceName, Namespace: serviceNamespace},
existingArgoCD)
assertNoError(t, err)
assert.Assert(t, existingArgoCD.Spec.NodePlacement == nil)
_, hasManagedAnnotation := existingArgoCD.Annotations[common.NodePlacementManagedByGitopsServiceAnnotation]
assert.Assert(t, !hasManagedAnnotation)
}

// If the DISABLE_DEFAULT_ARGOCD_INSTANCE is set, ensure that the default ArgoCD instance is not created.
Expand Down