OpenZFS

https://openzfs.github.io/openzfs-docs
Admin
OpenZFS is an open-source enterprise-grade file system and volume manager offering advanced data...
Tokens:461,915
Snippets:4,407
Trust Score:8.3
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install full GUI environment

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Ubuntu/Ubuntu%2018.04%20Root%20on%20ZFS.html

Installs the full Ubuntu desktop GUI and disables the initial setup screen.

```bash
apt install --yes ubuntu-desktop
vi /etc/gdm3/custom.conf
# In the [daemon] section, add: InitialSetupEnable=false

```

--------------------------------

### Configure network interfaces with setup-interfaces

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Alpine%20Linux/Root%20on%20ZFS.html

Run setup-interfaces with the -r option to start networking services properly. The example shows configuring a wireless interface with DHCP.

```bash
setup-interfaces -r
# You must use "-r" option to start networking services properly
# example:
network interface: wlan0
WiFi name:         <ssid>
ip address:        dhcp
<enter done to finish network config>
manual netconfig:  n

```

--------------------------------

### Install bootloader programs and partition tool

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Alpine%20Linux/Root%20on%20ZFS.html

Install parted, e2fsprogs, cryptsetup, and util-linux for partitioning and bootloader setup.

```bash
apk add parted e2fsprogs cryptsetup util-linux

```

--------------------------------

### Install and start OpenSSH server

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Debian/Debian%20Bullseye%20Root%20on%20ZFS.html

Install and start the OpenSSH server in the Live CD environment to allow remote access. After installation, the SSH service is restarted. The hint suggests finding your IP with `ip addr show scope global | grep inet` and connecting with `ssh user@IP`.

```bash
sudo apt install --yes openssh-server

sudo systemctl restart ssh

```

--------------------------------

### Install and start OpenSSH server

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Debian/Debian%20Trixie%20Root%20on%20ZFS.html

Install the OpenSSH server and restart the SSH service to enable remote access.

```bash
sudo apt install --yes openssh-server

sudo systemctl restart ssh
```

--------------------------------

### Set up apk repositories with setup-apkrepos

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Alpine%20Linux/Root%20on%20ZFS.html

Run setup-apkrepos to configure the apk repositories. A list of available mirrors is shown; press space bar to continue.

```bash
setup-apkrepos

```

--------------------------------

### Install systemd-boot with bootctl install

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/openSUSE/openSUSE%20Leap%20Root%20on%20ZFS.html

Installs systemd-boot. If the command fails with 'Failed to get machine id: No medium found', run 'systemd-machine-id-setup' first and then repeat the installation.

```bash
bootctl install

```

--------------------------------

### Install and start OpenSSH server

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Ubuntu/Ubuntu%2018.04%20Root%20on%20ZFS.html

Sets a password for the ubuntu user and installs openssh-server for remote access.

```bash
passwd
# There is no current password; hit enter at that prompt.
sudo apt install --yes openssh-server

```

--------------------------------

### Set up basic system environment

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Ubuntu/Ubuntu%2018.04%20Root%20on%20ZFS.html

Create a symlink for /etc/mtab and update the package list. Then reconfigure locales and timezone, ensuring en_US.UTF-8 is available. Optionally install nano.

```bash
ln -s /proc/self/mounts /etc/mtab
apt update

```

```bash
dpkg-reconfigure locales
dpkg-reconfigure tzdata

```

```bash
apt install --yes nano

```

--------------------------------

### Install documentation tools

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Arch%20Linux/index.html

Install the documentation build tools and add the local bin directory to your PATH. Run these commands after cloning the repository.

```bash
sudo pacman -S --needed python-pip make

pip3 install -r docs/requirements.txt

# Add ~/.local/bin to your "${PATH}", e.g. by adding this to ~/.bashrc:
[ -d "${HOME}"/.local/bin ] && export PATH="${HOME}"/.local/bin:"${PATH}"

```

--------------------------------

### Install ZFS prerequisites

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Debian/Debian%20Trixie%20Root%20on%20ZFS.html

