Skip to content

Commit

Permalink
accounting-guide: add service setup instructions
Browse files Browse the repository at this point in the history
Add instructions to the flux-accounting guide on installing and setting
up the flux-accounting service to be run alongside a Flux system
instance.
  • Loading branch information
cmoussa1 committed Mar 6, 2024
1 parent fd4bdbc commit 3079832
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion guides/accounting-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,27 @@ Installing Software Packages
============================

The ``flux-accounting`` package should be installed on the management node
from your Linux distribution package manager.
from your Linux distribution package manager. Once installed, the service
that accepts ``flux account`` commands and interacts with the flux-accounting
database can be started.

You can enable the service with ``systemctl``; if not configured with a custom
path, the flux-accounting systemd unit file will be installed to the same
location as flux-core's systemd unit file:

.. code-block:: console
$ sudo systemctl enable /path/to/flux-accounting.service
The service can then be controlled with ``systemd``. The service makes the
following assumptions:

1. A flux-accounting database has been created with ``flux account create-db``.
The service establishes a connection with the database in order to read from
and write to it.

2. An active Flux system instance is running. The flux-accounting service will
only run after the system instance is started.

Accounting Database Creation
============================
Expand Down

0 comments on commit 3079832

Please sign in to comment.