]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/man/ceph-volume add docs for zap sub-command
authorAlfredo Deza <adeza@redhat.com>
Mon, 22 Jan 2018 17:06:25 +0000 (12:06 -0500)
committerAndrew Schoen <aschoen@redhat.com>
Fri, 2 Feb 2018 19:49:05 +0000 (13:49 -0600)
Signed-off-by: Alfredo Deza <adeza@redhat.com>
(cherry picked from commit ad73be2c2a6ee273d37b706626974d6900742256)

doc/man/8/ceph-volume.rst

index aea91251b12e97dea7a9b8c7a8a669925f879c30..3898a861f1b675aec17a960fc0a1e3eb1470c96e 100644 (file)
@@ -135,6 +135,26 @@ Positional arguments:
   ``/path/to/sda1`` for regular devices.
 
 
+**zap**
+Zaps the given logical volume or partition. 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.
+
+However, the lv or partition will be kept intact.
+
+Usage, for logical volumes::
+
+      ceph-volume lvm zap {vg/lv}
+
+Usage, for logical partitions::
+
+      ceph-volume lvm zap /dev/sdc1
+
+Positional arguments:
+
+* <DEVICE>  Either in the form of ``vg/lv`` for logical volumes or
+  ``/path/to/sda1`` for regular devices.
+
 Availability
 ============