doc/mgr: add doc for crash mgr module

Signed-off-by: Dan Mick <dan.mick@redhat.com>

diff --git a/doc/mgr/crash.rst b/doc/mgr/crash.rst
new file mode 100644 (file)
index 0000000..5639f32
--- /dev/null
+++ b/doc/mgr/crash.rst
@@ -0,0 +1,60 @@
+Crash plugin
+============
+The crash plugin 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
+the monitors' storage.
+
+Enabling
+--------
+
+The *crash* module is enabled with::
+
+  ceph mgr module enable crash
+
+Commands
+--------
+::
+
+  ceph crash post -i <metafile>
+
+Save a crash dump.  The metadata file is a JSON blob stored in the crash
+dir as ``meta``.  As usual, the ceph command can be invoked with ``-i -``,
+and will read from stdin.
+
+::
+
+  ceph rm <crashid>
+
+Remove a specific crash dump.
+
+::
+
+  ceph crash ls
+
+List the timestamp/uuid crashids for all saved crash info.
+
+::
+
+  ceph crash stat
+
+Show a summary of saved crash info grouped by age.
+
+::
+
+  ceph crash info <crashid>
+
+Show all details of a saved crash.
+
+::
+
+   ceph crash prune <keep>
+
+Remove saved crashes older than 'keep' days.  <keep> must be an integer.
+
+

diff --git a/doc/mgr/index.rst b/doc/mgr/index.rst
index 28a1d8e97fbc35e556e10091980a8d1a62250d75..ea8c9d48ca1bf5db229100bc80ff9401cdc62862 100644 (file)
--- a/doc/mgr/index.rst
+++ b/doc/mgr/index.rst
@@ -38,3 +38,4 @@ sensible.
     Telegraf plugin <telegraf>
     Telemetry plugin <telemetry>
     Iostat plugin <iostat>
+    Crash plugin <crash>