RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-01-20 01:51:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc/mgr/modules: should use Option class for defining options

Browse Source 
it is the encouraged way to define options nowadays.

Signed-off-by: Kefu Chai <kchai@redhat.com>
This commit is contained in:
Kefu Chai 2021-05-06 11:57:27 +08:00
parent dc7df7c67e
commit ed79c4f74a
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/mgr/modules.rst
View File

@ -24,7 +24,8 @@ The most important methods to override are:
* a ``notify`` member function if your module needs to
take action when new cluster data is available.
* a ``handle_command`` member function if your module
exposes CLI commands.
exposes CLI commands. But this approach for exposing commands
is deprecated. For more details, see :ref:`mgr-module-exposing-commands`.
Some modules interface with external orchestrators to deploy
Ceph services. These also inherit from ``Orchestrator``, which adds
@ -100,6 +101,7 @@ following commands::
.. _mgr-module-exposing-commands:
Exposing commands
-----------------
@ -207,12 +209,10 @@ Modules can load and store configuration options using the
You must declare your available configuration options in the
``MODULE_OPTIONS`` class attribute, like this:
::
.. code-block:: python
MODULE_OPTIONS = [
{
"name": "my_option"
}
Option(name="my_option")
]
If you try to use set_module_option or get_module_option on options not declared