NAME

       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
       ceph-bluestore-tool bluefs-bdev-new-wal --path osd path --dev-target new-device
       ceph-bluestore-tool bluefs-bdev-new-db --path osd path --dev-target new-device
       ceph-bluestore-tool bluefs-bdev-migrate --path osd path --dev-target new-device --devs-source device1 [--devs-source device2]
       ceph-bluestore-tool free-dump|free-score --path osd path [ --allocator block/bluefs-wal/bluefs-db/bluefs-slow ]

DESCRIPTION

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

COMMANDS

       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.  Please  note  that  only  the new files created by BlueFS will be allocated on the
          preferred block device if it has enough free space, and the existing files that have spilled  over  to
          the  slow device will be gradually removed when RocksDB performs compaction.  In other words, if there
          is any data spilled over to the slow device, it will be moved to the fast device over time.

       bluefs-bdev-new-wal --path osd path --dev-target new-device
          Adds WAL device to BlueFS, fails if WAL device already exists.

       bluefs-bdev-new-db --path osd path --dev-target new-device
          Adds DB device to BlueFS, fails if DB device already exists.

       bluefs-bdev-migrate --dev-target new-device --devs-source device1 [--devs-source device2]
          Moves BlueFS data from source device(s) to the target one, source devices (except the  main  one)  are
          removed  on success. Target device can be both already attached or new device. In the latter case it's
          added to OSD replacing one of the source devices. Following replacement rules apply (in the  order  of
          precedence, stop on the first match):

              • if source list has DB volume - target device replaces it.

              • if source list has WAL volume - target device replace it.

              • if  source  list  has slow volume only - operation isn't permitted, requires explicit allocation
                via new-db/new-wal command.

       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 represents case when all
          free space is in one chunk. 1 represents worst possible fragmentation.

OPTIONS

       --dev *device*
              Add device to the list of devices to consider

       --devs-source *device*
              Add device to the list of devices to consider as sources for migrate operation

       --dev-target *device*
              Specify target device migrate operation or device to add for adding new DB/WAL.

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

       --allocator *name*
              Useful for free-dump and free-score actions. Selects allocator(s).

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 auxiliary 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*

BLUEFS LOG RESCUE

       Some  versions  of BlueStore were susceptible to BlueFS log growing extremaly large - beyond the point of
       making booting OSD impossible. This state is indicated by booting that  takes  very  long  and  fails  in
       _replay function.

       This can be fixed by::
              ceph-bluestore-tool fsck --path osd path --bluefs_replay_recovery=true

       It is advised to first check if rescue process would be successfull::
              ceph-bluestore-tool       fsck       --path       osd      path      --bluefs_replay_recovery=true
              --bluefs_replay_recovery_disable_compact=true

       If above fsck is successfull fix procedure can be applied.

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)

COPYRIGHT

       2010-2024,  Inktank  Storage,  Inc.  and  contributors. Licensed under Creative Commons Attribution Share
       Alike 3.0 (CC-BY-SA-3.0)

dev                                               Jan 11, 2024                            CEPH-BLUESTORE-TOOL(8)