pirocks/slurm-banking-plugins

🏦 Slurm banking plugins to manage service unit usage based on the myBRC API

Slurm Banking Plugins

Currently in development - Not ready for use

Slurm banking plugins provide allocation management to Slurm. The plugins deduct service units for completed and running jobs and prevent jobs from running if there are insufficient service units available. There are two plugins, one running on job submission and the other on job completion. The job completion plugin will reimburse service units if the job ran for less time than was expected based on its submission options. The plugins interact with an HTTP-based API to keep track of service units per account and user.

These plugins are written in Rust, an efficient and memory-safe programming language. It uses rust-bindgen to automatically generate the Rust foreign function interface (FFI) bindings based on the Slurm C header files.

Build Requirements

• Rust (including cargo)
• Slurm header files
• Clang (dependency for rust-bindgen)
• OpenSSL (dependency for reqwest)

Building

Since the Slurm jobcomp plugins need access to the "src/common/slurm_jobcomp.h" header, we need access to the Slurm source code src directory in order to build (as well as the normal <slurm/slurm.h> headers on the CPATH).

1. Edit the path at the top of the Makefile to point to the Slurm source code directory
2. Once you have all the dependencies, just run make :)
3. After building, you will find the .so files in the same directory as the Makefile

NixOS

shell.nix provides the environment for development on NixOS. I run the following:

nix-shell 
make

Developing

I use the docker-centos7-slurm Docker container as a base, and build the plugins on top of it.

make docker-dev builds the development container with Slurm plus all the other necessary dependencies for the plugins and drops you into a shell. The code is stored in /slurm-banking-plugins in the container. After making your changes, use make && make install to compile and install the plugins, then restart Slurm with supervisorctl restart all.