ceph-bluestore-tool – bluestore administrative tool

Synopsis

ceph-bluestore-tool command [ –dev device … ] [ –path osd path ] [ –out-dir dir ] [ –log-file | -l filename ] [ –deep ]
ceph-bluestore-tool fsck|repair –path osd path [ –deep ]
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

Description

ceph-bluestore-tool is a utility to perform low-level administrative operations on a BlueStore instance.

Commands

help

show help

fsck

run consistency check on BlueStore metadata. If –deep is specified, also read all object data and verify checksums.

repair

Run a consistency check and repair any errors we can.

bluefs-export

Export the contents of BlueFS (i.e., rocksdb files) to an output directory.

bluefs-bdev-sizes --path *osd path*

Print the device sizes, as understood by BlueFS, to stdout.

bluefs-bdev-expand --path *osd path*

Instruct BlueFS to check the size of its block devices and, if they have expanded, make use of the additional space.

show-label --dev *device* [...]

Show device label(s).

Options

--dev *device*

Add device to the list of devices to consider

--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.

--out-dir *dir*

Output directory for bluefs-export

-l, --log-file *log file*

file to log to

--log-level *num*

debug log level. Default is 30 (extremely verbose), 20 is very verbose, 10 is verbose, and 1 is not very verbose.

--deep

deep scrub/repair (read and validate object data, not just metadata)

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:

ceph-bluestore-tool show-label --dev *device*

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 auxilliary devices (db and wal) will only have the minimum required fields (OSD UUID, size, device type, birth time).

OSD directory priming

You can generate the content for an OSD data directory that can start up a BlueStore OSD with the prime-osd-dir command:

ceph-bluestore-tool prime-osd-dir --dev *main device* --path /var/lib/ceph/osd/ceph-*id*

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.

See also

ceph-osd(8)