Merge pull request #230 from projectsyn/feat/customize-operator-env

Support configuring arbitrary argocd-operator environment variables

Author: simu

class/defaults.yml

@@ -121,6 +121,7 @@ parameters:
       manifests_version: ${argocd:images:argocd_operator:tag}
       cluster_scope_namespaces:
         - "${argocd:namespace}"
+      env: {}
       kustomization_url: https://github.com/argoproj-labs/argocd-operator//config/default/
       kustomize_input:
         namePrefix: syn-

component/operator.jsonnet

@@ -7,16 +7,33 @@ local params = inv.parameters.argocd.operator;
 local image = params.images.argocd_operator;
 local rbac = params.images.kube_rbac_proxy;
 
+local skip(var) =
+  var == 'ARGOCD_CLUSTER_CONFIG_NAMESPACES';
+
 local kustomize_patch_scopens = if std.length(params.cluster_scope_namespaces) > 0 then {
   patches+: [
     {
-      patch: std.format(|||
-        - op: add
-          path: "/spec/template/spec/containers/1/env/-"
-          value:
-            name: "ARGOCD_CLUSTER_CONFIG_NAMESPACES"
-            value: "%s"
-      |||, std.join(',', params.cluster_scope_namespaces)),
+      patch: std.manifestYamlDoc([
+        {
+          op: 'add',
+          path: '/spec/template/spec/containers/1/env/-',
+          value: {
+            name: 'ARGOCD_CLUSTER_CONFIG_NAMESPACES',
+            value: std.join(',', params.cluster_scope_namespaces),
+          },
+        },
+      ] + [
+        {
+          op: 'add',
+          path: '/spec/template/spec/containers/1/env/-',
+          value: {
+            name: envvar,
+            value: params.env[envvar],
+          },
+        }
+        for envvar in std.objectFields(params.env)
+        if !skip(envvar)
+      ]),
       target: {
         kind: 'Deployment',
         name: 'argocd-operator-controller-manager',

docs/modules/ROOT/pages/references/parameters.adoc

@@ -302,18 +302,50 @@ Configuration for the ArgoCD operator which is deployed as part of this componen
 
 
 === `operator.namespace`
+
+[horizontal]
 type:: string
 default:: `syn-argocd-operator`
 
 The namespace in which to deploy the argocd operator
 
 === `operator.cluster_scope_namespaces`
+
+[horizontal]
 type:: array
 default:: `["${argocd:namespace}"]`
 
 List of namespaces in which argocd is allowed to be installed at the cluster scope.
 
+=== `operator.env`
+
+[horizontal]
+type:: dictionary
+default:: `{}`
+
+Entries in this dictionary are configured as environment variables for the argocd operator container.
+
+[NOTE]
+====
+The environment variable `ARGOCD_CLUSTER_CONFIG_NAMESPACES` can't be set through this parameter.
+
+This variable is configured through component parameter `operator.cluster_scope_namespaces`.
+====
+
+[IMPORTANT]
+====
+ArgoCD may fail to update the argocd-operator deployment after you remove an entry from this config parameter.
+If you get an error like the one shown below, you need to edit the argocd-operator deployment by hand and delete the environment variable(s) which you've removed from this parameter.
+
+[source]
+----
+Failed to compare desired state to live state: failed to calculate diff: error calculating server side diff: serverSideDiff error: error removing non config mutations for resource Deployment/syn-argocd-operator-controller-manager: error reverting webhook removed fields in predicted live resource: .spec.template.spec.containers: element 0: associative list with keys has an element that omits key field "name" (and doesn't have default value)
+----
+====
+
 === `operator.migrate`
+
+[horizontal]
 type:: string
 default:: `false`
 

tests/golden/params/argocd/argocd/10_operator/apps_v1_deployment_syn-argocd-operator-controller-manager.yaml

@@ -49,6 +49,8 @@ spec:
                   fieldPath: metadata.annotations['olm.targetNamespaces']
             - name: ARGOCD_CLUSTER_CONFIG_NAMESPACES
               value: syn
+            - name: FOO
+              value: bar
           image: quay.io/argoprojlabs/argocd-operator:v0.12.2
           livenessProbe:
             httpGet:

tests/params.yml

@@ -40,6 +40,8 @@ parameters:
       server: null
     operator:
       migrate: true
+      env:
+        FOO: bar
 
     instances:
       another-ns/nulled: null