ceph/doc/mgr/index.rst
Lenz Grimmer c3149421bc doc: Replaced "plugin" with "module" in the Mgr documentation
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>
2019-02-27 13:49:47 +01:00

49 lines
1.6 KiB
ReStructuredText

===================
Ceph Manager Daemon
===================
The :term:`Ceph Manager` daemon (ceph-mgr) runs alongside monitor daemons,
to provide additional monitoring and interfaces to external monitoring
and management systems.
Since the 12.x (*luminous*) Ceph release, the ceph-mgr daemon is required for
normal operations. The ceph-mgr daemon is an optional component in
the 11.x (*kraken*) Ceph release.
By default, the manager daemon requires no additional configuration, beyond
ensuring it is running. If there is no mgr daemon running, you will
see a health warning to that effect, and some of the other information
in the output of `ceph status` will be missing or stale until a mgr is started.
Use your normal deployment tools, such as ceph-ansible or ceph-deploy, to
set up ceph-mgr daemons on each of your mon nodes. It is not mandatory
to place mgr daemons on the same nodes as mons, but it is almost always
sensible.
.. toctree::
:maxdepth: 1
Installation and Configuration <administrator>
Writing modules <modules>
Writing orchestrator plugins <orchestrator_modules>
Dashboard module <dashboard>
DiskPrediction module <diskprediction>
Local pool module <localpool>
RESTful module <restful>
Zabbix module <zabbix>
Prometheus module <prometheus>
Influx module <influx>
Hello module <hello>
Telegraf module <telegraf>
Telemetry module <telemetry>
Iostat module <iostat>
Crash module <crash>
Orchestrator CLI module <orchestrator_cli>
Rook module <rook>
DeepSea module <deepsea>
Insights module <insights>
Ansible module <ansible>
SSH orchestrator <ssh>