Install debootstrap, gdisk, and zfsutils-linux in the live environment.

```bash
apt install --yes debootstrap gdisk zfsutils-linux
```

--------------------------------

### Booting from snapshot with root=ZFS=

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Debian/Debian%20GNU%20Linux%20initrd%20documentation.html

Boot parameter example for booting from a snapshot. The root=ZFS= parameter specifies the snapshot to clone and use as root filesystem.

```text
linux   /BOOT/debian@/boot/vmlinuz-5.10.0-9-amd64 root=ZFS=rpool/ROOT/debian@some_snapshot ro

```

--------------------------------

### Snapshot initial installation

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Debian/Debian%20Bullseye%20Root%20on%20ZFS.html

Creates initial snapshots of the boot and root datasets before the first boot. Useful for rollback after upgrades; old snapshots should be removed later to save space.

```bash
zfs snapshot bpool/BOOT/debian@install
zfs snapshot rpool/ROOT/debian@install

```

--------------------------------

### Install enhanced_base pattern (desktop)

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/openSUSE/openSUSE%20Leap%20Root%20on%20ZFS.html

Installs the enhanced_base pattern for a desktop setup. May include extra packages that can be considered bloat.

```bash
zypper --root /mnt install -t pattern enhanced_base

```

--------------------------------

### Snapshot initial installation

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Debian/Debian%20Buster%20Root%20on%20ZFS.html

Creates snapshots of the initial installation for bpool and rpool. Useful before upgrades; old snapshots should be removed later to save space.

```bash
zfs snapshot bpool/BOOT/debian@install
zfs snapshot rpool/ROOT/debian@install
```

--------------------------------

### Install base pattern (server)

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/openSUSE/openSUSE%20Leap%20Root%20on%20ZFS.html

Installs the base pattern for a server setup. Avoids busybox-grep which masks the default kernel package.

```bash
zypper --root /mnt install -t pattern base

```

--------------------------------

### Build and view documentation

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Arch%20Linux/index.html

Build the HTML documentation and open it in your default browser. Run these commands from the repository root after making changes.

```bash
cd docs
make html
sensible-browser _build/html/index.html

```

--------------------------------

### Install ZFS in Live CD environment

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Debian/Debian%20Buster%20Root%20on%20ZFS.html

Install ZFS in the Live CD environment. The dkms dependency is installed manually from buster (not buster-backports) to avoid issues. The module must be built and loaded before installing zfsutils-linux, otherwise zfs-mount.service will fail to start.

```bash
apt install --yes debootstrap gdisk dkms dpkg-dev linux-headers-amd64

apt install --yes -t buster-backports --no-install-recommends zfs-dkms

modprobe zfs
apt install --yes -t buster-backports zfsutils-linux

```

--------------------------------

### Install ZFS support from live media

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Alpine%20Linux/Root%20on%20ZFS.html

Install the ZFS package from the live media to enable ZFS support.

```bash
apk add zfs

```

--------------------------------

### Chroot into installed environment

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Ubuntu/Ubuntu%2020.04%20Root%20on%20ZFS.html

Chroots into the installed environment after mounting the ZFS pools. Mounts necessary filesystems and runs mount -a to complete the setup.

```bash
mount --make-private --rbind /dev  /mnt/dev
mount --make-private --rbind /proc /mnt/proc
mount --make-private --rbind /sys  /mnt/sys
mount -t tmpfs tmpfs /mnt/run
mkdir /mnt/run/lock
chroot /mnt /bin/bash --login
mount -a

```

--------------------------------

### Install ZFS with apt

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Ubuntu/Ubuntu%2020.04%20Root%20on%20ZFS%20for%20Raspberry%20Pi.html

Install ZFS on the Raspberry Pi. On first boot, you may get 'Waiting for cache lock' because unattended-upgrades is running in the background; wait for it to finish.

```bash
apt update

apt install pv zfs-initramfs

```

--------------------------------

