Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc/mgr/plugins: add note about distinction between config and kv store #21671

Merged
merged 1 commit into from
Apr 30, 2018
Merged

doc/mgr/plugins: add note about distinction between config and kv store #21671

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions doc/mgr/plugins.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down