From: Andrew Schoen <aschoen@redhat.com>
Date: Tue, 24 Oct 2017 15:13:40 +0000 (-0500)
Subject: docs for ceph-volume lvm zap
X-Git-Tag: v13.0.1~367^2~1
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=3e93a31deda96ed6fb23fa19ce3e273de05f7d88;p=ceph-ci.git

docs for ceph-volume lvm zap

Signed-off-by: Andrew Schoen <aschoen@redhat.com>
---

diff --git a/doc/ceph-volume/index.rst b/doc/ceph-volume/index.rst
index 155acb649ab..b75ccd41b2e 100644
--- a/doc/ceph-volume/index.rst
+++ b/doc/ceph-volume/index.rst
@@ -30,3 +30,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
index 00000000000..8d42a9089d8
--- /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