tools/ceph-bluestore-tool: Added zap-device documentation

- added zap documentation
- explained show-label lock exclusion

Signed-off-by: Adam Kupczyk <akupczyk@ibm.com>

diff --git a/doc/man/8/ceph-bluestore-tool.rst b/doc/man/8/ceph-bluestore-tool.rst
index fa25facedce0a58086d84513d76da83ee658cd98..7332df7a538174fcc783e1c9862ef718da5d2c8d 100644 (file)
--- a/doc/man/8/ceph-bluestore-tool.rst
+++ b/doc/man/8/ceph-bluestore-tool.rst
@@ -30,6 +30,7 @@ Synopsis
 | **ceph-bluestore-tool** reshard --path *osd path* --sharding *new sharding* [ --sharding-ctrl *control string* ]
 | **ceph-bluestore-tool** show-sharding --path *osd path*
 | **ceph-bluestore-tool** trim --path *osd path*
+| **ceph-bluestore-tool** zap-device --dev *dev path*
 
 
 Description
@@ -106,7 +107,8 @@ Commands
 
 :command:`show-label` --dev *device* [...]
 
-   Show device label(s).          
+   Show device label(s).
+   The label may be printed while an OSD is running.
 
 :command:`free-dump` --path *osd path* [ --allocator block/bluefs-wal/bluefs-db/bluefs-slow ]
 
@@ -139,6 +141,10 @@ Commands
    and allows the drive to perform more efficient internal housekeeping.
    If BlueStore runs with discard enabled, this option may not be useful.
 
+:command: `zap-device` --dev *dev path*
+
+   Zeros all device label locations. This effectively makes device appear empty.
+
 Options
 =======
 
@@ -200,8 +206,8 @@ Useful to provide necessary configuration options when access to monitor/ceph.co
 Device labels
 =============
 
-Every BlueStore block device has a single block label at the beginning of the
-device.  You can dump the contents of the label with::
+Every BlueStore block device has a block label at the beginning of the device.
+You can dump the contents of the label with::
 
   ceph-bluestore-tool show-label --dev *device*
 
@@ -209,6 +215,10 @@ The main device will have a lot of metadata, including information
 that used to be stored in small files in the OSD data directory.  The
 auxiliary devices (db and wal) will only have the minimum required
 fields (OSD UUID, size, device type, birth time).
+The main device contains additional label copies at offsets: 1G, 10G, 100G and 1000G.
+Corrupted labels are fixed as part of repair::
+
+  ceph-bluestore-tool repair --dev *device*
 
 OSD directory priming
 =====================