From c4f4e74db8b45c5e2d77f3731b50c80157d158c9 Mon Sep 17 00:00:00 2001 From: Christopher Moussa Date: Wed, 31 Jan 2024 11:40:08 -0800 Subject: [PATCH] glossary: add expanded definition for 'fair-share' 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. --- guides/accounting-guide.rst | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/guides/accounting-guide.rst b/guides/accounting-guide.rst index d9372f8..7fe7a8f 100644 --- a/guides/accounting-guide.rst +++ b/guides/accounting-guide.rst @@ -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 ` for a more + detailed explanation of how fair-share is utilized within flux-accounting. * **urgency**: a user-controlled factor to prioritize their own jobs. @@ -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 @@ -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::