summaryrefslogtreecommitdiffstats
path: root/doc/mgr/index.rst
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/mgr/index.rst52
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/mgr/index.rst b/doc/mgr/index.rst
new file mode 100644
index 000000000..4d20d5098
--- /dev/null
+++ b/doc/mgr/index.rst
@@ -0,0 +1,52 @@
+.. _ceph-manager-daemon:
+
+===================
+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 cephadm, 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>
+ Ceph RESTful API <ceph_api/index>
+ Alerts module <alerts>
+ 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>
+ Insights module <insights>
+ Orchestrator module <orchestrator>
+ Rook module <rook>
+ RGW module <rgw>
+ MDS Autoscaler module <mds_autoscaler>
+ NFS module <nfs>
+ Progress Module <progress>
+ CLI API Commands module <cli_api>