Cluster deployment#

If you have some machines either on the cloud or not, and you want to deploy Xorbits via command lines, you can refer to this documentation.

Installation#

First, ensure Xorbits is correctly installed on each machine, if not, see installation document.

Starting Supervisor#

Among the machines, pick at least one as the supervisor which ships with a web service as well, starting supervisor via command:

xorbits-supervisor -H <supervisor_ip> -p <supervisor_port> -w <web_port>

Or using python -m:

python -m xorbits.supervisor -H <supervisor_ip> -p <supervisor_port> -w <web_port>

<web_port> is used for creating a web service, which is used for:

Provide a web UI to show cluster status and detailed information of submitted tasks.
Accept connections from clients when users call xorbits.init(“<supervisor_ip>:<web_port>”) to connect to a cluster.

Starting Workers#

The rest of the machines can be started as workers via command:

xorbits-worker -H <worker_ip> -p <worker_port> -s <supervisor_ip>:<supervisor_port>

Or using python -m:

python -m xorbits.worker -H <worker_ip> -p <worker_port> -s <supervisor_ip>:<supervisor_port>

Connecting to Created Cluster#

Now, you can connect to the supervisor from anywhere that can run Python code.

import xorbits
xorbits.init("http://<supervisor_ip>:<supervisor_web_port>")

Replace the <supervisor_ip> with the supervisor IP that you just specified and <supervisor_web_port> with the supervisor web port.

Xorbits Web UI#

You can open a web browser and type http://<supervisor_ip>:<supervisor_web_port> to open Xorbits Web UI to look up resource usage of workers and execution progress of submitted tasks.

Command Line Options#

Common Options#

Common Command line options are listed below.

Argument	Description
`-H`	Service IP binding, `0.0.0.0` by default
`-p`	Port of the service. If absent, a randomized port will be used
`-f`	Path to service configuration file. Absent when use default configuration.
`-s`	List of supervisor endpoints, separated by commas. Useful for workers to spot supervisors, or when you want to run more than one supervisor
`--log-level`	Log level, can be `debug`, `info`, `warning`, `error`
`--log-format`	Log format, can be Python logging format
`--log-conf`	Python logging configuration file, `logging.conf` by default
`--use-uvloop`	Whether to use `uvloop` to accelerate, `auto` by default

Extra Options for Supervisors#

Argument	Description
`-w`	Port of web service in supervisor

Extra Options for Workers#

Argument	Description
`--n-cpu`	Number of CPU cores to use. If absent, the value will be the available number of cores
`--n-io-process`	Number of IO processes for network operations. 1 by default
`--cuda-devices`	Index of CUDA devices to use. If not specified, all devices will be used. Specifying an empty string will ignore all devices

Example#

For instance, if you want to start a Xorbits cluster with one supervisor and two workers, you can run commands below (memory and CPU tunings are omitted):

On Supervisor (192.168.1.10):

xorbits-supervisor -H 192.168.1.10 -p 7001 -w 7005

On Worker 1 (192.168.1.20):

xorbits-worker -H 192.168.1.20 -p 7003 -s 192.168.1.10:7001

On Worker 2 (192.168.1.21):

xorbits-worker -H 192.168.1.21 -p 7004 -s 192.168.1.10:7001

On a client which is able to connect to supervisor, you can run the Python code below to verify:

import xorbits
import xorbits.numpy as np

xorbits.init('http://192.168.1.10:7005')
print(np.random.rand(100, 100).mean())