Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
chu11 committed Aug 15, 2024
1 parent 59fda47 commit 10252d5
Show file tree
Hide file tree
Showing 2 changed files with 61 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 @@ -363,7 +363,8 @@ MAN5_FILES_PRIMARY = \
man5/flux-config-ingest.5 \
man5/flux-config-kvs.5 \
man5/flux-config-policy.5 \
man5/flux-config-queues.5
man5/flux-config-queues.5 \
man5/flux-config-content-sqlite.5


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


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

The Flux system may configure one of several possible content backends for
storing data to long term disk. The ``content-sqlite`` module is one
such backend, using ``sqlite`` for storage.

The ``content-sqlite`` table may contain the following keys:


KEYS
====

journal_mode
(optional) Configure the sqlite journal mode. By default is set to ``WAL``
if a flux statedir is configured, otherwise defaults to ``OFF``. Legal options
are ``DELETE``, ``TRUNCATE``, ``PERSIST``, ``MEMORY``, ``WAL``, and ``OFF``.

synchronous
(optional) Configure the sqlite synchronous mode. By default is set to ``NORMAL``
if a flux statedir is configured, otherwise defaults to ``OFF``. Legal options
are ``EXTRA``, ``FULL``, ``NORMAL``, ``OFF``.

perallocate
(optional)


EXAMPLES
========

::

[exec]
imp = "/usr/libexec/flux/flux-imp"
job-shell = "/usr/libexec/flux/flux-shell-special"


RESOURCES
=========

.. include:: common/resources.rst


FLUX RFC
========

:doc:`rfc:spec_15`


SEE ALSO
========

:man5:`flux-config`,
`systemd.resource-control(5) <https://www.freedesktop.org/software/systemd/man/systemd.resource-control.html>`_

0 comments on commit 10252d5

Please sign in to comment.