Skip to content

Commit 59043e1

Browse files
garlickmergify[bot]
authored andcommitted
flux-broker-attributes(7): describe mincrit topo
Problem: the attribute man page entry for tbon.topology does not include 'mincrit'. Add a mincrit description. Change the tbon.topology entry to present the schemes in a list form, since the paragraph form was getting unwieldy.
1 parent cd31287 commit 59043e1

File tree

2 files changed

+25
-6
lines changed

2 files changed

+25
-6
lines changed

doc/man7/flux-broker-attributes.rst

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -177,12 +177,30 @@ TREE BASED OVERLAY NETWORK
177177
==========================
178178

179179
tbon.topo [Updates: C]
180-
URI describing the TBON tree topology such as ``kary:16``. The ``kary``
181-
scheme selects a complete, k-ary tree with fanout *k*, with ``kary:0``
182-
meaning that rank 0 is the parent of all other ranks by convention. The
183-
``binomial`` scheme selects a binomial tree topology of the minimum order
184-
that fits the instance size. Default: ``kary:32``, unless bootstrapping by
185-
TOML configuration, then see :man5:`flux-config-bootstrap`.
180+
A URI describing the TBON tree topology. The following schemes are
181+
available:
182+
183+
kary:k
184+
A complete, k-ary tree with fanout *k*. By convention, ``kary:0``
185+
indicates that rank 0 is the parent of all other ranks.
186+
187+
mincrit[:k]
188+
Minimize critical ranks. The tree height is limited to three.
189+
If *k* is specified, it sets the number of router (interior) ranks,
190+
making the number of critical ranks *k* plus one. The fanout from
191+
routers to leaves is determined by the instance size. If *k* is
192+
unspecified, *k* is set to a value that avoids exceeding a fanout of
193+
1024 at any level. If that cannot be achieved in three levels,
194+
then rank 0 is overloaded.
195+
196+
binomial
197+
Binomial tree topology of the minimum order that fits the instance size.
198+
199+
custom
200+
The topology is set by TOML configuration.
201+
See :man5:`flux-config-bootstrap`.
202+
203+
The default value is ``kary:32``.
186204

187205
tbon.descendants
188206
Number of descendants "below" this node of the tree based

doc/test/spell.en.pws

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -969,3 +969,4 @@ YQ
969969
composable
970970
orchestrator
971971
fsck
972+
mincrit

0 commit comments

Comments
 (0)