-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: add man pages for bank commands
Problem: There are no manual pages for the bank commands in flux-accounting. Add man pages for add-bank, view-bank, delete-bank, and edit-bank.
- Loading branch information
Showing
8 changed files
with
236 additions
and
1 deletion.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
.. flux-help-section: flux account | ||
======================== | ||
flux-account-add-bank(1) | ||
======================== | ||
|
||
|
||
SYNOPSIS | ||
======== | ||
|
||
**flux** **account** **add-bank** BANK SHARES [--parent-bank=PARENT-BANK] | ||
|
||
DESCRIPTION | ||
=========== | ||
|
||
.. program:: flux account add-bank | ||
|
||
:program:`flux account add-bank` will add a new bank to the ``bank_table`` in | ||
the flux-accounting database. If the bank being added is not the root bank, its | ||
parent must be specified when added. Shares allocated to the bank can also be | ||
configured when adding the bank. | ||
|
||
.. option:: --parent-bank | ||
|
||
The name of the parent bank. | ||
|
||
EXAMPLES | ||
-------- | ||
|
||
A parent bank does not need to be specified when adding the root bank: | ||
|
||
.. code-block:: console | ||
$ flux account add-bank root 1 | ||
All others, however, require a parent bank: | ||
|
||
.. code-block:: console | ||
$ flux account add-bank bankA 1 --parent-bank=root |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
.. flux-help-section: flux account | ||
=========================== | ||
flux-account-delete-bank(1) | ||
=========================== | ||
|
||
|
||
SYNOPSIS | ||
======== | ||
|
||
**flux** **account** **delete-bank** BANK | ||
|
||
DESCRIPTION | ||
=========== | ||
|
||
.. program:: flux account delete-bank | ||
|
||
:program:`flux account delete-bank` will set a bank's ``active`` field to ``0`` | ||
in the ``bank_table``. Banks can be reactivated by simply re-adding them to the | ||
``bank_table`` with ``flux account add-bank``. | ||
|
||
EXAMPLES | ||
-------- | ||
|
||
A bank can be deactivated by calling ``delete-bank``: | ||
|
||
.. code-block:: console | ||
$ flux account delete-bank bankA |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
.. flux-help-section: flux account | ||
========================= | ||
flux-account-edit-bank(1) | ||
========================= | ||
|
||
|
||
SYNOPSIS | ||
======== | ||
|
||
**flux** **account** **edit-bank** BANK [OPTIONS] | ||
|
||
DESCRIPTION | ||
=========== | ||
|
||
.. program:: flux account edit-bank | ||
|
||
:program:`flux account edit-bank` allows for the modifications of certain | ||
fields for a given bank. The list of modifiable fields are as follows: | ||
|
||
.. option:: --parent-bank | ||
|
||
The name of the parent bank. | ||
|
||
.. option:: --shares | ||
|
||
The amount of available resources their organization considers the bank | ||
should be entitled to use relative to other competing banks. | ||
|
||
EXAMPLES | ||
-------- | ||
|
||
.. code-block:: console | ||
$ flux account edit-bank bankA --shares=100 |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
.. flux-help-section: flux account | ||
========================== | ||
flux-account-list-banks(1) | ||
========================== | ||
|
||
|
||
SYNOPSIS | ||
======== | ||
|
||
**flux** **account** **list-banks** | ||
|
||
DESCRIPTION | ||
=========== | ||
|
||
.. program:: flux account list-banks | ||
|
||
:program:`flux account list-banks` will list all of the banks in the | ||
``bank_table``. By default, it will include every column in the ``bank_table``, | ||
but the output can be customized by specifying which columns to include. | ||
|
||
.. option:: --inactive | ||
|
||
Include inactive banks in the output. | ||
|
||
.. option:: --fields | ||
|
||
A list of columns from the table to include in the output. By default, all | ||
columns are included. | ||
|
||
.. option:: --table | ||
|
||
Output data in table format. By default, the format of any returned data is | ||
in JSON. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
.. flux-help-section: flux account | ||
========================= | ||
flux-account-view-bank(1) | ||
========================= | ||
|
||
|
||
SYNOPSIS | ||
======== | ||
|
||
**flux** **account** **view-bank** BANK [OPTIONS] | ||
|
||
DESCRIPTION | ||
=========== | ||
|
||
.. program:: flux account view-bank | ||
|
||
:program:`flux account view-bank` returns all of the various attributes for | ||
the bank specified. Options can be passed in to view all users that belong to | ||
this bank or view the bank in relation to other banks in the flux-accounting | ||
database hierarchy. | ||
|
||
.. option:: --tree | ||
|
||
View the flux-accounting database hierarchy in a tree format where BANK is | ||
the root of the tree. | ||
|
||
.. option:: --parsable | ||
|
||
Similar to ``--tree``, view the flux-accounting database hierarchy in a | ||
tree format where BANK is the root of the tree, delimited by a pipe (``|``) | ||
character. | ||
|
||
.. option:: --users | ||
|
||
List every user that belongs to BANK, along with their basic accounting | ||
information. |
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
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