Slurm Docker Cluster

This is a multi-container Slurm cluster using docker-compose. The compose file creates named volumes for persistent storage of MySQL data files as well as Slurm state and log directories.

Containers and Volumes

The compose file will run the following containers:

• mysql
• slurmdbd
• slurmctld
• c1 (slurmd)
• c2 (slurmd)

The compose file will create the following named volumes:

• etc_munge ( -> /etc/munge )
• etc_slurm ( -> /etc/slurm )
• slurm_jobdir ( -> /data )
• var_lib_mysql ( -> /var/lib/mysql )
• var_log_slurm ( -> /var/log/slurm )

Building the Docker Image

Build the image locally:

docker build -t slurm-docker-cluster:21.08 .

Build a different version of Slurm using Docker build args and the Slurm Git tag:

docker build --build-arg SLURM_TAG="slurm-19-05-2-1" -t slurm-docker-cluster:19.05.2 .

Or equivalently using docker-compose:

SLURM_TAG=slurm-19-05-2-1 IMAGE_TAG=19.05.2 docker-compose build

Starting the Cluster

Run docker-compose to instantiate the cluster:

IMAGE_TAG=19.05.2 docker-compose up -d

Register the Cluster with SlurmDBD

To register the cluster to the slurmdbd daemon, run the register_cluster.sh script:

./register_cluster.sh

Note: You may have to wait a few seconds for the cluster daemons to become ready before registering the cluster. Otherwise, you may get an error such as sacctmgr: error: Problem talking to the database: Connection refused.

You can check the status of the cluster by viewing the logs: docker-compose logs -f

Accessing the Cluster from the command line

Use docker exec to run a bash shell on the controller container:

docker exec -it slurmctld bash

From the shell, execute slurm commands, for example:

[root@slurmctld /]# sinfo
PARTITION AVAIL  TIMELIMIT  NODES  STATE NODELIST
normal*      up 5-00:00:00      2   idle c[1-2]

Submitting Jobs

The slurm_jobdir named volume is mounted on each Slurm container as /data. Therefore, in order to see job output files while on the controller, change to the /data directory when on the slurmctld container and then submit a job:

[root@slurmctld /]# cd /data/
[root@slurmctld data]# sbatch --wrap="uptime"
Submitted batch job 2
[root@slurmctld data]# ls
slurm-2.out

Accessing the Cluster via Slurm REST API

Create a JSON Web Token (JWT) for authentication to slurmrestd.

docker exec slurmctld /usr/bin/scontrol token username=slurm

Copy/paste the result in your shell to create the SLURM_JWT env variable.

List all the OpenAPI plugins supported by slurmrestd.

docker exec slurmctld /usr/sbin/slurmrestd -s list

slurmrestd: Possible OpenAPI plugins:
slurmrestd: openapi/v0.0.35
slurmrestd: openapi/v0.0.37
slurmrestd: openapi/dbv0.0.36
slurmrestd: openapi/dbv0.0.37
slurmrestd: openapi/v0.0.36

Note the highest value, here v0.0.37, which is part of the base URI http://localhost:8080/slurm/v0.0.37.

Examples

curl --header "X-SLURM-USER-NAME: slurm" --header "X-SLURM-USER-TOKEN: $SLURM_JWT" 'http://localhost:8080/slurm/v0.0.37/ping'

{
   "meta": {
     "plugin": {
       "type": "openapi\/v0.0.37",
       "name": "Slurm OpenAPI v0.0.37"
     },
     "Slurm": {
       "version": {
         "major": 21,
         "micro": 6,
         "minor": 8
       },
       "release": "21.08.6"
     }
   },
   "errors": [
   ],
   "pings": [
     {
       "hostname": "slurmctld",
       "ping": "UP",
       "status": 0,
       "mode": "primary"
     }
   ]
 }

curl --header "X-SLURM-USER-NAME: slurm" --header "X-SLURM-USER-TOKEN: $SLURM_JWT" --header "Content-Type: application/json" -d @example_job.json 'http://localhost:8080/slurm/v0.0.37/job/submit'

{
   "meta": {
     "plugin": {
       "type": "openapi\/v0.0.37",
       "name": "Slurm OpenAPI v0.0.37"
     },
     "Slurm": {
       "version": {
         "major": 21,
         "micro": 6,
         "minor": 8
       },
       "release": "21.08.6"
     }
   },
   "errors": [
   ],
   "job_id": 1,
   "step_id": "BATCH",
   "job_submit_user_msg": ""
 }

See logs

See logs from slurmrestd.

docker-compose logs -f slurmctld

See logs from slurmctld.

docker exec slurmctld tail -f /var/log/slurm/slurmd.log

See the completed jobs.

docker exec slurmctld tail -f /var/log/slurm/jobcomp.log

See also

• slurmrestd
• Slurm REST API
• Slurm REST API Reference

Stopping and Restarting the Cluster

docker-compose stop
docker-compose start

Deleting the Cluster

To remove all containers and volumes, run:

docker-compose stop
docker-compose rm -f
docker volume rm slurm-docker-cluster_etc_munge slurm-docker-cluster_etc_slurm slurm-docker-cluster_slurm_jobdir slurm-docker-cluster_var_lib_mysql slurm-docker-cluster_var_log_slurm