Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(release): release slurmutils version 0.7.0 #21

Merged
merged 3 commits into from
Sep 20, 2024
Merged

chore(release): release slurmutils version 0.7.0 #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
89fa7cb
docs(cgroup): add cgroup editor docs to README
NucciTheBoss Sep 20, 2024
48381d6
chore(release): bump slurmutils version 0.6.0 -> 0.7.0
NucciTheBoss Sep 20, 2024
2b37c4f
docs: revise `slurmutils.editors` section
NucciTheBoss Sep 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 17 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand All @@ -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"
NucciTheBoss marked this conversation as resolved.
Show resolved Hide resolved
```

## 🤔 What's next?

If you want to learn more about all the things you can do with slurmutils,
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>"]
Expand Down