Installation

Begin checkpoint/migrate/restoring stateful workloads in SLURM in under 5 minutes!

To use Cedana in SLURM, you need to be registered with us! Reach out to [e-mail] to get set up with an organization.

You can also deploy fully self-hosted, with zero limitations on where you can store your checkpoints! Check out configuration. If you have any questions, please reach out to us at [e-mail].

You can install Cedana on a SLURM node in 3 ways:

1. [Option 1] Install from web (recommended)

2. [Option 2] Install using Cedana

3. [Option 3] Build from source

These steps must be performed on all SLURM controller and compute nodes in your cluster!

Install from web (recommended)

The web installer will automatically install the latest stable version of Cedana and all plugins required for SLURM support with sane defaults.

Install

Check Authentication for more details on how to get an authentication token.

export CEDANA_URL=https://myorg.cedana.ai/v1
export CEDANA_AUTH_TOKEN=your_auth_token
export CEDANA_CLUSTER_ID=your_cluster_id

curl -fsSL "${CEDANA_URL}/install/slurm" -H "Authorization: Bearer ${CEDANA_AUTH_TOKEN}" | sudo -E bash -s -- --node-role <node-role>

• Register a new cluster through Cedana Dashboard.

• Use ?version=x.y.z query parameter to install a specific version.

• Use ?build=alpha&version=feat/my-branch to install an alpha build from a branch.

• Use --node-role controller on controller nodes, --node-role worker on worker nodes, and --node-role login on login (submission) nodes. --controller, --worker, and --login are accepted shorthands in scripts/install-release.sh.

Configure

For changes in configuration, follow instructions on Cedana Daemon configuration.

After you have made changes to the configuration, simply run the installer again to update and restart Cedana on the node.

export CEDANA_URL=https://myorg.cedana.ai/v1
export CEDANA_AUTH_TOKEN=your_auth_token

curl -fsSL "${CEDANA_URL}/install/slurm" -H "Authorization: Bearer ${CEDANA_AUTH_TOKEN}" | sudo -E bash -s -- --node-role <node-role>

And you're all set! Check out Manual Checkpoint/Restore to test it out. Below sections are on the alternative methods to install Cedana SLURM.

Install using Cedana

You can also install SLURM support directly using Cedana, if you have Cedana already installed.

Install

First, install Cedana by following instructions on Cedana Daemon installation.

Check Authentication for more details on how to get an authentication token.

Then, install the slurm plugin and run the setup:

export CEDANA_URL=https://myorg.cedana.ai/v1
export CEDANA_AUTH_TOKEN=your_auth_token
export CEDANA_CLUSTER_ID=your_cluster_id

sudo cedana plugin install slurm
sudo cedana slurm setup --node-role <node-role>

• Register a new cluster through Cedana Dashboard.

• Use --node-role controller on controller nodes, --node-role worker on worker nodes, and --node-role login on login (submission) nodes. --controller, --worker, and --login are accepted shorthands in scripts/install-release.sh.

This should setup everything required. If you wish to setup manually, follow the next section.

Install (manual)

For deployments that require installing the plugin files manually, you can download the files directly.

First, install Cedana by following instructions on Cedana Daemon installation.

Check Authentication for more details on how to get an authentication token.

To get the Cedana SLURM plugin:

export CEDANA_URL=https://myorg.cedana.ai/v1
export CEDANA_AUTH_TOKEN=your_auth_token
export CEDANA_CLUSTER_ID=your_cluster_id

sudo cedana version --init-config
sudo cedana plugin remove slurm slurm/wlm
sudo cedana plugin install slurm slurm/wlm

For alpha builds:

export CEDANA_URL=https://myorg.cedana.ai/v1
export CEDANA_AUTH_TOKEN=your_auth_token
export CEDANA_CLUSTER_ID=your_cluster_id
export CEDANA_PLUGINS_BUILDS=alpha

sudo cedana version --init-config
sudo ./cedana plugin remove slurm slurm/wlm
sudo ./cedana plugin install slurm@main slurm/wlm@main-slurm-25-11-5-1

This will download the cedana-slurm binary to /usr/local/bin and the SLURM plugin files to /usr/local/lib. Remember to replace the slurm-25-11-5-1 above with the SLURM version your cluster is running.

