Add diskprophet plugin user guide.

doc/mgr/diskprophet.rst

@@ -0,0 +1,76 @@
+DiskProphet plugin
+=============
+
+The DiskProphet plugin actively sends information to a DiskProphet server like:
+
+- Ceph status
+- I/O operations
+- I/O bandwidth
+- OSD status
+- OSD physical disk smart data
+- Storage utilization
+
+Enabling
+--------
+You can enable the *diskprophet* module with:
+
+::
+
+    ceph mgr module enable diskprophet
+
+Configuration
+-------------
+
+Below configuration keys are vital for the module to work:
+
+- diskprophet_server
+- diskprophet_user
+- diskprophet_password
+
+The parameter *diskprophet_server* controls the hostname of the DiskProphet
+server to which the plugin will send the items. This can be a IP-Address if
+ required by your installation.
+
+The parameter *diskprophet_user* and *diskprophet_password* controls the user
+ of the DiskProphet that can fetch each physical disk predicted health state. 
+
+Configuration keys
+^^^^^^^^^^^^^^^^^^^
+
+Configuration keys can be set on any machine with the proper cephx credentials,
+these are usually Monitors where the *client.admin* key is present.
+
+::
+
+    ceph diskprophet config-set <diskprophet_server> <diskprophet_user> <diskprophet_password>
+
+The current configuration of the module can also be shown:
+
+::
+
+   ceph diskprophet config-show
+
+Fetch physical disk of the osd predicted health status
+------------------------------------------------------
+
+User can use command to fetch each physical disk of the osd predicted health status.
+
+::
+
+    ceph diskprophet diskprophet get-predicted-status <osd id>
+
+
+Debugging
+---------
+
+Should you want to debug the Zabbix module increase the logging level for
+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[diskprophet]* for easy filtering.
+