From: Jan Fajerski Date: Thu, 26 Apr 2018 10:01:59 +0000 (+0200) Subject: doc/mgr/plugins: add note about distinction between config and kv store X-Git-Tag: v13.1.0~48^2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F21671%2Fhead;p=ceph.git doc/mgr/plugins: add note about distinction between config and kv store Signed-off-by: Jan Fajerski --- diff --git a/doc/mgr/plugins.rst b/doc/mgr/plugins.rst index eb41dee3088..2dc3b56c023 100644 --- a/doc/mgr/plugins.rst +++ b/doc/mgr/plugins.rst @@ -68,6 +68,11 @@ Configuration options Modules can load and store configuration options using the ``set_config`` and ``get_config`` methods. +.. note:: Use ``set_config`` and ``get_config`` to manage user-visible + configuration options that are not blobs (like certificates). If you want to + persist module-internal data or binary configuration data consider using + the `KV store`_. + You must declare your available configuration options in the ``OPTIONS`` class attribute, like this: