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.

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): bump version of slurmutils to 0.9.0 #36

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
46 changes: 33 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,10 @@ slurmutils package include:

#### `from slurmutils.editors import ...`

* `acctgatherconfig`: An editor for _acct_gather.conf_ configuration files.
NucciTheBoss marked this conversation as resolved.
Show resolved Hide resolved
* `cgroupconfig`: An editor for _cgroup.conf_ configuration files.
* `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 @@ -52,6 +53,37 @@ $ poetry install
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:

##### `acctgatherconfig`

###### Edit a pre-existing _acct_gather.conf_ configuration file

```python
from slurmutils.editors import acctgatherconfig

with acctgatherconfig.edit("/etc/slurm/acct_gather.conf") as config:
config.profile_influx_db_database = "test_acct_gather_db"
config.profile_influx_db_default = ["NONE"]
config.profile_influx_db_host = "testhostname1"
config.profile_influx_db_pass = "testpassword1"
config.profile_influx_dbrt_policy = "testpolicy1"
config.profile_influx_db_user = "testuser1"
config.profile_influx_db_timeout = "20"
```

##### `cgroupconfig`

###### Edit a pre-existing _cgroup.conf_ configuration file

```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"
```

##### `slurmconfig`

###### Edit a pre-existing _slurm.conf_ configuration file
Expand Down Expand Up @@ -98,18 +130,6 @@ 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,
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
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.8.3"
version = "0.9.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
1 change: 1 addition & 0 deletions slurmutils/editors/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@

"""Editors for Slurm workload manager configuration files."""

from . import acctgatherconfig as acctgatherconfig
from . import cgroupconfig as cgroupconfig
from . import slurmconfig as slurmconfig
from . import slurmdbdconfig as slurmdbdconfig
2 changes: 1 addition & 1 deletion slurmutils/models/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

"""Data models for common Slurm objects."""

from .acct_gather import AcctGatherConfig as AcctGatherConfig
from .acctgather import AcctGatherConfig as AcctGatherConfig
from .cgroup import CgroupConfig as CgroupConfig
from .slurm import DownNodes as DownNodes
from .slurm import FrontendNode as FrontendNode
Expand Down
File renamed without changes.