src/ceph/doc/man/8/ceph-bluestore-tool.rst

   1 :orphan:
   2
   3 ======================================================
   4  ceph-bluestore-tool -- bluestore administrative tool
   5 ======================================================
   6
   7 .. program:: ceph-bluestore-tool
   8
   9 Synopsis
  10 ========
  11
  12 | **ceph-bluestore-tool** *command*
  13   [ --dev *device* ... ]
  14   [ --path *osd path* ]
  15   [ --out-dir *dir* ]
  16   [ --log-file | -l *filename* ]
  17   [ --deep ]
  18 | **ceph-bluestore-tool** fsck|repair --path *osd path* [ --deep ]
  19 | **ceph-bluestore-tool** show-label --dev *device* ...
  20 | **ceph-bluestore-tool** prime-osd-dir --dev *device* --path *osd path*
  21 | **ceph-bluestore-tool** bluefs-export --path *osd path* --out-dir *dir*
  22 | **ceph-bluestore-tool** bluefs-export --path *osd path* --out-dir *dir*
  23
  24
  25 Description
  26 ===========
  27
  28 **ceph-bluestore-tool** is a utility to perform low-level administrative
  29 operations on a BlueStore instance.
  30
  31 Commands
  32 ========
  33
  34 .. option:: help
  35
  36    show help
  37
  38 .. option:: fsck
  39
  40    run consistency check on BlueStore metadata.  If *--deep* is specified, also read all object data and verify checksums.
  41
  42 .. option:: repair
  43
  44    Run a consistency check *and* repair any errors we can.
  45
  46 .. option:: bluefs-export
  47
  48    Export the contents of BlueFS (i.e., rocksdb files) to an output directory.
  49
  50 .. option:: bluefs-bdev-sizes --path *osd path*
  51
  52    Print the device sizes, as understood by BlueFS, to stdout.
  53
  54 .. option:: bluefs-bdev-expand --path *osd path*
  55
  56    Instruct BlueFS to check the size of its block devices and, if they have expanded, make use of the additional space.
  57
  58 .. option:: show-label --dev *device* [...]
  59
  60    Show device label(s).
  61
  62 Options
  63 =======
  64
  65 .. option:: --dev *device*
  66
  67    Add *device* to the list of devices to consider
  68
  69 .. option:: --path *osd path*
  70
  71    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.
  72
  73 .. option:: --out-dir *dir*
  74
  75    Output directory for bluefs-export
  76
  77 .. option:: -l, --log-file *log file*
  78
  79    file to log to
  80
  81 .. option:: --log-level *num*
  82
  83    debug log level.  Default is 30 (extremely verbose), 20 is very
  84    verbose, 10 is verbose, and 1 is not very verbose.
  85
  86 .. option:: --deep
  87
  88    deep scrub/repair (read and validate object data, not just metadata)
  89
  90 Device labels
  91 =============
  92
  93 Every BlueStore block device has a single block label at the beginning of the
  94 device.  You can dump the contents of the label with::
  95
  96   ceph-bluestore-tool show-label --dev *device*
  97
  98 The main device will have a lot of metadata, including information
  99 that used to be stored in small files in the OSD data directory.  The
 100 auxilliary devices (db and wal) will only have the minimum required
 101 fields (OSD UUID, size, device type, birth time).
 102
 103 OSD directory priming
 104 =====================
 105
 106 You can generate the content for an OSD data directory that can start up a
 107 BlueStore OSD with the *prime-osd-dir* command::
 108
 109   ceph-bluestore-tool prime-osd-dir --dev *main device* --path /var/lib/ceph/osd/ceph-*id*
 110
 111
 112 Availability
 113 ============
 114
 115 **ceph-bluestore-tool** is part of Ceph, a massively scalable,
 116 open-source, distributed storage system. Please refer to the Ceph
 117 documentation at http://ceph.com/docs for more information.
 118
 119
 120 See also
 121 ========
 122
 123 :doc:`ceph-osd <ceph-osd>`\(8)