Bug 263232 - FreeBSD Handbook: potentially confusing descriptions of UFS and GELI
Summary: FreeBSD Handbook: potentially confusing descriptions of UFS and GELI
Status: Open
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: freebsd-doc (Nobody)
URL: https://github.com/freebsd/freebsd-do...
Keywords: needs-patch
Depends on:
Blocks: handbook-2022
  Show dependency tree / graph
 
Reported: 2022-04-12 04:26 UTC by Graham Perrin
Modified: 2023-10-04 18:37 UTC (History)
1 user (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Graham Perrin freebsd_committer freebsd_triage 2022-04-12 04:26:16 UTC 
From <https://docs.freebsd.org/en/books/handbook/book/#bsdinstall-partitioning>: 

> * Auto (UFS) partitioning automatically sets up the disk partitions 
>   using the UFS file system.
> 
> * …
> 
> * …
> 
> * Auto (ZFS) partitioning creates a root-on-ZFS system with optional 
>   GELI encryption support for boot environments.

UFS is not used for the swap partition, and so on. 

geli(8) is not solely for 'Auto (ZFS)', and is not boot environment-oriented.
Comment 1 Graham Perrin freebsd_committer freebsd_triage 2022-04-12 04:44:35 UTC 
Maybe better, for <https://github.com/freebsd/freebsd-doc/blob/main/documentation/content/en/books/handbook/bsdinstall/_index.adoc#6-allocating-disk-space>: 

> * Auto (UFS) uses UFS for the file system within the system partition.
> 
> * …
> 
> * …
> 
> * Auto (ZFS) uses ZFS for file systems within the system partition.
> 
> The two automatic options allow use of GELI (not ZFS) to encrypt swap and 
> system partitions. For more information about GELI, see …

– and bring forward the 'more info' blurb that's currently under <https://github.com/freebsd/freebsd-doc/blob/main/documentation/content/en/books/handbook/bsdinstall/_index.adoc#64-guided-partitioning-using-root-on-zfs>. 

----

<https://github.com/freebsd/freebsd-doc/blob/main/documentation/content/en/books/handbook/bsdinstall/_index.adoc#85-add-users> should include something like this: 

> If you intend to use OpenZFS encryption for any user's home directory, 
> refrain from adding the user at this stage. 

From <https://openzfs.github.io/openzfs-docs/man/8/zfs-load-key.8.html#Encryption>: 

> … Creating an encrypted dataset requires specifying the encryption and keyformat properties 
> at creation time, …

– at, not after. The installer uses adduser(8), which does not yet support this. 

<https://www.freebsd.org/cgi/man.cgi?query=adduser&sektion=8&manpath=FreeBSD>
Comment 2 Pau Amma 2022-04-15 00:13:19 UTC 
(In reply to Graham Perrin from comment #1)
Do the ZFS parts also apply to pre-OpenZFS releases, that is 12.x?
Comment 3 Graham Perrin freebsd_committer freebsd_triage 2022-04-23 09:03:57 UTC 
(In reply to PauAmma from comment #2)

I believe so. 

Someone else might like to confirm.
Comment 4 Graham Perrin freebsd_committer freebsd_triage 2022-04-23 09:05:42 UTC 
(In reply to Graham Perrin from comment #3)

… the port of OpenZFS can be installed on FreeBSD 12.⋯
Comment 5 Pau Amma 2022-04-24 01:55:17 UTC 
(In reply to Graham Perrin from comment #4)
I meant the ZFS in base r12, which IIRC isn't OpenZFS.