docs: add walkthrough (#34)

jackfrancis · Jan 9, 2021 · c9b2c44 · c9b2c44
1 parent 51d3df0
commit c9b2c44
Show file tree

Hide file tree

Showing 3 changed files with 620 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -26,8 +26,9 @@ We encourage folks who are using the above stated, known-working Kubernetes + Az
 The kamino project publishes a Helm Chart called "vmss-prototype". You may use that Chart to take a snapshot of the OS image from one instance in your VMSS node pool, and then update the VMSS model definition so that future instances (nodes) use that image snapshot. For example:
 
 ```bash
-$ helm install --repo https://jackfrancis.github.io/kamino/ vmss-prototype \
-  update-vmss-model-image-from-instance-0 --namespace default \
+$ helm install --repo https://jackfrancis.github.io/kamino/ \
+  update-vmss-model-image-from-instance-0 \
+  vmss-prototype --namespace default \
   --set kamino.scheduleOnControlPlane=true \
   --set kamino.targetNode=k8s-pool1-12345678-vmss000000
 ```
@@ -44,6 +45,8 @@ If you're not familiar with using `helm` tool to manage Kubernetes resource depl
 
 - https://helm.sh/docs/intro/quickstart/
 
+A complete walkthrough of using `vmss-prototype` on a cluster is [here][vmss-prototype-walkthrough].
+
 More detailed information on `vmss-prototype` is [here][vmss-prototype].
 
 # Documentation
@@ -52,4 +55,5 @@ All [documentation can be found here][docs].
 
 [docs]: docs/README.md
 [status]: docs/status.md
+[vmss-prototype-walkthrough]: helm/vmss-prototype/walkthrough.md
 [vmss-prototype]: helm/vmss-prototype/README.md
diff --git a/helm/vmss-prototype/README.md b/helm/vmss-prototype/README.md
@@ -12,12 +12,15 @@ This simple concept can dramatically improve node scaling response time and reli
 Below is the canonical way to run vmss-prototype on your cluster using our published Helm Chart:
 
 ```bash
-$ helm install --repo https://jackfrancis.github.io/kamino/ vmss-prototype \
-  update-vmss-model-image-from-instance-0 --namespace default \
+$ helm install --repo https://jackfrancis.github.io/kamino/ \
+  update-vmss-model-image-from-instance-0 \
+  vmss-prototype --namespace default \
   --set kamino.scheduleOnControlPlane=true \
   --set kamino.targetNode=k8s-pool1-12345678-vmss000000
 ```
 
+A complete walkthrough of using `vmss-prototype` on a cluster is [here](walkthrough.md).
+
 ## Cluster Configuration Requirements before using
 
 `vmss-prototype` assumes a few things about the way your cluster has been built: