From e7f7cb29c40bb5cea6d52cb0262f9769753c52cd Mon Sep 17 00:00:00 2001 From: dHannasch Date: Mon, 2 Nov 2020 21:59:14 -0700 Subject: [PATCH] [docs] Show expected terminal output for manual cluster setup (#11752) Co-authored-by: Richard Liaw --- doc/source/cluster/index.rst | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/doc/source/cluster/index.rst b/doc/source/cluster/index.rst index 88fe75bf2..224bb2f19 100644 --- a/doc/source/cluster/index.rst +++ b/doc/source/cluster/index.rst @@ -87,23 +87,39 @@ random port. .. code-block:: bash - ray start --head --port=6379 + $ ray start --head --port=6379 + ... + Next steps + To connect to this Ray runtime from another node, run + ray start --address=':6379' --redis-password='' + + If connection fails, check your firewall settings and network configuration. The command will print out the address of the Redis server that was started -(and some other address information). +(the local node IP address plus the port number you specified). -**Then on all of the other nodes**, run the following. Make sure to replace +**Then on each of the other nodes**, run the following. Make sure to replace ``
`` with the value printed by the command on the head node (it should look something like ``123.45.67.89:6379``). .. code-block:: bash - ray start --address=
+ $ ray start --address=
--redis-password='' + -------------------- + Ray runtime started. + -------------------- + + To terminate the Ray runtime, run + ray stop If you wish to specify that a machine has 10 CPUs and 1 GPU, you can do this with the flags ``--num-cpus=10`` and ``--num-gpus=1``. See the :ref:`Configuration ` page for more information. -Now we've started the Ray runtime. +If you see ``Ray runtime started.``, then the node successfully connected to +the ``
``. If the ``
`` is inaccessible (because, for example, +the head node is not actually running), then you will get an error such as +``Unable to connect to Redis. If the Redis instance is on a different machine, +check that your firewall is configured properly.`` Stopping Ray ~~~~~~~~~~~~