From: John Spray <john.spray@redhat.com>
Date: Mon, 16 Apr 2018 21:29:42 +0000 (-0400)
Subject: doc: update mgr plugin guide
X-Git-Tag: v13.1.0~143^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=5414b738009727c7cbaf748d614976290a17b330;p=ceph.git

doc: update mgr plugin guide

...for recent config changes.  Explain about MgrModule.OPTIONS,
and explain the new store/config distinction.

Signed-off-by: John Spray <john.spray@redhat.com>
---

diff --git a/doc/mgr/plugins.rst b/doc/mgr/plugins.rst
index 0ac5ee1ba762..eb41dee3088b 100644
--- a/doc/mgr/plugins.rst
+++ b/doc/mgr/plugins.rst
@@ -62,25 +62,91 @@ Ceph mon and admin socket commands (see mon/MonCommands.h in
 the Ceph source for examples). Note that the "poll" field is optional,
 and is set to False by default.
 
-Config settings
----------------
+Configuration options
+---------------------
+
+Modules can load and store configuration options using the
+``set_config`` and ``get_config`` methods.
+
+You must declare your available configuration options in the
+``OPTIONS`` class attribute, like this:
+
+::
+
+    OPTIONS = [
+        {
+            "name": "my_option"
+        }
+    ]
+
+If you try to use set_config or get_config on options not declared
+in ``OPTIONS``, an exception will be raised.
+
+You may choose to provide setter commands in your module to perform
+high level validation.  Users can also modify configuration using
+the normal `ceph config set` command, where the configuration options
+for a mgr module are named like `mgr/<module name>/<option>`.
 
-Modules have access to a simple key/value store (keys and values are
-byte strings) for storing configuration.  Don't use this for
-storing large amounts of data.
+If a configuration option is different depending on which node
+the mgr is running on, then use *localized* configuration (
+``get_localized_config``, ``set_localized_config``).  This may be necessary
+for options such as what address to listen on.  Localized options may
+also be set externally with ``ceph config set``, where they key name
+is like ``mgr/<module name>/<mgr id>/<option>``
 
-Config values are stored using the mon's config-key commands.
+If you need to load and store data (e.g. something larger, binary, or multiline),
+use the KV store instead of configuration options (see next section).
 
-Hints for using these:
+Hints for using config options:
 
-* Reads are fast: ceph-mgr keeps a local in-memory copy
-* Don't set things by hand with "ceph config-key", the mgr doesn't update
-  at runtime (only set things from within modules).
-* Writes block until the value is persisted, but reads from another
-  thread will see the new value immediately.
+* Reads are fast: ceph-mgr keeps a local in-memory copy, so in many cases
+  you can just do a get_config every time you use a option, rather than
+  copying it out into a variable.
+* Writes block until the value is persisted (i.e. round trip to the monitor),
+  but reads from another thread will see the new value immediately.
+* If a user has used `config set` from the command line, then the new
+  value will become visible to `get_config` immediately, although the
+  mon->mgr update is asynchronous, so `config set` will return a fraction
+  of a second before the new value is visible on the mgr.
+
+.. py:currentmodule:: mgr_module
+.. automethod:: MgrModule.get_config
+.. automethod:: MgrModule.set_config
+.. automethod:: MgrModule.get_localized_config
+.. automethod:: MgrModule.set_localized_config
+
+KV store
+--------
+
+Modules have access to a private (per-module) key value store, which
+is implemented using the monitor's "config-key" commands.  Use
+the ``set_store`` and ``get_store`` methods to access the KV store from
+your module.
+
+The KV store commands work in a similar way to the configuration
+commands.  Reads are fast, operating from a local cache.  Writes block
+on persistence and do a round trip to the monitor.
+
+This data can be access from outside of ceph-mgr using the
+``ceph config-key [get|set]`` commands.  Key names follow the same
+conventions as configuration options.  Note that any values updated
+from outside of ceph-mgr will not be seen by running modules until
+the next restart.  Users should be discouraged from accessing module KV
+data externally -- if it is necessary for users to populate data, modules
+should provide special commands to set the data via the module.
+
+Use the ``get_store_prefix`` function to enumerate keys within
+a particular prefix (i.e. all keys starting with a particular substring).
+
+
+.. automethod:: MgrModule.get_store
+.. automethod:: MgrModule.set_store
+.. automethod:: MgrModule.set_store_json
+.. automethod:: MgrModule.get_store_json
+.. automethod:: MgrModule.get_localized_store
+.. automethod:: MgrModule.set_localized_store
+.. automethod:: MgrModule.get_store_prefix
 
-Any config settings you want to expose to users from your module will
-need corresponding hooks in ``COMMANDS`` to expose a setter.
 
 Accessing cluster data
 ----------------------
@@ -103,7 +169,6 @@ to cope with the possibility.
 Note that these accessors must not be called in the modules ``__init__``
 function. This will result in a circular locking exception.
 
-.. py:currentmodule:: mgr_module
 .. automethod:: MgrModule.get
 .. automethod:: MgrModule.get_server
 .. automethod:: MgrModule.list_servers