Skip to content

Commit eb9ceec

Browse files
committed
Convert demo script to asciidoc
Instead of having a google doc link, let's move it to the site properly
1 parent 13d344c commit eb9ceec

File tree

8 files changed

+121
-5
lines changed

8 files changed

+121
-5
lines changed
Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
---
2+
title: Demo Script
3+
weight: 60
4+
aliases: /multicloud-gitops/demo/
5+
---
6+
7+
include::modules/comm-attributes.adoc[]
8+
:toc:
9+
:imagesdir: /images
10+
:_content-type: REFERENCE
11+
12+
[id="demo-intro"]
13+
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]
16+
17+
[id="demo-objectives"]
18+
19+
== Objectives
20+
21+
In this demo you will complete the following:
22+
23+
* Prepare your local workstation
24+
* Deploy the pattern
25+
* Extend the pattern with a small tweak
26+
27+
[id="getting-started"]
28+
29+
== Getting Started
30+
31+
* Make sure you have met all the link:/learn/quickstart/#installation_prerequisitesrequirements[requirements]
32+
* Follow the link:../mcg-getting-started[Getting Started Guide] to ensure that you have met all of the prequisites
33+
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[]
51+
52+
53+
54+
[id="secrets"]
55+
56+
=== Secrets loading
57+
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.
60+
61+
Let's copy the template to our home folder and reload the secrets:
62+
[source,terminal]
63+
cp ./values-secret.yaml.template ~/values-secret-multicloud-gitops.yaml
64+
./pattern.sh make load-secrets
65+
66+
67+
At this point if the `config-demo` application was not green already it should become green in the ArgoCD user interface.
68+
69+
70+
[id="verify"]
71+
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!":
79+
80+
image:multicloud-gitops/hello-world.png[]
81+
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:
83+
84+
image:multicloud-gitops/config-demo.png[]
85+
86+
=== Make a small change to the test web pages
87+
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>
103+
104+
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:
108+
109+
image:multicloud-gitops/config-demo-patched.png[]
110+
111+
[id="summary"]
112+
113+
== Summary
114+
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.
119+
120+
For more information on Validated Patterns visit our
121+
link:https://validatedpatterns.io/[website]

modules/mcg-architecture.adoc

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,3 @@ View and download all of the diagrams above from the link:https://www.redhat.com
7676
== Presentation
7777

7878
View a short presentation slide deck about Multicloud GitOps link:https://speakerdeck.com/rhvalidatedpatterns/multicloud-gitops[here]
79-
80-
[id="demo-script"]
81-
== Demo Script
82-
83-
View a demo script walking you through the whole pattern installation link:https://docs.google.com/document/d/1fXfH0Ws90-58LVDw3RDn_LkiILwRdJWwmsxwP0Od_is/edit#heading=h.mnh4e4mvolww[here]
63.5 KB
Loading
81.4 KB
Loading
51.6 KB
Loading
203 KB
Loading
150 KB
Loading
28.9 KB
Loading

0 commit comments

Comments
 (0)