From c3149421bcd7be7f31cda58a2c56b92f5834a66d Mon Sep 17 00:00:00 2001 From: Lenz Grimmer Date: Wed, 27 Feb 2019 13:49:47 +0100 Subject: [PATCH] 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 --- doc/mgr/crash.rst | 6 ++--- doc/mgr/diskprediction.rst | 20 ++++++++-------- doc/mgr/hello.rst | 8 +++---- doc/mgr/index.rst | 36 ++++++++++++++-------------- doc/mgr/influx.rst | 6 ++--- doc/mgr/insights.rst | 4 ++-- doc/mgr/iostat.rst | 2 +- doc/mgr/localpool.rst | 4 ++-- doc/mgr/{plugins.rst => modules.rst} | 8 +++---- doc/mgr/prometheus.rst | 4 ++-- doc/mgr/restful.rst | 4 ++-- doc/mgr/telegraf.rst | 6 ++--- doc/mgr/telemetry.rst | 4 ++-- doc/mgr/zabbix.rst | 13 +++++----- doc/start/intro.rst | 2 +- 15 files changed, 63 insertions(+), 64 deletions(-) rename doc/mgr/{plugins.rst => modules.rst} (98%) diff --git a/doc/mgr/crash.rst b/doc/mgr/crash.rst index 5639f32ebb2b9..8a988103022ea 100644 --- a/doc/mgr/crash.rst +++ b/doc/mgr/crash.rst @@ -1,13 +1,13 @@ -Crash plugin +Crash Module ============ -The crash plugin collects information about daemon crashdumps and stores +The crash module collects information about daemon crashdumps and stores it in the Ceph cluster for later analysis. Daemon crashdumps are dumped in /var/lib/ceph/crash by default; this can be configured with the option 'crash dir'. Crash directories are named by time and date and a randomly-generated UUID, and contain a metadata file 'meta' and a recent log file, with a "crash_id" that is the same. -This plugin allows the metadata about those dumps to be persisted in +This module allows the metadata about those dumps to be persisted in the monitors' storage. Enabling diff --git a/doc/mgr/diskprediction.rst b/doc/mgr/diskprediction.rst index e3af133144a65..779cda5d41e9e 100644 --- a/doc/mgr/diskprediction.rst +++ b/doc/mgr/diskprediction.rst @@ -1,10 +1,10 @@ ===================== -DISKPREDICTION PLUGIN +Diskprediction Module ===================== -The *diskprediction* plugin supports two modes: cloud mode and local mode. In cloud mode, the disk and Ceph operating status information is collected from Ceph cluster and sent to a cloud-based DiskPrediction server over the Internet. DiskPrediction server analyzes the data and provides the analytics and prediction results of performance and disk health states for Ceph clusters. +The *diskprediction* module supports two modes: cloud mode and local mode. In cloud mode, the disk and Ceph operating status information is collected from Ceph cluster and sent to a cloud-based DiskPrediction server over the Internet. DiskPrediction server analyzes the data and provides the analytics and prediction results of performance and disk health states for Ceph clusters. -Local mode doesn't require any external server for data analysis and output results. In local mode, the *diskprediction* plugin uses an internal predictor module for disk prediction service, and then returns the disk prediction result to the Ceph system. +Local mode doesn't require any external server for data analysis and output results. In local mode, the *diskprediction* module uses an internal predictor module for disk prediction service, and then returns the disk prediction result to the Ceph system. | Local predictor: 70% accuracy | Cloud predictor for free: 95% accuracy @@ -39,7 +39,7 @@ The connection settings are used for connection between Ceph and DiskPrediction Local Mode ---------- -The *diskprediction* plugin leverages Ceph device health check to collect disk health metrics and uses internal predictor module to produce the disk failure prediction and returns back to Ceph. Thus, no connection settings are required in local mode. The local predictor module requires at least six datasets of device health metrics to implement the prediction. +The *diskprediction* module leverages Ceph device health check to collect disk health metrics and uses internal predictor module to produce the disk failure prediction and returns back to Ceph. Thus, no connection settings are required in local mode. The local predictor module requires at least six datasets of device health metrics to implement the prediction. Run the following command to use local predictor predict device life expectancy. @@ -86,7 +86,7 @@ Additional optional configuration settings are the following: Diskprediction Data =================== -The *diskprediction* plugin actively sends/retrieves the following data to/from DiskPrediction server. +The *diskprediction* module actively sends/retrieves the following data to/from DiskPrediction server. Metrics Data @@ -268,14 +268,14 @@ Osd: +----------------------+-----------------------------------------+ - Ceph each objects correlation information -- The plugin agent information -- The plugin agent cluster information -- The plugin agent host information +- The module agent information +- The module agent cluster information +- The module agent host information SMART Data ----------- -- Ceph physical device SMART data (provided by Ceph *devicehealth* plugin) +- Ceph physical device SMART data (provided by Ceph *devicehealth* module) Prediction Data @@ -348,6 +348,6 @@ use the following command. debug mgr = 20 -With logging set to debug for the manager the plugin will print out logging +With logging set to debug for the manager the module will print out logging message with prefix *mgr[diskprediction]* for easy filtering. diff --git a/doc/mgr/hello.rst b/doc/mgr/hello.rst index 2c55b66cf29a0..725355fc97012 100644 --- a/doc/mgr/hello.rst +++ b/doc/mgr/hello.rst @@ -1,5 +1,5 @@ -hello world -=========== +Hello World Module +================== This is a simple module skeleton for documentation purposes. @@ -35,5 +35,5 @@ The log is found at:: Documenting ----------- -After adding a new mgr module/plugin, be sure to add its documentation to ``doc/mgr/plugin_name.rst``. -Also, add a link to your new plugin into ``doc/mgr/index.rst``. +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``. diff --git a/doc/mgr/index.rst b/doc/mgr/index.rst index 3e913eff15253..ff2d5b9c97152 100644 --- a/doc/mgr/index.rst +++ b/doc/mgr/index.rst @@ -26,23 +26,23 @@ sensible. :maxdepth: 1 Installation and Configuration - Writing plugins + Writing modules Writing orchestrator plugins - Dashboard plugin - DiskPrediction plugin - Local pool plugin - RESTful plugin - Zabbix plugin - Prometheus plugin - Influx plugin - Hello plugin - Telegraf plugin - Telemetry plugin - Iostat plugin - Crash plugin - Orchestrator CLI plugin - Rook plugin - DeepSea plugin - Insights plugin - Ansible plugin + Dashboard module + DiskPrediction module + Local pool module + RESTful module + Zabbix module + Prometheus module + Influx module + Hello module + Telegraf module + Telemetry module + Iostat module + Crash module + Orchestrator CLI module + Rook module + DeepSea module + Insights module + Ansible module SSH orchestrator diff --git a/doc/mgr/influx.rst b/doc/mgr/influx.rst index 62c643b885d5a..eab9494a96f0b 100644 --- a/doc/mgr/influx.rst +++ b/doc/mgr/influx.rst @@ -1,11 +1,11 @@ ============= -Influx Plugin +Influx Module ============= -The influx plugin continuously collects and sends time series data to an +The influx module continuously collects and sends time series data to an influxdb database. -The influx plugin was introduced in the 13.x *Mimic* release. +The influx module was introduced in the 13.x *Mimic* release. -------- Enabling diff --git a/doc/mgr/insights.rst b/doc/mgr/insights.rst index b66de3de4e6fc..37b8903f165a1 100644 --- a/doc/mgr/insights.rst +++ b/doc/mgr/insights.rst @@ -1,7 +1,7 @@ -Insights plugin +Insights Module =============== -The insights plugin collects and exposes system information to the Insights Core +The insights module collects and exposes system information to the Insights Core data analysis framework. It is intended to replace explicit interrogation of Ceph CLIs and daemon admin sockets, reducing the API surface that Insights depends on. The insights reports contains the following: diff --git a/doc/mgr/iostat.rst b/doc/mgr/iostat.rst index 521c0bd7ace03..f9f8493831bca 100644 --- a/doc/mgr/iostat.rst +++ b/doc/mgr/iostat.rst @@ -3,7 +3,7 @@ iostat ====== -This plugin shows the current throughput and IOPS done on the Ceph cluster. +This module shows the current throughput and IOPS done on the Ceph cluster. Enabling -------- diff --git a/doc/mgr/localpool.rst b/doc/mgr/localpool.rst index b31ed6049fc9a..4948dc756043b 100644 --- a/doc/mgr/localpool.rst +++ b/doc/mgr/localpool.rst @@ -1,7 +1,7 @@ -Local pool plugin +Local Pool Module ================= -The *localpool* plugin can automatically create RADOS pools that are +The *localpool* module can automatically create RADOS pools that are localized to a subset of the overall cluster. For example, by default, it will create a pool for each distinct rack in the cluster. This can be useful for some deployments that want to distribute some data locally as well as globally across the cluster . diff --git a/doc/mgr/plugins.rst b/doc/mgr/modules.rst similarity index 98% rename from doc/mgr/plugins.rst rename to doc/mgr/modules.rst index c3c2c8c587070..662565c0f2a30 100644 --- a/doc/mgr/plugins.rst +++ b/doc/mgr/modules.rst @@ -10,7 +10,7 @@ ceph-mgr module developer's guide This is developer documentation, describing Ceph internals that are only relevant to people writing ceph-mgr modules. -Creating a plugin +Creating a module ----------------- In pybind/mgr/, create a python module. Within your module, create a class @@ -32,7 +32,7 @@ additional methods to the base ``MgrModule`` class. See :ref:`Orchestrator modules ` for more on creating these modules. -Installing a plugin +Installing a module ------------------- Once your module is present in the location set by the @@ -59,7 +59,7 @@ severities 20, 4, 1 and 0 respectively. Exposing commands ----------------- -Set the ``COMMANDS`` class attribute of your plugin to a list of dicts +Set the ``COMMANDS`` class attribute of your module to a list of dicts like this:: COMMANDS = [ @@ -197,7 +197,7 @@ an SQL database. There are no consistency rules about access to cluster structures or daemon metadata. For example, an OSD might exist in OSDMap but have no metadata, or vice versa. On a healthy cluster these -will be very rare transient states, but plugins should be written +will be very rare transient states, but modules should be written to cope with the possibility. Note that these accessors must not be called in the modules ``__init__`` diff --git a/doc/mgr/prometheus.rst b/doc/mgr/prometheus.rst index 49551f5098283..54b1f53f34455 100644 --- a/doc/mgr/prometheus.rst +++ b/doc/mgr/prometheus.rst @@ -1,12 +1,12 @@ ================= -Prometheus plugin +Prometheus Module ================= Provides a Prometheus exporter to pass on Ceph performance counters from the collection point in ceph-mgr. Ceph-mgr receives MMgrReport messages from all MgrClient processes (mons and OSDs, for instance) with performance counter schema data and actual counter data, and keeps -a circular buffer of the last N samples. This plugin creates an HTTP +a circular buffer of the last N samples. This module creates an HTTP endpoint (like all Prometheus exporters) and retrieves the latest sample of every counter when polled (or "scraped" in Prometheus terminology). The HTTP path and query parameters are ignored; all extant counters diff --git a/doc/mgr/restful.rst b/doc/mgr/restful.rst index 51f59c40f8b9e..271e37bbf4cf3 100644 --- a/doc/mgr/restful.rst +++ b/doc/mgr/restful.rst @@ -1,7 +1,7 @@ -restful plugin +Restful Module ============== -RESTful plugin offers the REST API access to the status of the cluster +RESTful module offers the REST API access to the status of the cluster over an SSL-secured connection. Enabling diff --git a/doc/mgr/telegraf.rst b/doc/mgr/telegraf.rst index 309cff4a3d541..5944f7255cd63 100644 --- a/doc/mgr/telegraf.rst +++ b/doc/mgr/telegraf.rst @@ -1,7 +1,7 @@ =============== -Telegraf Plugin +Telegraf Module =============== -The Telegraf plugin collects and sends statistics series to a Telegraf agent. +The Telegraf module collects and sends statistics series to a Telegraf agent. The Telegraf agent can buffer, aggregate, parse and process the data before sending it to an output which can be InfluxDB, ElasticSearch and many more. @@ -10,7 +10,7 @@ Currently the only way to send statistics to Telegraf from this module is to use the socket listener. The module can send statistics over UDP, TCP or a UNIX socket. -The Telegraf plugin was introduced in the 13.x *Mimic* release. +The Telegraf module was introduced in the 13.x *Mimic* release. -------- Enabling diff --git a/doc/mgr/telemetry.rst b/doc/mgr/telemetry.rst index 8bb194bd7dcee..668e70fc7c296 100644 --- a/doc/mgr/telemetry.rst +++ b/doc/mgr/telemetry.rst @@ -1,6 +1,6 @@ -Telemetry plugin +Telemetry Module ================ -The telemetry plugin sends anonymous data about the cluster, in which it is running, back to the Ceph project. +The telemetry module sends anonymous data about the cluster, in which it is running, back to the Ceph project. The data being sent back to the project does not contain any sensitive data like pool names, object names, object contents or hostnames. diff --git a/doc/mgr/zabbix.rst b/doc/mgr/zabbix.rst index c4fc32a144a69..2f899b22eeb04 100644 --- a/doc/mgr/zabbix.rst +++ b/doc/mgr/zabbix.rst @@ -1,7 +1,7 @@ -Zabbix plugin +Zabbix Module ============= -The Zabbix plugin actively sends information to a Zabbix server like: +The Zabbix module actively sends information to a Zabbix server like: - Ceph status - I/O operations @@ -12,7 +12,7 @@ The Zabbix plugin actively sends information to a Zabbix server like: Requirements ------------ -The plugin requires that the *zabbix_sender* executable is present on *all* +The module requires that the *zabbix_sender* executable is present on *all* machines running ceph-mgr. It can be installed on most distributions using the package manager. @@ -96,7 +96,7 @@ The current configuration of the module can also be shown: Template ^^^^^^^^ A `template `_. -(XML) to be used on the Zabbix server can be found in the source directory of the plugin. +(XML) to be used on the Zabbix server can be found in the source directory of the module. This template contains all items and a few triggers. You can customize the triggers afterwards to fit your needs. @@ -124,6 +124,5 @@ ceph-mgr and check the logs. [mgr] debug mgr = 20 -With logging set to debug for the manager the plugin will print various logging -lines prefixed with *mgr[zabbix]* for easy filtering. - +With logging set to debug for the manager the module will print various logging +lines prefixed with *mgr[zabbix]* for easy filtering. \ No newline at end of file diff --git a/doc/start/intro.rst b/doc/start/intro.rst index c6ad03e727780..69f1bb99f5aa4 100644 --- a/doc/start/intro.rst +++ b/doc/start/intro.rst @@ -27,7 +27,7 @@ required when running Ceph Filesystem clients. responsible for keeping track of runtime metrics and the current state of the Ceph cluster, including storage utilization, current performance metrics, and system load. The Ceph Manager daemons also - host python-based plugins to manage and expose Ceph cluster + host python-based modules to manage and expose Ceph cluster information, including a web-based :ref:`mgr-dashboard` and `REST API`_. At least two managers are normally required for high availability. -- 2.39.5