From 7a2e324a6e1c3e145d3b1e04e6f006defbe0e0b4 Mon Sep 17 00:00:00 2001 From: N Balachandran Date: Wed, 13 Mar 2024 17:27:49 +0530 Subject: [PATCH] doc/rbd: add map information for clone images to rbd-encryption.rst Add information on the arguments required when mapping the formatted clone of an encrypted parent image. Co-authored-by: Zac Dover Signed-off-by: N Balachandran --- doc/rbd/rbd-encryption.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/rbd/rbd-encryption.rst b/doc/rbd/rbd-encryption.rst index 3f37a8b1cf857..a13839efe0776 100644 --- a/doc/rbd/rbd-encryption.rst +++ b/doc/rbd/rbd-encryption.rst @@ -240,6 +240,18 @@ The same applies to creating a formatted clone of an unformatted (plaintext) image since an unformatted image does not have a header at all. +To map a formatted clone, provide encryption formats and passphrases +for the clone itself and all of its explicitly formatted parent images. +The order in which ``encryption-format`` and ``encryption-passphrase-file`` +options should be provided is based on the image hierarchy: start with +that of the cloned image, then its parent and so on. + +Here is an example of a command that maps a formatted clone: + +.. prompt:: bash # + + rbd device map -t nbd -o encryption-passphrase-file=clone-passphrase.bin -o encryption-passphrase-file=passphrase.bin mypool/myclone + .. _journal feature: ../rbd-mirroring/#enable-image-journaling-feature .. _Supported Formats: #supported-formats .. _rbd-nbd: ../../man/8/rbd-nbd -- 2.39.5