mirror_zfs

mirror of https://git.proxmox.com/git/mirror_zfs.git synced 2025-10-25 01:14:59 +03:00

History

Savyasachee Jha 5eae5a88b2 Multiple dracut module install script cleanups - Replaced intances of `dracut_install` with `inst_simple` - Removed calls to `test -x mark_hostonly` because the function is an inbuilt dracut function - Removed redundant installation of `systemd-ask-password` and `systemd-tty-ask-password-agent` because they are already installed by the systemd module. There is no need to install them again - Removed multiple calls to the `mark_hostonly` function because the `inst_simple` has a command-line switch for it - Cleaned up the installation of the `zpool.cache`, `vdev_id.conf` and `hostid` files to make the logic easier to follow - Cleaned up and simplified the systemd service installation logic by invoking systemctl instead of creating symlinks manually - Replaced various hard-coded paths with dracut equivalents to better conform with expected dracut behaviour - Removed redundant call to `mkdir` (`inst_simple` creates the parent directory if it does not exist on the destination initrd) Reviewed-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Reviewed-by: Andrew J. Hesford <ajh@sideband.org> Signed-off-by: Savyasachee Jha <hi@savyasacheejha.com> Closes #13010		2022-02-16 15:28:18 -08:00
..
02zfsexpandknowledge	Add `--enable=all` to ShellCheck by default	2022-02-07 11:59:09 -08:00
90zfs	Multiple dracut module install script cleanups	2022-02-16 15:28:18 -08:00
Makefile.am	contrib: rename initrd READMEs to README.md	2022-02-11 11:44:27 -08:00
README.md	contrib: rename initrd READMEs to README.md	2022-02-11 11:44:27 -08:00

README.md

Basic setup

Install zfs-dracut
Set mountpoint=/ for your root dataset (for compatibility, legacy also works, but is not recommended for new installations):
```
zfs set mountpoint=/ pool/dataset
```
Either (a) set bootfs= on the pool to the dataset:
```
zpool set bootfs=pool/dataset pool
```
Or (b) append root=zfs:pool/dataset to your kernel cmdline.
Re-generate your initrd and update it in your boot bundle

Encrypted datasets have keys loaded automatically or prompted for.

If the root dataset contains children with mountpoint=s of /etc, /bin, /lib*, or /usr, they're mounted too.

cmdline

`root=`	Root dataset is…	Pools imported
(empty)	the first `bootfs=` after `zpool import -aN`	all
`zfs:AUTO`	(as above, but overriding other autoselection methods)	all
`ZFS=pool/dataset`	`pool/dataset`	`pool`
`zfs:pool/dataset`	(as above)	`pool`

All +es are replaced with spaces (i.e. to boot from root pool/data set, pass root=zfs:root+pool/data+set).

The dataset can be at any depth, including being the pool's root dataset (i.e. root=zfs:pool).

spl_hostid: passed to zgenhostid -f, useful to override the /etc/hostid file baked into the initrd.
bootfs.snapshot, bootfs.snapshot=snapshot-name: enables zfs-snapshot-bootfs.service, which creates a snapshot $root_dataset@$(uname -r) (or, in the second form, $root_dataset@snapshot-name) after pool import but before the rootfs is mounted. Failure to create the snapshot is noted, but booting continues.
bootfs.rollback, bootfs.rollback=snapshot-name: enables zfs-snapshot-bootfs.service, which -Rf rolls back to $root_dataset@$(uname -r) (or, in the second form, $root_dataset@snapshot-name) after pool import but before the rootfs is mounted. Failure to roll back will fall down to the rescue shell. This has obvious potential for data loss: make sure your persistent data is not below the rootfs and you don't care about any intermediate snapshots.
If both bootfs.snapshot and bootfs.rollback are set, bootfs.rollback is ordered after bootfs.snapshot.
zfs_force, zfs.force, zfsforce: add -f to all zpool import invocations. May be useful. Use with caution.