1CEPH-BLUESTORE-TOOL(8) Ceph CEPH-BLUESTORE-TOOL(8)
2
3
4
6 ceph-bluestore-tool - bluestore administrative tool
7
9 ceph-bluestore-tool command
10 [ --dev device ... ]
11 [ --path osd path ]
12 [ --out-dir dir ]
13 [ --log-file | -l filename ]
14 [ --deep ]
15 ceph-bluestore-tool fsck|repair --path osd path [ --deep ]
16 ceph-bluestore-tool show-label --dev device ...
17 ceph-bluestore-tool prime-osd-dir --dev device --path osd path
18 ceph-bluestore-tool bluefs-export --path osd path --out-dir dir
19 ceph-bluestore-tool bluefs-bdev-new-wal --path osd path --dev-target new-device
20 ceph-bluestore-tool bluefs-bdev-new-db --path osd path --dev-target new-device
21 ceph-bluestore-tool bluefs-bdev-migrate --path osd path --dev-target new-device --devs-source device1 [--devs-source device2]
22
23
25 ceph-bluestore-tool is a utility to perform low-level administrative
26 operations on a BlueStore instance.
27
29 help
30 show help
31
32 fsck [ --deep ]
33 run consistency check on BlueStore metadata. If --deep is speci‐
34 fied, also read all object data and verify checksums.
35
36 repair
37 Run a consistency check and repair any errors we can.
38
39 bluefs-export
40 Export the contents of BlueFS (i.e., rocksdb files) to an output
41 directory.
42
43 bluefs-bdev-sizes --path osd path
44 Print the device sizes, as understood by BlueFS, to stdout.
45
46 bluefs-bdev-expand --path osd path
47 Instruct BlueFS to check the size of its block devices and, if they
48 have expanded, make use of the additional space.
49
50 bluefs-bdev-new-wal --path osd path --dev-target new-device
51 Adds WAL device to BlueFS, fails if WAL device already exists.
52
53 bluefs-bdev-new-db --path osd path --dev-target new-device
54 Adds DB device to BlueFS, fails if DB device already exists.
55
56 bluefs-bdev-migrate --dev-target new-device --devs-source device1
57 [--devs-source device2]
58 Moves BlueFS data from source device(s) to the target one, source
59 devices (except the main one) are removed on success. Target device
60 can be both already attached or new device. In the latter case it's
61 added to OSD replacing one of the source devices. Following replace‐
62 ment rules apply (in the order of precedence, stop on the first
63 match):
64
65 · if source list has DB volume - target device replaces it.
66
67 · if source list has WAL volume - target device replace it.
68
69 · if source list has slow volume only - operation isn't permit‐
70 ted, requires explicit allocation via new-db/new-wal command.
71
72 show-label --dev device [...]
73 Show device label(s).
74
76 --dev *device*
77 Add device to the list of devices to consider
78
79 --devs-source *device*
80 Add device to the list of devices to consider as sources for
81 migrate operation
82
83 --dev-target *device*
84 Specify target device migrate operation or device to add for
85 adding new DB/WAL.
86
87 --path *osd path*
88 Specify an osd path. In most cases, the device list is inferred
89 from the symlinks present in osd path. This is usually simpler
90 than explicitly specifying the device(s) with --dev.
91
92 --out-dir *dir*
93 Output directory for bluefs-export
94
95 -l, --log-file *log file*
96 file to log to
97
98 --log-level *num*
99 debug log level. Default is 30 (extremely verbose), 20 is very
100 verbose, 10 is verbose, and 1 is not very verbose.
101
102 --deep deep scrub/repair (read and validate object data, not just meta‐
103 data)
104
106 Every BlueStore block device has a single block label at the beginning
107 of the device. You can dump the contents of the label with:
108
109 ceph-bluestore-tool show-label --dev *device*
110
111 The main device will have a lot of metadata, including information that
112 used to be stored in small files in the OSD data directory. The auxil‐
113 iary devices (db and wal) will only have the minimum required fields
114 (OSD UUID, size, device type, birth time).
115
117 You can generate the content for an OSD data directory that can start
118 up a BlueStore OSD with the prime-osd-dir command:
119
120 ceph-bluestore-tool prime-osd-dir --dev *main device* --path /var/lib/ceph/osd/ceph-*id*
121
123 ceph-bluestore-tool is part of Ceph, a massively scalable, open-source,
124 distributed storage system. Please refer to the Ceph documentation at
125 http://ceph.com/docs for more information.
126
128 ceph-osd(8)
129
131 2010-2014, Inktank Storage, Inc. and contributors. Licensed under Cre‐
132 ative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)
133
134
135
136
137dev Apr 29, 2019 CEPH-BLUESTORE-TOOL(8)