Skip to content

Commit 6f88d30

Browse files
committed
doc: document resource.reserve config key
Problem: The `reserve` key in the `[resource]` table is not documented. Document it.
1 parent b0b89e2 commit 6f88d30

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

doc/man5/flux-config-resource.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,21 @@ rediscover
7979
(optional) If true, force rediscovery of resources using HWLOC, rather
8080
then using the R and HWLOC XML from the enclosing instance.
8181

82+
reserve
83+
(optional) A string value that defines cores to reserve for the OS
84+
and the broker ranks on which to reserve them. The argument is specified
85+
as::
86+
87+
cores[@ranks] [cores[@ranks]]...
88+
89+
where cores is an RFC 22 idset specifying the cores to reserve, and
90+
the optional ranks is an RFC 22 idset specifying the ranks on which to
91+
reserve them. If ``@ranks`` is not supplied, then cores will be reserved
92+
on all ranks. Multiple instances of ``cores[@ranks]`` may be specified
93+
(separated by whitespace) to reserve a different set of cores on different
94+
ranks. For example, ``0-3@0 0`` would reserve cores 0-3 on rank 0 and
95+
core 0 on all other ranks.
96+
8297
Note that updates to the resource table are ignored until the next Flux
8398
restart.
8499

0 commit comments

Comments
 (0)