Skip to content

Commit 7a2e324

Browse files
nbalachazdover23
andcommitted
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 <[email protected]> Signed-off-by: N Balachandran <[email protected]>
1 parent e08c812 commit 7a2e324

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

doc/rbd/rbd-encryption.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,18 @@ The same applies to creating a formatted clone of an unformatted
240240
(plaintext) image since an unformatted image does not have a header at
241241
all.
242242

243+
To map a formatted clone, provide encryption formats and passphrases
244+
for the clone itself and all of its explicitly formatted parent images.
245+
The order in which ``encryption-format`` and ``encryption-passphrase-file``
246+
options should be provided is based on the image hierarchy: start with
247+
that of the cloned image, then its parent and so on.
248+
249+
Here is an example of a command that maps a formatted clone:
250+
251+
.. prompt:: bash #
252+
253+
rbd device map -t nbd -o encryption-passphrase-file=clone-passphrase.bin -o encryption-passphrase-file=passphrase.bin mypool/myclone
254+
243255
.. _journal feature: ../rbd-mirroring/#enable-image-journaling-feature
244256
.. _Supported Formats: #supported-formats
245257
.. _rbd-nbd: ../../man/8/rbd-nbd

0 commit comments

Comments
 (0)