Merge pull request #607 from raghavi101/label-selector-cli

feat: Add labelSelector option to filter the ArgoCD instances for reconciliation

Author: iam-veeramalla

common/common.go

@@ -16,6 +16,8 @@ limitations under the License.
 
 package common
 
+import "os"
+
 const (
 	// ArgoCDInstanceName is the default Argo CD instance name
 	ArgoCDInstanceName = "openshift-gitops"
@@ -39,3 +41,10 @@ func InfraNodeSelector() map[string]string {
 		"node-role.kubernetes.io/infra": "",
 	}
 }
+
+func StringFromEnv(env string, defaultValue string) string {
+	if str := os.Getenv(env); str != "" {
+		return str
+	}
+	return defaultValue
+}

config/manager/manager.yaml

@@ -32,6 +32,8 @@ spec:
           value: openshift-gitops
         - name: OPERATOR_NAME
           value: gitops-operator
+        - name : LABEL_SELECTOR
+          value: ""
         image: controller:latest
         livenessProbe:
           httpGet:

hack/non-olm-install/README.md

@@ -86,6 +86,7 @@ The following environment variables can be set to configure various options for
 | **SERVER_CLUSTER_ROLE** |This environment variable enables administrators to configure a common cluster role to use across all of the managed namespaces in the role bindings the operator creates for the Argo CD server. | None |
 | **WATCH_NAMESPACE** | namespaces in which Argo applications can be created | None |
 | **ENABLE_CONVERSION_WEBHOOK** | This environment variable enables conversion webhook to convert v1alpha1 ArgoCD resources to v1beta1 | true |
+| **ARGOCD_LABEL_SELECTOR** | This environment variable will enable the operator to reconcile only the corresponding ArgoCD instances having the matching label selector. The label selector can be set on argocd-opertor by exporting `ARGOCD_LABEL_SELECTOR` (eg: `export ARGOCD_LABEL_SELECTOR=foo=bar`). The labels can be added to the argocd instances using the command `kubectl label argocd test1 foo=bar -n test-argocd`. | None |
 ### Running the script
 
 #### Usage

hack/non-olm-install/install-gitops-operator.sh

@@ -41,6 +41,7 @@ CONTROLLER_CLUSTER_ROLE=${CONTROLLER_CLUSTER_ROLE:-""}
 DISABLE_DEFAULT_ARGOCD_INSTANCE=${DISABLE_DEFAULT_ARGOCD_INSTANCE:-"false"}
 SERVER_CLUSTER_ROLE=${SERVER_CLUSTER_ROLE:-""}
 WATCH_NAMESPACE=${WATCH_NAMESPACE:-""}
+ARGOCD_LABEL_SELECTOR=${ARGOCD_LABEL_SELECTOR:-""}
 ENABLE_CONVERSION_WEBHOOK=${ENABLE_CONVERSION_WEBHOOK:-"true"}
 
 # Print help message
@@ -232,6 +233,8 @@ spec:
           value: \"${SERVER_CLUSTER_ROLE}\"
         - name: WATCH_NAMESPACE
           value: \"${WATCH_NAMESPACE}\"
+        - name: ARGOCD_LABEL_SELECTOR
+          value: \"${ARGOCD_LABEL_SELECTOR}\"
         - name: ENABLE_CONVERSION_WEBHOOK
           value: \"${ENABLE_CONVERSION_WEBHOOK}\"" > ${WORK_DIR}/env-overrides.yaml
 }