To install the files, transfer the files to the required directories:

# install to the worker nodes (slurmd), controller nodes (slurmctld), and the database node (slurmdbd)
sudo install /usr/local/bin/cedana-slurm <binary-directory>/cedana-slurm
sudo install /usr/local/lib/cli_filter_cedana.so <slurm-plugin-directory>/cli_filter_cedana.so
sudo install /usr/local/lib/job_submit_cedana.so <slurm-plugin-directory>/job_submit_cedana.so
sudo install /usr/local/lib/task_cedana.so <slurm-plugin-directory>/task_cedana.so
sudo install /usr/local/lib/spank_cedana.so <slurm-plugin-directory>/spank_cedana.so

Update the /etc/slurm/plugstack.conf to include the spank_cedana.so:

+required <slurm-plugin-directory>/spank_cedana.so

Update the /etc/slurm/slurm.conf to include the plugins:

-TaskPlugin=task/affinity,task/cgroup
+TaskPlugin=task/affinity,task/cgroup,task/cedana
+CliFilterPlugins=cli_filter/cedana
+JobSubmitPlugins=job_submit/cedana

Reload the slurmctld and slurmd with:

sudo systemctl restart slurmctld
sudo systemctl restart slurmd

On the database node (slurmdbd), start cedana-slurm:

sudo cedana-slurm daemon

Or, if you are using systemd, create the service file:

export LOG_PATH=/var/log/cedana-slurm.log
export SERVICE_FILE=/etc/systemd/system/cedana-slurm.service
export APP_PATH=/usr/local/bin/cedana-slurm

cat <<EOF | tee "$SERVICE_FILE" >/dev/null
[Unit]
Description=Cedana Daemon
[Service]
ExecStart=$APP_PATH daemon start
User=root
Group=root
Restart=no

[Install]
WantedBy=multi-user.target

[Service]
StandardError=append:$LOG_PATH
StandardOutput=append:$LOG_PATH
EOF

Configure

For changes in Cedana configuration, follow instructions on Cedana Daemon configuration.

Privileged mode (root)

In privileged mode, the checkpointing and restoring are done as root. Privileged mode requires no additional configuration.

Unprivileged mode (user)

In unprivileged mode, the checkpointing and restoring are done as the job's user, i.e., the UID of the SLURM job performs the checkpoint and restore. This configuration is useful when the root is demoted for security purposes. For example, NFS with root_squash requires unprivileged mode.

To enable unprivileged mode, set Slurm.Unprivileged to true in the Cedana Daemon configuration. Otherwise, just do this:

export CEDANA_URL=https://myorg.cedana.ai/v1
export CEDANA_AUTH_TOKEN=your_auth_token
export CEDANA_SLURM_UNPRIVILEGED=1

sudo cedana version --merge-config

In addition, the cedana-slurm, cedana, and criu binaries must have the required capabilities for users to perform checkpoint and restore.

setcap CAP_SYS_PTRACE,CAP_DAC_READ_SEARCH,CAP_CHECKPOINT_RESTORE+eip /usr/local/bin/criu
setcap CAP_SYS_PTRACE,CAP_DAC_READ_SEARCH,CAP_CHECKPOINT_RESTORE+eip /usr/local/bin/cedana
setcap CAP_SYS_PTRACE,CAP_DAC_READ_SEARCH,CAP_CHECKPOINT_RESTORE+eip /usr/local/bin/cedana-slurm

Build from source

Check make help for available build targets.

Build all binaries:

make all

By default, the binaries will be built using the cedana/cedana-slurm:build docker image.

These binaries are useless on their own. You need to install Cedana to use them.

First, install Cedana by following instructions on Cedana Daemon installation. Then, install the slurm plugin after changing into the build directory:

cd build
sudo cedana plugin install slurm
sudo cedana slurm setup --node-role <node-role>

You need to be in the build directory for the cedana slurm setup command to work, as it needs to find the binaries you just built.

Check Authentication for more details on how to get an authentication token.

You're all set up! Let's checkpoint some workloads. Continue to Checkpoint/restore to get started.

Uninstall

To remove Cedana SLURM completely, run on all nodes:

sudo cedana slurm destroy