repo: create a doc folder, add flux-accounting guide
#446
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cmoussa1
added
documentation
This was referenced May 9, 2024
jameshcorbett
approved these changes
May 9, 2024
doc/guide/accounting-guide.rst
Outdated
|
|
||
| Both "types" of jobs, *running* and *active*, are based on Flux's definitions | ||
| of job states_. *Active* jobs can be in any state but INACTIVE. *Running* jobs | ||
| are jobs in both RUN and CLEANUP states. |
There was a problem hiding this comment.
"in either RUN or CLEANUP states"?
There was a problem hiding this comment.
Good suggestion, thanks for catching this - I will fix!
Problem: flux-accounting has a guide, but it lives in another repo, which can be tedious to maintain. Add the flux-accounting guide to this repository in a newly-created doc/ folder.
Problem: The version number of flux-accounting is mentioned in the guide, but since this document now lives in the flux-accounting repo, it can now be implied that the guide applies to the current version. Drop the mention of the version number of flux-accounting from the guide.
Problem: The Accounting Guide does not detail instructions for the new job archival method in flux-accounting. Update the flux-accounting guide with the new instructions on setting up the new Python script that fetches inactive jobs and stores them in the flux-accounting DB to be used for job usage and fair share calculation. Update the code block that shows which commands to set up with flux-cron. Update the list of tables present in the flux-accounting database to account for the new "jobs" table.
|
Thanks for reviewing @jameshcorbett! Setting MWP here |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
flux-accounting has a guide in flux-docs, which can be tedious to maintain when things change here in this repo.
This PR adds the flux-accounting guide to this repository in a newly-created
doc/folder, following a similar format to flux-core. It also removes the flux-accounting version number from the guide.Lastly, I've added a commit to update the instructions on running commands to populate the flux-accounting DB with job records now that #357 has landed.