-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
flux-config-kvs(5): add new man page
Problem: No documentation for the new [kvs] config options exists. Add man page.
- Loading branch information
Showing
2 changed files
with
48 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,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` |