Skip to content

Commit

Permalink
updating guidance to be clear
Browse files Browse the repository at this point in the history
  • Loading branch information
kquinn1204 committed Dec 17, 2024
1 parent 7adc72a commit 49f01b7
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 19 deletions.
2 changes: 2 additions & 0 deletions content/patterns/multicloud-gitops/mcg-managed-cluster.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ include::modules/comm-attributes.adoc[]
[id="attach-managed-cluster"]
= Attach a managed cluster (edge) to the management hub

The use of this Multicloud GitOps pattern depends on having at least one running Red Hat OpenShift cluster.

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.

include::modules/mcg-understanding-rhacm-requirements.adoc[leveloffset=+1]
Expand Down
32 changes: 27 additions & 5 deletions modules/comm-designate-cluster-as-managed-cluster-site.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,38 @@ To tag the cluster as `clusterGroup=<managed-cluster-group>`, complete the follo

.Procedure

. To find the new cluster, run the following command:
. To list all managed clusters, run the following command:
+
[source,terminal]
----
oc get managedcluster.cluster.open-cluster-management.io
$ oc get managedcluster.cluster.open-cluster-management.io
----
+
This will display a list of managed clusters registered in ACM, including their names and statuses.

. 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:
+
[source,terminal]
----
$ oc label managedcluster.cluster.open-cluster-management.io/YOURCLUSTER site=managed-cluster
----

. To apply the label, run the following command:
.Verification

. Confirm that the label was applied by running the following command:
+
[source,terminal]
----
oc label managedcluster.cluster.open-cluster-management.io/YOURCLUSTER site=managed-cluster
----
$ oc get managedcluster.cluster.open-cluster-management.io/YOURCLUSTER --show-labels
----
+
This will display the labels associated with the cluster, verifying that the new label has been successfully added..

. 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:
+
[source,terminal]
----
$ oc label managedcluster.cluster.open-cluster-management.io/YOURCLUSTER clusterGroup=<group-name>
----
+
Replace `<group-name>` with the appropriate value, such as `factory`.
4 changes: 2 additions & 2 deletions modules/mcg-deploying-managed-cluster-using-rhacm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@
+
[NOTE]
====
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.
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.
====

.Procedure

. 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.
. On the *Managed clusters* tab, click *Import cluster*.
. 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*.
. 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*.

Now that RHACM is no longer deploying the managed cluster applications everywhere, you must indicate that the new cluster has the managed cluster role.
15 changes: 7 additions & 8 deletions modules/mcg-deploying-mcg-pattern.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ $ oc get storageclass -o custom-columns=NAME:.metadata.name,PROVISIONER:.provisi
NAME PROVISIONER DEFAULT
gp2-csi ebs.csi.aws.com <none>
gp3-csi ebs.csi.aws.com true
----

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

.. Select an *Installation mode*:
*** *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.
*** *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.
+
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.

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

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

.Verification
To confirm that the installation is successful:
Expand Down Expand Up @@ -203,9 +202,9 @@ To know the cluster group name for the patterns that you want to deploy, check t
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.
====

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

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

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

. Verify that the Operators have been installed.
.. To verify, in the OpenShift Container Platform web console, navigate to *Operators → Installed Operators* page.
.. Check that the Operator is installed in the `openshift-operators` namespace and its status is `Succeeded`.
. 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.
.. Check that *{rh-gitops} Operator* is installed in the `openshift-operators` namespace and its status is `Succeeded`.
. 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`.
+
image::multicloud-gitops/multicloud-gitops-argocd.png[Multicloud GitOps Hub]

Expand Down
8 changes: 4 additions & 4 deletions modules/mcg-understanding-rhacm-requirements.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ $ git checkout my-branch main
----

. In the `value-hub.yaml` file, add a `managedClusterGroup` for each cluster or group of clusters that you want to manage as one.

+
[source,yaml]
----
managedClusterGroups:
Expand All @@ -31,11 +31,11 @@ managedClusterGroups:
- name: clusterGroup.isHubCluster
value: false
----

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

+
For example:

+
[source,yaml]
----
clusterGroup:
Expand Down
Binary file modified static/images/multicloud-gitops/multicloud-gitops-argocd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 49f01b7

Please sign in to comment.