Skip to content

Commit

Permalink
glossary: add expanded definition for 'fair-share'
Browse files Browse the repository at this point in the history
Problem: flux-accounting doesn't have a clear definition for fair-share
and its place in the priority plugin in terms of calculating a job's
priority.

Add 'fair-share' as a term in the Glossary section with an expanded
definition.

Make the "Glossary" section a referenceable one in the flux-accounting
guide so that when fair-share is mentioned in the Multi-Factor Priority
Plugin section, the expanded definition can be easily linked to.
  • Loading branch information
cmoussa1 committed Mar 1, 2024
1 parent 38837f2 commit c4f4e74
Showing 1 changed file with 13 additions and 1 deletion.
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

0 comments on commit c4f4e74

Please sign in to comment.