devcluster

A developer tool for running the Determined cluster.

Configuring

Check out the example.yaml config file, which should work on tip-of-master. It will not quite work out-of-the box; you'll have to replace MY_IP_ADDR with your computer's external ip address.

Note that relative paths in the config file should be relative to the path in the DET_PROJ environment variable (see Running, below).

Running

You can run the code from the git root by running python -m devcluster, or install it into your python environment with pip install -e . and then just call devcluster by itself.

You will need to set the DET_PROJ environment variable. devcluster will cd into that directory after reading the --config option on the command line but before doing anything else.

You can either specify a config file via the --config or -c option, or devcluster will try to read the default config file at ~/.devcluster.yaml.

Keybindings

• 1-3 set target states for the cluster (as shown in the status bar)
• !-# toggle logs for the corresponding stage (as shown in the status bar)
• q or ctrl+c once to quit, or twice to force-quit (which may leave dangling docker containers laying around)
• u/d will scroll up/down, and U/D will scroll up/down faster Scrolling support is only partially line-aware; it will scroll by literal log chunks, which may each be more or less than a line
• x will reset scrolling to continue following logs
• Spacebar will emit a visual separator with a timestamp to the console stream.
• With the default configuration, the keys h, w, and c will trigger building the harness, webui, and docs, respectively.

Server/Client Mode

You can run devcluster as a headless server:

python -m devcluster server --port 1234

Sending a SIGINT (via ctrl+c) or a SIGTERM (via kill) will close it.

You can also connect the UI to a headless server:

python -m devcluster client --port 1234

In client mode, pressing q or ctrl+c will only close the UI; it will not affect the server.

Philosophy

devcluster tries as much as possible to be a standalone tool for running arbitrary versions of the Determined cluster. It is tested as far back as v0.12.3.

Some defaults are kept up-to-date with tip-of-master to simplify the config file for the most-common use case, but in general preference was given to being configurable and explicit.

TODO

• support docker volumes
• config file reloading