Skip to content

doc: add man page for clear-usage command, update docs with related information #814

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.

Sign up for GitHub

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

Merged
mergify merged 4 commits into from
Feb 12, 2026
Merged

doc: add man page for clear-usage command, update docs with related information #814

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
50640c6
t: add permission check test for clear-usage
cmoussa1 Feb 11, 2026
2429431
doc: update add-bank(1), edit-bank(1)
cmoussa1 Feb 11, 2026
7094e50
doc: add man(1) page for flux-account-clear-usage
cmoussa1 Feb 11, 2026
5a870c4
doc: add section on resetting usage for a bank
cmoussa1 Feb 11, 2026
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
3 changes: 2 additions & 1 deletion doc/Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ MAN1_FILES_PRIMARY = \
man1/flux-account-show-usage.1 \
man1/flux-account-edit-all-users.1 \
man1/flux-account-export-json.1 \
man1/flux-account-view-usage-report.1
man1/flux-account-view-usage-report.1 \
man1/flux-account-clear-usage.1

RST_FILES = \
$(MAN1_FILES_PRIMARY:.1=.rst)
Expand Down
15 changes: 15 additions & 0 deletions doc/components/job-usage-calculation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,21 @@ that make up their historical job usage value:
moussa | 12345 | A | 100.0 | 243.5 | 8.7 | 0.0


Resetting the usage for a bank
==============================

The job usage value for a bank (and all of the users under that bank) can be
reset with the :man1:`flux-account-clear-usage` command. This will allow you to
quickly clear any amount of recently accrued usage, which, on a high-traffic
system, can ultimately bump up its users' fair-share values after the entire
hierarchy's job usage and fair-share values are updated.

An optional timestamp can also be specified when running this command to tell
flux-accounting to *only* consider jobs newer than said timestamp with the
``--ignore-older-than`` optional argument. By default, the ``clear-usage``
command will notify any future job usage updates to ignore jobs submitted under
that bank older than when the command was issued.

Calculating job usage arbitrarily
=================================

Expand Down
7 changes: 7 additions & 0 deletions doc/man1/flux-account-add-bank.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,13 @@ configured when adding the bank.

An associated priority to be applied to jobs submitted under this bank.

.. option:: --ignore-older-than
Copy link
Member

@wihobbs wihobbs Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. option:: --ignore-older-than
.. option:: --ignore-older-than=SECONDS|DATETIME


A timestamp to which older jobs will be ignored when calculating job
usage; accepts multiple formats: seconds since epoch timestamp or human
readable timestamp (e.g. ``01/01/2025``, ``2025-01-01 08:00:00``, ``Jan 1,
2025 8am``)

EXAMPLES
--------

Expand Down
26 changes: 26 additions & 0 deletions doc/man1/flux-account-clear-usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. flux-help-section: flux account

===========================
flux-account-clear-usage(1)
===========================


SYNOPSIS
========

**flux** **account** **clear-usage** [BANK BANK ...] [OPTIONS]

DESCRIPTION
===========

.. program:: flux account clear-usage

:program:`flux account clear-usage` will reset the usage for one or more banks
and all of the users under those banks back to 0.

.. option:: --ignore-older-than

A timestamp to which older jobs will be ignored when calculating job
usage; accepts multiple formats: seconds since epoch timestamp or human
readable timestamp (e.g. ``01/01/2025``, ``2025-01-01 08:00:00``, ``Jan 1,
2025 8am``)
7 changes: 7 additions & 0 deletions doc/man1/flux-account-edit-bank.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@ fields for a given bank. The list of modifiable fields are as follows:

An associated priority to be applied to jobs submitted under this bank.

.. option:: --ignore-older-than

A timestamp to which older jobs will be ignored when calculating job
usage; accepts multiple formats: seconds since epoch timestamp or human
readable timestamp (e.g. ``01/01/2025``, ``2025-01-01 08:00:00``, ``Jan 1,
2025 8am``)

EXAMPLES
--------

Expand Down
7 changes: 7 additions & 0 deletions doc/manpages.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,4 +251,11 @@
[author],
1,
),
(
"man1/flux-account-clear-usage",
"flux-account-clear-usage",
"reset the job usage for a bank back to 0",
[author],
1,
),
]
11 changes: 11 additions & 0 deletions t/t1026-flux-account-perms.t
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,17 @@ test_expect_success 'edit-factor should not be accessible by all users' '
)
'

test_expect_success 'clear-usage should not be accessible by all users' '
newid=$(($(id -u)+1)) &&
( export FLUX_HANDLE_ROLEMASK=0x2 &&
export FLUX_HANDLE_USERID=$newid &&
touch users.csv &&
touch banks.csv &&
test_must_fail flux account clear-usage my_bank > no_access_clear_usage.out 2>&1 &&
grep "Request requires owner credentials" no_access_clear_usage.out
)
'

test_expect_success 'remove flux-accounting DB' '
rm $(pwd)/FluxAccountingTest.db
'
Expand Down