-
Notifications
You must be signed in to change notification settings - Fork 21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
admin guide: update for flux-core 0.29 #100
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! This should be very helpful.
Just a couple comments. The main one is that some of the content isn't showing up in the site preview (but I have no idea why)
Setting approval with the assumption we'll be able to figure that out.
adminguide.rst
Outdated
|
||
The possible status values are: | ||
|
||
.. list-table:: Subtree Status Values |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This table didn't show up in the readthedocs preview generated for the PR. See https://flux-framework--100.org.readthedocs.build/en/100/adminguide.html#overlay-netwrok
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I went ahead and replace the table with the kind of formatting we used for events in RFC 20. Hopeful that will work better.
adminguide.rst
Outdated
.. _overlay-network: | ||
|
||
^^^^^^^^^^^^^^^ | ||
Overlay Netwrok |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo: Netwrok
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pushing fix now
|
||
.. code-block:: console | ||
|
||
$ flux overlay status -vvv --ghost --pretty --color |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Show example output?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will do.
08bfb54
to
4a0a8ac
Compare
Problem: the admin guide says it refers to version 0.26, but we are now on 0.29. Update the current version to 0.29, carrying most of the text forward as is, except for the softening of some language about failure detection, and dropping config upgrade notes dating back to 0.22.
Ok pushed one last time with a couple of minor fixups to that first commit that I spotted on rereading. Should be ready - want to have another quick look? |
as a router to that node is actually the problem. The overlay parent | ||
of RANK may be listed with | ||
|
||
$ flux overlay parentof RANK |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing .. code-block::
here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops! Forced a push and will set MWP. Thanks!
Looks good. I just spotted one other formatting issue. Once that is resolved feel free to set MWP! |
Problem: the flux overlay command introduced in v0.29 will be of interest to sys admins, but is not represented. Add an Overlay Network subsection under the Troubleshooting section and cover the basics of the flux overlay command.
This updates some references to earlier flux-core versions to the one we are releasing today (0.29).
It also adds a little troubleshooting subsection for the overlay network that highlights the new
flux overlay
command.