doc/rbd: Document new RBD feature flags and librbd/krbd version support

Sources:

layering:

* https://github.com/ceph/ceph/commit/f87c441f6891e5e72d5e712d9a19e45a1b9a97eb
* krbd: https://github.com/torvalds/linux/commit/770eba6e295fd36e43881176ee0644b9cc2803f1

striping:

* https://github.com/ceph/ceph/commit/2e403ef2c98bb64220060c06b435fb1ffe08294e
* krbd: https://github.com/torvalds/linux/commit/770eba6e295fd36e43881176ee0644b9cc2803f1

exclusive-lock:

* https://github.com/ceph/ceph/commit/fa96bb4db47c500947efcab51892f45a04b03d30
* krbd: https://github.com/torvalds/linux/commit/ed95b21a4b0a71ef89306cdeb427d53cc9cb343f

object-map:

* https://github.com/ceph/ceph/commit/7e751ce9125cbeb04b9551afff4b91c6255c03f9

fast-diff:

* https://github.com/ceph/ceph/commit/16ad44cebcc5d2464be38b95f16e0d63d2b29ed1

deep-flatten:

* https://github.com/ceph/ceph/commit/b556d3173ae4483e681bb21658a7d484a2627386

journaling:

* https://github.com/ceph/ceph/commit/750771c6ff07f6fcf0235172ec68ff4d907c621d
* not a default: https://github.com/ceph/ceph/blob/1a14963/src/test/cli/rbd/help.t#L229

data-pool:

* https://github.com/ceph/ceph/commit/c5f22900474e0eed88910341de57e17e1cc154f0
* description: https://tracker.ceph.com/issues/17409
* krbd: https://github.com/torvalds/linux/commit/7e97332ea9caad3b7c6d86bc3b982e17eda2f736

operations:

* https://github.com/ceph/ceph/commit/209f6fc5a44e2d068ce0dd8b3e9a25ee700ad0e0
* description: https://github.com/torvalds/linux/commit/e573427a440fd67d3f522357d7ac901d59281948
* krbd: https://github.com/torvalds/linux/commit/e573427a440fd67d3f522357d7ac901d59281948

migrating:

* https://github.com/ceph/ceph/commit/2f7c4ae3fc7ec7a2bfe99e116bf5e4f71f24c6a1

Signed-off-by: Valentin Lorentz <progval+git@progval.net>

diff --git a/doc/rbd/rbd-config-ref.rst b/doc/rbd/rbd-config-ref.rst
index e408c0d5c5aeddcd28b272853a8ba4636db5990a..8fdc8a322fc72a74362c1b9d98b0c32170f5bc5a 100644 (file)
--- a/doc/rbd/rbd-config-ref.rst
+++ b/doc/rbd/rbd-config-ref.rst
@@ -136,8 +136,8 @@ Read-ahead is automatically disabled if caching is disabled.
 :Default: ``50 MiB``
 
 
-RBD Default Features
-====================
+RBD Features
+============
 
 RBD supports advanced features which can be specified via the command line when creating images or the default features can be specified via Ceph config file via 'rbd_default_features = <sum of feature numeric values>' or 'rbd_default_features = <comma-delimited list of CLI values>'
 
@@ -146,24 +146,36 @@ RBD supports advanced features which can be specified via the command line when
 :Description: Layering enables you to use cloning.
 :Internal value: 1
 :CLI value: layering
+:Added in: v0.70 (Emperor)
+:KRBD support: since v3.10
+:Default: yes
 
 ``Striping v2``
 
 :Description: Striping spreads data across multiple objects. Striping helps with parallelism for sequential read/write workloads.
 :Internal value: 2
 :CLI value: striping
+:Added in: v0.70 (Emperor)
+:KRBD support: since v3.10
+:Default: yes
 
 ``Exclusive locking``
 
 :Description: 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. 
 :Internal value: 4
 :CLI value: exclusive-lock
+:Added in: v0.92 (Hammer)
+:KRBD support: since v4.9
+:Default: yes
 
 ``Object map``
 
 :Description: 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.
 :Internal value: 8
 :CLI value: object-map
+:Added in: v0.93 (Hammer)
+:KRBD support: no
+:Default: yes
 
 
 ``Fast-diff``
@@ -171,6 +183,9 @@ RBD supports advanced features which can be specified via the command line when
 :Description: 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.
 :Internal value: 16
 :CLI value: fast-diff
+:Added in: v9.0.1 (Infernalis)
+:KRBD support: no
+:Default: yes
 
 
 ``Deep-flatten``
@@ -178,6 +193,9 @@ RBD supports advanced features which can be specified via the command line when
 :Description: 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.
 :Internal value: 32
 :CLI value: deep-flatten
+:Added in: v9.0.2 (Infernalis)
+:KRBD support: no
+:Default: yes
 
 
 ``Journaling``
@@ -185,6 +203,34 @@ RBD supports advanced features which can be specified via the command line when
 :Description: 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.
 :Internal value: 64
 :CLI value: journaling
+:Added in: v10.0.1 (Jewel)
+:KRBD support: no
+:Default: no
+
+
+``Data pool``
+
+:Description: On erasure-coded pools, the image data block objects need to be stored on a separate pool from the image metadata.
+:Internal value: 128
+:Added in: v11.1.0 (Kraken)
+:KRBD support: since v4.11
+:Default: no
+
+
+``Operations``
+
+:Description: Used to restrict older clients from performing certain maintenance operations against an image (e.g. clone, snap create).
+:Internal value: 256
+:Added in: v13.0.2 (Mimic)
+:KRBD support: since v4.16
+
+
+``Migrating``
+
+:Description: Used to restrict older clients from opening an image when it is in migration state.
+:Internal value: 512
+:Added in: v14.0.1 (Nautilus)
+:KRBD support: no
 
 
 RBD QOS Settings