CEPH-BLUESTORE-TOOL(8) - Linux man page online | Administration and privileged commands

Bluestore administrative tool.

May 19, 2020


ceph-bluestore-tool - bluestore administrative tool


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 ceph-bluestore-tool free-dump|free-score --path osd path [ --allocator block/bluefs-wal/bluef ↲ s-db/bluefs-slow ]


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


help show help fsck [ --deep ] 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). free-dump --path osd path [ --allocator block/bluefs-wal/bluefs-db/bluefs-slow ] Dump all free regions in allocator. free-score --path osd path [ --allocator block/bluefs-wal/bluefs-db/bluefs-slow ] Give a [0-1] number that represents quality of fragmentation in allocator. 0 repre‐ sents case when all free space is in one chunk. 1 represents worst possible fragmenta‐ tion.


--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 ver‐ bose, and 1 is not very verbose. --deep deep scrub/repair (read and validate object data, not just metadata) --allocator *name* Useful for free-dump and free-score actions. Selects allocator(s).


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


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*


ceph-bluestore-tool is part of Ceph, a massively scalable, open-source, distributed stor‐ age system. Please refer to the Ceph documentation at for more infor‐ mation.


2010-2020, Inktank Storage, Inc. and contributors. Licensed under Creative Commons Attri‐ bution Share Alike 3.0 (CC-BY-SA-3.0)
dev May 19, 2020 CEPH-BLUESTORE-TOOL(8)
This manual Reference Other manuals
ceph-bluestore-tool(8) referred by
refer to ceph-osd(8)
Download raw manual
Index Ceph (+35) dev (+35) № 8 (+5755)
Go top