From ae65f9d4c2bc4dfbc9cb03078b815d72ca5e7daf Mon Sep 17 00:00:00 2001
From: Mohamad Gebai <mgebai@suse.com>
Date: Wed, 16 May 2018 10:42:22 -0400
Subject: [PATCH] doc: add documentation for iostat

Conflicts:
        doc/releases/mimic.rst: remove file
        doc/mgr/index.rst: trivial resolution

Signed-off-by: Mohamad Gebai <mgebai@suse.com>
(cherry picked from commit 1e2bf1ec8c0dbe18b816ff9eb3243b73bb40d237)
---
 doc/mgr/index.rst  |  1 +
 doc/mgr/iostat.rst | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+)
 create mode 100644 doc/mgr/iostat.rst

diff --git a/doc/mgr/index.rst b/doc/mgr/index.rst
index a4f33fd867e48..d8440cb8e6a3d 100644
--- a/doc/mgr/index.rst
+++ b/doc/mgr/index.rst
@@ -37,3 +37,4 @@ sensible.
     Hello plugin <hello>
     Telemetry plugin <telemetry>
     Telegraf plugin <telegraf>
+    Iostat plugin <iostat>
diff --git a/doc/mgr/iostat.rst b/doc/mgr/iostat.rst
new file mode 100644
index 0000000000000..521c0bd7ace03
--- /dev/null
+++ b/doc/mgr/iostat.rst
@@ -0,0 +1,32 @@
+.. _mgr-iostat-overview:
+
+iostat
+======
+
+This plugin shows the current throughput and IOPS done on the Ceph cluster.
+
+Enabling
+--------
+
+To check if the *iostat* module is enabled, run::
+
+  ceph mgr module ls
+
+The module can be enabled with::
+
+  ceph mgr module enable iostat
+
+To execute the module, run::
+
+  ceph iostat
+
+To change the frequency at which the statistics are printed, use the ``-p``
+option::
+
+  ceph iostat -p <period in seconds>
+
+For example, use the following command to print the statistics every 5 seconds::
+
+  ceph iostat -p 5
+
+To stop the module, press Ctrl-C.
-- 
2.39.5