Merge pull request #1074 from deis/doc_deis_routers

docs(*): document DEIS_NUM_ROUTERS

Author: carmstrong

README.md

@@ -27,6 +27,7 @@ On your workstation:
 If you'd like to spin up more than one VM to test an entire cluster, there are a few additional prerequisites:
 * Edit [contrib/coreos/user-data](contrib/coreos/user-data) and add a unique discovery URL generated from `https://discovery.etcd.io/new`
 * Set `DEIS_NUM_INSTANCES` to the desired size of your cluster (typically 3 or 5): ```$ export DEIS_NUM_INSTANCES=3```
+* If you'd like to spin up more than one router, set `DEIS_NUM_ROUTERS`: ```$ export DEIS_NUM_ROUTERS=2```
 * Instead of `local.deisapp.com`, use either `local3.deisapp.com` or `local5.deisapp.com` as your cluster domain
 
 Note that for scheduling to work properly, clusters must consist of at least 3 nodes and always have an odd number of members.

contrib/ec2/README.md

@@ -36,6 +36,12 @@ For more information, see [optimal etcd cluster size](https://github.com/coreos/
 
 Deis clusters of less than 3 nodes are unsupported.
 
+## 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
+```
+
 ## Customize user-data
 Edit [user-data](../coreos/user-data) and add a new discovery URL.
 You can get a new one by sending a request to http://discovery.etcd.io/new.

contrib/rackspace/README.md

@@ -33,6 +33,17 @@ $ supernova production keypair-add --pub-key ~/.ssh/deis.pub deis-key
 ### 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.
 
+### Choose number of instances
+By default, the provision script will provision 3 servers. You can override this by setting `DEIS_NUM_INSTANCES`:
+```console
+$ DEIS_NUM_INSTANCES=5 ./provision-rackspace-cluster.sh deis-key
+```
+
+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.
+
 ### Run the provision script
 Run the [Rackspace provision script](provision-rackspace-cluster.sh) to spawn a new CoreOS cluster.
 You'll need to provide the name of the key pair you just added. Optionally, you can also specify a flavor name.
@@ -43,16 +54,12 @@ Usage: provision-rackspace-cluster.sh <key pair name> [flavor]
 $ ./provision-rackspace-cluster.sh deis-key
 ```
 
-By default, the script will provision 3 servers. You can override this by setting `DEIS_NUM_INSTANCES`:
+### Choose number of routers
+By default, the Makefile will provision 1 router. You can override this by setting `DEIS_NUM_ROUTERS`:
 ```console
-$ DEIS_NUM_INSTANCES=5 ./provision-rackspace-cluster.sh deis-key
+$ export DEIS_NUM_ROUTERS=2
 ```
 
-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.
-
 ### Initialize the cluster
 Once the cluster is up, get the hostname of any of the machines from Rackspace, set
 FLEETCTL_TUNNEL, and issue a `make run` from the project root: