[zfs] Add README.md with some implementation notes

This commit is contained in:
dalto 2021-11-16 18:16:32 -06:00
parent 7e17106f34
commit c70e31a919

14
src/modules/zfs/README.md Normal file
View File

@ -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