Skip to content

Commit 3b6f389

Browse files
kquinn1204kquinn1204
committed
updating guidance to be clear 3
1 parent 2700eaa commit 3b6f389

File tree

6 files changed

+90
-83
lines changed

6 files changed

+90
-83
lines changed

‎content/learn/getting-started-multi-cloud-gitops.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ A pop-up error with the message "Oh no! Something went wrong." might appear duri
219219

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

222-
Wait some time for everything to deploy. You can track the progress through the `Hub ArgoCD` UI from the nines menu. The viewing the `config-demo` project it appears stuck in a Degraded state. This is the expected behavior when installing using the OpenShift Container Platform console.
222+
Wait some time for everything to deploy. You can track the progress through the `Hub ArgoCD` UI from the nines menu. The `config-demo` project appears stuck in a `Degraded` state. This is the expected behavior when installing using the OpenShift Container Platform console.
223223

224224
* To resolve this you need to run the following to load the secrets into the vault:
225225
+

‎content/patterns/multicloud-gitops/mcg-cluster-sizing.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Cluster sizing
3-
weight: 30
3+
weight: 40
44
aliases: /multicloud-gitops/mcg-cluster-sizing/
55
---
66

‎content/patterns/multicloud-gitops/mcg-demo-script.adoc‎

Lines changed: 75 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Demo Script
3-
weight: 60
2+
title: Verifying the MultiCloud GitOps pattern
3+
weight: 20
44
aliases: /multicloud-gitops/demo/
55
---
66

@@ -11,111 +11,109 @@ include::modules/comm-attributes.adoc[]
1111

1212
[id="demo-intro"]
1313

14-
== Introduction
15-
The multicloud gitops pattern is designed to be an entrypoint into the Validated Patterns framework. For more information on Validated Patterns visit our link:/[documentation site]
14+
== Verifying the MultiCloud GitOps pattern
1615

17-
[id="demo-objectives"]
16+
The MultiCloud GitOps is designed to be an entrypoint into the Validated Patterns framework. The pattern includes two applications that can help you verify the installation. The `hello-world` application is a simple web page that prints "Hello World!" and the `config-demo` application is a simple web page that prints a secret that is loaded into the vault.
1817

19-
== Objectives
18+
Verify the applications are successfully deployed by following this procedure.
2019

21-
In this demo you will complete the following:
2220

23-
* Prepare your local workstation
24-
* Deploy the pattern
25-
* Extend the pattern with a small tweak
21+
.Procedure
22+
. Check the *Red Hat OpenShift GitOps Operator* is installed.
2623

27-
[id="getting-started"]
24+
. Launch the *Hub OpenShift ArgoCD* console from nines menu in the top right of the OpenShift console and verify the applications report the status `Healthy` and `Synched`.
2825

29-
== Getting Started
26+
Verify that the *hello-world* application deployed successfully as follows:
3027

31-
* Make sure you have met all the link:/learn/quickstart/#installation_prerequisites[installation prerequisites]
32-
* Follow the link:../mcg-getting-started[Getting Started Guide] to ensure that you have met all of the prerequisites
28+
. In the OpenShift console go to the *Networking* -> *Routes* menu options.
3329

34-
[NOTE]
35-
====
36-
This demo begins after `./pattern.sh make install` has been executed
37-
====
38-
39-
[id="demo"]
40-
41-
== Demo
42-
43-
Now that we have deployed the pattern onto our cluster, with `origin` pointing to your fork and using `my-branch` as the name of the used branch, we can begin to discover what has happened.
44-
You should be able to click on the nine-box and see the following entries:
45-
46-
image:multicloud-gitops/nine-box.png[]
47-
48-
If you now click on the "Hub ArgoCD" menu entry you will be taken to the ArgoCD instance with all the applications.
49-
50-
image:multicloud-gitops/hub-argocd.png[]
30+
. From the *Project:* drop down select the *hello-world* project.
5131

32+
. Click the *Location* URL. This should reveal the following:
33+
+
34+
[source,terminal]
35+
----
36+
Hello World!
5237
38+
Hub Cluster domain is 'apps.aws-hub-cluster.openshift.org'
39+
Pod is running on Local Cluster Domain 'apps.aws-hub-cluster.openshift.org'
40+
----
5341

