Skip to content

README.md

Latest commit

 

History

History
75 lines (54 loc) · 2.23 KB

README.md

File metadata and controls

75 lines (54 loc) · 2.23 KB
Raw

Slurm Runtime Environment

A containerized Slurm cluster used for interface testing and development.

Getting Started

Published images are versioned by Slurm release and tagged accordingly.
Launch a specific Slurm version by specifying the version in the image tag.

docker pull ghcr.io/better-hpc/slurm-env:[SLURM VERSION]
docker run ghcr.io/better-hpc/slurm-env:[SLURM VERSION]

To build images locally, provide the desired Slurm version at build time. Builds are supported for all Slurm versions with a corresponding configuration file in the configs directory. Note the build process compiles Slurm from source and may take several minutes to complete.

docker build --build-arg SLURM_VERSION=[SLURM VERSION] -t slurm-env:local .

All images include a test suite to ensure the generated container is functioning properly. These tests can be run from any running container instance.

docker run -i [IMAGE NAME] bats /tests

Fixtures and Services

Containers include all core services/utilities required by Slurm. This includes the following daemons and CLI utilities:

Running Services

  • slurmctld
  • slurmd
  • slurmdbd
  • slurmrestd

CLI Utilities

  • salloc
  • sbatch
  • sacct
  • sacctmgr
  • sbcast
  • scancel
  • squeue
  • sinfo
  • scontrol

The table below outlines the clusters, partitions, and nodes defined in the Slurm configuration.

Cluster Partition Nodes
bhpc partition1 node[1-5]
bhpc partition2 node[6-10]

The following environment variables are injected into the container to describe the active runtime.

Variable Name Value
CLUSTER_TYPE slurm
CLUSTER_VERSION $(sacctmgr --version)

Adding Slurm Versions

Support for new Slurm versions is added to this project in two steps:

  1. Add the new Slurm config files to the configs directory. The subdirectory should be named after the corresponding Slurm version.
  2. Ensure the new version is discoverable by the project's CI/CD workflows by adding the version number to the build matrix in configs/matrix.json.