From 46babe80b638eb607e2af6f0c8bb77e675d4d63b Mon Sep 17 00:00:00 2001 From: Alfredo Deza Date: Mon, 22 Jan 2018 11:41:32 -0500 Subject: [PATCH] doc/dev/ceph-volume update internal LVM metadata information Includes dmcrypt information, and updated key names to reflect current code Signed-off-by: Alfredo Deza --- doc/dev/ceph-volume/lvm.rst | 89 +++++++++++++++++++++++++++---------- 1 file changed, 65 insertions(+), 24 deletions(-) diff --git a/doc/dev/ceph-volume/lvm.rst b/doc/dev/ceph-volume/lvm.rst index f89424a229a..ceac235cdb6 100644 --- a/doc/dev/ceph-volume/lvm.rst +++ b/doc/dev/ceph-volume/lvm.rst @@ -23,7 +23,7 @@ looks like:: ceph.= -All tags are prefixed by the ``ceph`` keyword do claim ownership of that +All tags are prefixed by the ``ceph`` keyword to claim ownership of that namespace and make it easily identifiable. This is how the OSD ID would be used in the context of lvm tags:: @@ -54,74 +54,115 @@ Example:: ceph.cluster_fsid=7146B649-AE00-4157-9F5D-1DBFF1D52C26 + ``data_device`` --------------- Example:: ceph.data_device=/dev/ceph/data-0 + +``data_uuid`` +------------- +Example:: + + ceph.data_uuid=B76418EB-0024-401C-8955-AE6919D45CC3 + + ``journal_device`` ------------------ Example:: ceph.journal_device=/dev/ceph/journal-0 + +``journal_uuid`` +---------------- +Example:: + + ceph.journal_uuid=2070E121-C544-4F40-9571-0B7F35C6CB2B + + ``encrypted`` ------------- Example for enabled encryption with ``luks``:: - ceph.encrypted=luks - -For plain dmcrypt:: + ceph.encrypted=1 - ceph.encrypted=dmcrypt - -For disabled encryption:: +When encryption is not supported or simply disabled:: ceph.encrypted=0 + ``osd_fsid`` ------------ Example:: ceph.osd_fsid=88ab9018-f84b-4d62-90b4-ce7c076728ff + ``osd_id`` ---------- Example:: ceph.osd_id=1 -``block`` ---------- -Just used on :term:`bluestore` backends. + +``block_device`` +---------------- +Just used on :term:`bluestore` backends. Captures the path to the logical +volume path. Example:: - ceph.block=/dev/mapper/vg-block-0 + ceph.block_device=/dev/mapper/vg-block-0 + -``db`` ------- -Just used on :term:`bluestore` backends. +``block_uuid`` +-------------- +Just used on :term:`bluestore` backends. Captures either the logical volume UUID or +the partition UUID. Example:: - ceph.db=/dev/mapper/vg-db-0 + ceph.block_uuid=E5F041BB-AAD4-48A8-B3BF-31F7AFD7D73E -``wal`` -------- -Just used on :term:`bluestore` backends. + +``db_device`` +------------- +Just used on :term:`bluestore` backends. Captures the path to the logical +volume path. Example:: - ceph.wal=/dev/mapper/vg-wal-0 + ceph.db_device=/dev/mapper/vg-db-0 -``lockbox_device`` ------------------- -Only used when encryption is enabled, to store keys in an unencrypted -volume. +``db_uuid`` +----------- +Just used on :term:`bluestore` backends. Captures either the logical volume UUID or +the partition UUID. + +Example:: + + ceph.db_uuid=F9D02CF1-31AB-4910-90A3-6A6302375525 + + +``wal_device`` +-------------- +Just used on :term:`bluestore` backends. Captures the path to the logical +volume path. + +Example:: + + ceph.wal_device=/dev/mapper/vg-wal-0 + + +``wal_uuid`` +------------ +Just used on :term:`bluestore` backends. Captures either the logical volume UUID or +the partition UUID. Example:: - ceph.lockbox_device=/dev/mapper/vg-lockbox-0 + ceph.wal_uuid=A58D1C68-0D6E-4CB3-8E99-B261AD47CC39 -- 2.39.5