RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2024-12-18 01:16:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #21671 from jan--f/mgr-module-config-doc

Browse Source 
doc/mgr/plugins: add note about distinction between config and kv store

Reviewed-by: John Spray <john.spray@redhat.com>
This commit is contained in:
John Spray 2018-04-30 12:42:18 +01:00 committed by GitHub
commit b869bfadd9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/mgr/plugins.rst
View 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: