ceph-volume util.encryption add notes about extra b64decode call for ceph-disk

Signed-off-by: Alfredo Deza <adeza@redhat.com>

diff --git a/src/ceph-volume/ceph_volume/util/encryption.py b/src/ceph-volume/ceph_volume/util/encryption.py
index 174da30e3ef80a6feb90850b6e6b7abe590e205a..0abe9b6c189d0d7f6e9b9c7d77f1225ec25202fc 100644 (file)
--- a/src/ceph-volume/ceph_volume/util/encryption.py
+++ b/src/ceph-volume/ceph_volume/util/encryption.py
@@ -49,6 +49,8 @@ def plain_open(key, device, mapping):
     """
     Decrypt (open) an encrypted device, previously prepared with cryptsetup in plain mode
 
+    .. note: ceph-disk will require an additional b64decode call for this to work
+
     :param key: dmcrypt secret key
     :param device: absolute path to device
     :param mapping: mapping name used to correlate device. Usually a UUID
@@ -71,6 +73,8 @@ def luks_open(key, device, mapping):
     """
     Decrypt (open) an encrypted device, previously prepared with cryptsetup
 
+    .. note: ceph-disk will require an additional b64decode call for this to work
+
     :param key: dmcrypt secret key
     :param device: absolute path to device
     :param mapping: mapping name used to correlate device. Usually a UUID