Skip to content

Commit d72dd8f

Browse files
committed
doc: document resource.config in flux-config-resource(5)
Problem: The resource.config array is not documented. Add documentation of resource.config in flux-config-resource(5).
1 parent c2ad355 commit d72dd8f

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

doc/man5/flux-config-resource.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,36 @@ path
2424
passed from the enclosing Flux instance. The ``flux R`` utility may be
2525
used to generate this file.
2626

27+
config
28+
(optional) An array of resource config entries used as an alternative to
29+
a R object configured by ``resource.path``. Each array entry must contain
30+
a ``hosts`` key in RFC 29 Hostlist Format which configures the list of
31+
hosts to which the rest of the entry applies. The entry may also contain
32+
``cores`` and/or ``gpus`` keys which configure the set of core ids and
33+
GPU ids (in RFC 22 idset form) available on the targeted hosts, or a
34+
``properties`` key which is an array of property strings to assign to
35+
``hosts``. It is not an error to list a host multiple times, instead
36+
each entry updates ``hosts``. If the ``config`` array exists, then any
37+
``path`` is ignored.
38+
39+
Example::
40+
41+
[[resource.config]]
42+
hosts = "test[1-100]"
43+
cores = "0-7"
44+
45+
[[resource.config]]
46+
hosts = "test[1,2]"
47+
gpus = "0-1"
48+
49+
[[resource.config]]
50+
hosts = "test[1-89]"
51+
properties = ["batch"]
52+
53+
[[resource.config]]
54+
hosts = "test[90-100]"
55+
properties = ["debug"]
56+
2757
exclude
2858
(optional) A string value that defines one or more nodes to withhold
2959
from scheduling, either in RFC 22 idset form, or in RFC 29 hostlist form.

0 commit comments

Comments
 (0)