Skip to content

Commit f8fb336

Browse files
committed
Fix documentation
1 parent 30a1786 commit f8fb336

1 file changed

Lines changed: 5 additions & 25 deletions

File tree

README.md

Lines changed: 5 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@ The `profile::` sections list the available classes, their role and their parame
5757
- [`profile::rsyslog::server`](#profilersyslogserver)
5858
- [`profile::vector`](#profilevector)
5959
- [`profile::slurm::base`](#profileslurmbase)
60-
- [`profile::slurm::node`](#profileslurmnode)
6160
- [`profile::slurm::accounting`](#profileslurmaccounting)
6261
- [`profile::slurm::controller`](#profileslurmcontroller)
6362
- [`profile::slurm::node`](#profileslurmnode)
@@ -1450,7 +1449,7 @@ to all Slurm's roles. It also installs and configure Munge service.
14501449
| Variable | Description | Type |
14511450
| :---------------------- | :----------------------- | :------ |
14521451
| `cluster_name` | Name of the cluster | String |
1453-
| `munge_key` | Base64 encoded Munge key | String |
1452+
| `munge_key` | Base64 encoded Munge key | Optional[String] |
14541453
| `slurm_version` | Slurm version to install | Enum['24.05', '24.11', '25.05', '25.11'] |
14551454
| `os_reserved_memory` | Memory in MB reserved for the operating system on the compute nodes | Integer |
14561455
| `suspend_time` | Idle time (seconds) for nodes to becomes eligible for suspension. | Integer |
@@ -1462,14 +1461,14 @@ to all Slurm's roles. It also installs and configure Munge service.
14621461
| `enable_x11_forwarding` | Enable Slurm's built-in X11 forwarding capabilities | Boolean |
14631462
| `config_addendum` | Additional parameters included at the end of slurm.conf. | String |
14641463
| `log_level` | Log level of all Slurm daemon | Enum['quiet', 'fatal', 'error', 'info', 'verbose', 'debug', 'debug[2-5]'] |
1464+
| `ensure_munge` | Desired state of the `munge` service (`running` or `stopped`) | Enum['running', 'stopped'] |
14651465

14661466
<details>
14671467
<summary>default values</summary>
14681468

14691469
```yaml
14701470
profile::slurm::base::cluster_name: "%{alias('terraform.data.cluster_name')}"
1471-
profile::slurm::base::munge_key: ENC[PKCS7, ...]
1472-
profile::slurm::base::slurm_version: '23.11'
1471+
profile::slurm::base::slurm_version: '24.11'
14731472
profile::slurm::base::os_reserved_memory: 512
14741473
profile::slurm::base::suspend_time: 3600
14751474
profile::slurm::base::suspend_rate: 20
@@ -1488,25 +1487,6 @@ When `profile::slurm::base` is included, these classes are included too:
14881487
- [`profile::consul`](#profileconsul)
14891488
- [`profile::base::powertools`](#profilebasepowertools)
14901489

1491-
## `profile::slurm::node`
1492-
This class allows some configuration for the Slurm compute nodes.
1493-
1494-
### parameters
1495-
| Variable | Description | Type |
1496-
| :---------------------- | :------------------------------------------------------ | :----- |
1497-
| `ensure_slurmd` | Desired state of the `slurmd` service (`running` or `stopped`) | Enum['running', 'stopped'] |
1498-
| `pam_access_groups` | Groups that can access the node regardless of Slurm jobs | Array[String] |
1499-
1500-
<details>
1501-
<summary>default values</summary>
1502-
1503-
```yaml
1504-
profile::slurm::node::ensure_slurmd: 'running'
1505-
profile::slurm::node::pam_access_groups: ['wheel']
1506-
```
1507-
</details>
1508-
1509-
15101490
## `profile::slurm::accounting`
15111491

15121492
This class installs and configure the Slurm database daemon - **slurmdbd**.
@@ -1629,15 +1609,15 @@ This class installs and configure the Slurm node daemon - **slurmd**.
16291609

16301610
| Variable | Description | Type |
16311611
| :---------------------- | :-------------------------------------------------------------------------------------------- | :------ |
1632-
| `ensure` | Desired state of the `slurmd` service (`running` or `stopped`) | Enum['running', 'stopped'] |
1612+
| `ensure_slurmd` | Desired state of the `slurmd` service (`running` or `stopped`) | Enum['running', 'stopped'] |
16331613
| `enable_tmpfs_mounts` | Enable [spank-cc-tmpfs_mounts](https://github.com/ComputeCanada/spank-cc-tmpfs_mounts) plugin | Boolean |
16341614
| `pam_access_groups` | Groups that can access the node regardless of Slurm jobs | Array[String] |
16351615

16361616
<details>
16371617
<summary>default values</summary>
16381618

16391619
```yaml
1640-
profile::slurm::node::ensure: 'running'
1620+
profile::slurm::node::ensure_slurmd: 'running'
16411621
profile::slurm::node::enable_tmpfs_mounts: true
16421622
profile::slurm::node::pam_access_groups: ['wheel']
16431623
```

0 commit comments

Comments
 (0)