docs for ceph-volume lvm zap

Signed-off-by: Andrew Schoen <aschoen@redhat.com>
(cherry picked from commit 3e93a31deda96ed6fb23fa19ce3e273de05f7d88)

diff --git a/doc/ceph-volume/index.rst b/doc/ceph-volume/index.rst
index 7fab0c36ab4a2cad7faa57b0131b0da70b80f2e2..810f5e59b11edd8f9f64b08e264d89c024b07abe 100644 (file)
--- a/doc/ceph-volume/index.rst
+++ b/doc/ceph-volume/index.rst
@@ -29,3 +29,4 @@ technologies, including plain disks.
    lvm/scan
    lvm/systemd
    lvm/list
+   lvm/zap

diff --git a/doc/ceph-volume/lvm/zap.rst b/doc/ceph-volume/lvm/zap.rst
new file mode 100644 (file)
index 0000000..8d42a90
--- /dev/null
+++ b/doc/ceph-volume/lvm/zap.rst
@@ -0,0 +1,19 @@
+.. _ceph-volume-lvm-zap:
+
+``zap``
+=======
+
+This subcommand is used to zap lvs or partitions that have been used
+by ceph OSDs so that they may be reused. If given a path to a logical
+volume it must be in the format of vg/lv. Any filesystems present
+on the given lv or partition will be removed and all data will be purged.
+
+.. note:: The lv or partition will be kept intact.
+
+Zapping a logical volume::
+
+      ceph-volume lvm zap {vg name/lv name}
+
+Zapping a partition::
+
+      ceph-volume lvm zap /dev/sdc1