update sources to v12.2.3

[ceph.git] / ceph / doc / ceph-volume / simple / scan.rst

diff --git a/ceph/doc/ceph-volume/simple/scan.rst b/ceph/doc/ceph-volume/simple/scan.rst
index afeddabb86f0d83c456321b0ddac530f42889ce7..320fee8fb453506f761827e7dc7c0dc5c1350c9d 100644 (file)
--- a/ceph/doc/ceph-volume/simple/scan.rst
+++ b/ceph/doc/ceph-volume/simple/scan.rst
@@ -4,7 +4,8 @@
 ========
 Scanning allows to capture any important details from an already-deployed OSD
 so that ``ceph-volume`` can manage it without the need of any other startup
-workflows or tools (like ``udev`` or ``ceph-disk``).
+workflows or tools (like ``udev`` or ``ceph-disk``). Encryption with LUKS or
+PLAIN formats is fully supported.
 
 The command has the ability to inspect a running OSD, by inspecting the
 directory where the OSD data is stored, or by consuming the data partition.
@@ -42,6 +43,12 @@ are a few files that must exist in order to have a successful scan:
 * ``type``
 * ``whoami``
 
+If the OSD is encrypted, it will additionally add the following keys:
+
+* ``encrypted``
+* ``encryption_type``
+* ``lockbox_keyring``
+
 In the case of any other file, as long as it is not a binary or a directory, it
 will also get captured and persisted as part of the JSON object.
 
@@ -53,10 +60,16 @@ would look like::
 
     "whoami": "1",
 
-For files that may have more than one line, the contents are left as-is, for
-example, a ``keyring`` could look like this::
+For files that may have more than one line, the contents are left as-is, except
+for keyrings which are treated specially and parsed to extract the keyring. For
+example, a ``keyring`` that gets read as::
+
+    [osd.1]\n\tkey = AQBBJ/dZp57NIBAAtnuQS9WOS0hnLVe0rZnE6Q==\n
+
+Would get stored as::
+
+    "keyring": "AQBBJ/dZp57NIBAAtnuQS9WOS0hnLVe0rZnE6Q==",
 
-    "keyring": "[osd.1]\n\tkey = AQBBJ/dZp57NIBAAtnuQS9WOS0hnLVe0rZnE6Q==\n",
 
 For a directory like ``/var/lib/ceph/osd/ceph-1``, the command could look
 like::
@@ -64,9 +77,6 @@ like::
     ceph-volume simple scan /var/lib/ceph/osd/ceph1
 
 
-.. note:: There is no support for encrypted OSDs
-
-
 .. _ceph-volume-simple-scan-device:
 
 Device scan
@@ -93,9 +103,6 @@ could look like::
     ceph-volume simple scan /dev/sda1
 
 
-.. note:: There is no support for encrypted OSDs
-
-
 .. _ceph-volume-simple-scan-json:
 
 ``JSON`` contents
@@ -147,7 +154,7 @@ This is a sample ``JSON`` metadata, from an OSD that is using ``bluestore``::
             "uuid": "86ebd829-1405-43d3-8fd6-4cbc9b6ecf96"
         },
         "fsid": "86ebd829-1405-43d3-8fd6-4cbc9b6ecf96",
-        "keyring": "[osd.3]\n\tkey = AQBBJ/dZp57NIBAAtnuQS9WOS0hnLVe0rZnE6Q==\n",
+        "keyring": "AQBBJ/dZp57NIBAAtnuQS9WOS0hnLVe0rZnE6Q==",
         "kv_backend": "rocksdb",
         "magic": "ceph osd volume v026",
         "mkfs_done": "yes",