blob: 725355fc97012fc881b9322c19918e8d672fed0c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
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``.
|
