|
| 1 | +// Module included in the following assemblies: |
| 2 | +// |
| 3 | +// * argo_rollouts/using-cluster-scoped-rollouts-instance-to-manage-rollouts-resources.adoc |
| 4 | + |
| 5 | +:_mod-docs-content-type: PROCEDURE |
| 6 | +[id="gitops-configuring-a-cluster-scoped-argo-rollouts-instance-to-manage-rollouts-resources_{context}"] |
| 7 | += Configuring a cluster-scoped Argo Rollouts instance to manage rollout resources |
| 8 | + |
| 9 | +To configure a cluster-scoped Argo Rollouts instance for managing rollout resources, add the `CLUSTER_SCOPED_ARGO_ROLLOUTS_NAMESPACES` environment variable in the `Subscription` resource. This variable contains a list of user-defined namespaces which can be configured for a cluster-scoped Argo Rollouts installation. If the `CLUSTER_SCOPED_ARGO_ROLLOUTS_NAMESPACES` environment variable is empty, you can create cluster-scoped Argo Rollouts installation in the `openshift-gitops` namespace. |
| 10 | + |
| 11 | +[NOTE] |
| 12 | +==== |
| 13 | +You can only create a cluster-scoped Argo Rollouts instance if the `NAMESPACE_SCOPED_ARGO_ROLLOUTS` variable is set to `false`. By default, if the `NAMESPACE_SCOPED_ARGO_ROLLOUTS` variable is not defined, it is set to `false`. |
| 14 | +==== |
| 15 | + |
| 16 | +.Procedure |
| 17 | + |
| 18 | +. In the *Administrator* perspective of the web console, navigate to *Operators* → *Installed Operators* → *{gitops-title}* → *Subscription*. |
| 19 | + |
| 20 | +. Click the *Actions* list and then click *Edit Subscription*. |
| 21 | + |
| 22 | +. On the *openshift-gitops-operator* Subscription details page, under the *YAML* tab, edit the `Subscription` YAML file by adding the namespace of the Argo CD instance to the `CLUSTER_SCOPED_ARGO_ROLLOUTS_NAMESPACES` environment variable in the `spec` section: |
| 23 | ++ |
| 24 | +.Example configuring the `CLUSTER_SCOPED_ARGO_ROLLOUTS_NAMESPACES` environment variable |
| 25 | +[source,yaml] |
| 26 | +---- |
| 27 | +apiVersion: operators.coreos.com/v1alpha1 |
| 28 | +kind: Subscription |
| 29 | +metadata: |
| 30 | + name: openshift-gitops-operator |
| 31 | +spec: |
| 32 | + config: |
| 33 | + env: |
| 34 | + - name: NAMESPACE_SCOPED_ARGO_ROLLOUTS |
| 35 | + value: 'false' #<1> |
| 36 | + - name: CLUSTER_SCOPED_ARGO_ROLLOUTS_NAMESPACES |
| 37 | + value: <list_of_namespaces_in_the_cluster-scoped_Argo_CD_instances> #<2> |
| 38 | + ... |
| 39 | +---- |
| 40 | +<1> Specify this value to enable or disable the cluster-scoped installation. If the value is set to `'false'`, it means that the you have enabled cluster-scoped installation. If it is set to `'true'`, it means that you have enabled namespace-scoped installation. If the value is empty, it is set to `false`. |
| 41 | +<2> Specifies a comma-separated list of namespaces that can host a cluster-scoped Argo Rollouts instance, for example `test-123-cluster-scoped,test-456-cluster-scoped`. |
| 42 | + |
| 43 | +. Click *Save* and *Reload*. |
0 commit comments