rbd

title: rbd(8)

summary: manage rados block device (RBD) images

text:
# rbd(8)

## NAME
rbd - manage rados block device (RBD) images

## SYNOPSIS

```
rbd [ -c ceph.conf ] [ -m monaddr ] [--cluster cluster-name]
[ -p | --pool pool ] [ command ... ]
```

## DESCRIPTION
rbd is a utility for manipulating rados block device (RBD) images, used by the Linux rbd driver and the rbd storage driver for QEMU/KVM. RBD images are simple block devices that are striped over objects and stored in a RADOS object store. The size of the objects the image is striped over must be a power of two.

## OPTIONS
-c ceph.conf, --conf ceph.conf

Use ceph.conf configuration file instead of the default /etc/ceph/ceph.conf to determine monitor addresses during startup.

-m monaddress[:port]

Connect to specified monitor (instead of looking through ceph.conf).

--cluster cluster-name

Use different cluster name as compared to default cluster name ceph.

-p pool-name, --pool pool-name

Interact with the given pool. Required by most commands.

--namespace namespace-name

Use a pre-defined image namespace within a pool

--no-progress

Do not output progress information (goes to standard error by default for some commands).

## PARAMETERS
--image-format format-id

Specifies which object layout to use. The default is 2.

- format 1 - (deprecated) Use the original format for a new rbd image. This format is understood by all versions of librbd and the kernel rbd module, but does not support newer features like cloning.

- format 2 - Use the second rbd format, which is supported by librbd since the Bobtail release and the kernel rbd module since kernel 3.10 (except for "fancy" striping, which is supported since kernel 4.17). This adds support for cloning and is more easily extensible to allow more features in the future.

-s size-in-M/G/T, --size size-in-M/G/T

Specifies the size of the new rbd image or the new size of the existing rbd image in M/G/T. If no suffix is given, unit M is assumed.

--object-size size-in-B/K/M

Specifies the object size in B/K/M. Object size will be rounded up the nearest power of two; if no suffix is given, unit B is assumed. The default object size is 4M, smallest is 4K and maximum is 32M. The default value can be changed with the configuration option rbd_default_order, which takes a power of two (default object size is 2 ^ rbd_default_order).

--stripe-unit size-in-B/K/M

Specifies the stripe unit size in B/K/M. If no suffix is given, unit B is assumed. See striping section (below) for more details.

--stripe-count num

Specifies the number of objects to stripe over before looping back to the first object. See striping section (below) for more details.

--snap snap

Specifies the snapshot name for the specific operation.

--id username

Specifies the username (without the client. prefix) to use with the map command.

--keyring filename

Specifies a keyring file containing a secret for the specified user to use with the map command. If not specified, the default keyring locations will be searched.

--keyfile filename

Specifies a file containing the secret key of --id user to use with the map command. This option is overridden by --keyring if the latter is also specified.

--shared lock-tag

Option for lock add that allows multiple clients to lock the same image if they use the same tag. The tag is an arbitrary string. This is useful for situations where an image must be open from more than one client at once, like during live migration of a virtual machine, or for use underneath a clustered file system.

--format format

Specifies output formatting (default: plain, json, xml)

--pretty-format

Make json or xml formatted output more human-readable.

-o krbd-options, --options krbd-options

Specifies which options to use when mapping or unmapping an image via the rbd kernel driver. krbd-options is a comma-separated list of options (similar to mount(8) mount options). See kernel rbd (krbd) options section below for more details.

--read-only

Map the image read-only. Equivalent to -o ro.

--image-feature feature-name

Specifies which RBD format 2 feature should be enabled when creating an image. Multiple features can be enabled by repeating this option multiple times. The following features are supported:

- layering: layering support

- striping: striping v2 support

- exclusive-lock: exclusive locking support

- object-map: object map support (requires exclusive-lock)

- fast-diff: fast diff calculations (requires object-map)

- deep-flatten: snapshot flatten support

- journaling: journaled IO support (requires exclusive-lock)

- data-pool: erasure coded pool support

--image-shared

Specifies that the image will be used concurrently by multiple clients. This will disable features that are dependent upon exclusive ownership of the image.

--whole-object

Specifies that the diff should be limited to the extents of a full object instead of showing intra-object deltas. When the object map feature is enabled on an image, limiting the diff to the object extents will dramatically improve performance since the differences can be computed by examining the in-memory object map instead of querying RADOS for each object within the image.

--limit

Specifies the limit for the number of snapshots permitted.

## COMMANDS
bench --io-type <read | write | readwrite | rw> [--io-size size-in-B/K/M/G/T] [--io-threads num-ios-in-flight] [--io-total size-in-B/K/M/G/T] [--io-pattern seq | rand] [--rw-mix-read read proportion in readwrite] image-spec

Generate a series of IOs to the image and measure the IO throughput and latency. If no suffix is given, unit B is assumed for both --io-size and --io-total. Defaults are: --io-size 4096, --io-threads 16, --io-total 1G, --io-pattern seq, --rw-mix-read 50.

children snap-spec

List the clones of the image at the given snapshot. This checks every pool, and outputs the resulting poolname/imagename. This requires image format 2.

clone [--object-size size-in-B/K/M] [--stripe-unit size-in-B/K/M --stripe-count num] [--image-feature feature-name] [--image-shared] parent-snap-spec child-image-spec

Will create a clone (copy-on-write child) of the parent snapshot. Object size will be identical to that of the parent image unless specified. Size will be the same as the parent snapshot. The --stripe-unit and --stripe-count arguments are optional, but must be used together. The parent snapshot must be protected (see rbd snap protect). This requires image format 2.

config global get config-entity key

Get a global-level configuration override.

config global list [--format plain | json | xml] [--pretty-format] config-entity

List global-level configuration overrides.

config global set config-entity key value

Set a global-level configuration override.

config global remove config-entity key

Remove a global-level configuration override.

config image get image-spec key

Get an image-level configuration override.

config image list [--format plain | json | xml] [--pretty-format] image-spec

List image-level configuration overrides.

config image set image-spec key value

Set an image-level configuration override.

config image remove image-spec key

Remove an image-level configuration override.

config pool get pool-name key

Get a pool-level configuration override.

config pool list [--format plain | json | xml] [--pretty-format] pool-name

List pool-level configuration overrides.

config pool set pool-name key value

Set a pool-level configuration override.

config pool remove pool-name key

Remove a pool-level configuration override.

cp (src-image-spec | src-snap-spec) dest-image-spec

Copy the content of a src-image into the newly created dest-image. dest-image will have the same size, object size, and image format as src-image. Note: snapshots are not copied, use deep cp command to include snapshots.

create (-s | --size size-in-M/G/T) [--image-format format-id] [--object-size size-in-B/K/M] [--stripe-unit size-in-B/K/M --stripe-count num] [--thick-provision] [--no-progress] [--image-feature feature-name]... [--image-shared] image-spec

Will create a new rbd image. You must also specify the size via --size. The --stripe-unit and --stripe-count arguments are optional, but must be used together. If the --thick-provision is enabled, it will fully allocate storage for the image at creation time. It will take a long time to do. Note: thick provisioning requires zeroing the contents of the entire image.

deep cp (src-image-spec | src-snap-spec) dest-image-spec

Deep copy the content of a src-image into the newly created dest-image. Dest-image will have the same size, object size, image format, and snapshots as src-image.

device list [-t | --device-type device-type] [--format plain | json | xml] --pretty-format

Show the rbd images that are mapped via the rbd kernel module (default) or other supported device.

device map [-t | --device-type device-type] [--cookie device-cookie] [--show-cookie] [--snap-id snap-id] [--read-only] [--exclusive] [-o | --options device-options] image-spec | snap-spec

Map the specified image to a block device via the rbd kernel module (default) or other supported device (nbd or ubbd on Linux or ggate on FreeBSD). The --options argument is a comma separated list of device type specific options (opt1,opt2=val,...).

device unmap [-t | --device-type device-type] [-o | --options device-options] [--snap-id snap-id] image-spec | snap-spec | device-path

Unmap the block device that was mapped via the rbd kernel module (default) or other supported device. The --options argument is a comma separated list of device type specific options (opt1,opt2=val,...).

device attach [-t | --device-type device-type] --device device-path [--cookie device-cookie] [--show-cookie] [--snap-id snap-id] [--read-only] [--exclusive] [--force] [-o | --options device-options] image-spec | snap-spec

Attach the specified image to the specified block device (currently only nbd on Linux). This operation is unsafe and should not be normally used. In particular, specifying the wrong image or the wrong block device may lead to data corruption as no validation is performed by nbd kernel driver. The --options argument is a comma separated list of device type specific options (opt1,opt2=val,...).

device detach [-t | --device-type device-type] [-o | --options device-options] [--snap-id snap-id] image-spec | snap-spec | device-path

Detach the block device that was mapped or attached (currently only nbd on Linux). This operation is unsafe and should not be normally used. The --options argument is a comma separated list of device type specific options (opt1,opt2=val,...).

diff [--from-snap snap-name] [--whole-object] image-spec | snap-spec

Dump a list of byte extents in the image that have changed since the specified start snapshot, or since the image was created. Each output line includes the starting offset (in bytes), the length of the region (in bytes), and either 'zero' or 'data' to indicate whether the region is known to be zeros or may contain other data.

du [-p | --pool pool-name] [image-spec | snap-spec] [--merge-snapshots]