@@ -449,6 +452,9 @@ function print_info() {
   if [ ! -z "${WATCH_NAMESPACE}" ]; then
     echo "WATCH_NAMESPACE: ${WATCH_NAMESPACE}"
   fi
+  if [ ! -z "${ARGOCD_LABEL_SELECTOR}" ]; then
+    echo "ARGOCD_LABEL_SELECTOR: ${ARGOCD_LABEL_SELECTOR}"
+  fi
   if [ ! -z "${ENABLE_CONVERSION_WEBHOOK}" ]; then
     echo "ENABLE_CONVERSION_WEBHOOK: ${ENABLE_CONVERSION_WEBHOOK}"
   fi

main.go

@@ -29,13 +29,11 @@ import (
 	"go.uber.org/zap/zapcore"
 	_ "k8s.io/client-go/plugin/pkg/client/auth"
 
-	"k8s.io/apimachinery/pkg/runtime"
-	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
-
 	rolloutManagerApi "github.com/argoproj-labs/argo-rollouts-manager/api/v1alpha1"
 	rolloutManagerProvisioner "github.com/argoproj-labs/argo-rollouts-manager/controllers"
 	argov1alpha1api "github.com/argoproj-labs/argocd-operator/api/v1alpha1"
 	argov1beta1api "github.com/argoproj-labs/argocd-operator/api/v1beta1"
+	argocdcommon "github.com/argoproj-labs/argocd-operator/common"
 	argocdprovisioner "github.com/argoproj-labs/argocd-operator/controllers/argocd"
 	monitoringv1 "github.com/coreos/prometheus-operator/pkg/apis/monitoring/v1"
 	appsv1 "github.com/openshift/api/apps/v1"
@@ -46,6 +44,9 @@ import (
 	templatev1 "github.com/openshift/api/template/v1"
 	operatorsv1 "github.com/operator-framework/api/pkg/operators/v1"
 	operatorsv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
+	"k8s.io/apimachinery/pkg/labels"
+	"k8s.io/apimachinery/pkg/runtime"
+	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
 	clientgoscheme "k8s.io/client-go/kubernetes/scheme"
 	ctrl "sigs.k8s.io/controller-runtime"
 	"sigs.k8s.io/controller-runtime/pkg/healthz"
@@ -84,8 +85,10 @@ func main() {
 
 	var enableHTTP2 = false
 
+	var labelSelectorFlag string
 	flag.StringVar(&metricsAddr, "metrics-bind-address", ":8080", "The address the metric endpoint binds to.")
 	flag.StringVar(&probeAddr, "health-probe-bind-address", ":8081", "The address the probe endpoint binds to.")
+	flag.StringVar(&labelSelectorFlag, "label-selector", common.StringFromEnv(argocdcommon.ArgoCDLabelSelectorKey, argocdcommon.ArgoCDDefaultLabelSelector), "The label selector is used to map to a subset of ArgoCD instances to reconcile")
 	flag.BoolVar(&enableLeaderElection, "leader-elect", false,
 		"Enable leader election for controller manager. "+
 			"Enabling this will ensure there is only one active controller manager.")
@@ -179,10 +182,17 @@ func main() {
 		setupLog.Error(err, "unable to create controller", "controller", "Argo CD metrics")
 		os.Exit(1)
 	}
+	// Check the label selector format eg. "foo=bar"
+	if _, err := labels.Parse(labelSelectorFlag); err != nil {
+		setupLog.Error(err, "error parsing the labelSelector '%s'.", labelSelectorFlag)
+		os.Exit(1)
+	}
+	setupLog.Info(fmt.Sprintf("Watching label-selector \"%s\"", labelSelectorFlag))
 
 	if err = (&argocdprovisioner.ReconcileArgoCD{
-		Client: mgr.GetClient(),
-		Scheme: mgr.GetScheme(),
+		Client:        mgr.GetClient(),
+		Scheme:        mgr.GetScheme(),
+		LabelSelector: labelSelectorFlag,
 	}).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "Argo CD")
 		os.Exit(1)

test/openshift/e2e/sequential/1-105_validate_label_selector/01-add-label-selector.yaml

@@ -0,0 +1,23 @@
+apiVersion: kuttl.dev/v1beta1
+kind: TestStep
+commands:
+# patches the subscription to add label selector in argocd-operator
+
+# - script: |
+#       oc set env deployment openshift-gitops-operator-controller-manager -n openshift-gitops-operator ARGOCD_LABEL_SELECTOR=foo=bar -c manager
+# - script: sleep 30
+- script: |
+    if ! [ -z $NON_OLM ]; then
+      oc set env deployment openshift-gitops-operator-controller-manager -n openshift-gitops-operator ARGOCD_LABEL_SELECTOR=foo=bar -c manager
+      
+    elif [ -z $CI ]; then 
+
+      oc patch -n openshift-gitops-operator subscription openshift-gitops-operator \
+        --type merge --patch '{"spec": {"config": {"env": [{"name": "ARGOCD_LABEL_SELECTOR", "value": "foo=bar"}]}}}'
+
+    else
+    
+      oc patch -n openshift-gitops-operator subscription `subscription=gitops-operator- && oc get subscription --all-namespaces | grep $subscription | head -1 | awk '{print $2}'` \
+        --type merge --patch '{"spec": {"config": {"env": [{"name": "ARGOCD_LABEL_SELECTOR", "value": "foo=bar"}]}}}'
+    fi
+- script: sleep 120

test/openshift/e2e/sequential/1-105_validate_label_selector/02-errors.yaml

@@ -0,0 +1,7 @@
+apiVersion: argoproj.io/v1beta1
+kind: ArgoCD
+metadata:
+  name: test1
+  namespace: test-argocd
+status:
+  phase: Available

test/openshift/e2e/sequential/1-105_validate_label_selector/02-install.yaml

@@ -0,0 +1,8 @@
+apiVersion: argoproj.io/v1beta1
+kind: ArgoCD
+metadata:
+  name: test1
+  namespace: test-argocd
+  labels:
+    example: basic
+spec: {}

test/openshift/e2e/sequential/1-105_validate_label_selector/03-add-label.yaml

@@ -0,0 +1,8 @@
+apiVersion: kuttl.dev/v1beta1
+kind: TestStep
+commands:
+# patches the argocd instance with the label
+- script: |
+    kubectl label argocd test1 foo=bar -n test-argocd
+    
+- script: sleep 30

test/openshift/e2e/sequential/1-105_validate_label_selector/03-assert.yaml

@@ -0,0 +1,9 @@
+---
+apiVersion: argoproj.io/v1beta1
+kind: ArgoCD
+metadata:
+  name: test1
+  namespace: test-argocd
+status:
+  phase: Available
+---