import quincy beta 17.1.0

[ceph.git] / ceph / doc / man / 8 / ceph-bluestore-tool.rst

diff --git a/ceph/doc/man/8/ceph-bluestore-tool.rst b/ceph/doc/man/8/ceph-bluestore-tool.rst
index bb67ccc71e7e02e7181c7dfca7eeb4d135d02a0e..f6c88da09b24c402c7ea216f4151483271a7225e 100644 (file)
--- a/ceph/doc/man/8/ceph-bluestore-tool.rst
+++ b/ceph/doc/man/8/ceph-bluestore-tool.rst
@@ -11,11 +11,15 @@ Synopsis
 
 | **ceph-bluestore-tool** *command*
   [ --dev *device* ... ]
+  [ -i *osd_id* ]
   [ --path *osd path* ]
   [ --out-dir *dir* ]
   [ --log-file | -l *filename* ]
   [ --deep ]
 | **ceph-bluestore-tool** fsck|repair --path *osd path* [ --deep ]
+| **ceph-bluestore-tool** qfsck       --path *osd path*
+| **ceph-bluestore-tool** allocmap    --path *osd path*
+| **ceph-bluestore-tool** restore_cfb --path *osd path*
 | **ceph-bluestore-tool** show-label --dev *device* ...
 | **ceph-bluestore-tool** prime-osd-dir --dev *device* --path *osd path*
 | **ceph-bluestore-tool** bluefs-export --path *osd path* --out-dir *dir*
@@ -48,6 +52,19 @@ Commands
 
    Run a consistency check *and* repair any errors we can.
 
+:command:`qfsck`
+
+   run consistency check on BlueStore metadata comparing allocator data (from RocksDB CFB when exists and if not uses allocation-file) with ONodes state.
+
+:command:`allocmap`
+
+   performs the same check done by qfsck and then stores a new allocation-file (command is disabled by default and requires a special build)
+
+:command:`restore_cfb`
+
+   Reverses changes done by the new NCB code (either through ceph restart or when running allocmap command) and restores RocksDB B Column-Family (allocator-map).
+
+
 :command:`bluefs-export`
 
    Export the contents of BlueFS (i.e., RocksDB files) to an output directory.
@@ -121,6 +138,11 @@ Options
 
    Add *device* to the list of devices to consider
 
+.. option:: -i *osd_id*
+
+   Operate as OSD *osd_id*. Connect to monitor for OSD specific options.
+   If monitor is unavailable, add --no-mon-config to read from ceph.conf instead.
+
 .. option:: --devs-source *device*
 
    Add *device* to the list of devices to consider as sources for migrate operation
@@ -131,7 +153,7 @@ Options
 
 .. option:: --path *osd path*
 
-   Specify an osd path.  In most cases, the device list is inferred from the symlinks present in *osd path*.  This is usually simpler than explicitly specifying the device(s) with --dev.
+   Specify an osd path.  In most cases, the device list is inferred from the symlinks present in *osd path*.  This is usually simpler than explicitly specifying the device(s) with --dev. Not necessary if -i *osd_id* is provided.
 
 .. option:: --out-dir *dir*
 
@@ -161,6 +183,12 @@ Options
    <iterator_refresh_bytes>/<iterator_refresh_keys>/<batch_commit_bytes>/<batch_commit_keys>
    Default: 10000000/10000/1000000/1000
 
+Additional ceph.conf options
+============================
+
+Any configuration option that is accepted by OSD can be also passed to **ceph-bluestore-tool**.
+Useful to provide necessary configuration options when access to monitor/ceph.conf is impossible and -i option cannot be used.
+
 Device labels
 =============
 
@@ -185,14 +213,14 @@ BlueStore OSD with the *prime-osd-dir* command::
 BlueFS log rescue
 =====================
 
-Some versions of BlueStore were susceptible to BlueFS log growing extremaly large -
+Some versions of BlueStore were susceptible to BlueFS log growing extremely large -
 beyond the point of making booting OSD impossible. This state is indicated by
 booting that takes very long and fails in _replay function.
 
 This can be fixed by::
   ceph-bluestore-tool fsck --path *osd path* --bluefs_replay_recovery=true
 
-It is advised to first check if rescue process would be successfull::
+It is advised to first check if rescue process would be successful::
   ceph-bluestore-tool fsck --path *osd path* \
   --bluefs_replay_recovery=true --bluefs_replay_recovery_disable_compact=true
 
@@ -203,7 +231,7 @@ Availability
 
 **ceph-bluestore-tool** is part of Ceph, a massively scalable,
 open-source, distributed storage system. Please refer to the Ceph
-documentation at http://ceph.com/docs for more information.
+documentation at https://docs.ceph.com for more information.
 
 
 See also