From 7b91e50dbd289e65f10cb98c5eea9f3171c2d1f1 Mon Sep 17 00:00:00 2001 From: Sage Weil Date: Thu, 12 Oct 2017 11:40:11 -0500 Subject: [PATCH] doc/man/8/ceph-bluestore-tool: add man page Signed-off-by: Sage Weil --- ceph.spec.in | 1 + debian/ceph-osd.install | 1 + doc/man/8/CMakeLists.txt | 3 +- doc/man/8/ceph-bluestore-tool.rst | 123 ++++++++++++++++++++++++++++++ 4 files changed, 127 insertions(+), 1 deletion(-) create mode 100644 doc/man/8/ceph-bluestore-tool.rst diff --git a/ceph.spec.in b/ceph.spec.in index 1c146d18d7e3e..f08b28f6ce114 100644 --- a/ceph.spec.in +++ b/ceph.spec.in @@ -1414,6 +1414,7 @@ fi %{_udevrulesdir}/95-ceph-osd.rules %{_mandir}/man8/ceph-clsinfo.8* %{_mandir}/man8/ceph-osd.8* +%{_mandir}/man8/ceph-bluestore-tool.8* %if 0%{?rhel} && ! 0%{?centos} %attr(0755,-,-) %{_sysconfdir}/cron.hourly/subman %endif diff --git a/debian/ceph-osd.install b/debian/ceph-osd.install index 262082cfdfe96..0a386269f919a 100644 --- a/debian/ceph-osd.install +++ b/debian/ceph-osd.install @@ -19,3 +19,4 @@ usr/share/man/man8/ceph-disk.8 usr/share/man/man8/ceph-volume.8 usr/share/man/man8/ceph-volume-systemd.8 usr/share/man/man8/ceph-osd.8 +usr/share/man/man8/ceph-bluestore-tool.8 diff --git a/doc/man/8/CMakeLists.txt b/doc/man/8/CMakeLists.txt index c94fb3fc35f68..84e7640962083 100644 --- a/doc/man/8/CMakeLists.txt +++ b/doc/man/8/CMakeLists.txt @@ -27,7 +27,8 @@ set(osd_srcs ceph-volume.rst ceph-volume-systemd.rst ceph-osd.rst - osdmaptool.rst) + osdmaptool.rst + ceph-bluestore-tool.rst) set(mon_srcs ceph-mon.rst diff --git a/doc/man/8/ceph-bluestore-tool.rst b/doc/man/8/ceph-bluestore-tool.rst new file mode 100644 index 0000000000000..2f18c047c8a34 --- /dev/null +++ b/doc/man/8/ceph-bluestore-tool.rst @@ -0,0 +1,123 @@ +:orphan: + +====================================================== + ceph-bluestore-tool -- bluestore administrative tool +====================================================== + +.. program:: ceph-bluestore-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-dev --dev *device* --path *osd path* +| **ceph-bluestore-tool** bluefs-export --path *osd path* --out-dir *dir* +| **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 +======== + +.. option:: help + + show help + +.. option:: fsck + + run consistency check on BlueStore metadata. If *--deep* is specified, also read all object data and verify checksums. + +.. option:: repair + + Run a consistency check *and* repair any errors we can. + +.. option:: bluefs-export + + Export the contents of BlueFS (i.e., rocksdb files) to an output directory. + +.. option:: bluefs-bdev-sizes --path *osd path* + + Print the device sizes, as understood by BlueFS, to stdout. + +.. option:: 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. + +.. option:: show-label --dev *device* [...] + + Show device label(s). + +Options +======= + +.. option:: --dev *device* + + Add *device* to the list of devices to consider + +.. 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. + +.. option:: --out-dir *dir* + + Output directory for bluefs-export + +.. option:: -l, --log-file *log file* + + file to log to + +.. option:: --log-level *num* + + debug log level. Default is 30 (extremely verbose), 20 is very + verbose, 10 is verbose, and 1 is not very verbose. + +.. option:: --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 +======== + +:doc:`ceph-osd `\(8) -- 2.39.5