Commit f5e04eee authored by Pape, David (FWCC) - 139658's avatar Pape, David (FWCC) - 139658
Browse files

Updating README.md.

parent b249ca15
Pipeline #19649 passed with stage
in 3 minutes and 2 seconds
# Slurm in Docker
A Docker container (based on Fedora) running Slurm and Slurmctl daemons, providing Slurm commands
like `srun`, `sbatch`, etc. This container can be used for testing your HPC applications.
## Setup
The container is set up to automatically detect your hardware on start-up. It will provide one
compute node that shares the specifications of the platform it is running on (number of cores,
hyperthreading, ...). The *cluster* (if you want to call your single node that) is called `sid`
(Slurm in Docker) and it has one partition, `sidp`, containing said node.
When you start the container, the services are already up and running. You will be greeted by a Bash
shell running as `root`.
## Building and running the container
If you have Docker set up on your system, you can easily start the container by executing
`make run`. This will automatically build and tag the image for you. The first build may take a few
minutes.
The default target for make is `build`. This will build the container using the name and tag
specified at the top of the Makefile. If you wish to give the container a different name, you can
pass it to `make` as an argument, e.g. `make CONTAINER=slurm`.
## Just running the container
If you don't want to build the container yourself, you can pull it from HZDR's registry. (Remember
to log in and out!)
```bash
docker login registry.hzdr.de
docker pull registry.hzdr.de/pape58/slurm-in-docker:fedora-31
docker logout registry.hzdr.de
```
To run the container use this command:
```bash
docker run -ti --rm registry.hzdr.de/pape58/slurm-in-docker:fedora-31
```
The image is updated weekly.
## Using it in your CI job
... is as easy as
```yml
my_job:
image: registry.hzdr.de/pape58/slurm-in-docker:fedora-31
script:
- srun -n 2 hostname
```
## Running other programs
You can pass any program name to the container. At the moment, there are not a lot of programs
installed on it, though. Feel free to write an issue or provide a merge request if you have any
suggestions.
```bash
docker run -it --rm registry.hzdr.de/pape58/slurm-in-docker:fedora-31 ps faux
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment