Skip to content
Installation

Installation

sind ui is a command of sind: install sind first. Its Doctor page shows the checks of sind doctor. The steps on this page are for the CLI.

Prerequisites

  • Linux on x86-64 or ARM64, with the unified cgroup v2 hierarchy at /sys/fs/cgroup, mounted with nsdelegate.
  • Docker Engine 28.0 or later on that host, rootful and without userns-remap, with a Docker CLI of the same release.
  • For 10 or more nodes on the host, in one cluster or in several: fs.inotify.max_user_instances of at least 1024. The kernel’s default is 128, and raising it takes root (see Container exits with code 255).

sind doctor checks the Docker Engine, the daemon, cgroup v2 with nsdelegate and the inotify limit (see Verify).

Install

Releases include binaries for linux/amd64 and linux/arm64. The commands below install the amd64 one; on 64-bit ARM, use sind-linux-arm64 instead.

Download the binary and check it before you install it:

curl -fLO https://github.com/GSI-HPC/sind/releases/latest/download/sind-linux-amd64
gh attestation verify sind-linux-amd64 --repo GSI-HPC/sind \
  --signer-workflow GSI-HPC/sind/.github/workflows/release.yml

Each release publishes a build provenance attestation for its binaries, and the GitHub CLI checks with it that sind’s release workflow built the download. gh attestation verify needs a signed-in gh (gh auth login, or GH_TOKEN in the environment); without one, use the checksum route below. --signer-workflow matters: with --repo alone, any workflow of the repository would pass. Use gh 2.102.0 or later. Older releases match --signer-workflow only as a prefix, and 2.92.0 and earlier send your token to TUF mirror hosts. Without the GitHub CLI, compare the download with the release’s checksums.txt. That only detects a corrupted download, as the checksums come from the same release:

curl -fLO https://github.com/GSI-HPC/sind/releases/latest/download/checksums.txt
sha256sum --check --ignore-missing checksums.txt

System-wide installation into /usr/local/bin:

# install sets mode 755 and copies to the target directory
sudo install ./sind-linux-amd64 /usr/local/bin/sind

Per-user installation into ~/.local/bin:

install -D ./sind-linux-amd64 ~/.local/bin/sind

Most distributions include ~/.local/bin in $PATH by default, but only if the directory exists at login time. You may need to log out and back in after creating it.

Verify

Check that sind is installed and your system meets the prerequisites:

sind doctor

This checks the Docker Engine version, the daemon’s mode, where the daemon runs, the cgroup configuration, the inotify limit and, when systemd-resolved runs, the polkit rule for host DNS, and prints fix instructions if anything is missing. The Docker host, inotify and DNS policy checks only warn.

sind runs on the Docker host itself. Docker Desktop, whose daemon runs in a VM, and a daemon on another host, through DOCKER_HOST or a docker context, are not supported; sind doctor warns about them (see Docker host).

sind needs a rootful Docker daemon. Rootless Docker and a daemon with userns-remap are not supported: Docker refuses the --security-opt writable-cgroups=true that every sind node runs with. sind doctor reports both, and sind create cluster refuses them before it pulls an image. sind itself needs no root privileges and starts no privileged containers; it uses the Docker daemon your user can reach. Setting up the host can take root, such as to raise its inotify limit for 10 or more nodes (see Prerequisites).

Container image

sind requires a container image with systemd, munge, sshd, and Slurm installed. The default image is the official image published with your sind release, for sind v0.16.1 for example:

ghcr.io/gsi-hpc/sind-node:v0.16.1

It carries the newest Slurm release line that release supports and is published for linux/amd64 and linux/arm64. sind built from source (go install, make build) defaults to ghcr.io/gsi-hpc/sind-node:latest instead, the newest supported release line. To stay on a specific release line, set defaults.image in the cluster configuration to its tag, e.g. ghcr.io/gsi-hpc/sind-node:25.11. See Official images for the available tags.

sind pulls the image when it creates your first cluster, and after a sind upgrade, whose default image has a new tag. Subsequent creates reuse the cached image — use --pull to force a fresh pull:

sind create cluster --pull

Besides the node image, each realm’s mesh runs coredns/coredns:1.15.0 (DNS) from Docker Hub, and its SSH relay runs sind’s default node image whatever defaults.image says. A realm with a monitored cluster also runs grafana/grafana:13.3.1, prom/prometheus:v3.16.0, grafana/loki:3.7.9 and grafana/alloy:v1.21.3 from Docker Hub. Hosts that cannot reach Docker Hub or ghcr.io need these images preloaded.

See Container Images for details on building custom images.

Last updated on