Project

General

Profile

Actions
Copy link

Documentation #58354

closed

doc/ceph-volume/lvm/encryption.rst is inaccurate -- LUKS version 2 can be used, but the docs say that only LUKS version 1 is used

Added by Zac Dover over 1 year ago. Updated over 1 year ago.

Status:
Resolved
Priority:
Normal
Assignee:
Zac Dover
Category:
-
Target version:
-
% Done:

0%

Spent time:
2:00 h
Tags:
Backport:
Reviewed:
01/16/2023
Affected Versions:
Pull request ID:
49747

Description

Stefan Kooman's email of 20 Dec 2022 to , bearing the subject line "ceph-volume questions / enhancements", contains the following documentation-related complaint:

Wrong docs: The docs claim "only LUKS (version 1) is used". But this
seems no longer to be true in all cases. Modern distros use LUKS version
2 by default. And ceph-volume encryption.py is not explicitly forcing
the LUKS format version, so the default (2) gets used. That does seem to
work fine however, as I've got a test cluster fully encrypted with LUKS
2 OSDs, see:

cryptsetup luksDump
ceph--e3cf57cd--27dc--4cf2--9784--b2b5198dfcbb-osd--block--5a743d7f--2f60--47da--b9f3--46aa6f5df284
LUKS header information
Version: 2

The file relevant to this complaint is doc/ceph-volume/lvm/encryption.rst. The sole contributor to that file is Alfredo Deza. As of 24 Dec 2022, the last time that file was altered was 18 May 2018.

Actions
Copy link
 #1

Updated by Zac Dover over 1 year ago

  • Status changed from Need More Info to Fix Under Review
  • Pull request ID set to 49747

doc/ceph-volume/lvm/encryption.lvm is currently written informally. At some future time, the English in that file should be made clearer and more formal.

Actions
Copy link
 #2

Updated by Zac Dover over 1 year ago

  • Status changed from Fix Under Review to Resolved
  • Reviewed set to 01/16/2023
Actions
Copy link

Also available in: Atom PDF