Skip to content
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.

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

RHDEVDOCS-6197: Content creation #83242

Open
wants to merge 1 commit into
base: gitops-docs-main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,8 @@ Topics:
File: routing-traffic-by-using-argo-rollouts-for-openshift-service-mesh
- Name: Enabling support for namespace-scoped Argo Rollouts installation
File: enable-support-for-namespace-scoped-argo-rollouts-installation
- Name: Using a cluster-scoped rollouts instance to manage rollouts resources
File: using-cluster-scoped-rollouts-instance-to-manage-rollouts-resources
---
Name: Security
Dir: securing_openshift_gitops
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
:_mod-docs-content-type: ASSEMBLY
include::_attributes/common-attributes.adoc[]
[id="using-a-cluster-scoped-rollouts-instance-to-manage-rollouts-resources"]
= Using a cluster-scoped rollouts instance to manage rollouts resources
:context: using-a-cluster-scoped-rollouts-instance-to-manage-rollouts-resources

toc::[]

To manage rollouts resources, after you install the {gitops-titel} 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 {gitops-title} Operator and add user-defined namespaces to the `CLUSTER_SCOPED_ARGO_ROLLOUTS_NAMESPACES` environment variable in the `spec` section of the Argo CD instance.

[id="prerequisites_{context}"]
== Prerequisites

* You have logged in to the {OCP} cluster as an administrator.
* You have installed the {gitops-title} Operator on your {OCP} cluster.
* You have created a `RolloutManager` custom resource.

// Configuring a cluster-scoped rollouts instance to manage rollouts resources
include::modules/gitops-configuring-a-cluster-scoped-instance-to-manage-rollouts-resources.adoc[leveloffset=+1]

[role="_additional-resources"]
[id="additional-resources_{context}"]
== Additional resources
* xref:../argo_rollouts/using-argo-rollouts-for-progressive-deployment-delivery.adoc#gitops-creating-rolloutmanager-custom-resource_using-argo-rollouts-for-progressive-deployment-delivery[Creating RolloutManager custom resources]
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
// Module included in the following assemblies:
//
// * argo_rollouts/using-a-cluster-scoped-rollouts-instance-to-manage-rollouts-resources.adoc

:_mod-docs-content-type: PROCEDURE
[id="gitops-configuring-a-cluster-scoped-instance-to-manage-rollouts-resources_{context}"]
= Configuring a cluster-scoped rollouts instance to manage rollouts resources

To configure a cluster-scoped rollouts instance for managing rollouts 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 rollouts installation.

[NOTE]
====
You can only create a cluster-scoped rollouts instance if the `NAMESPACE_SCOPED_ARGO_ROLLOUTS` variable is set to `false`.
====

.Procedure
. In the *Administrator* perspective of the web console, navigate to *Operators* → *Installed Operators* → *{gitops-title}* → *Subscription*.
. Click the *Actions* list and then click *Edit Subscription*.
. 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
+
[source,yaml]
----
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
name: argo-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> The value set to `'false'` means that the installation defaults to cluster-scoped mode.
<2> Specifies the list of namespaces defined in the cluster scoped Argo CD instance, for example `test123-cluster-scoped`.

. Click *Save* and *Reload*.
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ apiVersion: argoproj.io/v1alpha1
kind: RolloutManager
metadata:
name: argo-rollout
namespace: openshift-gitops
labels:
example: basic
spec: {}
Expand Down