mirror of
https://github.com/ceph/ceph
synced 2024-12-24 20:33:27 +00:00
c3149421bc
The documentation currently refers to Ceph Manager Modules as "plugins" in many places, while the command line interface uses "module" to enable/disable modules. Replaced all occurences of "plugin" with "module" in the docs, to avoid confusion and to be in alignment with the CLI. Also fixed the capitalizations of some module chapters. Fixes: https://tracker.ceph.com/issues/38481 Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
40 lines
730 B
ReStructuredText
40 lines
730 B
ReStructuredText
Hello World Module
|
|
==================
|
|
|
|
This is a simple module skeleton for documentation purposes.
|
|
|
|
Enabling
|
|
--------
|
|
|
|
The *hello* module is enabled with::
|
|
|
|
ceph mgr module enable hello
|
|
|
|
To check that it is enabled, run::
|
|
|
|
ceph mgr module ls
|
|
|
|
After editing the module file (found in ``src/pybind/mgr/hello/module.py``), you can see changes by running::
|
|
|
|
ceph mgr module disable hello
|
|
ceph mgr module enable hello
|
|
|
|
or::
|
|
|
|
init-ceph restart mgr
|
|
|
|
To execute the module, run::
|
|
|
|
ceph hello
|
|
|
|
The log is found at::
|
|
|
|
build/out/mgr.x.log
|
|
|
|
|
|
Documenting
|
|
-----------
|
|
|
|
After adding a new mgr module, be sure to add its documentation to ``doc/mgr/module_name.rst``.
|
|
Also, add a link to your new module into ``doc/mgr/index.rst``.
|