From ee5c6fdfa43797b53591255cf52b0f4a961849b4 Mon Sep 17 00:00:00 2001 From: Ilya Dryomov Date: Fri, 7 Nov 2025 20:05:22 +0100 Subject: [PATCH] doc/rbd/rbd-config-ref: add clone settings section Expose rbd_default_clone_format option which has a fairly comprehensive description (much more verbose than most other options, anyway). This should help with understanding the difference between clone v1 and v2. Signed-off-by: Ilya Dryomov --- doc/rbd/rbd-config-ref.rst | 5 +++++ src/common/options/rbd.yaml.in | 10 +++++----- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/doc/rbd/rbd-config-ref.rst b/doc/rbd/rbd-config-ref.rst index c21731adca8a9..d6d5b68c57a0c 100644 --- a/doc/rbd/rbd-config-ref.rst +++ b/doc/rbd/rbd-config-ref.rst @@ -212,6 +212,11 @@ creating images or the default features can be configured via :KRBD support: no +Clone Settings +============== + +.. confval:: rbd_default_clone_format + QoS Settings ============ diff --git a/src/common/options/rbd.yaml.in b/src/common/options/rbd.yaml.in index a86a2e9730462..b12e2edc44e96 100644 --- a/src/common/options/rbd.yaml.in +++ b/src/common/options/rbd.yaml.in @@ -514,12 +514,12 @@ options: type: str level: advanced desc: default internal format for handling clones - long_desc: This sets the internal format for tracking cloned images. The setting - of '1' requires attaching to protected snapshots that cannot be removed until - the clone is removed/flattened. The setting of '2' will allow clones to be attached + long_desc: This sets the internal format for tracking cloned images. The value + of ``1`` requires attaching to protected snapshots that cannot be removed until + the clone is removed or flattened. The value of ``2`` will allow clones to be attached to any snapshot and permits removing in-use parent snapshots but requires Mimic - or later clients. The default setting of 'auto' will use the v2 format if the - cluster is configured to require mimic or later clients. + or later clients. The default value of ``auto`` will use the v2 format if the + cluster is configured to require Mimic or later clients. default: auto services: - rbd -- 2.39.5