Skip to content

Commit 4f3bbc8

Browse files
committed
document nodegroup.features to README
1 parent d16b6ba commit 4f3bbc8

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,10 @@ unique set of homogenous nodes:
6363
- `conf`: A string with the [resource specification](https://slurm.schedmd.com/slurm.conf.html#OPT_Gres_1) but requiring the format `<name>:<type>:<number>`, e.g. `gpu:A100:2`. Note the `type` is an arbitrary string.
6464
- `file`: A string with the [File](https://slurm.schedmd.com/gres.conf.html#OPT_File) (path to device(s)) for this resource, e.g. `/dev/nvidia[0-1]` for the above example.
6565
Note [GresTypes](https://slurm.schedmd.com/slurm.conf.html#OPT_GresTypes) must be set in `openhpc_config` if this is used.
66+
* `features`: Optional. List of [Features](https://slurm.schedmd.com/slurm.conf.html#OPT_Features) strings.
6667
* `node_params`: Optional. Mapping of additional parameters and values for
6768
[node configuration](https://slurm.schedmd.com/slurm.conf.html#lbAE).
69+
**NB:** Parameters which can be set via the keys above must not be included here.
6870

6971
Each nodegroup will contain hosts from an Ansible inventory group named
7072
`{{ openhpc_cluster_name }}_{{ group_name}}`. Note that:
@@ -88,6 +90,7 @@ partition. Each partition mapping may contain:
8890
given by `openhpc_job_maxtime`. The value should be quoted to avoid Ansible conversions.
8991
* `partition_params`: Optional. Mapping of additional parameters and values for
9092
[partition configuration](https://slurm.schedmd.com/slurm.conf.html#SECTION_PARTITION-CONFIGURATION).
93+
**NB:** Parameters which can be set via the keys above must not be included here.
9194

9295
`openhpc_job_maxtime`: Maximum job time limit, default `'60-0'` (60 days). See [slurm.conf](https://slurm.schedmd.com/slurm.conf.html) parameter `MaxTime` for format. The default is 60 days. The value should be quoted to avoid Ansible conversions.
9396

0 commit comments

Comments
 (0)