diff --git a/argo_rollouts/using-argo-rollouts-for-progressive-deployment-delivery.adoc b/argo_rollouts/using-argo-rollouts-for-progressive-deployment-delivery.adoc index aa430797c577..5e394bb07e2d 100644 --- a/argo_rollouts/using-argo-rollouts-for-progressive-deployment-delivery.adoc +++ b/argo_rollouts/using-argo-rollouts-for-progressive-deployment-delivery.adoc @@ -26,6 +26,9 @@ include::modules/gitops-installing-argo-rollouts-cli-on-linux.adoc[leveloffset=+ // Installing Argo Rollouts CLI on Mac OS include::modules/gitops-installing-argo-rollouts-cli-on-mac-os.adoc[leveloffset=+1] +// Enabling Argo Rollouts UI on an Argo CD instance +include::modules/gitops-enabling-argo-rollouts-ui-on-an-argo-cd-instance.adoc[leveloffset=+1] + [role="_additional-resources"] [id="additional-resources_{context}"] == Additional resources diff --git a/modules/gitops-enabling-argo-rollouts-ui-on-an-argo-cd-instance.adoc b/modules/gitops-enabling-argo-rollouts-ui-on-an-argo-cd-instance.adoc new file mode 100644 index 000000000000..4971e45d80c1 --- /dev/null +++ b/modules/gitops-enabling-argo-rollouts-ui-on-an-argo-cd-instance.adoc @@ -0,0 +1,53 @@ +// Module included in the following assemblies: +// +// * argo_rollouts/using-argo-rollouts-for-progressive-deployment-delivery.adoc + +:_mod-docs-content-type: PROCEDURE +[id="gitops-enabling-argo-rollouts-ui-on-an-argo-cd-instance_{context}"] += Enabling Argo Rollouts UI on an Argo CD instance + +To enable Argo Rollouts UI on an Argo CD instance, complete the following steps. + +.Prerequisites + +* You have access to the cluster with `cluster-admin` privileges. + +* You have installed the {gitops-title} Operator on your {OCP} cluster. + +* You have configured the `RolloutManager` custom resource (CR). + +.Procedure + +. Log in to the {OCP} web console. + +. In the *Administrator* perspective of the web console, click *Operators* -> *Installed Operators*. + +. Select *{gitops-title}* from the installed Operators list and click the *Argo CD* tab. + +. Select the Argo CD instance in the *Argo CD* tab under the `openshift-gitops` namespace. + +. Click *YAML* and add the following configuration to configure the Argo Rollouts UI: ++ +.Example enabling Argo Rollouts UI in the Argo CD CR +[source,yaml] +---- +apiVersion: argoproj.io/v1beta1 +kind: ArgoCD +metadata: + name: argocd +spec: + server: + enableRolloutsUI: true # <1> +---- +<1> Set this value to `true` to configure the `enableRolloutsUI` field. + +. Click *Save*. + +. In the *Administrator* perspective of the web console, go to the {rh-app-icon} menu and click *OpenShift GitOps* -> *Cluster Argo CD*. The login page of the Argo CD Web UI is displayed in a new window. + +. To access the Argo Rollouts UI in the Argo CD Web UI, configure a sample application that includes the Argo Rollouts resources. ++ +[NOTE] +==== +The `enableRolloutsUI` field restarts the Argo CD server deployment pod. Therefore, it takes a few seconds for the Argo Rollouts extension to enable in the Argo CD Web UI. +==== \ No newline at end of file