Quickstart
Create a cluster
sind mounts the working directory read-write into every node, and the Slurm jobs write their output there as root. Work in a scratch directory, not in your home directory:
mkdir sind-demo && cd sind-demoThe simplest command creates a cluster named default with one controller and one worker:
sind create cluster-
Start the web UI, and open the URL that it prints in your browser:
sind ui -
Press New cluster…. The New cluster page proposes a free name, such as
hpc, and starts from Quick test: a controller and two workers. Set the name todefaultand set workers to 1. -
Under Your files, press Change… and set Directory to the full path of your
sind-demodirectory, such as~/sind-demo, where the steps below write the job script. Otherwise the nodes mount~/sind/defaultat/data. -
Press Create default when the status at the top of the plan says
Ready.
The Runs block of the plan shows the command that it starts. sind ui also saves the config of the cluster, so you can run the same command from a terminal.
This is equivalent to using this configuration:
kind: Cluster
name: default
nodes:
- role: controller
- role: workersind will:
- Set up mesh infrastructure (network, DNS, SSH) if not already present
- Create a cluster network and volumes
- Generate munge keys and Slurm configuration
- Start all node containers
- Wait for all nodes to become ready
On a terminal, sind shows its progress while it works and leaves a line for each step it finished; where standard error is not a terminal, it prints nothing on success. See Progress Display. On a host that had neither the mesh nor the node image, the first cluster ends like this:
$ sind create cluster
✓ mesh 12s 4 ok 426 MiB at 35.5 MiB/s
✓ preflight 1.4s
✓ nodes 5.8s 2 ok
✓ mesh registration 0.3s
✓ slurm 4.6s 2 okCheck cluster status
sind get clustersOpen Clusters in the rail, then the cluster. Ready for jobs at the top of the Summary tab says whether the cluster can run a job now, and gives the commands to submit one. Below it, the tab shows each node and its services, such as munge, sshd and slurmctld.
The rest of this section shows the same with sind get.
NAME NODES (S/C/D/A/W) SLURM STATUS
default 2 (0/1/0/0/1) 26.05.6 runningView individual nodes:
sind get nodesCONTAINER CLUSTER ROLE FQDN IP STATUS
sind-default-controller default controller controller.default.sind.sind 172.19.0.2 running
sind-default-worker-0 default worker worker-0.default.sind.sind 172.19.0.3 runningFor detailed health information:
sind get clusterRun Slurm commands
Open an interactive shell on the controller (or submitter, if configured):
sind enterOr run one-shot commands without an interactive session:
sind exec -- sinfo
sind exec -- srun hostnameSubmit a batch job
Create a batch script in your working directory:
cat > job.sh << 'EOF'
#!/bin/bash
#SBATCH --job-name=hello
echo "Hello from $(hostname)"
sleep 30
EOFSubmit and monitor:
sind exec -- sbatch job.shSubmitted batch job <JOBID>Check the job queue:
sind exec -- squeueView the output after the job completes:
cat slurm-<JOBID>.outHello from worker-0By default, sind create cluster bind-mounts the current directory as /data inside all nodes. Batch scripts and output files are shared across the cluster and accessible directly on your host.
SSH into a node
sind ssh controller
sind ssh worker-0Scale up
Add more workers to the running cluster:
sind create worker --count 3Tear down
Delete the cluster:
sind delete cluster defaultOr delete all clusters at once:
sind delete cluster --allWhen the last cluster is deleted, sind automatically cleans up the shared mesh infrastructure.
Going further
Named clusters with custom configuration
Pipe a configuration directly into sind create cluster --config -:
sind create cluster --config - << 'EOF'
kind: Cluster
name: dev
defaults:
cpus: 2
memory: 1g
nodes:
- controller
- submitter
- worker: 3
EOFOr use a configuration file:
sind create cluster --config cluster.yamlMultiple clusters can run side by side — each gets its own network, volumes, and DNS namespace. See Cluster Configuration for all available options.





