Merge pull request #24 from jackfrancis/docs-quickstart

docs: quickstart and helm vmss-prototype docs

README.md

@@ -19,9 +19,37 @@ We encourage folks who are using the above stated, known-working Kubernetes + Az
 
 - https://github.com/jackfrancis/kamino/issues
 
+# Quickstart
+
+## vmss-prototype
+
+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 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 \
+  --set kamino.scheduleOnControlPlane=true \
+  --set kamino.targetNode=k8s-pool1-12345678-vmss000000
+```
+
+The above will create job `update-vmss-model-image-from-instance-0` in the `default` Kubernetes namespace if a few assumptions are true:
+
+- You run the above helm command in an execution context where the `KUBECONFIG` environment variable is set to the kubeconfig file that identifies a privileged connection to the Kubernetes cluster whose node pool you want to update.
+- The node `k8s-pool1-12345678-vmss000000` is running in your cluster, backed by an Azure VMSS instance, and is in a Ready state.
+- Your Kubernetes + Azure cluster was created by the [AKS Engine](https://github.com/Azure/aks-engine) tool (`vmss-prototype` will work with Kubernetes + Azure generally in the future: for now it is validated as known-working against AKS Engine-created clusters running VMSS node pools).
+
+We suggest the Job name `update-vmss-model-image-from-instance-0` only as a hypothetical example: you may choose any name you wish. Also, the targetNode value `k8s-pool1-12345678-vmss000000` is entirely a hypothetical example: make sure you use a value that correlates with an actual node that was created by an Azure VMSS that you want to update.
+
+If you're not familiar with using `helm` tool to manage Kubernetes resource deployments, lots of good docs are here:
+
+- https://helm.sh/docs/intro/quickstart/
+
+More detailed information on `vmss-prototype` is [here][vmss-prototype].
+
 # Documentation
 
 All [documentation can be found here][docs].
 
 [docs]: docs/README.md
 [status]: docs/status.md
+[vmss-prototype]: helm/vmss-prototype/README.md