From f846b26165c6d4deeb5349bd943a6d34a9a88152 Mon Sep 17 00:00:00 2001 From: SangBin Cho Date: Thu, 27 Aug 2020 12:00:16 -0700 Subject: [PATCH] [Doc] Add ports configuration & Move dashboard to the original place (#10281) * Done. * Address code review. * Addressed code review. --- doc/source/configure.rst | 22 ++++++++++++++++++++++ doc/source/index.rst | 1 - doc/source/using-ray.rst | 1 + 3 files changed, 23 insertions(+), 1 deletion(-) diff --git a/doc/source/configure.rst b/doc/source/configure.rst index 2dff93d58..98c9f8e55 100644 --- a/doc/source/configure.rst +++ b/doc/source/configure.rst @@ -113,6 +113,28 @@ start a new worker with the given *root temporary directory*. ├── plasma_store └── raylet # this could be deleted by Ray's shutdown cleanup. +Ports configurations +-------------------- +Ray requires bi-directional communication among its nodes in a cluster. Each of node is supposed to open specific ports to receive incoming network requests. + +All Nodes +~~~~~~~~~ +- ``--node-manager-port``: Raylet port for node manager. Default: Random value. +- ``--object-manager-port``: Raylet port for object manager. Default: Random value. + +The following options specify the range of ports used by worker processes across machines. All ports in the range should be open. + +- ``--min-worker-port``: Minimum port number worker can be bound to. Default: 10000. +- ``--max-worker-port``: Maximum port number worker can be bound to. Default: 10999. + +Head Node +~~~~~~~~~~~ +In addition to ports specified above, the head node needs to open several more ports. + +- ``--port``: Port of GCS. Default: 6379. +- ``--dashboard-port``: Port for accessing the dashboard. Default: 8265 +- ``--gcs-server-port``: GCS Server port. GCS server is a stateless service that is in charge of communicating with the GCS. Default: Random value. + Redis Port Authentication ------------------------- diff --git a/doc/source/index.rst b/doc/source/index.rst index 7a7d99ed7..d2acec412 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -213,7 +213,6 @@ Academic Papers :maxdepth: -1 :caption: Ray Observability - ray-dashboard.rst ray-metrics.rst .. toctree:: diff --git a/doc/source/using-ray.rst b/doc/source/using-ray.rst index cf3744d88..3f20a7f8a 100644 --- a/doc/source/using-ray.rst +++ b/doc/source/using-ray.rst @@ -17,6 +17,7 @@ Finally, we've also included some content on using core Ray APIs with `Tensorflo serialization.rst memory-management.rst troubleshooting.rst + ray-dashboard.rst advanced.rst using-ray-with-tensorflow.rst using-ray-with-pytorch.rst