Major change: exposing the Lieutenant API with ngrok, adding support for kind and microk8s

akosma · akosma · commit 39252a2bb9fa · 2020-08-12T14:40:56.000+02:00
diff --git a/0_requirements.sh b/0_requirements.sh
@@ -7,6 +7,9 @@ trim () {
 	echo -n "$var"
 }
 
+NGROK_VERSION=$(ngrok version)
+echo $NGROK_VERSION
+
 DOCKER_VERSION=$(docker version | grep Version -m 1)
 DOCKER_VERSION=$(trim "$DOCKER_VERSION")
 echo "Docker $DOCKER_VERSION"
diff --git a/1_lieutenant_on_minikube.sh b/1_lieutenant_on_minikube.sh
@@ -34,8 +34,12 @@ echo "===> For Minikube we must delete the default service and re-create it"
 kubectl -n lieutenant delete svc lieutenant-api
 kubectl -n lieutenant expose deployment lieutenant-api --type=NodePort --port=8080
 
-echo "===> Find Lieutenant URL"
-LIEUTENANT_URL=$(minikube service lieutenant-api -n lieutenant --url | sed 's/http:\/\///g' | awk '{split($0,a,":"); print "lieutenant." a[1] ".nip.io:" a[2]}')
+echo "===> Launch ngrok in the background tunneling towards the Lieutenant API"
+setsid ./ngrok.sh >/dev/null 2>&1 < /dev/null &
+sleep 2s
+
+echo "===> Find external Lieutenant URL through the ngrok API"
+LIEUTENANT_URL=$(curl http://localhost:4040/api/tunnels --silent | jq -r '.["tunnels"][0]["public_url"]')
 echo "===> Lieutenant API: $LIEUTENANT_URL"
 # end::demo[]
 
@@ -64,7 +68,7 @@ kubectl -n lieutenant get tenant
 kubectl -n lieutenant get gitrepo
 
 echo "===> Register a Lieutenant Cluster via the API"
-CLUSTER_ID=$(curl -s -H "$LIEUTENANT_AUTH" -H "Content-Type: application/json" -X POST --data "{ \"tenant\": \"${TENANT_ID}\", \"displayName\": \"Minikube cluster\", \"facts\": { \"cloud\": \"local\", \"distribution\": \"k3s\", \"region\": \"local\" }, \"gitRepo\": { \"url\": \"ssh://git@${GITLAB_ENDPOINT}/${GITLAB_USERNAME}/tutorial-cluster-minikube.git\" } }" "http://${LIEUTENANT_URL}/clusters" | jq -r ".id")
+CLUSTER_ID=$(curl -s -H "$LIEUTENANT_AUTH" -H "Content-Type: application/json" -X POST --data "{ \"tenant\": \"${TENANT_ID}\", \"displayName\": \"Minikube cluster\", \"facts\": { \"cloud\": \"local\", \"distribution\": \"k3s\", \"region\": \"local\" }, \"gitRepo\": { \"url\": \"ssh://git@${GITLAB_ENDPOINT}/${GITLAB_USERNAME}/tutorial-cluster-minikube.git\" } }" "${LIEUTENANT_URL}/clusters" | jq -r ".id")
 echo "Cluster ID: $CLUSTER_ID"
 
 echo "===> Retrieve the registered Clusters via API and directly on the cluster"
diff --git a/2_commodore_on_minikube.sh b/2_commodore_on_minikube.sh
@@ -19,15 +19,15 @@ fi
 echo "===> OK: commodore defaults forked: $GITHUB_COMMODORE_DEFAULTS"
 
 echo "===> Find Lieutenant URL"
-LIEUTENANT_URL=$(minikube service lieutenant-api -n lieutenant --url | sed 's/http:\/\///g' | awk '{split($0,a,":"); print "http://lieutenant." a[1] ".nip.io:" a[2]} "/"')
+LIEUTENANT_URL=$(curl http://localhost:4040/api/tunnels --silent | jq -r '.["tunnels"][0]["public_url"]')
 check_variable "LIEUTENANT_URL" $LIEUTENANT_URL
 
 echo "===> Find Cluster ID"
-CLUSTER_ID=$(kubectl -n lieutenant get cluster | grep c- | awk 'NR==1{print $1}')
+CLUSTER_ID=$(kubectl --context minikube -n lieutenant get cluster | grep c- | awk 'NR==1{print $1}')
 check_variable "CLUSTER_ID" $CLUSTER_ID
 
 echo "===> Find Lieutenant Token"
-LIEUTENANT_TOKEN=$(kubectl -n lieutenant get secret $(kubectl -n lieutenant get sa api-access-synkickstart -o go-template='{{(index .secrets 0).name}}') -o go-template='{{.data.token | base64decode}}')
+LIEUTENANT_TOKEN=$(kubectl --context minikube -n lieutenant get secret $(kubectl -n lieutenant get sa api-access-synkickstart -o go-template='{{(index .secrets 0).name}}') -o go-template='{{.data.token | base64decode}}')
 
 echo "===> Kickstart Commodore"
 echo "===> IMPORTANT: When prompted enter your SSH key password"
diff --git a/3_steward_on_minikube.sh b/3_steward_on_minikube.sh
@@ -10,7 +10,7 @@ CLUSTER_ID=$(kubectl --context minikube -n lieutenant get cluster | grep Minikub
 check_variable "CLUSTER_ID" $CLUSTER_ID
 
 echo "===> Find Lieutenant URL"
-LIEUTENANT_URL=$(minikube service lieutenant-api -n lieutenant --url | sed 's/http:\/\///g' | awk '{split($0,a,":"); print "http://lieutenant." a[1] ".nip.io:" a[2] }')
+LIEUTENANT_URL=$(curl http://localhost:4040/api/tunnels --silent | jq -r '.["tunnels"][0]["public_url"]')
 check_variable "LIEUTENANT_URL" $LIEUTENANT_URL
 
 echo "===> Find Lieutenant API token"
diff --git a/4_synthesize_on_k3s.sh b/4_synthesize_on_k3s.sh
@@ -12,11 +12,7 @@ check_variable "LIEUTENANT_TOKEN" $LIEUTENANT_TOKEN
 check_variable "COMMODORE_SSH_PRIVATE_KEY" $COMMODORE_SSH_PRIVATE_KEY
 
 # Launch K3s
-if [[ "$OSTYPE" == "darwin"* ]]; then
-  k3d cluster create projectsyn
-else
-  k3d cluster create projectsyn --network host
-fi
+k3d cluster create projectsyn
 
 wait_for_k3s
 wait_for_traefik
diff --git a/4_synthesize_on_kind.sh b/4_synthesize_on_kind.sh
@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+
+source lib/functions.sh
+
+check_variable "GITLAB_TOKEN" $GITLAB_TOKEN
+check_variable "GITLAB_ENDPOINT" $GITLAB_ENDPOINT
+check_variable "GITLAB_USERNAME" $GITLAB_USERNAME
+check_variable "TENANT_ID" $TENANT_ID
+check_variable "LIEUTENANT_URL" $LIEUTENANT_URL
+check_variable "LIEUTENANT_TOKEN" $LIEUTENANT_TOKEN
+check_variable "COMMODORE_SSH_PRIVATE_KEY" $COMMODORE_SSH_PRIVATE_KEY
+
+# Launch kind
+kind create cluster --name projectsyn
+
+LIEUTENANT_AUTH="Authorization: Bearer ${LIEUTENANT_TOKEN}"
+
+echo "===> Register this cluster via the API"
+CLUSTER_ID=$(curl -s -H "$LIEUTENANT_AUTH" -H "Content-Type: application/json" -X POST --data "{ \"tenant\": \"${TENANT_ID}\", \"displayName\": \"Kind cluster\", \"facts\": { \"cloud\": \"local\", \"distribution\": \"k3s\", \"region\": \"local\" }, \"gitRepo\": { \"url\": \"ssh://git@${GITLAB_ENDPOINT}/${GITLAB_USERNAME}/tutorial-cluster-kind.git\" } }" "${LIEUTENANT_URL}/clusters" | jq -r ".id")
+check_variable "CLUSTER_ID" $CLUSTER_ID
+
+echo "===> Kickstart Commodore"
+echo "===> IMPORTANT: When prompted enter your SSH key password"
+kubectl --context minikube -n lieutenant run commodore-shell \
+  --image=docker.io/projectsyn/commodore:v0.2.0 \
+  --env=COMMODORE_API_URL="$LIEUTENANT_URL" \
+  --env=COMMODORE_API_TOKEN="$LIEUTENANT_TOKEN" \
+  --env=COMMODORE_GLOBAL_GIT_BASE="https://github.com/$GITHUB_USERNAME" \
+  --env=SSH_PRIVATE_KEY="$(cat ${COMMODORE_SSH_PRIVATE_KEY})" \
+  --env=CLUSTER_ID="$CLUSTER_ID" \
+  --env=GITLAB_ENDPOINT="$GITLAB_ENDPOINT" \
+  --tty --stdin --restart=Never --rm --wait \
+  --image-pull-policy=Always \
+  --command \
+  -- /usr/local/bin/entrypoint.sh bash -c "ssh-keyscan $GITLAB_ENDPOINT >> /app/.ssh/known_hosts; commodore catalog compile $CLUSTER_ID --push"
+
+echo "===> COMMODORE DONE"
+
+echo "===> Check the validity of the bootstrap token"
+wait_for_token "$CLUSTER_ID"
+
+echo "===> Retrieve the Steward install URL"
+STEWARD_INSTALL=$(curl --header "$LIEUTENANT_AUTH" --silent "${LIEUTENANT_URL}/clusters/${CLUSTER_ID}" | jq -r ".installURL")
+echo "===> Steward install URL: $STEWARD_INSTALL"
+
+echo "===> Install Steward in the local kind cluster"
+kubectl --context kind-projectsyn apply -f "$STEWARD_INSTALL"
+
+echo "===> Check that Steward is running and that Argo CD Pods are appearing"
+kubectl --context kind-projectsyn -n syn get pod
+
+echo ""
+echo "===> STEWARD DONE"
diff --git a/4_synthesize_on_microk8s.sh b/4_synthesize_on_microk8s.sh
@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+
+source lib/functions.sh
+
+check_variable "GITLAB_TOKEN" $GITLAB_TOKEN
+check_variable "GITLAB_ENDPOINT" $GITLAB_ENDPOINT
+check_variable "GITLAB_USERNAME" $GITLAB_USERNAME
+check_variable "TENANT_ID" $TENANT_ID
+check_variable "LIEUTENANT_URL" $LIEUTENANT_URL
+check_variable "LIEUTENANT_TOKEN" $LIEUTENANT_TOKEN
+check_variable "COMMODORE_SSH_PRIVATE_KEY" $COMMODORE_SSH_PRIVATE_KEY
+
+# Launch microk8s
+microk8s start
+microk8s enable dns
+microk8s status --wait-ready
+
+LIEUTENANT_AUTH="Authorization: Bearer ${LIEUTENANT_TOKEN}"
+
+echo "===> Register this cluster via the API"
+CLUSTER_ID=$(curl -s -H "$LIEUTENANT_AUTH" -H "Content-Type: application/json" -X POST --data "{ \"tenant\": \"${TENANT_ID}\", \"displayName\": \"Microk8s cluster\", \"facts\": { \"cloud\": \"local\", \"distribution\": \"k3s\", \"region\": \"local\" }, \"gitRepo\": { \"url\": \"ssh://git@${GITLAB_ENDPOINT}/${GITLAB_USERNAME}/tutorial-cluster-microk8s.git\" } }" "${LIEUTENANT_URL}/clusters" | jq -r ".id")
+check_variable "CLUSTER_ID" $CLUSTER_ID
+
+echo "===> Kickstart Commodore"
+echo "===> IMPORTANT: When prompted enter your SSH key password"
+kubectl --context minikube -n lieutenant run commodore-shell \
+  --image=docker.io/projectsyn/commodore:v0.2.0 \
+  --env=COMMODORE_API_URL="$LIEUTENANT_URL" \
+  --env=COMMODORE_API_TOKEN="$LIEUTENANT_TOKEN" \
+  --env=COMMODORE_GLOBAL_GIT_BASE="https://github.com/$GITHUB_USERNAME" \
+  --env=SSH_PRIVATE_KEY="$(cat ${COMMODORE_SSH_PRIVATE_KEY})" \
+  --env=CLUSTER_ID="$CLUSTER_ID" \
+  --env=GITLAB_ENDPOINT="$GITLAB_ENDPOINT" \
+  --tty --stdin --restart=Never --rm --wait \
+  --image-pull-policy=Always \
+  --command \
+  -- /usr/local/bin/entrypoint.sh bash -c "ssh-keyscan $GITLAB_ENDPOINT >> /app/.ssh/known_hosts; commodore catalog compile $CLUSTER_ID --push"
+
+echo "===> COMMODORE DONE"
+
+echo "===> Check the validity of the bootstrap token"
+wait_for_token "$CLUSTER_ID"
+
+echo "===> Retrieve the Steward install URL"
+STEWARD_INSTALL=$(curl --header "$LIEUTENANT_AUTH" --silent "${LIEUTENANT_URL}/clusters/${CLUSTER_ID}" | jq -r ".installURL")
+echo "===> Steward install URL: $STEWARD_INSTALL"
+
+echo "===> Install Steward in the local kind cluster"
+microk8s.kubectl apply -f "$STEWARD_INSTALL"
+
+echo "===> Check that Steward is running and that Argo CD Pods are appearing"
+microk8s.kubectl -n syn get pod
+
+echo ""
+echo "===> STEWARD DONE"
diff --git a/5_delete.sh b/5_delete.sh
@@ -23,4 +23,4 @@ kubectl --context minikube -n lieutenant delete cluster "$MINIKUBE_CLUSTER_ID"
 kubectl --context minikube -n lieutenant delete tenant "$TENANT_ID"
 minikube delete
 k3d cluster delete projectsyn
-
+killall ngrok
diff --git a/assets/images/ngrok_inspect.png b/assets/images/ngrok_inspect.png
diff --git a/env.sh b/env.sh
@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-LIEUTENANT_URL=http://$(minikube service lieutenant-api -n lieutenant --url | sed 's/http:\/\///g' | awk '{split($0,a,":"); print "lieutenant." a[1] ".nip.io:" a[2]}')
+LIEUTENANT_URL=$(curl http://localhost:4040/api/tunnels --silent | jq -r '.["tunnels"][0]["public_url"]')
 export LIEUTENANT_URL
 
 TENANT_ID=$(kubectl --context minikube --namespace lieutenant get tenant | grep t- | awk 'NR==1{print $1}')
diff --git a/ngrok.sh b/ngrok.sh
@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+LOCAL_LIEUTENANT_URL=$(minikube service lieutenant-api -n lieutenant --url)
+ngrok http $LOCAL_LIEUTENANT_URL
diff --git a/tutorial.adoc b/tutorial.adoc
@@ -40,18 +40,18 @@ WARNING: This tutorial *was built and tested on a Linux system*; it should, howe
 
 To follow this tutorial you will need quite an array of software in your system:
 
-* https://www.docker.com/[Docker] version 19, or https://podman.io/[podman] version 2.0
+* https://ngrok.com/[ngrok] version 2.3
+* https://www.docker.com/[Docker] version 19
 * https://kubernetes.io/docs/tasks/tools/install-minikube/[Minikube] version 1.12
 * https://k3d.io/[K3d] version 3.0
 * A https://about.gitlab.com/[GitLab] account with your https://gitlab.com/profile/keys[SSH key configured]. You can use a private GitLab instance, if you have one nearby.
 * A https://github.com/[GitHub] account with your https://github.com/settings/keys[SSH key configured].
 * The following commands must be installed and available in your path: https://curl.haxx.se/[curl], https://stedolan.github.io/jq/[jq], `ssh-keyscan`, and `base64`.
 ** Although not required by this tutorial, you could also install https://github.com/mikefarah/yq[yq] and https://k9scli.io/[k9s], both very useful when working with Commodore Components.
-* As an editor, for this tutorial we will be using https://code.visualstudio.com/[Visual Studio Code] with the following extensions:
+* We will be editing files with https://code.visualstudio.com/[Visual Studio Code] together with the following extensions:
 ** https://github.com/hanseltime/vscode-jsonnet[vscode-jsonnet]
 ** https://marketplace.visualstudio.com/items?itemName=ahebrank.yaml2json[YAML to JSON extension]
 
-
 This tutorial project contains a `0_requirements.sh` script which outputs all of your currently installed versions of the aforementioned software packages.
 
 IMPORTANT: The specified version numbers are the minimum required. Also, please make sure that both your GitLab and GitHub accounts must have SSH keys configured.
@@ -156,6 +156,17 @@ Of course, in your case the NAME column will show different, random values. But
 
 NOTE: For more information, check out the https://syn.tools/lieutenant-operator/explanation/design.html[diagram] in the Project Syn website.
 
+==== Inspecting the Lieutenant API traffic
+
+Since we're using `ngrok` to expose our Lieutenant API we can inspect all the requests exchanged between the clusters and Lieutenant. For that, just open a browser window and point it to http://localhost:4040/inspect/http. The following image shows a screenshot of a typical Lieutenant API session.
+
+.Lieutenant API session inspected through ngrok
+image::ngrok_inspect.png[]
+
+=== Synthesize a Kind of Microk8s cluster
+
+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.
+
 == Creating a Commodore Component
 
 This section will dive into the actual work of creating Commodore components.
@@ -211,11 +222,23 @@ Now we are ready to compile our catalog. Every time you call the `commodore` too
 
 [source,bash]
 ----
-$ commodore catalog compile $MINIKUBE_CLUSTER_ID
-$ commodore catalog compile $K3S_CLUSTER_ID
+$ kubectl --context minikube -n lieutenant get cluster
+NAME                    DISPLAY NAME       TENANT                  AGE
+c-aged-cloud-4988       Kind cluster       t-weathered-fire-7929   3m58s
+c-late-cloud-248        K3s cluster        t-weathered-fire-7929   8m24s
+c-solitary-voice-5640   Minikube cluster   t-weathered-fire-7929   10m
+
+$ commodore catalog compile c-aged-cloud-4988
+...
+
+$ commodore catalog compile c-late-cloud-248
+...
+
+$ commodore catalog compile c-solitary-voice-5640
+...
 ----
 
-NOTE: We must repeat this operation for each cluster.
+NOTE: We must repeat this operation for each cluster, and of course, you should use the cluster IDs got 
 
 === Creating a New Commodore Component
 
@@ -390,7 +413,13 @@ We're ready! Now we just have to recompile both catalogs and push the changes. F
 
 [source,bash]
 ----
-$ commodore catalog compile --push $MINIKUBE_CLUSTER_ID
+$ kubectl --context minikube -n lieutenant get cluster
+NAME                    DISPLAY NAME       TENANT                  AGE                                                                                                                
+c-aged-cloud-4988       Kind cluster       t-weathered-fire-7929   3m58s                                                                                                                                                                                 
+c-late-cloud-248        K3s cluster        t-weathered-fire-7929   8m24s                                                                                                                                                                                 
+c-solitary-voice-5640   Minikube cluster   t-weathered-fire-7929   10m          
+
+$ commodore catalog compile c-solitary-voice-5640
 Agent pid 9
 Enter passphrase for /app/.ssh/id_rsa:
 Identity added: /app/.ssh/id_rsa (user@domain.com)
@@ -418,15 +447,19 @@ Updating catalog repository...
 Catalog compiled! 🎉
 ----
 
-We have to do this for both clusters!
+We have to do this for all clusters!
 
 [source,bash]
 ----
-$ commodore catalog compile --push $K3S_CLUSTER_ID
+$ commodore catalog compile c-aged-cloud-4988
 Agent pid 9
 Enter passphrase for /app/.ssh/id_rsa:
 Identity added: /app/.ssh/id_rsa (user@domain.com)
 ...
+
+$ commodore catalog compile c-late-cloud-248
+...
+
 ----
 
 Since ArgoCD, itself managed by Steward, is watching these repositories, it will pick up the new state and seamlessly deploy it across our two clusters in a few minutes.

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,9 @@ trim () {`
`7`	`7`	`echo -n "$var"`
`8`	`8`	`}`
`9`	`9`
	`10`	`+NGROK_VERSION=$(ngrok version)`
	`11`	`+echo $NGROK_VERSION`
	`12`	`+`
`10`	`13`	`DOCKER_VERSION=$(docker version \| grep Version -m 1)`
`11`	`14`	`DOCKER_VERSION=$(trim "$DOCKER_VERSION")`
`12`	`15`	`echo "Docker $DOCKER_VERSION"`