54-
[id="secrets"]
42+
Verify that the *config-demo* application deployed successfully as follows:
5543

56-
=== Secrets loading
44+
. In the OpenShift console go to the *Networking* -> *Routes* menu options.
5745

58-
By default in the MultiCloud GitOps pattern the secrets get loaded automatically via an out of band process inside the vault running in the OCP cluster. This means that running `./pattern.sh make install` will also call the `load-secrets` makefile target.
59-
This `load-secrets` target will look for a yaml file describing the secrets to be loaded into vault and in case it cannot find one it will use the `values-secret.yaml.template` file in the git repo to try and generate random secrets.
46+
. From the *Project:* drop down select the *config-demo* project.
6047

61-
Let's copy the template to our home folder and reload the secrets:
48+
. Click the *Location* URL. This should reveal the following:
49+
+
6250
[source,terminal]
63-
cp ./values-secret.yaml.template ~/values-secret-multicloud-gitops.yaml
64-
./pattern.sh make load-secrets
65-
51+
----
52+
Hub Cluster domain is 'apps.aws-hub-cluster.openshift.org'
53+
Pod is running on Local Cluster Domain 'apps.aws-hub-cluster.openshift.org'
54+
The secret is `secret`
55+
----
6656

67-
At this point if the `config-demo` application was not green already it should become green in the ArgoCD user interface.
57+
=== Customize the web page
6858

59+
make a small change to the `hello-world` application to see how the GitOps framework applies the change.
6960

70-
[id="verify"]
61+
.Procedure
7162

