OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. Explore the new docs experience today.
  1. Documentation
    2. history bug_report picture_as_pdf
×

Using a cluster-scoped Argo Rollouts instance to manage rollout resources

By default, Argo Rollouts supports the cluster-scoped mode of installation for Argo Rollouts custom resources (CRs). This mode of installation uses the CLUSTER_SCOPED_ARGO_ROLLOUTS_NAMESPACES environment variable to specify a list of namespaces that can be used to manage the rollout resources.

To manage Argo Rollouts resources, after you install the Red Hat OpenShift GitOps Operator on the cluster, you can create and configure a RolloutManager custom resource (CR) instance in the namespace of your choice. You can then update the existing Subscription object for the Red Hat OpenShift GitOps Operator and add user-defined namespaces to the CLUSTER_SCOPED_ARGO_ROLLOUTS_NAMESPACES environment variable in the spec section of the Argo CD instance.

Prerequisites

  • You have logged in to the OpenShift Container Platform cluster as an administrator.

  • You have installed the Red Hat OpenShift GitOps Operator on your OpenShift Container Platform cluster.

  • You have created a RolloutManager custom resource.

Configuring a cluster-scoped Argo Rollouts instance to manage rollout resources

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.

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.
Procedure

  1. In the Administrator perspective of the web console, navigate to Operators → Installed Operators → Red Hat OpenShift GitOps → Subscription.

  2. Click the Actions list and then click Edit Subscription.

  3. 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:

    Example configuring the CLUSTER_SCOPED_ARGO_ROLLOUTS_NAMESPACES environment variable
    apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: openshift-gitops-operator
spec:
  config:
   env:
    - name: NAMESPACE_SCOPED_ARGO_ROLLOUTS
      value: 'false' (1)
    - name: CLUSTER_SCOPED_ARGO_ROLLOUTS_NAMESPACES
      value: <list_of_namespaces_in_the_cluster-scoped_Argo_CD_instances> (2)
 ...
    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.
    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.

  4. Click Save and Reload.

Additional resources