Skip to content

Commit 49f01b7

Browse files
committed
updating guidance to be clear
1 parent 7adc72a commit 49f01b7

File tree

6 files changed

+42
-19
lines changed

6 files changed

+42
-19
lines changed

content/patterns/multicloud-gitops/mcg-managed-cluster.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ include::modules/comm-attributes.adoc[]
1313
[id="attach-managed-cluster"]
1414
= Attach a managed cluster (edge) to the management hub
1515

16+
The use of this Multicloud GitOps pattern depends on having at least one running Red Hat OpenShift cluster.
17+
1618
When you install the multi-cloud GitOps pattern, a hub cluster is setup. The hub cluster serves as the central point for managing and deploying applications across multiple clusters.
1719

1820
include::modules/mcg-understanding-rhacm-requirements.adoc[leveloffset=+1]

modules/comm-designate-cluster-as-managed-cluster-site.adoc

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,38 @@ To tag the cluster as `clusterGroup=<managed-cluster-group>`, complete the follo
1010

1111
.Procedure
1212

13-
. To find the new cluster, run the following command:
13+
. To list all managed clusters, run the following command:
1414
+
1515
[source,terminal]
1616
----
17-
oc get managedcluster.cluster.open-cluster-management.io
17+
$ oc get managedcluster.cluster.open-cluster-management.io
18+
----
19+
+
20+
This will display a list of managed clusters registered in ACM, including their names and statuses.
21+
22+
. Once you identify the target cluster for example `YOURCLUSTER`, label it with the desired key-value pair to associate it with a group or category. To apply the label, run the following command:
23+
+
24+
[source,terminal]
25+
----
26+
$ oc label managedcluster.cluster.open-cluster-management.io/YOURCLUSTER site=managed-cluster
1827
----
1928

20-
. To apply the label, run the following command:
29+
.Verification
30+
31+
. Confirm that the label was applied by running the following command:
2132
+
2233
[source,terminal]
2334
----
24-
oc label managedcluster.cluster.open-cluster-management.io/YOURCLUSTER site=managed-cluster
25-
----
35+
$ oc get managedcluster.cluster.open-cluster-management.io/YOURCLUSTER --show-labels
36+
----
37+
+
38+
This will display the labels associated with the cluster, verifying that the new label has been successfully added..
39+
40+
. Optional: If you’re grouping clusters under a clusterGroup for example `factory`, `devel`, or `prod`, add the clusterGroup label also by running the following command:
41+
+
42+
[source,terminal]
43+
----
44+
$ oc label managedcluster.cluster.open-cluster-management.io/YOURCLUSTER clusterGroup=<group-name>
45+
----
46+
+
47+
Replace `<group-name>` with the appropriate value, such as `factory`.

modules/mcg-deploying-managed-cluster-using-rhacm.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@
1414
+
1515
[NOTE]
1616
====
17-
After RHACM is installed, a message regarding a *Web console update is available*" might be displayed. Follow the instructions and click the *Refresh web console* link.
17+
After RHACM is installed, a message regarding a *Web console update is available* might be displayed. Follow the instructions and click the *Refresh web console* link.
1818
====
1919

2020
.Procedure
2121

2222
. In the left navigation panel of web console, click *local-cluster*. Select *All Clusters*. The RHACM web console is displayed with *Cluster** on the left navigation panel.
2323
. On the *Managed clusters* tab, click *Import cluster*.
24-
. On the *Import an existing cluster* page, enter the cluster name and choose *KUBECONFIG* as the "import mode". Add the tag `clusterGroup=region-one`. Click *Import*.
24+
. On the *Import an existing cluster* page, enter the cluster name and choose *KUBECONFIG* as the "import mode". Add the tag `clusterGroup=group-one`. Click *Import*.
2525

2626
Now that RHACM is no longer deploying the managed cluster applications everywhere, you must indicate that the new cluster has the managed cluster role.

modules/mcg-deploying-mcg-pattern.adoc

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ $ oc get storageclass -o custom-columns=NAME:.metadata.name,PROVISIONER:.provisi
4242
NAME PROVISIONER DEFAULT
4343
gp2-csi ebs.csi.aws.com <none>
4444
gp3-csi ebs.csi.aws.com true
45-
4645
----
4746

4847
* Optional: A second OpenShift cluster for multicloud demonstration.
@@ -155,12 +154,12 @@ Choosing a Community Operator warns that Red Hat does not certify Community Oper
155154
.. Select a *Version* (if more than one is available).
156155