72-
=== Verify the test web pages
73-
74-
If you now click on the `Routes` in the `Networking` menu entry you will see the following network routes:
75-
76-
image:multicloud-gitops/network-routes.png[]
77-
78-
Clicking on the `hello-world` application should show a small demo app that prints "Hello World!":
63+
. Edit `charts/all/hello-world/templates/hello-world-cm.yaml` adding the line `This is a patched version via git`` as shown below:
64+
+
65+
[source,terminal]
66+
----
67+
</head>
68+
<body>
69+
<h1>Hello World!</h1>
70+
+ <h1>This is a patched version via git</h1>
71+
<br/>
72+
<h2>
73+
Hub Cluster domain is '{{ .Values.global.hubClusterDomain }}' <br>
74+
----
75+
76+
. Commit this change by running the following command:
77+
+
78+
[source,terminal]
79+
----
80+
$ git commit -a -m "test a change"
81+
----
7982

80-
image:multicloud-gitops/hello-world.png[]
83+
. Push the change to the remote repository by running the following command:
84+
+
85+
[source,terminal]
86+
----
87+
$ git push origin my-branch
88+
----
8189

82-
Once the secrets are loaded correctly inside the vault, clicking on the `config-demo` route should display a small application where said secret is shown:
90+
ArgoCD will apply the change to the `hello-world` application.
8391

84-
image:multicloud-gitops/config-demo.png[]
92+
Verify that the update to the *hello-world* application is successfully applied as follows:
8593

86-
=== Make a small change to the test web pages
94+
. In the OpenShift console go to the *Networking* -> *Routes* menu options.
8795

88-
Now we can try and tweak the hello-world application and add the below line in
89-
the `charts/all/hello-world/templates/hello-world-cm.yaml` file:
90-
[source,patch]
91-
diff --git a/charts/all/hello-world/templates/hello-world-cm.yaml b/charts/all/hello-world/templates/hello-world-cm.yaml
92-
index e59561ca..bd416bc6 100644
93-
--- a/charts/all/hello-world/templates/hello-world-cm.yaml
94-
+++ b/charts/all/hello-world/templates/hello-world-cm.yaml
95-
@@ -14,6 +14,7 @@ data:
96-
</head>
97-
<body>
98-
<h1>Hello World!</h1>
99-
+ <h1>This is a patched version via git</h1>
100-
<br/>
101-
<h2>
102-
Hub Cluster domain is '{{ .Values.global.hubClusterDomain }}' <br>
96+
. From the *Project:* drop down select the *hello-world* project.
10397

98+
. Click the *Location* URL. This should reveal the following:
99+
+
100+
[source,terminal]
101+
----
102+
Hello World!
104103
105-
Once we commit the above change via `git commit -a -m "test a change"` and run
106-
`git push origin my-branch` we will be able to observe argo applying the above
107-
change:
104+
This is a patched version via git
108105
109-
image:multicloud-gitops/config-demo-patched.png[]
106+
Hub Cluster domain is 'apps.aws-hub-cluster.openshift.org'
107+
Pod is running on Local Cluster Domain 'apps.aws-hub-cluster.openshift.org'
108+
----
110109

111110
[id="summary"]
112111

113112
== Summary
114113

115-
You did it! You have completed the deployment of the MultiCloud GitOps pattern
116-
and you made a small local change and applied it via GitOps! Hopefully you are
117-
getting ideas of how you can take advantage of our GitOps framework to deploy
118-
and manage your applications.
114+
You did it! You have completed the deployment of the MultiCloud GitOps pattern and you made a small local change and applied it using GitOps.
115+
116+
Hopefully you are getting ideas of how you can take advantage of our GitOps framework to deploy and manage your applications.
119117

120-
For more information on Validated Patterns visit our
121-
link:https://validatedpatterns.io/[website]
118+
For more information about Validated Patterns visit our
119+
link:https://validatedpatterns.io/[website].

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Managed cluster sites
3-
weight: 20
3+
weight: 30
44
aliases: /multicloud-gitops/mcg-managed-cluster/
55
---
66

@@ -39,7 +39,7 @@ It might take a while for the RHACM agent and `agent-addons` to launch.
3939

4040
. Check the *Red Hat OpenShift GitOps Operator* is installed.
4141

42-
. Launch the *Group-One OpenShift ArgoCD* console from the top right nines menu of the OpenShift console.
42+
. Launch the *Group-One OpenShift ArgoCD* console from nines menu in the top right of the OpenShift console. Verify the applications report the status `Healthy` and `Synched`.
4343

4444
Verify that the *hello-world* application deployed successfully as follows:
4545

‎modules/mcg-about-customizing-pattern.adoc‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,14 @@ You can customize this demo in different ways.
1111
[id="split-config-demo"]
1212
== Split the config-demo across hub and regional clusters
1313

14-
Currently hub and regional clusters are reusing the exact same helm chart found at `charts/all/config-demo`. The first customization step could be to split the demo app in two separate charts: one in `charts/hub/config-demo` and one in `charts/region/config-demo`. Once `charts/all/config-demo` has been copied to `charts/hub/config-demo` and `charts/region/config-demo`, you need to include them in the respective `values-hub.yaml` and `values-region-one.yaml`, respectively.
14+
Currently hub and regional clusters are reusing the exact same helm chart found at `charts/all/config-demo`.
15+
16+
The first customization step could be to split the demo app in two separate charts:
17+
18+
* One in `charts/hub/config-demo`
19+
* One in `charts/region/config-demo`.
20+
21+
`charts/all/config-demo` has been copied to `charts/hub/config-demo` and `charts/region/config-demo`, you need to include them in the respective `values-hub.yaml` and `values-region-one.yaml`, respectively.
1522

1623
After completing this configuration, you can start customizing the two apps and make them output a different web page entirely depending if the pod is running on the hub or on the cluster.
1724

‎modules/mcg-deploying-mcg-pattern.adoc‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ NAME PROVISIONER DEFAULT
4343
gp2-csi ebs.csi.aws.com <none>
4444
gp3-csi ebs.csi.aws.com true
4545
----
46+
+
47+
For more information about creating a dynamic `StorageClass`, see the https://docs.openshift.com/container-platform/latest/storage/dynamic-provisioning.html[Dynamic provisioning].
4648

4749
* Optional: A second OpenShift cluster for multicloud demonstration.
4850
//Replaced git and podman prereqs with the tooling dependencies page
@@ -204,7 +206,7 @@ A pop-up error with the message "Oh no! Something went wrong." might appear duri
204206

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

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.
209+
Wait some time for everything to deploy. You can track the progress through the `Hub ArgoCD` UI from the nines menu. The `config-demo` project appears stuck in a `Degraded` state. This is the expected behavior when installing using the OpenShift Container Platform console.
208210

209211
* To resolve this you need to run the following to load the secrets into the vault:
210212
+

0 commit comments

Comments
 (0)