Skip to content

Commit

Permalink
flux-config-kvs(5): add new man page
Browse files Browse the repository at this point in the history
Problem: No documentation for the new [kvs] config options
exists.

Add man page.
  • Loading branch information
chu11 committed Jul 4, 2022
1 parent 99afa2e commit 38cde07
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 2 deletions.
3 changes: 2 additions & 1 deletion doc/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,8 @@ MAN5_FILES_PRIMARY = \
man5/flux-config-resource.5 \
man5/flux-config-archive.5 \
man5/flux-config-job-manager.5 \
man5/flux-config-ingest.5
man5/flux-config-ingest.5 \
man5/flux-config-kvs.5


MAN7_FILES = $(MAN7_FILES_PRIMARY)
Expand Down
46 changes: 46 additions & 0 deletions doc/man5/flux-config-kvs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
==================
flux-config-kvs(5)
==================


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

The Flux system instance **kvs** service provides the primary key value
store (i.e. "the KVS") for a large number of Flux services. For
example, job eventlogs are stored in the KVS.

The ``kvs`` table may contain the following keys:


KEYS
====

sync
(optional) The maximum length of time a change to the primary KVS
will stay in memory before it is flushed and the reference is
checkpointed. This used to protect against data loss in the event
of a Flux broker crash.


EXAMPLE
=======

::

[kvs]
sync = "30m"


RESOURCES
=========

Flux: http://flux-framework.org

RFC 23: Flux Standard Duration: https://flux-framework.readthedocs.io/projects/flux-rfc/en/latest/spec_23.html


SEE ALSO
========

:man5:`flux-config`
2 changes: 1 addition & 1 deletion doc/man5/flux-config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,4 @@ SEE ALSO
:man1:`flux-broker`, :man5:`flux-config-access`, :man5:`flux-config-bootstrap`,
:man5:`flux-config-tbon`, :man5:`flux-config-exec`, :man5:`flux-config-ingest`,
:man5:`flux-config-resource`, :man5:`flux-config-archive`,
:man5:`flux-config-job-manager`
:man5:`flux-config-job-manager`, :man5:`flux-config-kvs`
1 change: 1 addition & 0 deletions doc/manpages.py
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,7 @@
('man5/flux-config-resource', 'flux-config-resource', 'configure Flux resource service', [author], 5),
('man5/flux-config-archive', 'flux-config-archive', 'configure Flux job archival service', [author], 5),
('man5/flux-config-job-manager', 'flux-config-job-manager', 'configure Flux job manager service', [author], 5),
('man5/flux-config-kvs', 'flux-config-kvs', 'configure Flux kvs service', [author], 5),
('man7/flux-broker-attributes', 'flux-broker-attributes', 'overview Flux broker attributes', [author], 7),
('man7/flux-jobtap-plugins', 'flux-jobtap-plugins', 'overview Flux jobtap plugin API', [author], 7),
]
1 change: 1 addition & 0 deletions doc/test/spell.en.pws
Original file line number Diff line number Diff line change
Expand Up @@ -629,3 +629,4 @@ tmpfiles
EDEADLOCK
setpgrp
nosetpgrp
checkpointed

0 comments on commit 38cde07

Please sign in to comment.