Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ulhpc/puppet-slurm
A Puppet module designed to configure and manage SLURM(see https://slurm.schedmd.com/), an open source, fault-tolerant, and highly scalable cluster management and job scheduling system for large and small Linux clusters
https://github.com/ulhpc/puppet-slurm
job-scheduler munge puppet slurm
Last synced: 6 days ago
JSON representation
A Puppet module designed to configure and manage SLURM(see https://slurm.schedmd.com/), an open source, fault-tolerant, and highly scalable cluster management and job scheduling system for large and small Linux clusters
- Host: GitHub
- URL: https://github.com/ulhpc/puppet-slurm
- Owner: ULHPC
- License: apache-2.0
- Created: 2017-08-20T15:49:26.000Z (over 7 years ago)
- Default Branch: devel
- Last Pushed: 2025-01-07T00:57:21.000Z (about 1 month ago)
- Last Synced: 2025-01-12T19:06:53.788Z (28 days ago)
- Topics: job-scheduler, munge, puppet, slurm
- Language: Puppet
- Homepage:
- Size: 586 KB
- Stars: 19
- Watchers: 11
- Forks: 25
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing/index.md
- License: LICENSE
Awesome Lists containing this project
README
-*- mode: markdown; mode: visual-line; -*-
# Slurm Puppet Module
[](https://forge.puppet.com/ULHPC/slurm) [](LICENSE)  [](http://ulhpc-puppet-slurm.readthedocs.io) [](https://travis-ci.org/ULHPC/puppet-slurm)
Configure and manage [Slurm](https://slurm.schedmd.com/): A Highly Scalable Resource Manager
Copyright (c) 2017-2021 UL HPC Team
. see also http://hpc.uni.lu
## Overview
[Slurm](https://slurm.schedmd.com/) (aka "Simple Linux Utility for Resource Management") is a free and open-source job scheduler for Linux and Unix-like kernels, used by many of the world's supercomputers and computer clusters (~60% of Top500 rely on it).
> Slurm is an open source, fault-tolerant, and highly scalable cluster management and job scheduling system for large and small Linux clusters
It provides three key functions.
1. it allocates exclusive and/or non-exclusive access to resources (computer nodes) to users for some duration of time so they can perform work.
2. it provides a framework for starting, executing, and monitoring work (typically a parallel job such as MPI) on a set of allocated nodes.
3. Finally, it arbitrates contention for resources by managing a queue of pending jobs.
This [Puppet](https://puppet.com/) module is designed to configure and manage the
different daemons and components of a typical Slurm architecture, depicted below:
In particular, this module implements the following elements:
| Puppet Class | Description |
|--------------------|----------------------------------------------------------------------------------------------------------------------|
| `slurm` | The main slurm class, piloting all aspects of the configuration |
| `slurm::slurmdbd` | Specialized class for [Slurmdbd](https://slurm.schedmd.com/slurmdbd.html), the Slurm Database Daemon. |
| `slurm::slurmctld` | Specialized class for [Slurmctld](https://slurm.schedmd.com/slurmctld.html), the central management daemon of Slurm. |
| `slurm::slurmd` | Specialized class for [Slurmd](https://slurm.schedmd.com/slurmd.html), the compute node daemon for Slurm. |
| `slurm::login` | Specialized class to configure a Login node (i.e. without any of the slurm daemons) |
| `slurm::munge` | Manages [MUNGE]( https://github.com/dun/munge), an authentication service for creating and validating credentials. |
| `slurm::pam` | Handle PAM aspects for SLURM (Memlock for MPI etc.) |
| `slurm::params` | Defaults parameters for all the module classes/definition |
| `slurm::plugins` | Handles all default Slurm plugins -- NOT YET IMPLEMENTED |
| `slurm::pmix` | Handle PMIx aspects (download, build and installation) to make SLURM build compliant with PMIx, PMI1 and PMI2 |
| `slurm::repo` | Takes care of the control repository hosting the slurm configuration of the cluster |
| Puppet Defines | Description |
|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
| `slurm::acct:mgr` | Generic wrapper for all sacctmgr commands |
| `slurm::acct::{account,cluster,qos,user}` | adding (or removing) a {account,cluster,qos,user} to the slurm accounting database |
| `slurm::build` | building Slurm sources into packages (i.e. RPMs for the moment) for a given version passed as resource name |
| `slurm::download` | takes care of downloading the SLURM sources for a given version passed as resource name |
| `slurm::firewall` | takes care of firewall aspects for SLURM |
| `slurm::install::packages` | installs the Slurm packages, typically built from `slurm::build`, for a given version passed as resource name. |
| `slurm::pmix::{download,build,install}` | download, build and install [PMIx](https://slurm.schedmd.com/mpi_guide.html#pmix) |
| `slurm::repo::syncto` | synchronizes the content of the slurm control repository (see `slurm::repo`) toward a directory (typically a shared mountpoint) |
In addition, this puppet module implements several **private** classes:
* `slurm::accounting`: Setup the accounting structure
* `slurm::common[::redhat]`: handles common tasks to all daemon
* `slurm::config[::{cgroup,gres,topology}]`: handles the various aspects of the configuration of SLURM daemons -- see , i.e.
- [`slurm.conf`](https://slurm.schedmd.com/slurm.conf.html)
- [`slurmdbd.conf`](https://slurm.schedmd.com/slurmdbd.conf.html)
- [`topology.conf`](https://slurm.schedmd.com/topology.conf.html)
- [`cgroup.conf`](https://slurm.schedmd.com/cgroup.conf.html)
* `slurm::install`: wrapper to download, build and install the Slurm packages
* `slurm::plugins::lua`: takes care of the Job Submit plugin 'lua' i.e. of the file [`job_submit.lua`](https://github.com/SchedMD/slurm/blob/master/contribs/lua/job_submit.lua).
Also, a couple of extra definition in used in our infrastructure:
* `slurm::repo::syncto`: synchronize the control repository of the slurm configuration (which is cloned using the '`slurm::repo`' class) toward a directory (typically a shared GPFS/NFS mountpoint to make it available to all login and compute nodes)
All these components are configured through a set of variables you will find in [`manifests/params.pp`](https://github.com/ULHPC/puppet-slurm/blob/devel/manifests/params.pp).
_Note_: the various operations that can be conducted from this repository are piloted from a [`Rakefile`](https://github.com/ruby/rake) and assumes you have a running [Ruby](https://www.ruby-lang.org/en/) installation.
See `docs/contributing.md` for more details on the steps you shall follow to have this `Rakefile` working properly.
**IMPORTANT** Until the release of version 1.0 (denoting a usage in production on the [UL HPC Platform](http://hpc.uni.lu)), **this module is still to be considered in alpha state and a work in progress**. Use it at your own risks!
### Setup Requirements
This module currently only works completely on Redhat / CentOS 7 over Puppet >= 4.x.
Over operating systems and support for Puppet 5.x and above seems to work but is not guaranteed.
Yet feel free to contribute to this module to help us extending the usage of this module.
By default, some key configuration decisions are configured, namely:
* [MUNGE](https://github.com/dun/munge) is used for shared key authentication.
- the shared key is generated by default, but you probably want to provide it to puppet via a URI.
* None of the daemons are configured by default.
- You have to set the boolean parameter(s) `with_{slurmdbd,slurmctld,slurmd}` to `true` and/or include explicitly the `slurm::{slurmdbd,slurmctld,slurmd}` classes
* On a **production** system, you probably wants to follow the following tips:
- set globally `service_manage` to false - you probably want to control when the daemons are restarted (typically to ensure the slurm config is really in sync across the cluster)
- set global `do_package_install` to false
- maintain a single source of authority for the shared slurm configuration as a Git repository (called here the "_slurm control repository_")
* your **slurm controller(s) servers** would then rely on the `slurm::repo*` classes/definitions to maintain the consistency between the local config (in `/etc/slurm`, as generated by this module upon puppet runs and its extensive hiera configuration capabilities) and this repository.
* your **login and compute nodes**
not correlate the local `/etc/slurm` directory with
- you are advised to set the `service_manage` to false
## Forge Module Dependencies
See [`metadata.json`](https://github.com/ULHPC/puppet-slurm/blob/devel/metadata.json). In particular, this module depends on
* [puppetlabs/stdlib](https://forge.puppetlabs.com/puppetlabs/stdlib)
* [puppetlabs/mysql](https://forge.puppetlabs.com/puppetlabs/mysql)
* [puppetlabs/inifile](https://forge.puppetlabs.com/puppetlabs/inifile)
* [puppet/archive](https://forge.puppetlabs.com/puppet/archive)
* [puppet/yum](https://forge.puppetlabs.com/puppet/yum)
* [puppet/epel](https://forge.puppet.com/puppet/epel)
* [bodgit/rngd](https://forge.puppetlabs.com/bodgit/rngd)
* [ghoneycutt/pam](https://forge.puppetlabs.com/ghoneycutt/pam)
## Overview and Usage
The best way to use this module in a flexible way is to rely on [Hiera](https://puppet.com/docs/puppet/5.4/hiera_intro.html) coupled with a [role and profile](https://puppet.com/docs/pe/2017.1/r_n_p_intro.html).
* See the generic manifest [`default.pp`](https://github.com/ULHPC/puppet-slurm/blob/devel/tests/vagrant/puppet/manifests/default.pp)
* See the [`hiera.yaml`](https://github.com/ULHPC/puppet-slurm/blob/devel/tests/vagrant/puppet/hiera.yaml) and the associated [`hieradata/`](https://github.com/ULHPC/puppet-slurm/blob/devel/tests/vagrant/puppet/hieradata/), aimed at taking advantage of a custom `role` [facts](https://puppet.com/docs/facter/3.9/fact_overview.html)
* sample/simple profiles for each type of deployment can be found in [site/profiles/manifests/](site/profiles/manifests/)
- [`profiles::slurm`](https://github.com/ULHPC/puppet-slurm/blob/devel/tests/vagrant/puppet/site/profiles/manifests/slurm.pp): Profile (base) class used for slurm general settings
- [`profiles::slurm::slurmctld`](https://github.com/ULHPC/puppet-slurm/blob/devel/tests/vagrant/puppet/site/profiles/manifests/slurm/slurmctld.pp): Profile class used for setting up a Slurm Head node (where the slurmctld daemon runs)
- [`profiles::slurm::slurmdbd`](https://github.com/ULHPC/puppet-slurm/blob/devel/tests/vagrant/puppet/site/profiles/manifests/slurm/slurmdbd.pp): Profile class used for setting up a Slurm DBD (DataBase Daemon) node
- [`profiles::slurm::slurmd`](https://github.com/ULHPC/puppet-slurm/blob/devel/tests/vagrant/puppet/site/profiles/manifests/slurm/slurmd.pp): Profile class used for setting up a Slurm Compute node
- [`profiles::slurm::login`](https://github.com/ULHPC/puppet-slurm/blob/devel/tests/vagrant/puppet/site/profiles/manifests/slurm/login.pp): Profile class used for setting up a Login node (cluster frontend/access) i.e. without any daemon.
The main classes are now detailed.
### Class `slurm`
This is the main class defined in this module.
It accepts so many parameters that they are not listed here -- see the [puppet strings `@param`] comments of [`manifests/init.pp`](https://github.com/ULHPC/puppet-slurm/blob/devel/manifests/init.pp)
Use it as follows:
```ruby
include ::slurm
```
In which case you can define the class parameters using [Hiera](https://puppet.com/docs/puppet/5.4/hiera_intro.html) -- see for instance the default hiera configuration (used effectively in the vagrant deployment) in [`hieradata/default.yaml`](https://github.com/ULHPC/puppet-slurm/blob/devel/tests/vagrant/puppet/hieradata/defaults.yaml).
You can also prefer a profile-based approach -- see [`profiles::slurm`](https://github.com/ULHPC/puppet-slurm/blob/devel/tests/vagrant/puppet/site/profiles/manifests/slurm.pp) as a sample profile (base) class used for slurm general settings.
Other usage examples are proposed in [`tests/init.pp`](https://github.com/ULHPC/puppet-slurm/blob/devel/tests/init.pp), a more advanced usage (defining the network topology, the computing nodes and the SLURM partitions) in [`tests/advanced.pp`](https://github.com/ULHPC/puppet-slurm/blob/devel/tests/advanced.pp).
### Class `slurm::slurmdbd`
This class is responsible for setting up a __[Slurm Database Daemon](https://slurm.schedmd.com/slurmdbd.html)__, which provides a secure enterprise-wide interface to a database for Slurm.
In particular, it can run relatively independently of the other slurm daemon instances and thus is proposed as a separate independent class.
You can simply configure it as follows:
```ruby
include ::slurm
include ::slurm::slurmdbd
```
Alternatively, you can use the `with_slurdbd` parameter of the `::slurm` class:
```ruby
class { '::slurm':
with_slurmdbd => true,
}
```
See also [`tests/slurmdbd.pp`](tests/slurmdbd.pp), the sample profile [`profiles::slurm::slurmdbd`](https://github.com/ULHPC/puppet-slurm/blob/devel/tests/vagrant/puppet/site/profiles/manifests/slurm/slurmdbd.pp).
The `slurm::slurmdbd` accepts also so many parameters that they are not listed here -- see the [puppet strings `@param`] comments of [`manifests/slurmdbd.pp`](https://github.com/ULHPC/puppet-slurm/blob/devel/manifests/slurmdbd.pp) for more details.
For a sample [Hiera](https://puppet.com/docs/puppet/5.4/hiera_intro.html), see [`hieradata/default.yaml`](https://github.com/ULHPC/puppet-slurm/blob/devel/tests/vagrant/puppet/hieradata/defaults.yaml#L19-L25) (effectively used in the vagrant-based deployment).
### Class `slurm::slurmctld`
The main helper class specializing the main slurm class for setting up a __Slurm Head node__ (where the [slurmctld](https://slurm.schedmd.com/slurmctld.html) daemon runs).
```ruby
include ::slurm
include ::slurm::slurmctld
```
Alternatively, you can use the `with_slurctld` parameter of the `::slurm` class:
```ruby
class { '::slurm':
with_slurmctld => true,
}
```
See also [`tests/slurmctld.pp`](tests/slurmctld.pp), the sample profile [`profiles::slurm::slurmctld`](https://github.com/ULHPC/puppet-slurm/blob/devel/tests/vagrant/puppet/site/profiles/manifests/slurm/slurmctld.pp).
### Class `slurm::slurmd`
The main helper class specializing the main slurm class for setting up __ Slurm Compute node__ _i.e._ where the [`slurmd`](https://slurm.schedmd.com/slurmd.html) daemon runs.
```ruby
include ::slurm
include ::slurm::slurmd
```
Alternatively, you can use the `with_slurmd` parameter of the `::slurm` class:
```ruby
class { '::slurm':
with_slurmd => true,
}
```
### Class `slurm::login`
The main helper class specializing the main slurm class for setting up __ Slurm Login node__ _i.e._ where none of the slurm daemon runs (yet the slurm CLI commands are installed via the `slurm` package).
```ruby
include ::slurm
include ::slurm::login
```
See also [`tests/login_node.pp`](tests/login_node.pp), the sample profile [`profiles::slurm::login`](https://github.com/ULHPC/puppet-slurm/blob/devel/tests/vagrant/puppet/site/profiles/manifests/slurm/login.pp).
### Class `slurm::munge`
[MUNGE](https://github.com/dun/munge) (MUNGE Uid 'N' Gid Emporium) is an authentication service for creating and validating credentials. It is designed to be highly scalable for use in an HPC cluster environment.
It allows a process to authenticate the UID and GID of another local or remote process within a group of hosts having common users and groups. These hosts form a security realm that is defined by a shared cryptographic key.
Clients within this security realm can create and validate credentials without the use of root privileges, reserved ports, or platform-specific methods.
For more information, see
The puppet class `slurm::munge` is thus responsible for setting up a working Munge environment to
be used by the SLURM daemons -- see also
Use it as follows:
```ruby
include ::slurm::munge
```
Or, if you wish to provide the munge key using puppet URI:
```ruby
class {'::slurm::munge':
ensure => true,
key_source => "puppet:///modules/${myprofile}/munge.key"
}
```
If, as in the above example, the key is stored centrally in your control repository, you probably want to store it encrypted using [git-crypt](https://github.com/AGWA/git-crypt) for instance.
The `slurm::munge` class accepts the following parameters:
* `ensure` [String] Default: 'present'
- Ensure the presence (or absence) of the Munge service
* `create_key` [Boolean] Default: true
- Whether or not to generate a new key if it does not exists
* `daemon_args` [Array] Default: []
- Set the content of the DAEMON_ARGS variable, which permits to set additional command-line options to the daemon. For example, this can be used to override the location of the secret key (`--key-file`) or set the number of worker threads (`--num-threads`) See .
* `gid` [Integer] Default: 992
- GID of the munge group
* `key_content` [String] Default: undef
- The desired contents of a file, as a string. This attribute is mutually exclusive with source and target.
* `key_filename` [String] Default: '/etc/munge/munge.key'
- The secret key filename
* `key_source` [String] Default: undef
- A source file, which will be copied into place on the local system. This attribute is mutually exclusive with content. The normal form of a puppet: URI is `puppet:///modules//`
* `uid` [Integer] Default: 992
- UID of the munge user
Note that the `slurm` class makes use of this class by default as the parameter `manage_munge` is set to true by default.
### Definition `slurm::download`
This definition takes care of downloading the SLURM sources for a given version (passed as name to this resource) and placing them into `$target` directory. You can also invoke this definition with the full archive filename i.e. `slurm-.tar.bz2`.
* `ensure` [String] Default: `present`
- Ensure the presence (or absence) of building
* `target` [String] Default: `/usr/local/src`
- Target directory for the downloaded sources
* `checksum_type` [String] Default: `md5`
- archive file checksum type (none|md5|sha1|sha2|sh256|sha384| sha512).
* `checksum_verify` [Boolean] Default: false
- whether checksum will be verified (true|false).
* `checksum` [String] Default: ''
- archive file checksum (match checksum_type)
_Example_: Downloading version 19.05.3-2 (latest at the time of writing) of SLURM
```ruby
slurm::download { '19.05.3-2':
ensure => 'present',
checksum => '6fe2c6196f089f6210d5ba79e99b0656f5a527b4',
checksum_type => 'sha1',
target => '/usr/local/src/',
}
```
### Definition `slurm::build`
This definition takes care of building Slurm sources into RPMs using 'rpmbuild'.
It expect to get as resource name the SLURM version to build
This assumes the sources have been downloaded using slurm::download
* `ensure` [String] Default: `present`
- Ensure the presence (or absence) of building
* `srcdir` [String] Default: `/usr/local/src`
- Where the [downloaded] Slurm sources are located
* `dir` [String] Default: `/root/rpmbuild` on redhat systems
- Top directory of the sources builds (i.e. RPMs, debs...). For instance, built RPMs will be placed under `${dir}/RPMS/${::architecture}`
* `with` [Array] Default: `[ 'lua', ... ]`
- List of --with build options to pass to rpmbuild -- see
* `without` [Array] Default: `[]`
- List of --without build options to pass to rpmbuild -- see
_Example_: Building version 17.11.12 (latest at the time of writing) of SLURM
```ruby
slurm::build { '17.11.12':
ensure => 'present',
srcdir => '/usr/local/src',
dir => '/root/rpmbuild',
with => [ 'lua', 'mysql', 'openssl' ]
}
```
### Definition `slurm::install::packages`
This definition takes care of installing the Slurm packages, typically built from `slurm::build`, for a given version passed as resource name.
_Example_: installing slurmd packages in version 17.02.7:
```ruby
slurm::install::packages { '17.11.12':
ensure => 'present',
pkgdir => "/root/rpmbuild/RPMs/${::architecture}",
slurmd => true
}
```
## Librarian-Puppet / R10K Setup
You can of course configure the slurm module in your `Puppetfile` to make it available with [Librarian puppet](http://librarian-puppet.com/) or [r10k](https://github.com/adrienthebo/r10k) by adding the following entry:
# Modules from the Puppet Forge
mod "ULHPC/slurm"
or, if you prefer to work on the git version:
mod "ULHPC/slurm",
:git => 'https://github.com/ULHPC/puppet-slurm',
:ref => 'production'
## Hiera
You can see example of hiera configurations for this module under [`tests/vagrant/puppet/hieradata`](https://github.com/ULHPC/puppet-slurm/tree/devel/tests/vagrant/puppet/hieradata).
## Issues / Feature request
You can submit bug / issues / feature request using the [slurm Puppet Module Tracker](https://github.com/ULHPC/puppet-slurm/issues).
## Developments / Contributing to the code
If you want to contribute to the code, you shall be aware of the way this module is organized.
These elements are detailed on [`docs/contributing.md`](contributing/index.md).
You are more than welcome to contribute to its development by [sending a pull request](https://help.github.com/articles/using-pull-requests).
## Puppet modules tests within a Vagrant box
The best way to test this module in a non-intrusive way is to rely on [Vagrant](http://www.vagrantup.com/).
The `Vagrantfile` at the root of the repository pilot the provisioning of a virtual cluster configuring Slurm from the puppet provisionning capability of Vagrant over _this_ module.
```
$> vagrant status
Current machine states:
slurm-master not created (virtualbox)
access not created (virtualbox)
node-1 not created (virtualbox)
node-2 not created (virtualbox)
This environment represents multiple VMs. The VMs are all listed
above with their current state. For more information about a specific
VM, run `vagrant status NAME`.
$> vagrant up
[...]
+--------------|--------------------------|---------|----------|------------|-------------------------------|-------------+
| Puppet Testing infrastructure deployed on Vagrant |
+--------------|--------------------------|---------|----------|------------|-------------------------------|-------------+
| Name | Hostname | OS | vCPU/RAM | Role | Description | IP |
+--------------|--------------------------|---------|----------|------------|-------------------------------|-------------+
| slurm-master | slurm-master.vagrant.dev | centos7 | 2/2048 | controller | Slurm Controller #1 (primary) | 10.10.1.11 |
| access | access.vagrant.dev | centos7 | 1/1024 | login | Cluster frontend | 10.10.1.2 |
| node-1 | node-1.vagrant.dev | centos7 | 2/512 | node | Computing Node #1 | 10.10.1.101 |
| node-2 | node-2.vagrant.dev | centos7 | 2/512 | node | Computing Node #2 | 10.10.1.102 |
+--------------|--------------------------|---------|----------|------------|-------------------------------|-------------+
- Virtual Puppet Testing infrastructure deployed deployed!
```
_Note_: it takes roughly 38 minutes to deploy the full cluster from scratch. So be patient ;)
You can then test modifications of each configuration in the hiera file `tests/vagrant/puppet/custom.yaml` and
see the result by applying for instance:
```
$> vagrant provision --provision-with puppet slurm-master
```
See [`docs/vagrant.md`](vagrant.md) for more details.
## Online Documentation
[Read the Docs](https://readthedocs.org/) aka RTFD hosts documentation for the open source community and the [slurm](https://github.com/ULHPC/puppet-slurm) puppet module has its documentation (see the `docs/` directly) hosted on [readthedocs](http://ulhpc-puppet-slurm.rtfd.org).
See [`docs/rtfd.md`](rtfd.md) for more details.
## Licence
This project and the sources proposed within this repository are released under the terms of the [Apache-2.0](LICENCE) licence.
[](LICENSE)