flux-accounting guide: add setup instructions for new flux-accounting service #216
Conversation
|
I added a few notes to the flux-operator multi-tenant tutorial I think were helpful for accounting, namely:
And a note about database ownership / permissions if it's not there yet! The complete guide with the examples above starts here: https://flux-framework.org/flux-operator/getting_started/tutorials/multi-tenancy.html#view-logs maybe it would make sense to add a few of these points? At least I think I checked that guide when I was making this tutorial and I came to the slack to bother everyone still with questions 😆 |
cmoussa1
changed the title
|
@vsoch good suggestions! I think that would also be very helpful to add some of these pointers to the flux-accounting guide. I think adding these might be a little out of scope for this PR, but I'd be happy to open a separate issue and a near-future PR to add it. Does that sound okay? With that, now that flux-accounting |
|
Yep! |
cmoussa1
force-pushed
the
issue#215
branch
2 times, most recently
from
3079832 to
157e968
Compare
guides/accounting-guide.rst
Outdated
|
|
||
| .. code-block:: console | ||
|
|
||
| $ sudo systemctl enable /path/to/flux-accounting.service |
There was a problem hiding this comment.
The path should not be necessary here if the unit file is installed in the right place, which will be the case when installing from packages. sudo systemctl enable flux-accounting should be sufficient.
| 2. An active Flux system instance is running. The flux-accounting service will | ||
| only run after the system instance is started. |
There was a problem hiding this comment.
Rather than characterize these as assumptions, maybe "prerequisites"?
guides/accounting-guide.rst
Outdated
| @@ -11,7 +11,7 @@ Flux Accounting Guide | |||
| documented in this guide may change with regularity. | |||
|
|
|||
| This document is in DRAFT form and currently applies to flux-accounting | |||
| version 0.18.1. | |||
| version 0.30.0. | |||
There was a problem hiding this comment.
Needs to be bumped again.
Suggestion for later: move this document to the flux accounting project like we did with the admin guide and flux core. and stop mentioning the version in the guide, since it's then more obvious that the guide applies to the current version.
(Side benefit: if you set up readthedocs infrastructure in flux-accounting then man pages for the commands would be easy to add)
There was a problem hiding this comment.
This is a good suggestion, thanks! I'll open an issue to move this document to flux-accounting 👍
Problem: The version number mentioned in the flux-accounting guide is outdated. Update the version number in the flux-accounting guide.
Add instructions to the flux-accounting guide on installing and setting up the flux-accounting service to be run alongside a Flux system instance.
|
Thanks for the review @garlick! I just pushed up some fixes based on your suggestions and opened an issue in flux-accounting to go ahead and move this document in the near future. Since you approved already, I can set MWP here shortly :-) |
Background
flux-accounting has a new service that accepts
flux accountcommands that interact with the flux-accounting database and can be controlled withsystemd, but there are no setup instructions on how to get it going in the flux-accounting guide on our docs site.This PR adds a couple of small fixes along with a set of notes on installing and setting up the flux-accounting service in the flux-accounting guide. Since this new addition to documentation will be required as a result of the new flux-accounting release coming up in a few days, I will leave this is as [WIP] until the release has been finalized. Feel free to take a look at my changes proposed here in the meantime, though, in case there is any feedback. 👍
Fixes #215