Will calculate the provisioned and actual disk usage of all images and associated snapshots within the specified pool. It can also be used against individual images and snapshots. If the RBD fast-diff feature is not enabled on images, this operation will require querying the OSDs for every potential object within the image.

The --merge-snapshots will merge snapshots used space into their parent images.

encryption format image-spec format passphrase-file [--cipher-alg alg]

Formats image to an encrypted format. All data previously written to the image will become unreadable. Supported formats: luks1, luks2. Supported cipher algorithms: aes-128, aes-256 (default).

export [--export-format format (1 or 2)] (image-spec | snap-spec) [dest-path]

Export image to dest path (use - for stdout). The --export-format accepts '1' or '2' currently. Format 2 allow us to export not only the content of image, but also the snapshots and other properties, such as image_order, features.

export-diff [--from-snap snap-name] [--whole-object] (image-spec | snap-spec) dest-path

Export an incremental diff for an image to dest path (use - for stdout). If an initial snapshot is specified, only changes since that snapshot are included; otherwise, any regions of the image that contain data are included. The end snapshot is specified using the standard --snap option or @snap syntax (see below). The image diff format includes metadata about image size changes, and the start and end snapshots. It efficiently represents discarded or 'zero' regions of the image.

feature disable image-spec feature-name...

Disable the specified feature on the specified image. Multiple features can be specified.

feature enable image-spec feature-name...

Enable the specified feature on the specified image. Multiple features can be specified.

flatten [--encryption-format encryption-format --encryption-passphrase-file passphrase-file]... image-spec

If the image is a clone, copy all shared blocks from the parent snapshot and make the child independent of the parent, severing the link between parent snap and child. The parent snapshot can be unprotected and deleted if it has no further dependent clones. This requires image format 2.

group create group-spec

Create a group.

group image add group-spec image-spec

Add an image to a group.

group image list group-spec

List images in a group.

group image remove group-spec image-spec

Remove an image from a group.

group ls [-p | --pool pool-name]

List rbd groups.

group rename src-group-spec dest-group-spec

Rename a group. Note: rename across pools is not supported.

group rm group-spec

Delete a group.

group snap create group-snap-spec

Make a snapshot of a group.

group snap list group-spec

List snapshots of a group.

group snap rm group-snap-spec

Remove a snapshot from a group.

group snap rename group-snap-spec snap-name

Rename group's snapshot.

group snap rollback group-snap-spec

Rollback group to snapshot.

image-meta get image-spec key

Get metadata value with the key.

image-meta list image-spec

Show metadata held on the image. The first column is the key and the second column is the value.

image-meta remove image-spec key

Remove metadata key with the value.

image-meta set image-spec key value

Set metadata key with the value. They will displayed in image-meta list.

import [--export-format format (1 or 2)] [--image-format format-id] [--object-size size-in-B/K/M] [--stripe-unit size-in-B/K/M --stripe-count num] [--image-feature feature-name]... [--image-shared] src-path [image-spec]

Create a new image and import its data from path (use - for stdin). The import operation will try to create sparse rbd images if possible. For import from stdin, the sparsification unit is the data block size of the destination image (object size). The --stripe-unit and --stripe-count arguments are optional, but must be used together.

The --export-format accepts '1' or '2' currently. Format 2 allow us to import not only the content of image, but also the snapshots and other properties, such as image_order, features.

import-diff src-path image-spec

Import an incremental diff of an image and apply it to the current image. If the diff was generated relative to a start snapshot, we verify that snapshot already exists before continuing. If there was an end snapshot we verify it does not already exist before applying the changes, and create the snapshot when we are done.

info image-spec | snap-spec

Will dump information (such as size and object size) about a specific rbd image. If the image is a clone, information about its parent is also displayed. If a snapshot is specified, whether it is protected is shown as well.

journal client disconnect journal-spec

Flag image journal client as disconnected.

journal export [--verbose] [--no-error] src-journal-spec path-name

Export image journal to path (use - for stdout). It can be make a backup of the image journal especially before attempting dangerous operations. Note that this command may not always work if the journal is badly corrupted.

journal import [--verbose] [--no-error] path-name dest-journal-spec

Import image journal from path (use - for stdin).

journal info journal-spec

Show information about image journal.

journal inspect [--verbose] journal-spec

Inspect and report image journal for structural errors.

journal reset journal-spec

Reset image journal.

journal status journal-spec

Show status of image journal.

lock add [--shared lock-tag] image-spec lock-id

Lock an image. The lock-id is an arbitrary name for the user's convenience. By default, this is an exclusive lock, meaning it will fail if the image is already locked. The --shared option changes this behavior. Note that locking does not affect any operation other than adding a lock. It does not protect an image from being deleted.

lock ls image-spec

Show locks held on the image. The first column is the locker to use with the lock remove command.

lock rm image-spec lock-id locker

Release a lock on an image. The lock id and locker are as output by lock ls.

ls [-l | --long] [pool-name]

Will list all rbd images listed in the rbd_directory object. With -l, also show snapshots, and use longer-format output including size, parent (if clone), format, etc.

merge-diff first-diff-path second-diff-path merged-diff-path

Merge two continuous incremental diffs of an image into one single diff. The first diff's end snapshot must be equal with the second diff's start snapshot. The first diff could be - for stdin, and merged diff could be - for stdout, which enables multiple diff files to be merged using something like 'rbd merge-diff first second - | rbd merge-diff - third result'. Note this command currently only support the source incremental diff with stripe-count == 1

migration abort image-spec

Cancel image migration. This step may be run after successful or failed migration prepare or migration execute steps and returns the image to its initial (before migration) state. All modifications to the destination image are lost.

migration commit image-spec

Commit image migration. This step is run after successful migration prepare and migration execute steps and removes the source image data.

migration execute image-spec

Execute image migration. This step is run after a successful migration prepare step and copies image data to the destination.

migration prepare [--order order] [--object-size object-size] [--image-feature image-feature] [--image-shared] [--stripe-unit stripe-unit] [--stripe-count stripe-count] [--data-pool data-pool] [--import-only] [--source-spec json] [--source-spec-path path] src-image-spec [dest-image-spec]

Prepare image migration. This is the first step when migrating an image, i.e. changing the image location, format or other parameters that can't be changed dynamically. The destination can match the source, and in this case dest-image-spec can be omitted. After this step the source image is set as a parent of the destination image, and the image is accessible in copy-on-write mode by its destination spec. An image can also be migrated from a read-only import source by adding the --import-only optional and providing a JSON-encoded --source-spec or a path to a JSON-encoded source-spec file using the --source-spec-path optionals.

mirror image demote image-spec

Demote a primary image to non-primary for RBD mirroring.

mirror image disable [--force] image-spec

Disable RBD mirroring for an image. If the mirroring is configured in image mode for the image's pool, then it must be disabled for each image individually.

mirror image enable image-spec mode

Enable RBD mirroring for an image. If the mirroring is configured in image mode for the image's pool, then it must be enabled for each image individually. The mirror image mode can either be journal (default) or snapshot. The journal mode requires the RBD journaling feature.

mirror image promote [--force] image-spec

Promote a non-primary image to primary for RBD mirroring.

mirror image resync image-spec

Force resync to primary image for RBD mirroring.

mirror image status image-spec

Show RBD mirroring status for an image.

mirror pool demote [pool-name]

Demote all primary images within a pool or namespace to non-primary. Every mirror-enabled image in the pool or namespace will be demoted.

mirror pool disable [pool-name]

Disable RBD mirroring within a pool or namespace. When mirroring is disabled on a pool or namespace in this way, mirroring will also be disabled on all images (within the pool or namespace) for which mirroring was enabled, whether by default or explicitly.

mirror pool enable [pool-name] mode

Enable RBD mirroring within a pool or namespace. The mirroring mode can either be pool or image. If configured in pool mode, all images in the pool or namespace with the journaling feature enabled are mirrored. If configured in image mode, mirroring needs to be explicitly enabled (by mirror image enable command) on each image.

mirror pool info [pool-name]

Show information about the pool or namespace mirroring configuration. For a pool, it includes mirroring mode, peer UUID, remote cluster name, and remote client name. For a namespace, it includes only mirroring mode.

mirror pool peer add [pool-name] remote-cluster-spec

Add a mirroring peer to a pool. remote-cluster-spec is [remote client name@]remote cluster name. The default for remote client name is "client.admin".

This requires mirroring to be enabled on the pool.

mirror pool peer remove [pool-name] uuid

Remove a mirroring peer from a pool. The peer uuid is available from mirror pool info command.

mirror pool peer set [pool-name] uuid key value

Update mirroring peer settings. The key can be either client or cluster, and the value is corresponding to remote client name or remote cluster name.

mirror pool promote [--force] [pool-name]

Promote all non-primary images within a pool or namespace to primary. Every mirror-enabled image in the pool or namespace will be promoted.

mirror pool status [--verbose] [pool-name]

Show status for all mirrored images in the pool or namespace. With --verbose, show additional output status details for every mirror-enabled image in the pool or namespace.

mirror snapshot schedule add [-p | --pool pool] [--namespace namespace] [--image image] interval [start-time]

Add mirror snapshot schedule.

mirror snapshot schedule list [-R | --recursive] [--format format] [--pretty-format] [-p | --pool pool] [--namespace namespace] [--image image]

List mirror snapshot schedule.

mirror snapshot schedule remove [-p | --pool pool] [--namespace namespace] [--image image] interval [start-time]

Remove mirror snapshot schedule.

mirror snapshot schedule status [-p | --pool pool] [--format format] [--pretty-format] [--namespace namespace] [--image image]

Show mirror snapshot schedule status.

mv src-image-spec dest-image-spec

Rename an image. Note: rename across pools is not supported.

namespace create pool-name/namespace-name

Create a new image namespace within the pool.

namespace list pool-name

List image namespaces defined within the pool.

namespace remove pool-name/namespace-name

Remove an empty image namespace from the pool.

object-map check image-spec | snap-spec

Verify the object map is correct.

object-map rebuild image-spec | snap-spec

Rebuild an invalid object map for the specified image. An image snapshot can be specified to rebuild an invalid object map for a snapshot.

pool init [pool-name] [--force]

Initialize pool for use by RBD. Newly created pools must be initialized prior to use.

resize (-s | --size size-in-M/G/T) [--allow-shrink] [--encryption-format encryption-format --encryption-passphrase-file passphrase-file]... image-spec

Resize rbd image. The size parameter also needs to be specified. The --allow-shrink option lets the size be reduced.

rm image-spec

Delete an rbd image (including all data blocks). If the image has snapshots, this fails and nothing is deleted.

snap create snap-spec

Create a new snapshot. Requires the snapshot name parameter to be specified.

snap limit clear image-spec

Remove any previously set limit on the number of snapshots allowed on an image.

snap limit set [--limit] limit image-spec

Set a limit for the number of snapshots allowed on an image.

snap ls image-spec

Dump the list of snapshots of a specific image.

snap protect snap-spec

Protect a snapshot from deletion, so that clones can be made of it (see rbd clone). Snapshots must be protected before clones are made; protection implies that there exist dependent cloned children that refer to this snapshot. rbd clone will fail on a nonprotected snapshot. This requires image format 2.

snap purge image-spec

Remove all unprotected snapshots from an image.

snap rename src-snap-spec dest-snap-spec

Rename a snapshot. Note: rename across pools and images is not supported.

snap rm [--force] snap-spec

Remove the specified snapshot.

snap rollback snap-spec

Rollback image content to snapshot. This will iterate through the entire blocks array and update the data head content to the snapshotted version.

snap unprotect snap-spec

Unprotect a snapshot from deletion (undo snap protect). If cloned children remain, snap unprotect fails. (Note that clones may exist in different pools than the parent snapshot.) This requires image format 2.

sparsify [--sparse-size sparse-size] image-spec

Reclaim space for zeroed image extents. The default sparse size is 4096 bytes and can be changed via --sparse-size option with the following restrictions: it should be power of two, not less than 4096, and not larger than image object size.

status image-spec

Show the status of the image, including which clients have it open.

trash ls [pool-name]

List all entries from trash.

trash mv [--expires-at <expires-at>] image-spec

Move an image to the trash. Images, even ones actively in-use by clones, can be moved to the trash and deleted at a later time. Use --expires-at to set the expiration time of an image after which it's allowed to be removed.

trash purge [pool-name]

Remove all expired images from trash.

trash restore image-id

Restore an image from trash.

trash rm [--force] image-id

Delete an image from trash. If the image deferment time has not expired it can be removed using --force. An image that is actively in-use by clones or has snapshots cannot be removed.

trash purge schedule add [-p | --pool pool] [--namespace namespace] interval [start-time]

Add trash purge schedule.

trash purge schedule list [-R | --recursive] [--format format] [--pretty-format] [-p | --pool pool] [--namespace namespace]

List trash purge schedule.

trash purge schedule remove [-p | --pool pool] [--namespace namespace] interval [start-time]

Remove trash purge schedule.

trash purge schedule status [-p | --pool pool] [--format format] [--pretty-format] [--namespace namespace]

Show trash purge schedule status.

watch image-spec

Watch events on image.

## IMAGE, SNAP, GROUP AND JOURNAL SPECS

```
image-spec      is [pool-name/[namespace-name/]]image-name
snap-spec       is [pool-name/[namespace-name/]]image-name@snap-name
group-spec      is [pool-name/[namespace-name/]]group-name
group-snap-spec is [pool-name/[namespace-name/]]group-name@snap-name
journal-spec    is [pool-name/[namespace-name/]]journal-name
```

The default for pool-name is "rbd" and namespace-name is "". If an image name contains a slash character ('/'), pool-name is required.

The journal-name is image-id.

You may specify each name individually, using --pool, --namespace, --image, and --snap options, but this is discouraged in favor of the above spec syntax.

## STRIPING
RBD images are striped over many objects, which are then stored by the Ceph distributed object store (RADOS). As a result, read and write requests for the image are distributed across many nodes in the cluster, generally preventing any single node from becoming a bottleneck when individual images get large or busy.

The striping is controlled by three parameters:

object-size

The size of objects we stripe over is a power of two. It will be rounded up the nearest power of two. The default object size is 4 MB, smallest is 4K and maximum is 32M.

stripe-unit

Each [stripe-unit] contiguous bytes are stored adjacently in the same object, before we move on to the next object.

stripe-count

After we write [stripe-unit] bytes to [stripe-count] objects, we loop back to the initial object and write another stripe, until the object reaches its maximum size. At that point, we move on to the next [stripe-count] objects.

By default, [stripe-unit] is the same as the object size and [stripe-count] is 1. Specifying a different [stripe-unit] and/or [stripe-count] is often referred to as using "fancy" striping and requires format 2.

## KERNEL RBD (KRBD) OPTIONS
Most of these options are useful mainly for debugging and benchmarking. The default values are set in the kernel and may therefore depend on the version of the running kernel.

Per client instance rbd device map options:

- fsid=aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee - FSID that should be assumed by the client.

- ip=a.b.c.d[:p] - IP and, optionally, port the client should use.

- share - Enable sharing of client instances with other mappings (default).

- noshare - Disable sharing of client instances with other mappings.

- crc - Enable CRC32C checksumming for msgr1 on-the-wire protocol (default). For msgr2.1 protocol this option is ignored: full checksumming is always on in 'crc' mode and always off in 'secure' mode.

- nocrc - Disable CRC32C checksumming for msgr1 on-the-wire protocol. Note that only payload checksumming is disabled, header checksumming is always on. For msgr2.1 protocol this option is ignored.

- cephx_require_signatures - Require msgr1 message signing feature (since 3.19, default). This option is deprecated and will be removed in the future as the feature has been supported since the Bobtail release.

- nocephx_require_signatures - Don't require msgr1 message signing feature (since 3.19). This option is deprecated and will be removed in the future.

- tcp_nodelay - Disable Nagle's algorithm on client sockets (since 4.0, default).

- notcp_nodelay - Enable Nagle's algorithm on client sockets (since 4.0).

- cephx_sign_messages - Enable message signing for msgr1 on-the-wire protocol (since 4.4, default). For msgr2.1 protocol this option is ignored: message signing is built into 'secure' mode and not offered in 'crc' mode.

- nocephx_sign_messages - Disable message signing for msgr1 on-the-wire protocol (since 4.4). For msgr2.1 protocol this option is ignored.

- mount_timeout=x - A timeout on various steps in rbd device map and rbd device unmap sequences (default is 60 seconds). In particular, since 4.2 this can be used to ensure that rbd device unmap eventually times out when there is no network connection to a cluster.

- osdkeepalive=x - OSD keepalive timeout (default is 5 seconds).

- osd_idle_ttl=x - OSD idle TTL (default is 60 seconds).

Per mapping (block device) rbd device map options:

- rw - Map the image read-write (default). Overridden by --read-only.

- ro - Map the image read-only. Equivalent to --read-only.

- queue_depth=x - queue depth (since 4.2, default is 128 requests).

- lock_on_read - Acquire exclusive lock on reads, in addition to writes and discards (since 4.9).

- exclusive - Disable automatic exclusive lock transitions (since 4.12). Equivalent to --exclusive.

- lock_timeout=x - A timeout on waiting for the acquisition of exclusive lock (since 4.17, default is 0 seconds, meaning no timeout).

- notrim - Turn off discard and write zeroes offload support to avoid deprovisioning a fully provisioned image (since 4.17). When enabled, discard requests will fail with -EOPNOTSUPP, write zeroes requests will fall back to manually zeroing.

- abort_on_full - Fail write requests with -ENOSPC when the cluster is full or the data pool reaches its quota (since 5.0). The default behaviour is to block until the full condition is cleared.

- alloc_size - Minimum allocation unit of the underlying OSD object store backend (since 5.1, default is 64K bytes). This is used to round off and drop discards that are too small. For bluestore, the recommended setting is bluestore_min_alloc_size (currently set to 4K for all types of drives, previously used to be set to 64K for hard disk drives and 16K for solid-state drives). For filestore with filestore_punch_hole = false, the recommended setting is image object size (typically 4M).

- crush_location=x - Specify the location of the client in terms of CRUSH hierarchy (since 5.8). This is a set of key-value pairs separated from each other by '|', with keys separated from values by ':'. Note that '|' may need to be quoted or escaped to avoid it being interpreted as a pipe by the shell. The key is the bucket type name (e.g. rack, datacenter or region with default bucket types) and the value is the bucket name. For example, to indicate that the client is local to rack "myrack", data center "mydc" and region "myregion":

```
crush_location=rack:myrack|datacenter:mydc|region:myregion
```

Each key-value pair stands on its own: "myrack" doesn't need to reside in "mydc", which in turn doesn't need to reside in "myregion". The location is not a path to the root of the hierarchy but rather a set of nodes that are matched independently, owning to the fact that bucket names are unique within a CRUSH map. "Multipath" locations are supported, so it is possible to indicate locality for multiple parallel hierarchies:

```
crush_location=rack:myrack1|rack:myrack2|datacenter:mydc
```

- read_from_replica=no - Disable replica reads, always pick the primary OSD (since 5.8, default).

- read_from_replica=balance - When issued a read on a replicated pool, pick a random OSD for serving it (since 5.8). This mode is safe for general use only since Octopus (i.e. after "ceph osd require-osd-release octopus"). Otherwise it should be limited to read-only workloads such as images mapped read-only everywhere or snapshots.

- read_from_replica=localize - When issued a read on a replicated pool, pick the most local OSD for serving it (since 5.8). The locality metric is calculated against the location of the client given with crush_location; a match with the lowest-valued bucket type wins. For example, with default bucket types, an OSD in a matching rack is closer than an OSD in a matching data center, which in turn is closer than an OSD in a matching region. This mode is safe for general use only since Octopus (i.e. after "ceph osd require-osd-release octopus"). Otherwise it should be limited to read-only workloads such as images mapped read-only everywhere or snapshots.

- compression_hint=none - Don't set compression hints (since 5.8, default).

- compression_hint=compressible - Hint to the underlying OSD object store backend that the data is compressible, enabling compression in passive mode (since 5.8).

- compression_hint=incompressible - Hint to the underlying OSD object store backend that the data is incompressible, disabling compression in aggressive mode (since 5.8).

- ms_mode=legacy - Use msgr1 on-the-wire protocol (since 5.11, default).

- ms_mode=crc - Use msgr2.1 on-the-wire protocol, select 'crc' mode, also referred to as plain mode (since 5.11). If the daemon denies 'crc' mode, fail the connection.

- ms_mode=secure - Use msgr2.1 on-the-wire protocol, select 'secure' mode (since 5.11). 'secure' mode provides full in-transit encryption ensuring both confidentiality and authenticity. If the daemon denies 'secure' mode, fail the connection.

- ms_mode=prefer-crc - Use msgr2.1 on-the-wire protocol, select 'crc' mode (since 5.11). If the daemon denies 'crc' mode in favor of 'secure' mode, agree to 'secure' mode.

- ms_mode=prefer-secure - Use msgr2.1 on-the-wire protocol, select 'secure' mode (since 5.11). If the daemon denies 'secure' mode in favor of 'crc' mode, agree to 'crc' mode.

- rxbounce - Use a bounce buffer when receiving data (since 5.17). The default behaviour is to read directly into the destination buffer. A bounce buffer is needed if the destination buffer isn't guaranteed to be stable (i.e. remain unchanged while it is being read to). In particular this is the case for Windows where a system-wide "dummy" (throwaway) page may be mapped into the destination buffer in order to generate a single large I/O. Otherwise, "libceph: ... bad crc/signature" or "libceph: ... integrity error, bad crc" errors and associated performance degradation are expected.

- udev - Wait for udev device manager to finish executing all matching "add" rules and release the device before exiting (default). This option is not passed to the kernel.

- noudev - Don't wait for udev device manager. When enabled, the device may not be fully usable immediately on exit.

rbd device unmap options:

- force - Force the unmapping of a block device that is open (since 4.9). The driver will wait for running requests to complete and then unmap; requests sent to the driver after initiating the unmap will be failed.

- udev - Wait for udev device manager to finish executing all matching "remove" rules and clean up after the device before exiting (default). This option is not passed to the kernel.

- noudev - Don't wait for udev device manager.

## EXAMPLES
To create a new rbd image that is 100 GB:

```
rbd create mypool/myimage --size 102400
```

To use a non-default object size (8 MB):

```
rbd create mypool/myimage --size 102400 --object-size 8M
```

To delete an rbd image (be careful!):

```
rbd rm mypool/myimage
```

To create a new snapshot:

```
rbd snap create mypool/myimage@mysnap
```

To create a copy-on-write clone of a protected snapshot:

```
rbd clone mypool/myimage@mysnap otherpool/cloneimage
```

To see which clones of a snapshot exist:

```
rbd children mypool/myimage@mysnap
```

To delete a snapshot:

```
rbd snap rm mypool/myimage@mysnap
```

To map an image via the kernel with cephx enabled:

```
rbd device map mypool/myimage --id admin --keyfile secretfile
```

To map an image via the kernel with different cluster name other than default ceph:

```
rbd device map mypool/myimage --cluster cluster-name
```

To unmap an image:

```
rbd device unmap /dev/rbd0
```

To create an image and a clone from it:

```
rbd import --image-format 2 image mypool/parent
rbd snap create mypool/parent@snap
rbd snap protect mypool/parent@snap
rbd clone mypool/parent@snap otherpool/child
```

To create an image with a smaller stripe-unit (to better distribute small writes in some workloads):

```
rbd create mypool/myimage --size 102400 --stripe-unit 65536B --stripe-count 16
```

To change an image from one image format to another, export it and then import it as the desired image format:

```
rbd export mypool/myimage@snap /tmp/img
rbd import --image-format 2 /tmp/img mypool/myimage2
```

To lock an image for exclusive use:

```
rbd lock add mypool/myimage mylockid
```

To release a lock:

```
rbd lock remove mypool/myimage mylockid client.2485
```

To list images from trash:

```
rbd trash ls mypool
```

To defer delete an image (use --expires-at to set expiration time, default is now):

```
rbd trash mv mypool/myimage --expires-at "tomorrow"
```

To delete an image from trash (be careful!):

```
rbd trash rm mypool/myimage-id
```

To force delete an image from trash (be careful!):

```
rbd trash rm mypool/myimage-id  --force
```

To restore an image from trash:

```
rbd trash restore mypool/myimage-id
```

To restore an image from trash and rename it:

```
rbd trash restore mypool/myimage-id --image mynewimage
```

## AVAILABILITY
rbd is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at <https://docs.ceph.com> for more information.

## SEE ALSO
ceph <>(8), rados <>(8)

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


rbd-replay

package: ceph-common

title: rbd-replay(8)

text:
# rbd-replay(8)

## NAME
rbd-replay - replay rados block device (RBD) workloads

## SYNOPSIS

```
rbd-replay [ options ] replay_file
```

## DESCRIPTION
rbd-replay is a utility for replaying rados block device (RBD) workloads.

## OPTIONS
-c ceph.conf, --conf ceph.conf

Use ceph.conf configuration file instead of the default /etc/ceph/ceph.conf to determine monitor addresses during startup.

-p pool, --pool pool

Interact with the given pool. Defaults to 'rbd'.

--latency-multiplier

Multiplies inter-request latencies. Default: 1.

--read-only

Only replay non-destructive requests.

--map-image rule

Add a rule to map image names in the trace to image names in the replay cluster. A rule of image1@snap1=image2@snap2 would map snap1 of image1 to snap2 of image2.

--dump-perf-counters

Experimental Dump performance counters to standard out before an image is closed. Performance counters may be dumped multiple times if multiple images are closed, or if the same image is opened and closed multiple times. Performance counters and their meaning may change between versions.

## EXAMPLES
To replay workload1 as fast as possible:

```
rbd-replay --latency-multiplier=0 workload1
```

To replay workload1 but use test_image instead of prod_image:

```
rbd-replay --map-image=prod_image=test_image workload1
```

## AVAILABILITY
rbd-replay is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at <https://docs.ceph.com> for more information.

## SEE ALSO
rbd-replay-prep <>(8), rbd <>(8)

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

branch: sisyphus


rbd-replay-many

title: rbd-replay-many(8)

text:
# rbd-replay-many(8)

## NAME
rbd-replay-many - replay a rados block device (RBD) workload on several clients

## SYNOPSIS

```
rbd-replay-many [ options ] --original-image name host1 [ host2 [ ... ] ] -- rbd_replay_args
```

## DESCRIPTION
rbd-replay-many is a utility for replaying a rados block device (RBD) workload on several clients. Although all clients use the same workload, they replay against separate images. This matches normal use of librbd, where each original client is a VM with its own image.

Configuration and replay files are not automatically copied to clients. Replay images must already exist.

## OPTIONS
--original-image name

Specifies the name (and snap) of the originally traced image. Necessary for correct name mapping.

--image-prefix prefix

Prefix of image names to replay against. Specifying --image-prefix=foo results in clients replaying against foo-0, foo-1, etc. Defaults to the original image name.

--exec program

Path to the rbd-replay executable.

--delay seconds

Delay between starting each client. Defaults to 0.

## EXAMPLES
Typical usage:

```
rbd-replay-many host-0 host-1 --original-image=image -- -c ceph.conf replay.bin
```

This results in the following commands being executed:

```
ssh host-0 'rbd-replay' --map-image 'image=image-0' -c ceph.conf replay.bin
ssh host-1 'rbd-replay' --map-image 'image=image-1' -c ceph.conf replay.bin
```

## AVAILABILITY
rbd-replay-many is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at <https://docs.ceph.com> for more information.

## SEE ALSO
rbd-replay <>(8), rbd <>(8)

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


rbd-replay-prep

title: rbd-replay-prep(8)

text:
# rbd-replay-prep(8)

## NAME
rbd-replay-prep - prepare captured rados block device (RBD) workloads for replay

## SYNOPSIS

```
rbd-replay-prep [ --window seconds ] [ --anonymize ] trace_dir replay_file
```

## DESCRIPTION
rbd-replay-prep processes raw rados block device (RBD) traces to prepare them for rbd-replay.

## OPTIONS
--window seconds

Requests further apart than 'seconds' seconds are assumed to be independent.

--anonymize

Anonymizes image and snap names.

--verbose

Print all processed events to console

## EXAMPLES
To prepare workload1-trace for replay:

```
rbd-replay-prep workload1-trace/ust/uid/1000/64-bit workload1
```

## AVAILABILITY
rbd-replay-prep is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at <https://docs.ceph.com> for more information.

## SEE ALSO
rbd-replay <>(8), rbd <>(8)

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


rbdmap

title: rbdmap(8)

summary: map RBD devices at boot time

text:
# rbdmap(8)

## NAME
rbdmap - map RBD devices at boot time

## SYNOPSIS

```
rbdmap map
rbdmap unmap
```

## DESCRIPTION
rbdmap is a shell script that automates rbd map and rbd unmap operations on one or more RBD (RADOS Block Device) images. While the script can be run manually by the system administrator at any time, the principal use case is automatic mapping/mounting of RBD images at boot time (and unmounting/unmapping at shutdown), as triggered by the init system (a systemd unit file, rbdmap.service is included with the ceph-common package for this purpose).

The script takes a single argument, which can be either "map" or "unmap". In either case, the script parses a configuration file (defaults to /etc/ceph/rbdmap, but can be overridden via an environment variable RBDMAPFILE). Each line of the configuration file corresponds to an RBD image which is to be mapped, or unmapped.

The configuration file format is:

```
IMAGESPEC RBDOPTS
```

where IMAGESPEC should be specified as POOLNAME/IMAGENAME (the pool name, a forward slash, and the image name), or merely IMAGENAME, in which case the POOLNAME defaults to "rbd". RBDOPTS is an optional list of parameters to be passed to the underlying rbd map command. These parameters and their values should be specified as a comma-separated string:

```
PARAM1=VAL1,PARAM2=VAL2,...,PARAMN=VALN
```

This will cause the script to issue an rbd map command like the following:

```
rbd map POOLNAME/IMAGENAME --PARAM1 VAL1 --PARAM2 VAL2
```

(See the rbd manpage for a full list of possible options.) For parameters and values which contain commas or equality signs, a simple apostrophe can be used to prevent replacing them.

When run as rbdmap map, the script parses the configuration file, and for each RBD image specified attempts to first map the image (using the rbd map command) and, second, to mount the image.

When run as rbdmap unmap, images listed in the configuration file will be unmounted and unmapped.

rbdmap unmap-all attempts to unmount and subsequently unmap all currently mapped RBD images, regardless of whether or not they are listed in the configuration file.

If successful, the rbd map operation maps the image to a /dev/rbdX device, at which point a udev rule is triggered to create a friendly device name symlink, /dev/rbd/POOLNAME/IMAGENAME, pointing to the real mapped device.

In order for mounting/unmounting to succeed, the friendly device name must have a corresponding entry in /etc/fstab.

When writing /etc/fstab entries for RBD images, it's a good idea to specify the "noauto" (or "nofail") mount option. This prevents the init system from trying to mount the device too early - before the device in question even exists. (Since rbdmap.service executes a shell script, it is typically triggered quite late in the boot sequence.)

## EXAMPLES
Example /etc/ceph/rbdmap for three RBD images called "bar1", "bar2" and "bar3", which are in pool "foopool":

```
foopool/bar1    id=admin,keyring=/etc/ceph/ceph.client.admin.keyring
foopool/bar2    id=admin,keyring=/etc/ceph/ceph.client.admin.keyring
foopool/bar3    id=admin,keyring=/etc/ceph/ceph.client.admin.keyring,options='lock_on_read,queue_depth=1024'
```

Each line in the file contains two strings: the image spec and the options to be passed to rbd map. These two lines get transformed into the following commands:

```
rbd map foopool/bar1 --id admin --keyring /etc/ceph/ceph.client.admin.keyring
rbd map foopool/bar2 --id admin --keyring /etc/ceph/ceph.client.admin.keyring
rbd map foopool/bar2 --id admin --keyring /etc/ceph/ceph.client.admin.keyring --options lock_on_read,queue_depth=1024
```

If the images had XFS file systems on them, the corresponding /etc/fstab entries might look like this:

```
/dev/rbd/foopool/bar1 /mnt/bar1 xfs noauto 0 0
/dev/rbd/foopool/bar2 /mnt/bar2 xfs noauto 0 0
/dev/rbd/foopool/bar3 /mnt/bar3 xfs noauto 0 0
```

After creating the images and populating the /etc/ceph/rbdmap file, making the images get automatically mapped and mounted at boot is just a matter of enabling that unit:

```
systemctl enable rbdmap.service
```

## OPTIONS
None

## AVAILABILITY
rbdmap is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at <https://docs.ceph.com> for more information.

## SEE ALSO
rbd <>(8),

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


rgw-gap-list

title: rgw-gap-list(8)

text:
# rgw-gap-list(8)

## NAME
rgw-gap-list - List bucket index entries with damaged RADOS backing objects

## SYNOPSIS

```
rgw-gap-list
```

## DESCRIPTION
rgw-gap-list is an EXPERIMENTAL RADOS gateway user administration utility. It produces a listing of bucket index entries that have missing backing RADOS objects. It places the results and intermediate files on a local filesystem rather than on the Ceph cluster itself, and therefore will not itself consume additional cluster storage.

In theory these gaps should not exist. However because Ceph evolves rapidly, bugs do crop up, and they may result in bucket index entries that have missing RADOS objects, such as when a delete operation does not fully complete.

Behind the scenes it runs rados ls and radosgw-admin bucket radoslist ... and produces a list of those entries that appear in the latter but not the former. Those entries are presumed to be the gaps.

Note: Depending on the size of the pool(s) involved, this tool may be quite slow to produce its results.

## WARNINGS
This utility is considered EXPERIMENTAL.

## OPTIONS
-p pool

The RGW bucket data pool name. If option omitted the pool name will be prompted during execution. Multiple pools can be supplied as a space-separated double quoted list.

-t temp_directory

The tool can produce large intermediate files. By default /tmp is used, but if the filesystem housing /tmp doesn't have sufficient free space, a different directory (on a filesystem with sufficient free space) can be specified.

-m

Use two (multiple) threads to speed up the run.

## EXAMPLES
Launch the tool:

```
$ rgw-gap-list -p default.rgw.buckets.data -t /home/super_admin/temp_files
```

## AVAILABILITY
rgw-gap-list is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at <https://docs.ceph.com> for more information.

## SEE ALSO
radosgw-admin <>(8) rgw-orphan-list <>(8)

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


rgw-orphan-list

title: rgw-orphan-list(8)

text:
# rgw-orphan-list(8)

## NAME
rgw-orphan-list - list rados objects that are not indexed by rgw

## SYNOPSIS

```
rgw-orphan-list
```

## DESCRIPTION
rgw-orphan-list is an EXPERIMENTAL RADOS gateway user administration utility. It produces a listing of rados objects that are not directly or indirectly referenced through the bucket indexes on a pool. It places the results and intermediate files on the local filesystem rather than on the ceph cluster itself, and therefore will not itself consume additional cluster storage.

In theory orphans should not exist. However because ceph evolves rapidly, bugs do crop up, and they may result in orphans that are left behind.

In its current form this utility does not take any command-line arguments or options. It will list the available pools and prompt the user to enter the pool they would like to list orphans for.

Behind the scenes it runs rados ls and radosgw-admin bucket radoslist ... and produces a list of those entries that appear in the former but not the latter. Those entries are presumed to be the orphans.

## WARNINGS
This utility is currently considered EXPERIMENTAL.

This utility will produce false orphan entries for unindexed buckets since such buckets have no bucket indices that can provide the starting point for tracing.

## OPTIONS
At present there are no options.

## EXAMPLES
Launch the tool:

```
$ rgw-orphan-list
```

## AVAILABILITY
radosgw-admin is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at <https://docs.ceph.com> for more information.

## SEE ALSO
radosgw-admin <>(8) ceph-diff-sorted <>(8)

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


rgw-restore-bucket-index

title: rgw-restore-bucket-index(8)

text:
# rgw-restore-bucket-index(8)

## NAME
rgw-restore-bucket-index - try to restore a bucket's objects to its bucket index

## SYNOPSIS

```
rgw-restore-bucket-index
```

## DESCRIPTION
rgw-restore-bucket-index is an EXPERIMENTAL RADOS gateway user administration utility. It scans the data pool for objects that belong to a given bucket and tries to add those objects back to the bucket index. It's intended as a last resort after a catastrophic loss of a bucket index. Please thorougly review the Warnings listed below.

The utility works with regular (i.e., un-versioned) buckets, versioned buckets, and buckets were versioning has been suspended.

## WARNINGS
This utility is currently considered EXPERIMENTAL.

The results are unpredictable if the bucket is in active use while this utility is running.

The results are unpredictable if only some bucket's objects are missing from the bucket index. In such a case, consider using the "object reindex" subcommand of radosgw-admin to restore object's to the bucket index one-by-one.

For objects in versioned buckets, if the latest version is a delete marker, it will be restored. If a delete marker has been written over with a new version, then that delete marker will not be restored. This should have minimal impact on results in that the it recovers the latest version and previous versions are all accessible.

## COMMAND-LINE ARGUMENTS
-b <bucket>

Specify the bucket to be reindexed.

-p <pool>

Optional, specify the data pool containing head objects for the bucket. If omitted the utility will try to determine the data pool on its own.

-r <realm-name>

Optional, specify the realm if the restoration is not being applied to the default realm.

-g <zonegroup-name>

Optional, specify the zonegroup if the restoration is not being applied to the default zonegroup.

-z <zone-name>

Optional, specify the zone if the restoration is not being applied to the default zone.

-l <rados-ls-output-file>

Optional, specify a file containing the output of a rados listing of the data pool. Since listing the data pool can be an expensive and time-consuming operation, if trying to recover the indices for multiple buckets, it could be more efficient to re-use the same listing.

-t <temporary-directory>

Optional, specify a directory in which to store temporary files. The size of the temporary files is highly dependent on the number of bucket entries involved, so the partition on which the temporary directory exists should be of suitable size.

-y

Optional, proceed without further prompting. Without this option the utility will display some information and prompt the user as to whether to proceed. When provided, the utility will simply proceed. Please use caution when using this option.

## EXAMPLES
Attempt to restore the index for a bucket named summer-2023-photos:

```
$ rgw-restore-bucket-index -b summer-2023-photos
```

## AVAILABILITY
rgw-restore-bucket-index is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at <https://docs.ceph.com> for more information.

## SEE ALSO
radosgw-admin <>(8)

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


ceph-fuse

package: ceph-fuse

title: ceph-fuse(8)

summary: FUSE-based client for ceph

text:
# ceph-fuse(8)

## NAME
ceph-fuse - FUSE-based client for ceph

## SYNOPSIS

```
ceph-fuse [-n client.username] [ -m monaddr:port ] mountpoint [ fuse options ]
```

## DESCRIPTION
ceph-fuse is a FUSE ("Filesystem in USErspace") client for Ceph distributed file system. It will mount a ceph file system specified via the -m option or described by ceph.conf (see below) at the specific mount point. See Mount CephFS using FUSE <../../../cephfs/mount-using-fuse/> for detailed information.

The file system can be unmounted with:

```
fusermount -u mountpoint
```

or by sending SIGINT to the ceph-fuse process.

## OPTIONS
Any options not recognized by ceph-fuse will be passed on to libfuse.

-o opt,[opt...]

Mount options.

-c ceph.conf, --conf=ceph.conf

Use ceph.conf configuration file instead of the default /etc/ceph/ceph.conf to determine monitor addresses during startup.

-m monaddress[:port]

Connect to specified monitor (instead of looking through ceph.conf).

-n client.{cephx-username}

Pass the name of CephX user whose secret key is be to used for mounting.

--id <client-id>

Pass the name of CephX user whose secret key is be to used for mounting. --id takes just the ID of the client in contrast to -n. For example, --id 0 for using client.0.

-k <path-to-keyring>

Provide path to keyring; useful when it's absent in standard locations.

--client_mountpoint/-r root_directory

Use root_directory as the mounted root, rather than the full Ceph tree.

-f

Foreground: do not daemonize after startup (run in foreground). Do not generate a pid file.

-d

Run in foreground, send all log output to stderr and enable FUSE debugging (-o debug).

-s

Disable multi-threaded operation.

--client_fs

Pass the name of Ceph FS to be mounted. Not passing this option mounts the default Ceph FS on the Ceph cluster.

## AVAILABILITY
ceph-fuse is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at <https://docs.ceph.com> for more information.

## SEE ALSO
fusermount(8), ceph <>(8)

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


mount.fuse.ceph

title: mount.fuse.ceph(8)

summary: mount ceph-fuse from /etc/fstab.

text:
# mount.fuse.ceph(8)

## NAME
mount.fuse.ceph - mount ceph-fuse from /etc/fstab.

## SYNOPSIS

```
mount.fuse.ceph [-h] [-o OPTIONS [OPTIONS ...]]
device [device ...]
mountpoint [mount point ...]
```

## DESCRIPTION
mount.fuse.ceph is a helper for mounting ceph-fuse from /etc/fstab.

To use mount.fuse.ceph, add an entry in /etc/fstab like:

```
DEVICE    PATH        TYPE        OPTIONS
none      /mnt/ceph   fuse.ceph   ceph.id=admin,_netdev,defaults  0 0
none      /mnt/ceph   fuse.ceph   ceph.name=client.admin,_netdev,defaults  0 0
none      /mnt/ceph   fuse.ceph   ceph.id=myuser,ceph.conf=/etc/ceph/foo.conf,_netdev,defaults  0 0
```

ceph-fuse options are specified in the OPTIONS column and must begin with 'ceph.' prefix. This way ceph related fs options will be passed to ceph-fuse and others will be ignored by ceph-fuse.

## OPTIONS
ceph.id=<username>

Specify that the ceph-fuse will authenticate as the given user.

ceph.name=client.admin

Specify that the ceph-fuse will authenticate as client.admin

ceph.conf=/etc/ceph/foo.conf

Sets 'conf' option to /etc/ceph/foo.conf via ceph-fuse command line.

Any valid ceph-fuse options can be passed this way.

## ADDITIONAL INFO
The old format /etc/fstab entries are also supported:

```
DEVICE                              PATH        TYPE        OPTIONS
id=admin                            /mnt/ceph   fuse.ceph   defaults   0 0
id=myuser,conf=/etc/ceph/foo.conf   /mnt/ceph   fuse.ceph   defaults   0 0
```

## AVAILABILITY
mount.fuse.ceph is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at <https://docs.ceph.com> for more information.

## SEE ALSO
ceph-fuse <>(8), ceph <>(8)

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


ceph-immutable-object-cache

package: ceph-immutable-object-cache

title: ceph-immutable-object-cache(8)

summary: Ceph daemon for immutable object cache

text:
# ceph-immutable-object-cache(8)

## NAME
ceph-immutable-object-cache - Ceph daemon for immutable object cache

## SYNOPSIS

```
ceph-immutable-object-cache
```

## DESCRIPTION
ceph-immutable-object-cache is a daemon for object cache of RADOS objects among Ceph clusters. It will promote the objects to a local directory upon promote requests and future reads will be serviced from these cached objects.

It connects to local clusters via the RADOS protocol, relying on default search paths to find ceph.conf files, monitor addresses and authentication information for them, i.e. /etc/ceph/$cluster.conf, /etc/ceph/$cluster.keyring, and /etc/ceph/$cluster.$name.keyring, where $cluster is the human-friendly name of the cluster, and $name is the rados user to connect as, e.g. client.ceph-immutable-object-cache.

## OPTIONS
-c ceph.conf, --conf=ceph.conf

Use ceph.conf configuration file instead of the default /etc/ceph/ceph.conf to determine monitor addresses during startup.

-m monaddress[:port]

Connect to specified monitor (instead of looking through ceph.conf).

-i ID, --id ID

Set the ID portion of name for ceph-immutable-object-cache

-n TYPE.ID, --name TYPE.ID

Set the rados user name for the gateway (eg. client.ceph-immutable-object-cache)

--cluster NAME

Set the cluster name (default: ceph)

-d

Run in foreground, log to stderr

-f

Run in foreground, log to usual location

## AVAILABILITY
ceph-immutable-object-cache is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at <https://docs.ceph.com> for more information.

## SEE ALSO
rbd <>(8)

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


ceph-mds

package: ceph-mds

title: ceph-mds(8)

summary: ceph metadata server daemon

text:
# ceph-mds(8)

## NAME
ceph-mds - ceph metadata server daemon

## SYNOPSIS

```
ceph-mds -i <ID> [flags]
```

## DESCRIPTION
ceph-mds is the metadata server daemon for the Ceph distributed file system. One or more instances of ceph-mds collectively manage the file system namespace, coordinating access to the shared OSD cluster.

Each ceph-mds daemon instance should have a unique name. The name is used to identify daemon instances in the ceph.conf.

Once the daemon has started, the monitor cluster will normally assign it a logical rank, or put it in a standby pool to take over for another daemon that crashes. Some of the specified options can cause other behaviors.

## OPTIONS
-f, --foreground

Foreground: do not daemonize after startup (run in foreground). Do not generate a pid file. Useful when run via ceph-run <>(8).

-d

Debug mode: like -f, but also send all log output to stderr.

--setuser userorgid

Set uid after starting. If a username is specified, the user record is looked up to get a uid and a gid, and the gid is also set as well, unless --setgroup is also specified.

--setgroup grouporgid

Set gid after starting. If a group name is specified the group record is looked up to get a gid.

-c ceph.conf, --conf=ceph.conf

Use ceph.conf configuration file instead of the default /etc/ceph/ceph.conf to determine monitor addresses during startup.

-m monaddress[:port]

Connect to specified monitor (instead of looking through ceph.conf).

--id/-i ID

Set ID portion of the MDS name. The ID should not start with a numeric digit.

--name/-n TYPE.ID

Set the MDS name of the format TYPE.ID. The TYPE is obviously 'mds'. The ID should not start with a numeric digit.

## AVAILABILITY
ceph-mds is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at <https://docs.ceph.com> for more information.

## SEE ALSO
ceph <>(8), ceph-mon <>(8), ceph-osd <>(8)

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


ceph-mon

package: ceph-mon

title: ceph-mon(8)

summary: ceph monitor daemon

text:
# ceph-mon(8)

## NAME
ceph-mon - ceph monitor daemon

## SYNOPSIS

```
ceph-mon -i monid [ --mon-data mondatapath ]
```

## DESCRIPTION
ceph-mon is the cluster monitor daemon for the Ceph distributed file system. One or more instances of ceph-mon form a Paxos part-time parliament cluster that provides extremely reliable and durable storage of cluster membership, configuration, and state.

The mondatapath refers to a directory on a local file system storing monitor data. It is normally specified via the mon data option in the configuration file.

## OPTIONS
-f, --foreground

Foreground: do not daemonize after startup (run in foreground). Do not generate a pid file. Useful when run via ceph-run <>(8).

-d

Debug mode: like -f, but also send all log output to stderr.

--setuser userorgid

Set uid after starting. If a username is specified, the user record is looked up to get a uid and a gid, and the gid is also set as well, unless --setgroup is also specified.

--setgroup grouporgid

Set gid after starting. If a group name is specified the group record is looked up to get a gid.

-c ceph.conf, --conf=ceph.conf

Use ceph.conf configuration file instead of the default /etc/ceph/ceph.conf to determine monitor addresses during startup.

--mkfs

Initialize the mon data directory with seed information to form and initial ceph file system or to join an existing monitor cluster. Three pieces of information must be provided:

- The cluster fsid. This can come from a monmap (--monmap <path>) or explicitly via --fsid <uuid>.

- A list of monitors and their addresses. This list of monitors can come from a monmap (--monmap <path>), the mon host configuration value (in ceph.conf or via -m host1,host2,...), or (for backward compatibility) the deprecated mon addr lines in ceph.conf. If this monitor is to be part of the initial monitor quorum for a new Ceph cluster, then it must be included in the initial list, matching either the name or address of a monitor in the list. When matching by address, either the public addr or public subnet options may be used.

- The monitor secret key mon.. This must be included in the keyring provided via --keyring <path>.

--keyring

Specify a keyring for use with --mkfs.

--no-config-file

Signal that we don't want to rely on a ceph.conf, either user provided or the default, to run the daemon. This will entail providing all necessary options to the daemon as arguments.

## AVAILABILITY
ceph-mon is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at <https://docs.ceph.com> for more information.

## SEE ALSO
ceph <>(8), ceph-mds <>(8), ceph-osd <>(8)

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


ceph-bluestore-tool

package: ceph-osd

title: ceph-bluestore-tool(8)

summary: bluestore administrative tool

text:
# ceph-bluestore-tool(8)

## NAME
ceph-bluestore-tool - bluestore administrative tool

## SYNOPSIS

```
ceph-bluestore-tool command
[ --dev device ... ]
[ -i osd_id ]
[ --path osd path ]
[ --out-dir dir ]
[ --log-file | -l filename ]
[ --deep ]
ceph-bluestore-tool fsck|repair --path osd path [ --deep ]
ceph-bluestore-tool qfsck       --path osd path
ceph-bluestore-tool allocmap    --path osd path
ceph-bluestore-tool restore_cfb --path osd path
ceph-bluestore-tool show-label --dev device ...
ceph-bluestore-tool show-label-at --dev device --offset lba...
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 ]
ceph-bluestore-tool reshard --path osd path --sharding new sharding [ --sharding-ctrl control string ]
ceph-bluestore-tool show-sharding --path osd path
ceph-bluestore-tool zap-device --dev dev path
```

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

## COMMANDS
help

show help

fsck [ --deep ] (on|off) or (yes|no) or (1|0) or (true|false)

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.

qfsck

run consistency check on BlueStore metadata comparing allocator data (from RocksDB CFB when exists and if not uses allocation-file) with ONodes state.

allocmap

performs the same check done by qfsck and then stores a new allocation-file (command is disabled by default and requires a special build)

restore_cfb

Reverses changes done by the new NCB code (either through ceph restart or when running allocmap command) and restores RocksDB B Column-Family (allocator-map).

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 device. Source devices (except the main one) are removed on success. Expands the target storage (updates the size label), making "bluefs-bdev-expand" unnecessary. The target device can be either a new device or a device that is already attached. If the device is a new device, it is added to the OSD replacing one of the source devices. The following replacement rules apply (in the order of precedence, stop on the first match):

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

- if the source list has WAL volume - the target device replaces it.

- if the source list has slow volume only - the operation isn't permitted and requires explicit allocation via a new-DB/new-WAL command.

show-label --dev device [...]

Show device label(s). The label may be printed while an OSD is running.

show-label-at --dev device --offset

```
*
```

lba*[...] Show device label at specific disk location. Dedicated DB/WAL volumes have a single label at offset 0. Main device could have valid labels at multiple locations: 0/1GiB/10GiB/100GiB/1000GiB. The labels at some locations might not exist though. The label may be printed while an OSD is running.

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.

reshard --path osd path --sharding new sharding [ --resharding-ctrl control string ]

Changes sharding of BlueStore's RocksDB. Sharding is build on top of RocksDB column families. This option allows to test performance of new sharding without need to redeploy OSD. Resharding is usually a long process, which involves walking through entire RocksDB key space and moving some of them to different column families. Option --resharding-ctrl provides performance control over resharding process. Interrupted resharding will prevent OSD from running. Interrupted resharding does not corrupt data. It is always possible to continue previous resharding, or select any other sharding scheme, including reverting to original one.

show-sharding --path osd path

Show sharding that is currently applied to BlueStore's RocksDB.

command

zap-device --dev dev path Zeros all device label locations. This effectively makes device appear empty.

## OPTIONS
--dev *device*

Add device to the list of devices to consider

-i *osd_id*

Operate as OSD osd_id. Connect to monitor for OSD specific options. If monitor is unavailable, add --no-mon-config to read from ceph.conf instead.

--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. Not necessary if -i osd_id is provided.

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

--resharding-ctrl *control string*

Provides control over resharding process. Specifies how often refresh RocksDB iterator, and how large should commit batch be before committing to RocksDB. Option format is: <iterator_refresh_bytes>/<iterator_refresh_keys>/<batch_commit_bytes>/<batch_commit_keys> Default: 10000000/10000/1000000/1000

## ADDITIONAL CEPH.CONF OPTIONS
Any configuration option that is accepted by OSD can be also passed to ceph-bluestore-tool. Useful to provide necessary configuration options when access to monitor/ceph.conf is impossible and -i option cannot be used.

## DEVICE LABELS
Every BlueStore block device has a block label at the beginning of the device. Main device might optionaly have additional labels at different locations for the sake of OSD robustness. 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). The main device contains additional label copies at offsets: 1GiB, 10GiB, 100GiB and 1000GiB. Corrupted labels are fixed as part of repair:

```
ceph-bluestore-tool repair --dev *device*
```

## 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 extremely 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 successful::

ceph-bluestore-tool fsck --path osd path --bluefs_replay_recovery=true --bluefs_replay_recovery_disable_compact=true

If above fsck is successful 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 <https://docs.ceph.com> for more information.

## SEE ALSO
ceph-osd <>(8)

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


ceph-clsinfo

title: ceph-clsinfo(8)

summary: show class object information

text:
# ceph-clsinfo(8)

## NAME
ceph-clsinfo - show class object information

## SYNOPSIS

```
ceph-clsinfo [ options ] ... filename
```

## DESCRIPTION
ceph-clsinfo can show name, version, and architecture information about a specific class object.

## OPTIONS
-n, --name

Shows the class name

-v, --version

Shows the class version

-a, --arch

Shows the class architecture

## AVAILABILITY
ceph-clsinfo is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at <https://docs.ceph.com> for more information.

## SEE ALSO
ceph <>(8)

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


ceph-osd

title: ceph-osd(8)

summary: ceph object storage daemon

text:
# ceph-osd(8)

## NAME
ceph-osd - ceph object storage daemon

## SYNOPSIS

```
ceph-osd -i osdnum [ --osd-data datapath ] [ --osd-journal
journal ] [ --mkfs ] [ --mkjournal ] [--flush-journal] [--check-allows-journal] [--check-wants-journal] [--check-needs-journal] [ --mkkey ] [ --osdspec-affinity ]
```

## DESCRIPTION
ceph-osd is the object storage daemon for the Ceph distributed file system. It manages data on local storage with redundancy and provides access to that data over the network.

For Filestore-backed clusters, the argument of the --osd-data datapath option (which is datapath in this example) should be a directory on an XFS file system where the object data resides. The journal is optional. The journal improves performance only when it resides on a different disk than the disk specified by datapath . The storage medium on which the journal is stored should be a low-latency medium (ideally, an SSD device).

## OPTIONS
-f, --foreground

Foreground: do not daemonize after startup (run in foreground). Do not generate a pid file. Useful when run via ceph-run <>(8).

-d

Debug mode: like -f, but also send all log output to stderr.

--setuser userorgid

Set uid after starting. If a username is specified, the user record is looked up to get a uid and a gid, and the gid is also set as well, unless --setgroup is also specified.

--setgroup grouporgid

Set gid after starting. If a group name is specified the group record is looked up to get a gid.

--osd-data osddata

Use object store at osddata.

--osd-journal journal

Journal updates to journal.

--check-wants-journal

Check whether a journal is desired.

--check-allows-journal

Check whether a journal is allowed.

--check-needs-journal

Check whether a journal is required.

--mkfs

Create an empty object repository. This also initializes the journal (if one is defined).

--mkkey

Generate a new secret key. This is normally used in combination with --mkfs as it is more convenient than generating a key by hand with ceph-authtool <>(8).

--mkjournal

Create a new journal file to match an existing object repository. This is useful if the journal device or file is wiped out due to a disk or file system failure.

--flush-journal

Flush the journal to permanent store. This runs in the foreground so you know when it's completed. This can be useful if you want to resize the journal or need to otherwise destroy it: this guarantees you won't lose data.

--get-cluster-fsid

Print the cluster fsid (uuid) and exit.

--get-osd-fsid

Print the OSD's fsid and exit. The OSD's uuid is generated at --mkfs time and is thus unique to a particular instantiation of this OSD.

--get-journal-fsid

Print the journal's uuid. The journal fsid is set to match the OSD fsid at --mkfs time.

-c ceph.conf, --conf=ceph.conf

Use ceph.conf configuration file instead of the default /etc/ceph/ceph.conf for runtime configuration options.

-m monaddress[:port]

Connect to specified monitor (instead of looking through ceph.conf).

--osdspec-affinity

Set an affinity to a certain OSDSpec. This option can only be used in conjunction with --mkfs.

## AVAILABILITY
ceph-osd is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at <https://docs.ceph.com> for more information.

## SEE ALSO
ceph <>(8), ceph-mds <>(8), ceph-mon <>(8), ceph-authtool <>(8)

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


ceph-diff-sorted

package: ceph-radosgw

title: ceph-diff-sorted(8)

summary: compare two sorted files line by line

text:
# ceph-diff-sorted(8)

## NAME
ceph-diff-sorted - compare two sorted files line by line

## SYNOPSIS

```
ceph-diff-sorted file1 file2
```

## DESCRIPTION
ceph-diff-sorted is a simplified diff utility optimized for comparing two files with lines that are lexically sorted.

The output is simplified in comparison to that of the standard diff tool available in POSIX systems. Angle brackets ('<' and '>') are used to show lines that appear in one file but not the other. The output is not compatible with the patch tool.

This tool was created in order to perform diffs of large files (e.g., containing billions of lines) that the standard diff tool cannot handle efficiently. Knowing that the lines are sorted allows this to be done efficiently with minimal memory overhead.

The sorting of each file needs to be done lexically. Most POSIX systems use the LANG environment variable to determine the sort tool's sorting order. To sort lexically we would need something such as:

$ LANG=C sort some-file.txt >some-file-sorted.txt

## EXAMPLES
Compare two files:

```
$ ceph-diff-sorted fileA.txt fileB.txt
```

## EXIT STATUS
When complete, the exit status will be set to one of the following:

0

files same

1

files different

2

usage problem (e.g., wrong number of command-line arguments)

3

problem opening input file

4

bad file content (e.g., unsorted order or empty lines)

## AVAILABILITY
ceph-diff-sorted is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at <https://docs.ceph.com> for more information.

## SEE ALSO
rgw-orphan-list <>(8)

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


radosgw

title: radosgw(8)

summary: rados REST gateway

text:
# radosgw(8)

## NAME
radosgw - rados REST gateway

## SYNOPSIS

```
radosgw
```

## DESCRIPTION
radosgw is an HTTP REST gateway for the RADOS object store, a part of the Ceph distributed storage system. It is implemented as a FastCGI module using libfcgi, and can be used in conjunction with any FastCGI capable web server.

## OPTIONS
-c ceph.conf, --conf=ceph.conf

Use ceph.conf configuration file instead of the default /etc/ceph/ceph.conf to determine monitor addresses during startup.

-m monaddress[:port]

Connect to specified monitor (instead of looking through ceph.conf).

-i ID, --id ID

Set the ID portion of name for radosgw

-n TYPE.ID, --name TYPE.ID

Set the rados user name for the gateway (eg. client.radosgw.gateway)

--cluster NAME

Set the cluster name (default: ceph)

-d

Run in foreground, log to stderr

-f

Run in foreground, log to usual location

--rgw-region=region

The region where radosgw runs

--rgw-zone=zone

The zone where radosgw runs

## CONFIGURATION
Earlier RADOS Gateway had to be configured with Apache and mod_fastcgi. Now, mod_proxy_fcgi module is used instead of mod_fastcgi. mod_proxy_fcgi works differently than a traditional FastCGI module. This module requires the service of mod_proxy which provides support for the FastCGI protocol. So, to be able to handle FastCGI protocol, both mod_proxy and mod_proxy_fcgi have to be present in the server. Unlike mod_fastcgi, mod_proxy_fcgi cannot start the application process. Some platforms have fcgistarter for that purpose. However, external launching of application or process management may be available in the FastCGI application framework in use.

Apache must be configured in a way that enables mod_proxy_fcgi to be used with localhost tcp.

The following steps show the configuration in Ceph's configuration file i.e, /etc/ceph/ceph.conf and the gateway configuration file i.e, /etc/httpd/conf.d/rgw.conf (RPM-based distros) or /etc/apache2/conf-available/rgw.conf (Debian-based distros) with localhost tcp:

1.

For distros with Apache 2.2 and early versions of Apache 2.4 that use localhost TCP, append the following contents to /etc/ceph/ceph.conf:

```
[client.radosgw.gateway]
host = {hostname}
keyring = /etc/ceph/ceph.client.radosgw.keyring
log_file = /var/log/ceph/client.radosgw.gateway.log
rgw_frontends = fastcgi socket_port=9000 socket_host=0.0.0.0
rgw_print_continue = false
```

2.

Add the following content in the gateway configuration file: For Debian/Ubuntu add in /etc/apache2/conf-available/rgw.conf:

```
<VirtualHost *:80>
ServerName localhost
DocumentRoot /var/www/html
ErrorLog /var/log/apache2/rgw_error.log
CustomLog /var/log/apache2/rgw_access.log combined
# LogLevel debug
RewriteEngine On
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]
SetEnv proxy-nokeepalive 1
ProxyPass / fcgi://localhost:9000/
</VirtualHost>
```

For CentOS/RHEL add in /etc/httpd/conf.d/rgw.conf:

```
<VirtualHost *:80>
ServerName localhost
DocumentRoot /var/www/html
ErrorLog /var/log/httpd/rgw_error.log
CustomLog /var/log/httpd/rgw_access.log combined
# LogLevel debug
RewriteEngine On
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]
SetEnv proxy-nokeepalive 1
ProxyPass / fcgi://localhost:9000/
</VirtualHost>
```

3.

Add the following content in the gateway configuration file: For CentOS/RHEL add in /etc/httpd/conf.d/rgw.conf:

```
<VirtualHost *:80>
ServerName localhost
DocumentRoot /var/www/html
ErrorLog /var/log/httpd/rgw_error.log
CustomLog /var/log/httpd/rgw_access.log combined
# LogLevel debug
RewriteEngine On
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L]
SetEnv proxy-nokeepalive 1
ProxyPass / unix:///var/run/ceph/ceph.radosgw.gateway.fastcgi.sock|fcgi://localhost:9000/
</VirtualHost>
```

4.

Generate a key for radosgw to use for authentication with the cluster.

```
ceph-authtool -C -n client.radosgw.gateway --gen-key /etc/ceph/keyring.radosgw.gateway
ceph-authtool -n client.radosgw.gateway --cap mon 'allow rw' --cap osd 'allow rwx' /etc/ceph/keyring.radosgw.gateway
```

5.

Add the key to the auth entries.

```
ceph auth add client.radosgw.gateway --in-file=keyring.radosgw.gateway
```

6.

Start Apache and radosgw. Debian/Ubuntu:

```
sudo /etc/init.d/apache2 start
sudo /etc/init.d/radosgw start
```

CentOS/RHEL:

```
sudo apachectl start
sudo /etc/init.d/ceph-radosgw start
```

## USAGE LOGGING
radosgw maintains an asynchronous usage log. It accumulates statistics about user operations and flushes it periodically. The logs can be accessed and managed through radosgw-admin.

The information that is being logged contains total data transfer, total operations, and total successful operations. The data is being accounted in an hourly resolution under the bucket owner, unless the operation was done on the service (e.g., when listing a bucket) in which case it is accounted under the operating user.

Following is an example configuration:

```
[client.radosgw.gateway]

    rgw_enable_usage_log = true

    rgw_usage_log_tick_interval = 30

    rgw_usage_log_flush_threshold = 1024

    rgw_usage_max_shards = 32

    rgw_usage_max_user_shards = 1
```

The total number of shards determines how many total objects hold the usage log information. The per-user number of shards specify how many objects hold usage information for a single user. The tick interval configures the number of seconds between log flushes, and the flush threshold specify how many entries can be kept before resorting to synchronous flush.

## AVAILABILITY
radosgw is part of Ceph, a massively scalable, open-source, distributed storage system. Please refer to the Ceph documentation at <https://docs.ceph.com> for more information.

## SEE ALSO
ceph <>(8) radosgw-admin <>(8)

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


rgw-policy-check

title: rgw-policy-check(8)

summary: verify syntax of bucket policy

text:
# rgw-policy-check(8)

## NAME
rgw-policy-check - verify syntax of bucket policy

## SYNOPSIS

```
rgw-policy-check
-t tenant [ filename ... ]
```

## DESCRIPTION
This program reads one or more files containing bucket policy and determines if it is syntactically correct. It does not check to see if the policy makes sense; it only checks to see if the file would be accepted by the policy parsing logic inside radsogw.

More than one filename may be specified. If no files are given, the program will read from stdin.

On success, the program will say nothing. On failure, the program will emit a error message indicating the problem. The program will terminate with non-zero exit status if one or more policies could not be read or parsed.

## AVAILABILITY
rgw-policy-check 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
radosgw <>(8)

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