refactor(contrib/digitalocean): clean up README, act more like other contrib/ scripts

Updates the README to flow more like the other contrib/ scripts.
Also adds a provision-do-cluster.sh

Author: carmstrong

contrib/digitalocean/README.md

@@ -1,42 +1,79 @@
-# How to Provision a Deis Controller on Digital Ocean
+# Provision a Deis Cluster on Digital Ocean
 
-Here are the steps to get started on Digital Ocean:
+Note that Digital Ocean does not support CoreOS images natively. To work around this, the provision
+scripts for Digital Ocean first create a CoreOS image which will be used for provisioning the cluster.
+
+Digital Ocean support was contributed by [sttts](https://github.com/sttts). The CoreOS bootstrapping
+is heavily based on [Levi Aul's code](https://gist.github.com/tsutsu/490f35f48897df0f5173).
+
+To deploy Deis to Digital Ocean:
 
 ## Customize cloud-config.yml
 Edit [user-data](../coreos/user-data) and add a discovery URL. This URL will be used by all nodes in this Deis cluster. You can get a new discovery URL by sending a request to http://discovery.etcd.io/new.
 
-## Install DO command line client and authorize:
+## Install tugboat and authorize:
+The tugboat gem consumes the Digital Ocean API.
 ```console
 $ gem install tugboat
 $ tugboat authorize
 ```
 You can leave all but the client and API keys as the defaults.
 
-Find out about the ID of your ssh key (import it into DO if it's not listed):
+## Upload keys
+Choose an SSH keypair to use for Deis and import it to Digital Ocean:
+```console
+$ tugboat add-key deis
+```
+
+Then, get the ID of the key:
 ```console
 $ tugboat keys
 ```
 
-## Create a controller image:
+## Create a Deis image:
 ```console
-$ ./provision-digitalocean-controller-image.sh <YOU SSH KEY ID>
+$ ./provision-digitalocean-deis-image.sh <SSH KEY ID>
 ```
 
-## Deploy controllers
-Use the created image to launch (an odd number) controller droplets, either via UI
-or on the command line using tugboat:
+## Choose number of instances
+By default, the script will provision 3 servers. You can override this by setting `DEIS_NUM_INSTANCES`:
+```console
+$ export DEIS_NUM_INSTANCES=5
+```
+
+Note that for scheduling to work properly, clusters must consist of at least 3 nodes and always have an odd number of members.
+For more information, see [optimal etcd cluster size](https://github.com/coreos/etcd/blob/master/Documentation/optimal-cluster-size.md).
+
+Deis clusters of less than 3 nodes are unsupported.
+
+## Deploy cluster
+Run the provision script:
 ```console
-$ tugboat create deis1 -r <REGION_ID> -i <IMAGE_ID> -p true -k <SSH_ID> -s 65
+$ ./provision-do-cluster.sh <REGION_ID> <IMAGE_ID> <SSH_ID> <SIZE>
 ```
 
 Not all regions allow private networks. Choose one which does, e.g. NY 2, Amsterdam 2 or
 Singapore 1 at the time of this writing (check the web UI for the current private network
-support).
+support). You can enumerate all the regions with:
 
-The provisioning script uses a 512 MB droplet by default because for iamge creation
+```console
+$ tugboat regions
+```
+
+The provisioning script uses a 512 MB droplet by default because for image creation
 more memory is not needed. Deis controller nodes will need at least 2 GB to even start all
-the services. Add the memory requirements of deployed applications and choose an adequat
-droplet size, e.g. 8 GB (ID "65").
+the services. Add the memory requirements of deployed applications and choose an adequate
+droplet size. The default is 8 GB (ID "65"). You can enumerate all sizes with:
+
+```console
+$ tugboat sizes
+```
+
+## Choose number of routers
+By default, the Makefile will provision 1 router. You can override this by setting `DEIS_NUM_ROUTERS`:
+```console
+$ export DEIS_NUM_ROUTERS=2
+```
 
 ## Initialize the cluster
 Once the cluster is up, get the IPs of any of the machines using `tugboat droplets`, set
@@ -63,7 +100,7 @@ email: info@opdemand.com
 ## Hack on Deis
 If you'd like to use this deployment to build Deis, you'll need to set `DEIS_HOSTS` to an array of your cluster hosts:
 ```console
-$ export DEIS_HOSTS=10.21.12.1 10.21.12.2 10.21.12.3
+$ DEIS_HOSTS="1.2.3.4 2.3.4.5 3.4.5.6" make build
 ```
 
 This variable is used in the `make build` command.

…ovision-digitalocean-controller-image.sh …ean/provision-digitalocean-deis-image.shcontrib/digitalocean/provision-digitalocean-controller-image.sh renamed to contrib/digitalocean/provision-digitalocean-deis-image.sh contrib/digitalocean/provision-digitalocean-controller-image.sh renamed to contrib/digitalocean/provision-digitalocean-deis-image.sh

@@ -99,8 +99,6 @@ done
 echo_green "done"
 
 echo
-echo_green "Congratulations: The Deis controller image $NAME was created with ID $IMAGE_ID."
+echo_green "Congratulations: The Deis image $NAME was created with ID $IMAGE_ID."
 echo
-echo "Spawn controllers with:"
-echo
-echo "  tugboat create deis1 -i $IMAGE_ID -r $REGION -p true -k $SSH_ID -s 65"
+echo_yellow "Launch the cluster with: ./provision-do-cluster.sh $REGION $IMAGE_ID $SSH_ID 65"

contrib/digitalocean/provision-do-cluster.sh

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+#
+# Usage: ./provision-do-cluster.sh <REGION_ID> <IMAGE_ID> <SSH_ID> <SIZE>
+#
+
+set -e
+
+THIS_DIR=$(cd $(dirname $0); pwd) # absolute path
+CONTRIB_DIR=$(dirname $THIS_DIR)
+
+source $CONTRIB_DIR/utils.sh
+
+# check for DO tools in $PATH
+if ! which tugboat > /dev/null; then
+  echo_red 'Please install the tugboat gem and ensure it is in your $PATH.'
+  exit 1
+fi
+
+if [ -z "$DEIS_NUM_INSTANCES" ]; then
+    DEIS_NUM_INSTANCES=3
+fi
+
+# check that the CoreOS user-data file is valid
+$CONTRIB_DIR/util/check-user-data.sh
+
+# launch the Deis cluster on Digital Ocean
+i=1 ; while [[ $i -le $DEIS_NUM_INSTANCES ]] ; do \
+    NAME=deis-$i
+    echo_yellow "Provisioning ${NAME}..."
+    tugboat create $NAME -r $1 -i $2 -p true -k $3 -s $4
+    ((i = i + 1)) ; \
+done
+
+echo_green "Your Deis cluster has successfully deployed to Digital Ocean."
+echo_green "Please continue to follow the instructions in the README."