157156
.. Select an *Installation mode*:
158-
*** *All namespaces on the cluster (default)* installs the Operator in the default `openshift-operators` namespace to watch and be made available to all namespaces in the cluster. This option is not always available.
159-
*** *A specific namespace on the cluster* allows you to choose a specific, single namespace in which to install the Operator. The Operator will only watch and be made available for use in this single namespace.
157+
+
158+
The only supported mode for this Operator is *All namespaces on the cluster (default)*. This installs the Operator in the default `openshift-operators` namespace to watch and be made available to all namespaces in the cluster. This option is not always available.
160159

161160
.. Select *Automatic* or *Manual* approval strategy.
162161

163-
. Click *Install* to make the Operator available to the selected namespaces on this {ocp} cluster.
162+
. Click *Install* to make the Operator available to the default `openshift-operators` namespace on this {ocp} cluster.
164163

165164
.Verification
166165
To confirm that the installation is successful:
@@ -203,9 +202,9 @@ To know the cluster group name for the patterns that you want to deploy, check t
203202
A pop-up error with the message "Oh no! Something went wrong." might appear during the process. This error can be safely disregarded as it does not impact the installation of the Multicloud GitOps pattern. Use the Hub ArgoCD UI, accessible through the nines menu, to check the status of ArgoCD instances, which will display states such as progressing, healthy, and so on, for each managed application. The Cluster ArgoCD provides detailed status on each application, as defined in the clustergroup values file.
204203
====
205204

206-
The {rh-gitops} Operator displays in list of *Installed Operators*. The {rh-gitops} Operator installs the remaining assets and artifacts for this pattern. To view the installation of these assets and artifacts, such as {rh-rhacm-first}, ensure that you switch to *Project:All Projects*.
205+
The *{rh-gitops} Operator* displays in list of *Installed Operators*. The *{rh-gitops} Operator* installs the remaining assets and artifacts for this pattern. To view the installation of these assets and artifacts, such as *{rh-rhacm-first}*, ensure that you switch to *Project:All Projects*.
207206

208-
When viewing the `config-demo` project through the Hub `ArgoCD` UI from the nines menu, it appears stuck in a Degraded state. This is the expected behavior when installing using the OpenShift Container Platform console.
207+
When viewing the `config-demo` project through the `Hub ArgoCD` UI from the nines menu, it appears stuck in a `Degraded` state. This is the expected behavior when installing using the OpenShift Container Platform console.
209208

210209
* To resolve this you need to run the following to load the secrets into the vault:
211210
+
@@ -256,8 +255,8 @@ $ ./pattern.sh make install
256255

257256
. Verify that the Operators have been installed.
258257
.. To verify, in the OpenShift Container Platform web console, navigate to *Operators → Installed Operators* page.
259-
.. Check that the Operator is installed in the `openshift-operators` namespace and its status is `Succeeded`.
260-
. Verify that all applications are synchronized. Under the project `multicloud-gitops-hub` click the URL for the `hub` gitops `server`. The Vault application is not synched.
258+
.. Check that *{rh-gitops} Operator* is installed in the `openshift-operators` namespace and its status is `Succeeded`.
259+
. Verify that all applications are synchronized. Under *Networking \-> Routes \* select the *Location URL* associated with the *hub-gitops-server* . All application are report status as `Synched`.
261260
+
262261
image::multicloud-gitops/multicloud-gitops-argocd.png[Multicloud GitOps Hub]
263262

modules/mcg-understanding-rhacm-requirements.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ $ git checkout my-branch main
1818
----
1919

2020
. In the `value-hub.yaml` file, add a `managedClusterGroup` for each cluster or group of clusters that you want to manage as one.
21-
21+
+
2222
[source,yaml]
2323
----
2424
managedClusterGroups:
@@ -31,11 +31,11 @@ managedClusterGroups:
3131
- name: clusterGroup.isHubCluster
3232
value: false
3333
----
34-
34+
+
3535
The above YAML file segment deploys the `clusterGroup` applications on managed clusters with the label `clusterGroup=group-one`. Specific subscriptions and Operators, applications and projects for that `clusterGroup` are then managed in a `value-group-one.yaml` file.
36-
36+
+
3737
For example:
38-
38+
+
3939
[source,yaml]
4040
----
4141
clusterGroup:
14.4 KB
Loading

0 commit comments

Comments
 (0)