summaryrefslogtreecommitdiffstats
path: root/src/ceph/doc/man/8/ceph-bluestore-tool.rst
diff options
context:
space:
mode:
Diffstat (limited to 'src/ceph/doc/man/8/ceph-bluestore-tool.rst')
-rw-r--r--src/ceph/doc/man/8/ceph-bluestore-tool.rst123
1 files changed, 0 insertions, 123 deletions
diff --git a/src/ceph/doc/man/8/ceph-bluestore-tool.rst b/src/ceph/doc/man/8/ceph-bluestore-tool.rst
deleted file mode 100644
index 7a7b0ea..0000000
--- a/src/ceph/doc/man/8/ceph-bluestore-tool.rst
+++ /dev/null
@@ -1,123 +0,0 @@
-: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-dir --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 <ceph-osd>`\(8)