diff --git a/README.md b/README.md index ebfca90..311f811 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ slurmutils package include: * `slurmconfig`: An editor for _slurm.conf_ configuration files. * `slurmdbdconfig`: An editor for _slurmdbd.conf_ configuration files. +* `cgroupconfig`: An editor for _cgroup.conf_ configuration files. For more information on how to use or contribute to slurmutils, check out the [Getting Started](#-getting-started) and [Development](#-development) @@ -46,13 +47,12 @@ $ poetry install ### Usage -#### Editors +#### `slurmutils.editors` -##### `slurmconfig` +This module provides an API for editing files, and creating new files if they do not +exist. Here's some operations you can perform on files using the editors in this module: -This module provides an API for editing both _slurm.conf_ and _Include_ files, -and can create new configuration files if they do not exist. Here's some common Slurm -lifecycle management operators you can perform using this editor: +##### `slurmconfig` ###### Edit a pre-existing _slurm.conf_ configuration file @@ -85,10 +85,6 @@ with slurmconfig.edit("/etc/slurm/slurm.conf") as config: ##### `slurmdbdconfig` -This module provides and API for editing _slurmdbd.conf_ files, and can create new -_slurmdbd.conf_ files if they do not exist. Here's some operations you can perform -on the _slurmdbd.conf_ file using this editor: - ###### Edit a pre-existing _slurmdbd.conf_ configuration file ```python @@ -102,6 +98,18 @@ with slurmdbdconfig.edit("/etc/slurm/slurmdbd.conf") as config: del config.auth_alt_parameters ``` +##### `cgroupconfig` + +```python +from slurmutils.editors import cgroupconfig + +with cgroupconfig.edit("/etc/slurm/cgroup.conf") as config: + config.constrain_cores = "yes" + config.constrain_devices = "yes" + config.constrain_ram_space = "yes" + config.constrain_swap_space = "yes" +``` + ## 🤔 What's next? If you want to learn more about all the things you can do with slurmutils, diff --git a/pyproject.toml b/pyproject.toml index 6c25611..b9d7d06 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -18,7 +18,7 @@ build-backend = "poetry.core.masonry.api" [tool.poetry] name = "slurmutils" -version = "0.6.0" +version = "0.7.0" description = "Utilities and APIs for interfacing with the Slurm workload manager." repository = "https://github.com/charmed-hpc/slurmutils" authors = ["Jason C. Nucciarone "]