Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cmd-ntrf committed Jun 10, 2024
1 parent f8eb57c commit 1475bfd
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ The `profile::` sections list the available classes, their role and their parame
- [`profile::slurm::base`](#profileslurmbase)
- [`profile::slurm::accounting`](#profileslurmaccounting)
- [`profile::slurm::controller`](#profileslurmcontroller)
- [`profile::slurm::node`](#profileslurmnode)
- [`profile::software_stack`](#profilesoftware_stack)
- [`profile::squid::server`](#profilesquidserver)
- [`profile::sssd::client`](#profilesssdclient)
Expand Down Expand Up @@ -1092,6 +1093,38 @@ When `profile::slurm::accounting` is included, these classes are included too:
- [`profile::slurm::base`](#profileslurmbase)
- [`profile::mail::server`](#profilemailserver)


## `profile::slurm::node`

This class installs and configure the Slurm node daemon - **slurmd**.

### parameters

| Variable | Description | Type |
| :---------------------- | :-------------------------------------------------------------------------------------------- | :------ |
| `enable_tmpfs_mounts` | Enable [spank-cc-tmpfs_mounts](https://github.com/ComputeCanada/spank-cc-tmpfs_mounts) plugin | Boolean |

<details>
<summary>default values</summary>

```yaml
profile::slurm::node::enable_tmpfs_mounts: true
```
</details>

<details>
<summary>example</summary>

```yaml
profile::slurm::node::enable_tmpfs_mounts: false
```
</details>

### dependency

When `profile::slurm::node` is included, this class is included too:
- [`profile::slurm::base`](#profileslurmbase)

## `profile::software_stack`

This class configures the initial shell profile that user will load on login and
Expand Down

0 comments on commit 1475bfd

Please sign in to comment.