Skip to content

Commit da90062

Browse files
committed
Corrected README and rephrased parts of the tutorial
1 parent 39252a2 commit da90062

2 files changed

Lines changed: 16 additions & 6 deletions

File tree

README.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@ This tutorial provides all the information required to create your first Commodo
44

55
== Contents
66

7-
The contents of the tutorial are in the `tutoria.adoc` file.
7+
The contents of the tutorial are in the `tutorial.adoc` file. The scripts help encapsulate the knowledge required to spin up a Project Syn installation with at least 2 clusters.
8+
9+
== Requirements
10+
11+
The `0_requirements.sh` script shows the current versions of all required software.
812

913
== Build PDF
1014

tutorial.adoc

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,10 @@ include::1_lieutenant_on_minikube.sh[tag=demo]
9696

9797
This script will launch a new Minikube instance, will apply all the required `kubectl` commands, and wait for the cluster to be in the expected state before continuing.
9898

99+
It will also expose the Lieutenant API using the https://ngrok.com/[ngrok] reverse proxy tool.
100+
101+
WARNING: You do not need a commercial (paying) ngrok account to use it; just https://ngrok.com/download[download] the version corresponding to your system and make sure it is accessible through your `PATH`.
102+
99103
Once the script has run, you will find two new private repositories in your GitLab account: one named `tutorial-cluster-minikube` and another named `tutorial-tenant`. Project Syn tools use these repositories to perform https://www.gitops.tech/["GitOps"] operations on all the clusters.
100104

101105
.GitLab account after installation of Lieutenant
@@ -120,7 +124,7 @@ We can easily install Steward on Minikube using the `./3_steward_on_minikube.sh`
120124

121125
=== Synthesize a K3s Cluster
122126

123-
Now it is time to spin our second cluster, this time using K3s, itself managed using K3d. Again, a couple of scripts will make our life easier.
127+
Now it is time to spin our second cluster, this time using K3s, itself managed using https://k3d.io/[K3d]. Again, a couple of scripts will make our life easier.
124128

125129
First we need to get some variables from our environment:
126130

@@ -129,7 +133,7 @@ First we need to get some variables from our environment:
129133
$ source ./env.sh
130134
----
131135

132-
And now we can run a script that will not only spin a new k3s cluster, but will also install Steward and register it as a cluster belonging to our tenant.
136+
Now we can run a script that will not only spin a new k3s cluster, but will also install Steward and register it as a cluster belonging to our tenant. That is, we will "synthesize" our cluster.
133137

134138
TIP: The term "synthesize" means performing all the required steps so that a cluster can be managed as part of a Project Syn metacluster.
135139

@@ -163,13 +167,15 @@ Since we're using `ngrok` to expose our Lieutenant API we can inspect all the re
163167
.Lieutenant API session inspected through ngrok
164168
image::ngrok_inspect.png[]
165169

166-
=== Synthesize a Kind of Microk8s cluster
170+
=== Synthesize Kind or Microk8s clusters
171+
172+
IMPORTANT: This is an optional step!
167173

168-
This is an optional step! If you feel adventurous and have enough available RAM in your system, install https://kind.sigs.k8s.io/[kind] or https://microk8s.io/[Microk8s] and run the `./4_synthesize_on_kind.sh` or `./4_synthesize_on_microk8s.sh` scripts, to spin up yet another cluster (or two!) to be added to your current tenant.
174+
If you feel adventurous enough, and still have enough available RAM in your system, install https://kind.sigs.k8s.io/[kind] or https://microk8s.io/[Microk8s] and run the `./4_synthesize_on_kind.sh` or `./4_synthesize_on_microk8s.sh` scripts, to spin up yet another cluster (or two!) to be added to your current tenant.
169175

170176
== Creating a Commodore Component
171177

172-
This section will dive into the actual work of creating Commodore components.
178+
Now we're getting to the actual subject of this tutorial! Let us dive into the real task of creating a new Commodore component.
173179

174180
=== Using the Commodore Docker Image
175181

0 commit comments

Comments
 (0)