From 9a888ea7ee6a93145490711fa06357292fe09475 Mon Sep 17 00:00:00 2001 From: Jan Fajerski Date: Thu, 26 Apr 2018 12:01:59 +0200 Subject: [PATCH] doc/mgr/plugins: add note about distinction between config and kv store Signed-off-by: Jan Fajerski --- doc/mgr/plugins.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/mgr/plugins.rst b/doc/mgr/plugins.rst index eb41dee3088b..2dc3b56c023a 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: -- 2.47.3