From c70e31a919fe1481dae54af3bbd61030573c5d15 Mon Sep 17 00:00:00 2001 From: dalto Date: Tue, 16 Nov 2021 18:16:32 -0600 Subject: [PATCH] [zfs] Add README.md with some implementation notes --- src/modules/zfs/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 src/modules/zfs/README.md diff --git a/src/modules/zfs/README.md b/src/modules/zfs/README.md new file mode 100644 index 000000000..0114865a0 --- /dev/null +++ b/src/modules/zfs/README.md @@ -0,0 +1,14 @@ +## zfs Module Notes + +There are a few considerations to be aware of when enabling the zfs module +* You must provide zfs kernel modules or kernel support on the ISO for the zfs module to function +* Support for zfs in the partition module is conditional on the zfs module being enabled +* If you use grub with zfs, you must have `ZPOOL_VDEV_NAME_PATH=1` in your environment when running grub-install or grub-mkconfig. + * Calamares will ensure this happens during the bootloader module. + * It will also add it to `/etc/environment` so it will be available in the installation + * If you have an scripts or other processes that trigger grub-mkconfig during the install process, be sure to add that to the environnent +* In most cases, you will need to enable services for zfs support appropriate to your distro. For example, when testing on Arch the following services were enabled: + * zfs.target + * zfs-import-cache + * zfs-mount + * zfs-import.target