diff --git a/src/modules/zfs/README.md b/src/modules/zfs/README.md index 9138a0598..1d64e3a89 100644 --- a/src/modules/zfs/README.md +++ b/src/modules/zfs/README.md @@ -6,7 +6,10 @@ 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 + * The zfs kernel module must be loaded prior to the partition module running + * One way to acheive this is by running `modprobe zfs` * Support for zfs in the partition module is conditional on the zfs module being enabled +* The config for the default pools and datasets is configured and described in modules/zfs.conf * 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 diff --git a/src/modules/zfs/zfs.conf b/src/modules/zfs/zfs.conf index f2f8f52b0..e5a0aa348 100644 --- a/src/modules/zfs/zfs.conf +++ b/src/modules/zfs/zfs.conf @@ -10,6 +10,9 @@ poolName: zpcala # A list of options that will be passed to zpool create +# +# Encryption options should generally not be added here since they will be added by +# selecting the encrypt disk option in the partition module poolOptions: "-f -o ashift=12 -O mountpoint=none -O acltype=posixacl -O relatime=on" # A list of options that will be passed to zfs create when creating each dataset @@ -17,6 +20,10 @@ poolOptions: "-f -o ashift=12 -O mountpoint=none -O acltype=posixacl -O relatime datasetOptions: "-o compression=lz4 -o atime=off -o xattr=sa" # An array of datasets that will be created on the zpool mounted at / +# +# This default configuration is commonly used when support for booting more than one distro +# out of a single zpool is desired. If you decide to keep this default configuration, +# you should replace "distro" with an identifier that represents your distro. datasets: - dsName: ROOT mountpoint: none