|
| 1 | +// Module included in the following assemblies: |
| 2 | +// |
| 3 | +// * argo_rollouts/using-argo-rollouts-for-progressive-deployment-delivery.adoc |
| 4 | + |
| 5 | +:_mod-docs-content-type: PROCEDURE |
| 6 | +[id="gitops-enabling-argo-rollouts-ui-on-an-argo-cd-instance_{context}"] |
| 7 | += Enabling Argo Rollouts UI on an Argo CD instance |
| 8 | + |
| 9 | +To enable Argo Rollouts UI on an Argo CD instance, complete the following steps. |
| 10 | + |
| 11 | +.Prerequisites |
| 12 | + |
| 13 | +* You have access to the cluster with `cluster-admin` privileges. |
| 14 | +
|
| 15 | +* You have installed the {gitops-title} Operator on your {OCP} cluster. |
| 16 | +
|
| 17 | +* You have configured the *RolloutManager* custom resource (CR). |
| 18 | +
|
| 19 | +.Procedure |
| 20 | + |
| 21 | +. Log in to the {OCP} web console. |
| 22 | + |
| 23 | +. In the *Administrator* perspective of the web console, click *Operators* -> *Installed Operators*. |
| 24 | + |
| 25 | +. Select *{gitops-title}* from the installed Operators list and click the *Argo CD* tab. |
| 26 | + |
| 27 | +. Select the Argo CD instance in the *Argo CD* tab under the `openshift-gitops` namespace. |
| 28 | + |
| 29 | +. Click *YAML* and add the following configuration to configure the Argo Rollouts UI: |
| 30 | ++ |
| 31 | +.Example enabling Argo Rollouts UI in the Argo CD CR |
| 32 | +[source,yaml] |
| 33 | +---- |
| 34 | +apiVersion: argoproj.io/v1beta1 |
| 35 | +kind: ArgoCD |
| 36 | +metadata: |
| 37 | + name: argocd |
| 38 | +spec: |
| 39 | + server: |
| 40 | + enableRolloutsUI: true <1> |
| 41 | +---- |
| 42 | +<1> Set this value to `true` to configure the `enableRolloutsUI` field. |
| 43 | + |
| 44 | +. Click *Save*. |
| 45 | + |
| 46 | +. In the *Administrator* perspective of the web console, navigate to the {rh-app-icon} menu -> *OpenShift GitOps* -> *Cluster Argo CD*. The login page of the Argo CD Web UI is displayed in a new window. |
| 47 | + |
| 48 | +. To access the Argo Rollouts UI in the Argo CD Web UI, configure a sample application that includes the Argo Rollouts resources. |
| 49 | ++ |
| 50 | +[NOTE] |
| 51 | +==== |
| 52 | +The `enableRolloutsUI` field restarts the Argo CD server deployment pod, so it takes a few seconds for the Argo Rollouts extension to enable in the Argo CD Web UI. |
| 53 | +==== |
0 commit comments