From 307983270ca52c73a18092a18263f2f5dae71dba Mon Sep 17 00:00:00 2001 From: Christopher Moussa Date: Wed, 1 Mar 2023 09:10:18 -0800 Subject: [PATCH] accounting-guide: add service setup instructions Add instructions to the flux-accounting guide on installing and setting up the flux-accounting service to be run alongside a Flux system instance. --- guides/accounting-guide.rst | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/guides/accounting-guide.rst b/guides/accounting-guide.rst index 1bf2eef..9fc843a 100644 --- a/guides/accounting-guide.rst +++ b/guides/accounting-guide.rst @@ -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 ============================