You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.adoc
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,11 @@ This tutorial provides all the information required to create your first Commodo
4
4
5
5
== Contents
6
6
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.
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.
98
98
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
+
99
103
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.
100
104
101
105
.GitLab account after installation of Lieutenant
@@ -120,7 +124,7 @@ We can easily install Steward on Minikube using the `./3_steward_on_minikube.sh`
120
124
121
125
=== Synthesize a K3s Cluster
122
126
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.
124
128
125
129
First we need to get some variables from our environment:
126
130
@@ -129,7 +133,7 @@ First we need to get some variables from our environment:
129
133
$ source ./env.sh
130
134
----
131
135
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.
133
137
134
138
TIP: The term "synthesize" means performing all the required steps so that a cluster can be managed as part of a Project Syn metacluster.
135
139
@@ -163,13 +167,15 @@ Since we're using `ngrok` to expose our Lieutenant API we can inspect all the re
163
167
.Lieutenant API session inspected through ngrok
164
168
image::ngrok_inspect.png[]
165
169
166
-
=== Synthesize a Kind of Microk8s cluster
170
+
=== Synthesize Kind or Microk8s clusters
171
+
172
+
IMPORTANT: This is an optional step!
167
173
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.
169
175
170
176
== Creating a Commodore Component
171
177
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.
0 commit comments