Bug 1467907

Summary:	Clevis does not document its LUKS unlockers in the man pages
Product:	Red Hat Enterprise Linux 7	Reporter:	Nathaniel McCallum <npmccallum>
Component:	clevis	Assignee:	Nathaniel McCallum <npmccallum>
Status:	CLOSED ERRATA	QA Contact:	Jiri Jaburek <jjaburek>
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	7.4	CC:	dpal, jjaburek
Target Milestone:	rc
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2018-04-10 18:27:23 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Nathaniel McCallum 2017-07-05 13:32:02 UTC

It would be helpful, for example, to know that for unlocking you need to install clevis-dracut or clevis-udisks2. Further, it would be helpful to know that after installing clevis-dracut on a preexisting system, you'll need to run dracut -f.

Comment 4 Nathaniel McCallum 2017-11-27 16:06:08 UTC

The man page section is already fixed upstream. Here is the full text of the paragraph in question:


"After a reboot, Clevis will attempt to unlock all _netdev devices listed in /etc/crypttab when systemd prompts for their passwords. This implies that systemd support for _netdev is required."

What do you think is unclear in the phrase "_netdev devices listed in /etc/crypttab"?

Comment 5 Jiri Jaburek 2017-11-27 20:17:07 UTC

(In reply to Nathaniel McCallum from comment #4)
> The man page section is already fixed upstream. Here is the full text of the
> paragraph in question:
> 
> 
> "After a reboot, Clevis will attempt to unlock all _netdev devices listed in
> /etc/crypttab when systemd prompts for their passwords. This implies that
> systemd support for _netdev is required."
> 
> What do you think is unclear in the phrase "_netdev devices listed in
> /etc/crypttab"?

A system administrator is likely to know the "_netdev" feature of fstab, but not the (new) "_netdev" feature of crypttab. This can lead to misunderstanding of "_netdev devices" as "devices mounted with _netdev in fstab", whereas the proper meaning is "devices with _netdev in crypttab".

This is not a major request or anything (which is why I didn't make a bug out of it), but IMO better wording would be;
"Clevis will attempt to unlock all devices listed in /etc/crypttab with the _netdev option specified, see crypttab(5), when systemd prompts for their passwords."

It is nitpicking a bit, but I've been in those situations several times.

Thanks.

Comment 8 errata-xmlrpc 2018-04-10 18:27:23 UTC

Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2018:0985