search

flux-framework / flux-core

core services for the Flux resource management framework
GNU Lesser General Public License v3.0
168 stars 50 forks source link

docs: rfc flux-config-bootstrap diagram #6411

Closed vsoch closed 3 weeks ago

vsoch commented 3 weeks ago

I've been trying to make different topology designs this weekend, and this was the only example I could find of a slightly interesting tree in the flux config. I spent a ton of time confused not because the tree was complex, but because I mistook a comma for a dash (meaning I was reading test[1-128] instead of test[1,128], and didn't see it until I sat down with pen and paper to draw it out. To save others the time of also making this mistake, I'm adding a diagram to the docs here that explicitly shows the tree and describes some of the components in text.

Problem: It is really easy to miss the subtle comma (instead of a dash) for one of the bootstrap directives, resulting in a lot of confusion trying to figure out how the tree makes sense. Solution: Provide a visual diagram of the tree and some additional explanation to make it explicitly clear.

image

vsoch commented 3 weeks ago

Ooh, sorry that wasn't clear. Thanks for making it better for next intrepid explorer!

That's me, the eXplorasaurus! :t-rex: :mag_right:

garlick commented 3 weeks ago

I'll go ahead and set MWP on this one.

vsoch commented 3 weeks ago

Thanks!

codecov[bot] commented 3 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 83.62%. Comparing base (ff63621) to head (37154e1). Report is 2 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #6411 +/- ## ========================================== - Coverage 83.63% 83.62% -0.01% ========================================== Files 524 524 Lines 87617 87617 ========================================== - Hits 73281 73273 -8 - Misses 14336 14344 +8 ``` [see 10 files with indirect coverage changes](https://app.codecov.io/gh/flux-framework/flux-core/pull/6411/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=flux-framework)