resource_config.json, switching between host and client mode, and targeting remote machines from the CLI.
Prepare Each Remote Server
Every GRID node that hosts containers must run the container server—a lightweight FastAPI service that manages Docker lifecycle tasks on behalf of the CLI. Think of it as the daemon that receives commands such as “init”, “update”, and “session start” and executes them on the host.- Install GRID Enterprise on the remote machine (same prerequisites as the installation guide). A lightweight Python environment is sufficient:
The optional
[server]extra installs the dependencies required to run the container server. - Set up data and licensing on the remote host:
- Launch the container server. It keeps running until you stop it (run it in a tmux session, systemd service, or similar):
The CLI and container server authenticate via a bearer token. By default both sides use
grid-enterprise-token; setGRID_API_TOKENto the same value on the server and client if you change it.
Resource Configuration Refresher
GRID reads its topology from~/.grid/resource_config.json. A freshly installed CLI generates the minimal configuration that assumes host mode on the current machine:
serve– whentrue, the CLI is allowed to run containers locally. Setting it tofalseturns the CLI into a pure client that only orchestrates remote servers.servers– an array of nodes that the CLI can target. Each entry must include anid(used with the@idsyntax) and anip. Additional fields, such asstorage, are optional.
~/.grid/resource_config.json (or inside the directory referenced by GRID_DATA_DIR if you customised it during installation).
Switching to Client Mode
If the containers will run on dedicated hosts and your workstation should only issue commands, setserve to false:
@node0) or by selecting a default.
Adding Remote Nodes
Declare each remote machine in theservers array. Here is a typical entry:
storage block is covered in detail in Mounting Storage; it lets you bind host directories into the GRID containers.
Save the file and restart the CLI to pick up the changes.
Connect from the Client
On the workstation where you operate the CLI, run:serve is false, the CLI starts in client-only mode and immediately connects to the remote container server whenever you invoke a command. If serve is true, the CLI still runs locally but can target additional nodes that you configured.
Working with Nodes in the CLI
Within the shell, use thenode commands to inspect and select targets:
@<id>, the CLI warns you and falls back to the current default.
Network & Access Checklist
Remote nodes must be reachable by the CLI and your browser:- 8060 from the CLI machine (container server API)
- 8000 from the CLI machine (session API)
- 8890, 3080, 9090, 9877 from your browser if you plan to open notebooks, simulations, or rerun visualisations