Update the pip wheel in example.yaml and add docs (#1381)

doc/source/autoscaling.rst

@@ -1,7 +1,7 @@
-Cluster setup and auto-scaling (Experimental)
-=============================================
+Cloud Setup and Auto-Scaling
+============================
 
-The Ray ``create_or_update`` command starts an AWS Ray cluster from your personal computer. Once the cluster is up, you can then SSH into it to run Ray programs.
+The ``ray create_or_update`` command starts an AWS Ray cluster from your personal computer. Once the cluster is up, you can then SSH into it to run Ray programs.
 
 Quick start
 -----------
@@ -9,11 +9,10 @@ Quick start
 First, ensure you have configured your AWS credentials in ``~/.aws/credentials``,
 as described in `the boto docs <http://boto3.readthedocs.io/en/latest/guide/configuration.html>`__.
 
-Then you're ready to go. The provided `ray/python/ray/autoscaler/aws/example.yaml <https://github.com/ray-project/ray/tree/master/python/ray/autoscaler/aws/example.yaml>`__ cluster config file will create a small cluster with a m4.large
-head node (on-demand), and two m4.large `spot workers <https://aws.amazon.com/ec2/spot/>`__.
+Then you're ready to go. The provided `ray/python/ray/autoscaler/aws/example.yaml <https://github.com/ray-project/ray/tree/master/python/ray/autoscaler/aws/example.yaml>`__ cluster config file will create a small cluster with a m4.large head node (on-demand), and two m4.large `spot workers <https://aws.amazon.com/ec2/spot/>`__, configured to autoscale up to four m4.large workers.
 
 Try it out by running these commands from your personal computer. Once the cluster is started, you can then
-SSH into the head node to run Ray programs with ``ray.init(redis_address="<node_ip>:6379")``.
+SSH into the head node to run Ray programs with ``ray.init(redis_address="<node_internal_ip>:6379")``.
 
 .. code-block:: bash
 
@@ -21,22 +20,70 @@ SSH into the head node to run Ray programs with ``ray.init(redis_address="<node_
     # out the command that can be used to SSH into the cluster head node.
     $ ray create_or_update ray/python/ray/autoscaler/aws/example.yaml
 
-    # Resize the cluster without interrupting running jobs
+    # Reconfigure autoscaling behavior without interrupting running jobs
     $ ray create_or_update ray/python/ray/autoscaler/aws/example.yaml \
-        --max-workers=N --sync-only
+        --max-workers=N --no-restart
 
     # Teardown the cluster
     $ ray teardown ray/python/ray/autoscaler/aws/example.yaml
 
-Common configurations
+Updating your cluster
 ---------------------
 
-Note: auto-scaling support is not fully implemented yet (targeted for 0.4.0).
+When you run ``ray create_or_update`` with an existing cluster, the command checks if the local configuration differs from the applied configuration of the cluster. This includes any changes to synced files specified in the ``file_mounts`` section of the config. If so, the new files and config will be uploaded to the cluster. Following that, Ray services will be restarted.
 
-The example configuration above is enough to get started with Ray, but for more
-compute intensive workloads you will want to change the instance types to e.g.
-use GPU or larger compute instance by editing the yaml file. Here are a few common
-configurations:
+You can also run ``ray create_or_update`` to restart a cluster if it seems to be in a bad state (this will restart all Ray services even if there are no config changes).
+
+If you don't want the update to restart services (e.g. because the changes don't require a restart), pass ``--no-restart`` to the update call.
+
+Autoscaling
+-----------
+
+Ray clusters come with a load-based auto-scaler. When cluster resource usage exceeds a configurable threshold (80% by default), new nodes will be launched up the specified ``max_workers`` limit. When nodes are idle for more than a timeout, they will be removed, down to the ``min_workers`` limit. The head node is never removed.
+
+The default idle timeout is 5 minutes. This is because in AWS there is a minimum billing charge of 5 minutes per instance, after which usage is billed by the second.
+
+Monitoring cluster status
+-------------------------
+
+You can monitor cluster usage and auto-scaling status by tailing the autoscaling logs in ``/tmp/raylogs/monitor-*.log``.
+
+The Ray autoscaler also reports per-node status in the form of instance tags. In the AWS console, you can click on a Node, go the the "Tags" pane, and add the ``ray:NodeStatus`` tag as a column. This lets you see per-node statuses at a glance:
+
+.. image:: autoscaler-status.png
+
+Customizing cluster setup
+-------------------------
+
+You are encouraged to copy the example YAML file and modify it to your needs. This may include adding additional setup commands to install libraries or sync local data files. After you have customized the nodes, it is also a good idea to create a new machine image (AMI) and use that in the config file. This reduces worker setup time, improving the efficiency of auto-scaling.
+
+The setup commands you use should ideally be *idempotent*, that is, can be run more than once. This allows Ray to update nodes after they have been created. You can usually make commands idempotent with small modifications, e.g. ``git clone foo`` can be rewritten as ``test -e foo || git clone foo`` which checks if the repo is already cloned first.
+
+Syncing git branches
+--------------------
+
+A common use case is syncing a particular local git branch to all workers of the cluster. There is a nice way to do this as follows:
+
+.. code-block:: yaml
+
+    file_mounts: {
+        "/tmp/current_branch_sha": "/path/to/local/repo/.git/refs/heads/<YOUR_BRANCH_NAME>",
+    }
+
+    setup_commands:
+        - test -e <REPO_NAME> || git clone https://github.com/<REPO_ORG>/<REPO_NAME>.git
+        - cd <REPO_NAME> && git fetch && git checkout `cat /tmp/current_branch_sha`
+
+This tells ``ray create_or_update`` to sync the current git branch SHA from your personal computer to a temporary file on the cluster. Then, the setup commands read that file to figure out which SHA they should checkout on the nodes. The final workflow to update the cluster then becomes just this:
+
+1. Make local changes to a git branch
+2. Commit the changes with ``git commit`` and ``git push``
+3. Update files on your Ray cluster with ``ray create_or_update``
+
+Common cluster configurations
+-----------------------------
+
+The ``example.yaml`` configuration is enough to get started with Ray, but for more compute intensive workloads you will want to change the instance types to e.g. use GPU or larger compute instance by editing the yaml file. Here are a few common configurations:
 
 **GPU single node**: use Ray on a single large GPU instance.
 
@@ -84,10 +131,9 @@ with GPU worker nodes instead.
     worker_nodes:
         InstanceMarketOptions:
             MarketType: spot
-        InstanceType: p2.8xlarge
+        InstanceType: p2.xlarge
 
 Additional Cloud providers
 --------------------------
 
-To use Ray autoscaling on other Cloud providers or cluster management systems, you can implement the ``NodeProvider`` interface
-(~100 LOC) and register it in `node_provider.py <https://github.com/ray-project/ray/tree/master/python/ray/autoscaler/node_provider.py>`__.
+To use Ray autoscaling on other Cloud providers or cluster management systems, you can implement the ``NodeProvider`` interface (~100 LOC) and register it in `node_provider.py <https://github.com/ray-project/ray/tree/master/python/ray/autoscaler/node_provider.py>`__. Contributions are welcome!

doc/source/using-ray-on-a-cluster.rst

@@ -1,6 +1,10 @@
 Using Ray on a Cluster
 ======================
 
+.. note::
+
+    Starting with Ray 0.4.0 if you're using AWS you can use the automated `setup commands <http://ray.readthedocs.io/en/latest/autoscaling.html>`__.
+
 The instructions in this document work well for small clusters. For larger
 clusters, follow the instructions for `managing a cluster with parallel ssh`_.
 

doc/source/using-ray-on-a-large-cluster.rst

@@ -1,6 +1,10 @@
 Using Ray on a Large Cluster
 ============================
 
+.. note::
+
+    Starting with Ray 0.4.0 if you're using AWS you can use the automated `setup commands <http://ray.readthedocs.io/en/latest/autoscaling.html>`__.
+
 Deploying Ray on a cluster requires a bit of manual work. The instructions here
 illustrate how to use parallel ssh commands to simplify the process of running
 commands and scripts on many machines simultaneously.

python/ray/autoscaler/aws/example.yaml

@@ -3,7 +3,7 @@ cluster_name: default
 
 # The minimum number of workers nodes to launch in addition to the head
 # node. This number should be >= 0.
-min_workers: 0
+min_workers: 2
 
 # The maximum number of workers nodes to launch in addition to the head
 # node. This takes precedence over min_workers.
@@ -70,8 +70,7 @@ setup_commands:
     # Note: if you're developing Ray, you probably want to create an AMI that
     # has your Ray repo pre-cloned. Then, you can replace the pip installs
     # below with a git checkout <your_sha> (and possibly a recompile).
-    # TODO(ekl) update this to a wheel from master
-    - pip install -U https://s3-us-west-2.amazonaws.com/ray-wheels/f5ea44338eca392df3a868035df3901829cc2ca1/ray-0.3.0-cp36-cp36m-manylinux1_x86_64.whl
+    - pip install -U https://s3-us-west-2.amazonaws.com/ray-wheels/b6c42f96beab3ee00fe4b246e5e9d0479ad379ca/ray-0.3.0-cp36-cp36m-manylinux1_x86_64.whl
 
 # Custom commands that will be run on the head node after common setup.
 head_setup_commands: