This change adds a new section describing how to use ZFS native encryption including examples to the handbook. It is based on my own training material, the open-zfs.org documentation on the subject and the corresponding man pages (zfs load-key, zfs unload-key). Then I ran my writeup through an AI for grammar, typo and active voice fixes, instructing it to not make any changes to the text itself.
Details
- apply the patch to the handbook
- View the output (new section 23.6)
- Comment or approve
Diff Detail
- Repository
- R9 FreeBSD doc repository
- Lint
Lint Skipped - Unit
Tests Skipped
Event Timeline
| documentation/content/en/books/handbook/zfs/_index.adoc | ||
|---|---|---|
| 2669 ↗ | (On Diff #180780) | Isn't this a contradiction to the line above if encryption applies to datasets and not pools regardless of the bootablity? |
| 2722 ↗ | (On Diff #180780) | The title text should be uppercase: Creating an Encrypted Dataset |
| 2753 ↗ | (On Diff #180780) | Ditto |
| 2793 ↗ | (On Diff #180780) | You should either consistently write "cannot" or "can not", but do not mix. |
Thanks for the comments, @michaelo . I'll update the patch to reflect your suggested changes.
| documentation/content/en/books/handbook/zfs/_index.adoc | ||
|---|---|---|
| 2669 ↗ | (On Diff #180780) | This is more about the loader not being able to start from an encrypted dataset. The pool may not be encrypted itself, but if the root-dataset is encrypted, FreeBSD won't be able to start. Would it help if I rewrite it to this:
? |
| 2722 ↗ | (On Diff #180780) | Right, I'll fix this inconsistency here and below. Thanks for noticing! |
| 2793 ↗ | (On Diff #180780) | Good catch, I'll make sure that I fix this in the next update. |
| documentation/content/en/books/handbook/zfs/_index.adoc | ||
|---|---|---|
| 2669 ↗ | (On Diff #180780) | But my problem still holds: The encrytion applies to datasets, not pools. So one needs to say that FreeBSD's loader cannot boot from encrypted datasets? |