### Setup system groups

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Ubuntu/Ubuntu%2020.04%20Root%20on%20ZFS.html

Creates the lpadmin, lxd, and sambashare system groups.

```bash
addgroup --system lpadmin
addgroup --system lxd
addgroup --system sambashare

```

--------------------------------

### Snapshot initial installation

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Debian/Debian%20Stretch%20Root%20on%20ZFS.html

Creates initial snapshots of the boot and root datasets after the first boot. These snapshots can be used to roll back the system to its initial state.

```bash
# zfs snapshot bpool/BOOT/debian@install
# zfs snapshot rpool/ROOT/debian@install
```

--------------------------------

### Setup LUKS Crypttab

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Ubuntu/Ubuntu%2020.04%20Root%20on%20ZFS.html

Install cryptsetup and configure /etc/crypttab for LUKS encrypted partitions.

```bash
apt install --yes cryptsetup

echo luks1 /dev/disk/by-uuid/$(blkid -s UUID -o value ${DISK}-part4) \
    none luks,discard,initramfs > /etc/crypttab
```

--------------------------------

### Install GRUB for UEFI booting

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/openSUSE/openSUSE%20Tumbleweed%20Root%20on%20ZFS.html

Install GRUB for UEFI, create an EFI system partition, mount it, and add it to /etc/fstab.

```bash
zypper install grub2-x86_64-efi dosfstools os-prober
mkdosfs -F 32 -s 1 -n EFI ${DISK}-part2
mkdir /boot/efi
echo /dev/disk/by-uuid/$(blkid -s PARTUUID -o value ${DISK}-part2) \
   /boot/efi vfat defaults 0 0 >> /etc/fstab
mount /boot/efi

```

--------------------------------

### Get kernel version

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/openSUSE/openSUSE%20Leap%20Root%20on%20ZFS.html

Extracts the kernel version from /boot/vmlinuz-* files, used for kernel installation.

```bash
kernel_version=$(find /boot/vmlinuz-* | grep -Eo '[[:digit:]]*\.[[:digit:]]*\.[[:digit:]]*\-.*-default')

```

--------------------------------

### Install and start OpenSSH server

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Ubuntu/Ubuntu%2020.04%20Root%20on%20ZFS.html

Sets a password for the ubuntu user and installs the OpenSSH server and the full vim package. The full vim package fixes terminal problems that occur when using vim-tiny over SSH.

```bash
passwd
# There is no current password.
sudo apt install --yes openssh-server vim

```

--------------------------------

### Install GRUB/Linux/ZFS (UEFI)

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Ubuntu/Ubuntu%2020.04%20Root%20on%20ZFS.html

Install the necessary packages for UEFI booting.

```bash
apt install --yes \
    grub-efi-amd64 grub-efi-amd64-signed linux-image-generic \
    shim-signed zfs-initramfs zsys
```

--------------------------------

### Install and start OpenSSH server in Live CD

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Debian/Debian%20Stretch%20Root%20on%20ZFS.html

Optional step to enable SSH access to the target system from a second machine. Run as a regular user (the prompt shows $). After installation, restart the SSH service.

```bash
$ sudo apt update
$ sudo apt install --yes openssh-server
$ sudo systemctl restart ssh

```

--------------------------------

### Setup /etc/crypttab for LUKS

Source: https://openzfs.github.io/openzfs-docs/Getting%20Started/Debian/Debian%20Bullseye%20Root%20on%20ZFS.html

For LUKS installs only, sets up /etc/crypttab. Installs cryptsetup and cryptsetup-initramfs, then writes a crypttab entry for the LUKS partition. The initramfs option is a work-around for cryptsetup not supporting ZFS. For mirror or raidz topologies, repeat entries for luks2, etc., adjusting for each disk.

```bash
apt install --yes cryptsetup cryptsetup-initramfs

echo luks1 /dev/disk/by-uuid/$(blkid -s UUID -o value ${DISK}-part4) \
    none luks,discard,initramfs > /etc/crypttab

```
Tokens:
Raw