Skip to content

Commit 9fd8b47

Browse files
authored
Merge pull request #83242 from Dhruv-Soni11/RHDEVDOCS-6197
RHDEVDOCS-6197: Content creation for cluster-scoped installation
2 parents 2990546 + af80602 commit 9fd8b47

4 files changed

+71
-2
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,8 @@ Topics:
129129
File: configuring_traffic_management_and_metric_plugins_in_argo_rollouts
130130
- Name: Enabling high availability support for Argo Rollouts
131131
File: enabling-ha-support-for-argo-rollouts
132+
- Name: Using a cluster-scoped Argo Rollouts instance to manage resources
133+
File: using-cluster-scoped-rollouts-instance-to-manage-rollouts-resources
132134
---
133135
Name: Security
134136
Dir: securing_openshift_gitops
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
include::_attributes/common-attributes.adoc[]
3+
[id="using-cluster-scoped-argo-rollouts-instance-to-manage-rollouts-resources"]
4+
= Using a cluster-scoped Argo Rollouts instance to manage rollout resources
5+
context: using-cluster-scoped-argo-rollouts-instance-to-manage-rollouts-resources
6+
7+
toc::[]
8+
9+
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.
10+
11+
To manage Argo Rollouts resources, after you install the {gitops-title} 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.
12+
13+
[id="prerequisites_{context}"]
14+
== Prerequisites
15+
* You have logged in to the {OCP} cluster as an administrator.
16+
* You have installed the {gitops-title} Operator on your {OCP} cluster.
17+
* You have created a `RolloutManager` custom resource.
18+
19+
// Configuring a cluster-scoped Argo Rollouts instance to manage rollout resources
20+
include::modules/gitops-configuring-a-cluster-scoped-argo-rollouts-instance-to-manage-rollouts-resources.adoc[leveloffset=+1]
21+
22+
[role="_additional-resources"]
23+
[id="additional-resources_{context}"]
24+
== Additional resources
25+
* 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]
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * argo_rollouts/using-cluster-scoped-rollouts-instance-to-manage-rollouts-resources.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="gitops-configuring-a-cluster-scoped-argo-rollouts-instance-to-manage-rollouts-resources_{context}"]
7+
= Configuring a cluster-scoped Argo Rollouts instance to manage rollout resources
8+
9+
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.
10+
11+
[NOTE]
12+
====
13+
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`.
14+
====
15+
16+
.Procedure
17+
18+
. In the *Administrator* perspective of the web console, navigate to *Operators**Installed Operators**{gitops-title}**Subscription*.
19+
20+
. Click the *Actions* list and then click *Edit Subscription*.
21+
22+
. 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:
23+
+
24+
.Example configuring the `CLUSTER_SCOPED_ARGO_ROLLOUTS_NAMESPACES` environment variable
25+
[source,yaml]
26+
----
27+
apiVersion: operators.coreos.com/v1alpha1
28+
kind: Subscription
29+
metadata:
30+
name: openshift-gitops-operator
31+
spec:
32+
config:
33+
env:
34+
- name: NAMESPACE_SCOPED_ARGO_ROLLOUTS
35+
value: 'false' #<1>
36+
- name: CLUSTER_SCOPED_ARGO_ROLLOUTS_NAMESPACES
37+
value: <list_of_namespaces_in_the_cluster-scoped_Argo_CD_instances> #<2>
38+
...
39+
----
40+
<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`.
41+
<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`.
42+
43+
. Click *Save* and *Reload*.

modules/gitops-creating-rolloutmanager-custom-resource.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,7 @@ apiVersion: argoproj.io/v1alpha1
3333
kind: RolloutManager
3434
metadata:
3535
name: argo-rollout
36-
labels:
37-
example: basic
36+
namespace: openshift-gitops
3837
spec: {}
3938
----
4039

0 commit comments

Comments
 (0)