Skip to content

RHDEVDOCS-6468: Adding a missing module in GitOps 1.16 #94081

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 4, 2025
Merged

RHDEVDOCS-6468: Adding a missing module in GitOps 1.16 #94081

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions argo_rollouts/using-argo-rollouts-for-progressive-deployment-delivery.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
53 changes: 53 additions & 0 deletions modules/gitops-enabling-argo-rollouts-ui-on-an-argo-cd-instance.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To enable Argo Rollouts UI on an Argo CD instance, complete the following steps.
You can enable Argo Rollouts UI on an Argo CD instance.

Avoid self-referential language, such as "This topic covers…​" or "Use this procedure to…​".


.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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.Example enabling Argo Rollouts UI in the Argo CD CR
.Example enabling Argo Rollouts UI in the `ArgoCD` CR
  • Consider using the name of the CR - ArgoCD instead of plain text Argo CD

[source,yaml]
----
apiVersion: argoproj.io/v1beta1
kind: ArgoCD
metadata:
name: argocd
spec:
server:
enableRolloutsUI: true # <1>
----
Comment on lines +40 to +41
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
enableRolloutsUI: true # <1>
----
enableRolloutsUI: true # <1>
# ...
----

use an ellipsis (…​) to show that the file continues before or after the quoted block. For YAML, use ('#…​') instead.

<1> Set this value to `true` to configure the `enableRolloutsUI` field.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<1> Set this value to `true` to configure the `enableRolloutsUI` field.
<1> Set the value of the `enableRolloutsUI` field to `true`.


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