Skip to content
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

Merged
merged 3 commits into from
Sep 3, 2021

Conversation

garlick
Copy link
Member

@garlick garlick commented Sep 3, 2021

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.

Copy link
Contributor

@grondo grondo left a 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
Copy link
Contributor

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

Copy link
Member Author

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: Netwrok

Copy link
Member Author

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Show example output?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will do.

@garlick garlick force-pushed the admin_0.29 branch 2 times, most recently from 08bfb54 to 4a0a8ac Compare September 3, 2021 18:13
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.
@garlick
Copy link
Member Author

garlick commented Sep 3, 2021

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing .. code-block:: here

Copy link
Member Author

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!

@grondo
Copy link
Contributor

grondo commented Sep 3, 2021

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.
@garlick garlick added the merge-when-passing mark PR for auto-merging by mergify.io bot label Sep 3, 2021
@mergify mergify bot merged commit 872e164 into flux-framework:master Sep 3, 2021
@garlick garlick deleted the admin_0.29 branch September 3, 2021 19:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge-when-passing mark PR for auto-merging by mergify.io bot
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants