Skip to content

Commit 59ebcab

Browse files
grondogarlick
authored andcommitted
admin-guide: clarify queue property name requirements
Problem: There is a statement in the admin guide that it is good practice to use property names that match the corresponding queue name, but no reason for this practice is given. Explain that queue properties do not need to match the queue name, but note that it is good practice because it allows flux-resource list to suppress these duplicate names in is output.
1 parent 62fd5fd commit 59ebcab

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

doc/guide/admin.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -732,8 +732,12 @@ Adding Queues
732732

733733
It may be useful to configure a Flux system instance with multiple queues.
734734
Each queue should be associated with a non-overlapping resource subset,
735-
identified by property name. It is good practice for queues to create a
736-
new property that has the same name as the queue.
735+
identified by property name. It is good practice for queues to create a
736+
new property that has the same name as the queue. (There is no requirement
737+
that queue properties match the queue name, but this will cause extra entries
738+
in the PROPERTIES column for these queues. When queue names match property
739+
names, :command:`flux resource list` suppresses these matching properties
740+
in its output.)
737741

738742
When queues are defined, all jobs must specify a queue at submission time.
739743
If that is inconvenient, then ``policy.jobspec.defaults.system.queue`` may

0 commit comments

Comments
 (0)