]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/mgr/plugins: add note about distinction between config and kv store 21671/head
authorJan Fajerski <jfajerski@suse.com>
Thu, 26 Apr 2018 10:01:59 +0000 (12:01 +0200)
committerJan Fajerski <jfajerski@suse.com>
Thu, 26 Apr 2018 10:01:59 +0000 (12:01 +0200)
Signed-off-by: Jan Fajerski <jfajerski@suse.com>
doc/mgr/plugins.rst

index eb41dee3088b0a831e24704174b94c93a8bae633..2dc3b56c023abe29a6e143e975363b33ced777bb 100644 (file)
@@ -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: