Project

General

Profile

Documentation #15000

Need better documentation to describe RBD image features

Added by Jason Dillaman about 8 years ago. Updated over 5 years ago.

Status:
Resolved
Priority:
Normal
Target version:
-
% Done:

0%

Tags:
Backport:
Reviewed:
Affected Versions:
Pull request ID:

History

#1 Updated by Jason Dillaman almost 8 years ago

The features can be specified via the command-line when creating images or the default features can be specified in the Ceph config file via 'rbd_default_features = <sum of feature numeric values>' or 'rbd_default_features = <comma-delimited list of CLI feature names>'

  • Layering: Layering enables you to use cloning
    Config numeric value: 1
    CLI value: layering
  • Striping v2: Striping spreads data across multiple objects. Striping helps with parallelism for sequential read/write workloads.
    Config numeric value: 2
    CLI value: striping
  • Exclusive locking: When enabled, it requires a client to get a lock on an object before making a write. Exclusive lock should only be enabled when a single client is accessing an image at the same time.
    Config numeric value: 4
    CLI value: exclusive-lock
  • Object map: Object map support depends on exclusive lock support. Block devices are thin provisioned—​meaning, they only store data that actually exists. Object map support helps track which objects actually exist (have data stored on a drive). Enabling object map support speeds up I/O operations for cloning; importing and exporting a sparsely populated image; and deleting.
    Config numeric value: 8
    CLI value: object-map
  • Fast-diff: Fast-diff support depends on object map support and exclusive lock support. It adds another property to the object map, which makes it much faster to generate diffs between snapshots of an image, and the actual data usage of a snapshot much faster.
    Config numeric value: 16
    CLI value: fast-diff
  • Deep-flatten: Deep-flatten makes rbd flatten work on all the snapshots of an image, in addition to the image itself. Without it, snapshots of an image will still rely on the parent, so the parent will not be delete-able until the snapshots are deleted. Deep-flatten makes a parent independent of its clones, even if they have snapshots.
    Config numeric value: 32
    CLI value: deep-flatten
  • Journaling: Journaling support depends on exclusive lock support. Journaling records all modifications to an image in the order they occur. RBD mirroring utilizes the journal to replicate a crash consistent image to a remote cluster.
    Config numeric value: 64
    CLI value: journaling

#2 Updated by Peter Gervai over 6 years ago

This one definitely should find its way into the documentation! It is very hard to find any info on features, even google fail to help.
Puhleeese?

#3 Updated by Jason Dillaman over 5 years ago

  • Status changed from New to In Progress
  • being worked on by Gaurav Sitlani

#4 Updated by Jason Dillaman over 5 years ago

#5 Updated by Gaurav Sitlani over 5 years ago

  • Assignee set to Gaurav Sitlani

#6 Updated by Jason Dillaman over 5 years ago

  • Status changed from In Progress to Resolved

Also available in: Atom PDF