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 1, 2022
1 parent daf8ca6 commit 17f2b60
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 1 deletion.
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 period of time (in RFC 23 Flux Standard Duration
format) that the KVS will regularly checkpoint a reference to its
primary namespace. The checkpoint is 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`

0 comments on commit 17f2b60

Please sign in to comment.