Skip to content

Commit e993a54

Browse files
committed
tidy up README
1 parent f126bba commit e993a54

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,16 +83,17 @@ unique set of homogenous nodes:
8383
`openhpc_partitions`: Optional, default `[]`. List of mappings, each defining a
8484
partition. Each partition mapping may contain:
8585
* `name`: Required. Name of partition.
86-
* `groups`: Optional. List of nodegroup names. If omitted, the partition name
87-
is assumed to match a nodegroup name.
86+
* `groups`: Optional. List of node group names. If omitted, the node group
87+
with the same name as the partition is used.
8888
* `default`: Optional. A boolean flag for whether this partion is the default. Valid settings are `YES` and `NO`.
89-
* `maxtime`: Optional. A partition-specific time limit following the format of [slurm.conf](https://slurm.schedmd.com/slurm.conf.html) parameter `MaxTime`. The default value is
90-
given by `openhpc_job_maxtime`. The value should be quoted to avoid Ansible conversions.
89+
* `maxtime`: Optional. A partition-specific time limit overriding `openhpc_job_maxtime`.
9190
* `partition_params`: Optional. Mapping of additional parameters and values for
9291
[partition configuration](https://slurm.schedmd.com/slurm.conf.html#SECTION_PARTITION-CONFIGURATION).
9392
**NB:** Parameters which can be set via the keys above must not be included here.
9493

95-
`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.
94+
`openhpc_job_maxtime`: Maximum job time limit, default `'60-0'` (60 days), see
95+
[slurm.conf:MaxTime](https://slurm.schedmd.com/slurm.conf.html#OPT_MaxTime).
96+
**NB:** This should be quoted to avoid Ansible conversions.
9697

9798
`openhpc_cluster_name`: name of the cluster.
9899

0 commit comments

Comments
 (0)