==================
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
====

checkpoint-period
   (optional) Sets a 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.

gc-threshold
   (optional) Sets the number of KVS commits (distinct root snapshots)
   after which offline garbage collection is performed by
   :man1:`flux-shutdown`. A value of 100000 may be a good starting
   point.

.. note::
   In a system instance, when brokers are started with systemd, garbage
   collection is automatic and a configured threshold has no effect.
   If ``gc-threshold`` is not configured in an instance started another way,
   it may be manually requested with :option:`flux-shutdown --gc`.


EXAMPLE
=======

::

   [kvs]
   checkpoint-period = "30m"
   gc-threshold = 100000

RESOURCES
=========

.. include:: common/resources.rst


FLUX RFC
========

:doc:`rfc:spec_23`


SEE ALSO
========

:man1:`flux-shutdown`,:man5:`flux-config`