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

glossary: add expanded definition for 'fair-share' #261

Merged
merged 1 commit into from
Mar 1, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion guides/accounting-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,8 @@ importance in the overall priority calculation. The current factors present in
the multi-factor priority plugin are:

* **fair-share**: the ratio between the amount of resources allocated vs. resources
consumed.
consumed. See the :ref:`Glossary definition <glossary-section>` for a more
detailed explanation of how fair-share is utilized within flux-accounting.

* **urgency**: a user-controlled factor to prioritize their own jobs.

Expand All @@ -311,6 +312,7 @@ 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.

.. _glossary-section:

********
Glossary
Expand All @@ -322,6 +324,16 @@ association
bank
An account that contains associations.

fair-share
A metric used to ensure equitable resource allocation among associations
within a shared system. It represents the ratio between the amount of
resources an association is allocated versus the amount actually consumed.
The fair-share value influences an association's priority when submitting
jobs to the system, adjusting dynamically to reflect current usage compared
to allocated quotas. High consumption relative to allocation can decrease an
association's fair-share value, reducing their priority for future resource
allocation, thereby promoting balanced usage across all associations to
maintain system fairness and efficiency.

.. note::

Expand Down
Loading