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: docs/modules/ROOT/pages/index.adoc
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ This tutorial should give you a good idea of how all the different pieces of Pro
33
33
As for the required knowledge bits and pieces:
34
34
35
35
* You should understand https://syn.tools/syn/about/features.html[what Project Syn is], and its https://syn.tools/syn/about/architecture.html[architecture].
36
-
* You should have already followed the https://docs.syn.tools/syn/tutorials/getting-started.html[Getting Started with Project Syn] tutorial, and be familiar with common Project Syn tasks.
36
+
* You should have already followed the https://syn.tools/syn/tutorials/getting-started.html[Getting Started with Project Syn] tutorial, and be familiar with common Project Syn tasks.
37
37
38
38
This tutorial *was built on a Linux system*, and tested in both Linux and macOS; it should, however, be easily ported to other https://en.wikipedia.org/wiki/Unix-like[Unices], since all tools referenced here are cross-platform.
To install Lieutenant Operator and API on Minikube, we are going to execute the `./1_lieutenant_on_minikube.sh` script. This script mimicks the steps explained in the https://docs.syn.tools/syn/tutorials/getting-started.html["Getting Started"] tutorial, so we will not explain it here.
87
+
To install Lieutenant Operator and API on Minikube, we are going to execute the `./1_lieutenant_on_minikube.sh` script. This script mimicks the steps explained in the https://syn.tools/syn/tutorials/getting-started.html["Getting Started"] tutorial, so we will not explain it here.
88
88
89
89
The script is quite self-explanatory. It 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.
90
90
@@ -97,13 +97,13 @@ image::gitlab_01.png[]
97
97
98
98
=== Bootstrapping Commodore on Minikube
99
99
100
-
The second step in this tutorial is to bootstrap https://docs.syn.tools/commodore/[Commodore] in our Minikube cluster. For that we can just run the `./2_commodore_on_minikube.sh` script. This script requires an environment variable to run: `COMMODORE_SSH_PRIVATE_KEY` which should contain the path to your personal SSH public key.
100
+
The second step in this tutorial is to bootstrap https://syn.tools/commodore/[Commodore] in our Minikube cluster. For that we can just run the `./2_commodore_on_minikube.sh` script. This script requires an environment variable to run: `COMMODORE_SSH_PRIVATE_KEY` which should contain the path to your personal SSH public key.
101
101
102
102
WARNING: Do not press the kbd:[Enter] key when prompted with the `If you don't see a command prompt, try pressing enter` message! Instead, type the passphrase of your SSH key.
103
103
104
104
=== Install Steward on Minikube
105
105
106
-
Now that Lieutenant is installed we can install https://docs.syn.tools/steward/[Steward] on our cluster. This tool is in charge of bootstrapping https://argoproj.github.io/argo-cd/[Argo CD] which watches the GitLab and GitHub repositories, and triggers the GitOps operations required to keep each cluster up-to-date.
106
+
Now that Lieutenant is installed we can install https://syn.tools/steward/[Steward] on our cluster. This tool is in charge of bootstrapping https://argoproj.github.io/argo-cd/[Argo CD] which watches the GitLab and GitHub repositories, and triggers the GitOps operations required to keep each cluster up-to-date.
107
107
108
108
We can easily install Steward on Minikube using the `./3_steward_on_minikube.sh` script.
109
109
@@ -157,7 +157,7 @@ Now we're getting to the actual subject of this tutorial! Let us dive into the r
157
157
158
158
We are going to use now the `commodore` tool to generate and compile our new component. This tool is written in Python and requires quite a few dependencies; to make our lives easier, we are instead going to use the corresponding https://hub.docker.com/r/projectsyn/commodore[container image available in Docker Hub].
159
159
160
-
This is why it is strongly recommended that you define an ad-hoc shortcut, as explained in the https://docs.syn.tools/commodore/running-commodore.html["Running Commodore"] page, which will make using `commodore` a much simpler task. That page contains information relevant for Linux and macOS users.
160
+
This is why it is strongly recommended that you define an ad-hoc shortcut, as explained in the https://syn.tools/commodore/explanation/running-commodore.html["Running Commodore"] page, which will make using `commodore` a much simpler task. That page contains information relevant for Linux and macOS users.
161
161
162
162
But for this tutorial, you can simply run the following command to get the job done:
0 commit comments