From 03baefed4fd57a3b782b8405e5e76c75fe2b9151 Mon Sep 17 00:00:00 2001
From: mrIncompetent <henrik@henrik-schmidt.de>
Date: Tue, 18 Dec 2018 14:15:40 +0100
Subject: [PATCH 1/3] add document to describe the provision command

---
 cmd/provision/README.md | 65 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 cmd/provision/README.md

diff --git a/cmd/provision/README.md b/cmd/provision/README.md
new file mode 100644
index 000000000..1af72fc3f
--- /dev/null
+++ b/cmd/provision/README.md
@@ -0,0 +1,65 @@
+# Provisioning
+
+This command offers all required functionality to provision an host, to join a Kubernetes cluster.
+
+The following operating systems are supported
+- Ubuntu 18.04
+- CentOS 7
+- ContainerLinux / CoreOS (Not tested with RedHat CoreOS)
+
+## Requirements
+- The cluster needs to use the bootstrap token authentication
+
+## CLI
+
+```bash
+./provision \
+    --kubelet-version="v1.13.1" \
+    --cloud-provider="openstack" \
+    --cloud-config="/etc/kubernetes/cloud-config" \
+    --token="AAAAAAAAAAAAAAAA" \
+    --ca-cert="/etc/kubernetes/ca.crt"
+```
+
+## Process
+
+Nodes will boot with a cloud-init (Or Ignition) which writes required files & a shell script (called `setup.sh` here).
+
+### cloud-init (Or ignition)
+Parts which will be covered by cloud-init (or Ignition)
+
+- Install SSH keys
+- Configure hostname
+- `ca.crt`
+    The CA certificate which got used to issue the certificates of the API server serving certificates
+- `cloud-config`
+    A optional cloud-config used by the kubelet to interact with the cloud provider.
+- `setup.sh`  
+    Is responsible for downloading the `provision` binary and to execute it.
+    The download of the binary might also be done using built-in `cloud-init` (or Ignition) features
+
+### Provision
+
+The provision binary will identify the operating system and execute a set of provisioning steps.
+
+The provisioning process gets separated into 2 phases:
+- Base provisioning
+  Install and configure all required dependencies
+- Join
+  Write & start the kubelet systemd unit
+
+#### Base provisioning
+The following steps belong into the base provisioning:
+- Install required packages (apt & yum action)
+- Configure required kernel parameter (Like ip forwarding, etc.)
+- Configure required kernel modules
+- Disable swap
+- Download & install the CNI plugins
+- Download & Install docker
+- Download Kubelet
+- Install health checks (Kubelet & Docker)
+
+#### Join
+
+This part will:
+- Write & start the kubelet systemd unit 

From d0e982c1dee7010996530719bf2976fc9678dc47 Mon Sep 17 00:00:00 2001
From: mrIncompetent <henrik@henrik-schmidt.de>
Date: Tue, 18 Dec 2018 14:30:33 +0100
Subject: [PATCH 2/3] add text about offline usage and development process

---
 cmd/provision/README.md | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/cmd/provision/README.md b/cmd/provision/README.md
index 1af72fc3f..7060baa8b 100644
--- a/cmd/provision/README.md
+++ b/cmd/provision/README.md
@@ -40,7 +40,7 @@ Parts which will be covered by cloud-init (or Ignition)
 
 ### Provision
 
-The provision binary will identify the operating system and execute a set of provisioning steps.
+The `provision` binary will identify the operating system and execute a set of provisioning steps.
 
 The provisioning process gets separated into 2 phases:
 - Base provisioning
@@ -63,3 +63,15 @@ The following steps belong into the base provisioning:
 
 This part will:
 - Write & start the kubelet systemd unit 
+
+## Offline usage
+
+The `provision` binary should also be usable for "prebaking" images, which then can be used for offline usage.
+
+## Development process
+
+To make sure the local development version of the `provision` command gets used for new machines created by the local running machine controller,
+a new flag `--provision-source` must be introduced. 
+This flag will instruct the machine controller to download the `provision` binary from the specified location.
+
+For simplicity the `/hack/run-machine-controller.sh` will be updated to include a step which will compile the `provoision` command & upload it to a gcs bucket. 

From 5e8b411aea858f81800c5d443e2654a649f880dd Mon Sep 17 00:00:00 2001
From: mrIncompetent <henrik@henrik-schmidt.de>
Date: Tue, 18 Dec 2018 14:51:53 +0100
Subject: [PATCH 3/3] remove comma

---
 cmd/provision/README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/cmd/provision/README.md b/cmd/provision/README.md
index 7060baa8b..d4c790010 100644
--- a/cmd/provision/README.md
+++ b/cmd/provision/README.md
@@ -1,6 +1,6 @@
 # Provisioning
 
-This command offers all required functionality to provision an host, to join a Kubernetes cluster.
+This command offers all required functionality to provision an host to join a Kubernetes cluster.
 
 The following operating systems are supported
 - Ubuntu 18.04