Difference between revisions of "ZFS Install Guide"

Latest revision as of 01:01, 23 May 2013

[edit] Introduction

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the Regular Funtoo Installation. Follow the normal installation and only use this guide for steps 2, 3, and 8.

[edit] Introduction to ZFS

Since ZFS is a new technology for Linux, it can be helpful to understand some of its benefits, particularly in comparison to BTRFS, another popular next-generation Linux filesystem:

• On Linux, the ZFS code can be updated independently of the kernel to obtain the latest fixes. btrfs is exclusive to Linux and you need to build the latest kernel sources to get the latest fixes.

• ZFS is supported on multiple platforms. The platforms with the best support are Solaris, FreeBSD and Linux. Other platforms with varying degrees of support are NetBSD, Mac OS X and Windows. btrfs is exclusive to Linux.

• ZFS has the Adaptive Replacement Cache replacement algorithm while btrfs uses the linux kernel's Last Recently Used replacement algorithm. The former often has an overwhelmingly superior hit rate, which means fewer disk accesses.

• ZFS has the ZFS Intent Log and SLOG devices, which accelerates small synchronous write performance.

• ZFS handles internal fragmentation gracefully, such that you can fill it until 100%. Internal fragmentation in btrfs can make btrfs think it is full at 10%. Btrfs has no automatic rebalancing code, so it requires a manual rebalance to correct it.

• ZFS has raidz, which is like RAID 5/6 (or a hypothetical RAID 7 that supports 3 parity disks), except it does not suffer from the RAID write hole issue thanks to its use of CoW and a variable stripe size. btrfs gained integrated RAID 5/6 functionality in Linux 3.9. However, its implementation uses a stripe cache that can only partially mitigate the effect of the RAID write hole.

• ZFS send/receive implementation supports incremental update when doing backups. btrfs' send/receive implementation requires sending the entire snapshot.

• ZFS supports data deduplication, which is a memory hog and only works well for specialized workloads. btrfs has no equivalent.

• ZFS datasets have a hierarchical namespace while btrfs subvolumes have a flat namespace.

• ZFS has the ability to create virtual block devices called zvols in its namespace. btrfs has no equivalent and must rely on the loop device for this functionality, which is cumbersome.

The only area where btrfs is ahead of ZFS is in the area of small file efficiency. btrfs supports a feature called block suballocation, which enables it to store small files far more efficiently than ZFS. It is possible to use another filesystem (e.g. reiserfs) on top of a ZFS zvol to obtain similar benefits (with arguably better data integrity) when dealing with many small files (e.g. the portage tree).

[edit] Disclaimers

[edit] Video Tutorial

As a companion to the install instructions below, a YouTube video ZFS install tutorial is now available:

[edit] Setting up your environment

In order for us to install Funtoo on ZFS, you will need an environment that provides the ZFS tools. We will be downloading two things:

1. System Rescue CD,
2. ZFS System Rescue Module (SRM)

This is just a file that when combined with System Rescue CD, gives you those tools.

Name: SystemRescueCd-x86-3.5.0 (390 MiB)
Release Date: 2013-03-25
md5sum 48552b9e905872bd5061eb112b73ea20

Funtoo now has mirrored copies of System Rescue CD and the ZFS SRM at the links below.

Download System Rescue CD 3.5.0
Download the ZFS System Rescue Module

Follow the instructions here to download and place the srm into your flash drive.

[edit] Creating partitions

There are two ways to partition your disk: You can use your entire drive and let ZFS automatically partition it for you, or you can do it manually.

We will be showing you how to partition it manually because if you partition it manually you get to create your own layout, you get to have your own separate /boot partition (Which is nice since not every bootloader supports booting from ZFS pools), and you get to boot into RAID10, RAID5 (RAIDZ) pools and any other layouts due to you having a separate /boot partition.

[edit] fdisk (MBR Style)

A Fresh Start:

First lets make sure that the disk is completely wiped from any previous disk labels and partitions. We will also assume that /dev/sda is the target drive.

Command (m for help): o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.

Now that we have a clean drive, we will create the new layout.

Create Partition 1 (boot):

Command: n ↵
Partition type: ↵
Partition number: ↵
First sector: ↵
Last sector: +250M ↵

Create Partition 2 (ZFS):

Command: n ↵
Partition type: ↵
Partition number: ↵
First sector: ↵
Last sector: ↵

Command: t ↵
Partition number: 2 ↵
Hex code: bf ↵

Command: p ↵

Device Boot      Start         End      Blocks   Id  System
/dev/sda1            2048      514047      256000   83  Linux
/dev/sda2          514048  1953525167   976505560   bf  Solaris

[edit] gdisk (GPT Style)

A Fresh Start:

First lets make sure that the disk is completely wiped from any previous disk labels and partitions. We will also assume that /dev/sda is the target drive.

# gdisk /dev/sda

Command: x ↵
Expert command: z ↵
About to wipe out GPT on /dev/sda. Proceed?: y ↵
GPT data structures destroyed! You may now partition the disk using fdisk or other utilities.
Blank out MBR?: y ↵

Now that we have a clean drive, we will create the new layout.

Create Partition 1 (boot):

Command: n ↵
Partition Number: ↵
First sector: ↵
Last sector: +250M ↵
Hex Code: ↵

Create Partition 2 (BIOS Boot Partition):

Command: n ↵
Partition Number: ↵
First sector: ↵
Last sector: +32M ↵
Hex Code: EF02 ↵

Create Partition 3 (ZFS):

Command: n ↵
Partition Number: ↵
First sector: ↵
Last sector: ↵
Hex Code: bf00 ↵

Command: p ↵

Number  Start (sector)    End (sector)  Size       Code  Name
   1            2048          514047   250.0 MiB   8300  Linux filesystem
   2          514048          579583   32.0 MiB    EF02  BIOS boot partition
   3          579584      1953525134   931.2 GiB   BF00  Solaris root

Command: w ↵

[edit] Format your boot volume

Format your separate /boot partition:

# mkfs.ext2 /dev/sda1

[edit] Create the zpool

We will first create the pool. The pool will be named `rpool` and the disk will be aligned to 4096 (using ashift=12)

# zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2

[edit] Create the zfs datasets

We will now create some datasets. For this installation, we will create a small but future proof amount of datasets. We will have a dataset for the OS (/), and your swap. We will also show you how to create some optional datasets: /home, /var, /usr/src, and /usr/portage.

Create some empty containers for organization purposes, and make the dataset that will hold /
# zfs create -o mountpoint=none rpool/ROOT
# zfs create -o mountpoint=/ rpool/ROOT/funtoo

Optional, but recommended datasets: /home, /root
# zfs create -o mountpoint=/home rpool/HOME
# zfs create -o mountpoint=/root rpool/HOME/root

Optional datasets: /usr/src, /var
# zfs create -o mountpoint=none rpool/FUNTOO
# zfs create -o mountpoint=/usr/src rpool/FUNTOO/src
# zfs create -o mountpoint=/var rpool/FUNTOO/var

[edit] Creating a separate portage dataset (optional)

Creating a separate portage dataset could be useful if you would like to keep your portage tree, distfiles (source code files), and packages (your compiled binaries if you have FEATURES="buildpkg" enabled) in a safe place (or if you want to back up this directory up easily). This requires a few extra steps because we can't just do a regular emerge --sync when we initially chroot. We will need to download a portage snapshot tarball and extract it into the directory. The required steps for getting and extracting the snapshot will be shown later on in the guide once you chroot into the environment.

For now just create the datasets:

# zfs create -o mountpoint=/usr/portage -o compression=off rpool/FUNTOO/portage
# zfs create -o mountpoint=/usr/portage/distfiles -o compression=off rpool/FUNTOO/distfiles

[edit] Create your swap zvol

Make your swap +1G greater than your RAM. An 8G machine would have 9G of SWAP (This is kinda big though).

# zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap

[edit] Format your swap zvol

# mkswap -f /dev/zvol/rpool/swap
# swapon /dev/zvol/rpool/swap

[edit] Last minute checks and touches

Check to make sure everything appears fine:

# zpool status
# zfs list

Copy the zpool.cache file to your new environment.

# mkdir -p /mnt/funtoo/etc/zfs
# cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs

Make an empty mtab file

# touch /mnt/funtoo/etc/mtab

Now we will continue to install funtoo.

[edit] Installing Funtoo

Download and install the Funtoo stage3 and continue installation as normal.

Then chroot into your new funtoo environment:

# cd /mnt/funtoo

Mount your boot drive
# mount /dev/sda1 /mnt/funtoo/boot

Bind the kernel related directories
# mount --rbind /proc proc
# mount --rbind /dev dev
# mount --rbind /sys sys

Copy network settings
# cp /etc/resolv.conf etc/
chroot into your new funtoo environment
# env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

[edit] Syncing your portage tree

[edit] If you didn't create a separate portage dataset, then just sync your portage tree as normal.

# emerge --sync

[edit] If you did create a separate portage dataset, let's now get the portage snapshot set up.

Change into your /usr directory
# cd /usr

Download and extract the portage snapshot
# wget http://ftp.osuosl.org/pub/funtoo/funtoo-current/snapshots/portage-latest.tar.xz
# tar xf portage-latest.tar.xz

Change into your portage directory and checkout the funtoo branch
# cd portage
# git checkout funtoo.org

Now sync your portage tree
# emerge --sync

[edit] Kernel Configuration

Tested with kernel 2.6.32, 3.2.34, 3.6.X, 3.7.X, 3.8.X.

When you get up to the kernel, make sure that you disable the CFQ scheduler, and turn on No-op (It's the default one once you disable all schedulers). The reason for this is because ZFS has its own scheduler and the CFQ one conflicts with it. Go to your kernel config, and make sure you have the following: (there should be a /usr/src/linux symlink as well)

ZLIB_INFLATE/DEFLATE must be compiled into the kernel (not as a module).
> ZLIB_INFLATE [=y], ZLIB_DEFLATE [=y]

General setup --->
> [*] Initial RAM filesystem and RAM disk (initramfs/initrd) support
> () Initramfs source file(s)

[*] Enable loadable module support --->
[*] Module unloading

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev

Cryptographic API --->
<*> Deflate compression algorithm
<*> Zlib compression algorithm

* All other drivers required to see your PATA/SATA drives must be compiled in.

Continue and compile/install your kernel:

# make bzImage modules
# make install
# make modules_install

[edit] Installing the ZFS userspace tools

# emerge -av zfs

# zpool status
# zfs list

If everything worked, continue.

[edit] Install the bootloader

[edit] GRUB 2

Before you do this, make sure this checklist is followed:

• Installed kernel and kernel modules
• Installed zfs package from the tree
• /dev, /proc, /sys are mounted in the chroot environment

Once all this is checked, let's install grub2. First we need to enable the "libzfs" use flag so zfs support is compiled for grub2.

# echo "sys-boot/grub libzfs" >> /etc/portage/package.use

Then we will compile grub2:

# emerge -av grub

Once this is done, you can check that grub is version 2.00 by doing the following command:

# grub-install --version
grub-install (GRUB) 2.00

Now try to install grub2:

# grub-install --no-floppy /dev/sda

You should receive the following message

Installation finished. No error reported.

If not, then go back to the above checklist.

[edit] Extlinux

There are four things we need to do for extlinux:

1. Install extlinux bootloader
2. Write the .bin to the front of the target disk
3. Toggle BIOS partition flag
4. Write a extlinux configuration file

First emerge extlinux:

# emerge -av syslinux

Then create a /boot/extlinux directory:

# cd /boot
# mkdir /boot/extlinux

Change into the extlinux dir and install the bootloader:

# cd /boot/extlinux
# extlinux --install .

[edit] MBR

# fdisk /dev/sda

Command: a ↵
Partition number: 1 ↵
Command: w ↵

Printing the fdisk partition layout should show a star next to /dev/sda1:

/dev/sda   *    2048    514047    256000    83    Linux

Flash the .bin to the front of the disk:

# dd conv=notrunc bs=440 count=1 if=/usr/share/syslinux/mbr.bin of=/dev/sda

[edit] GPT

# sgdisk /dev/sda --attributes=1:set:2

Flash the .bin to the front of the disk:

# dd conv=notrunc bs=440 count=1 if=/usr/share/syslinux/gptmbr.bin of=/dev/sda

We will write the extlinux/grub configuration file in the next section.

[edit] Create a boot symlink

We will create a boot symlink so that we can have "consistent" boot configurations without any errors.

# cd /boot
# ln -s . boot

You should now have a symlink called 'boot' inside /boot that points to /boot :).

[edit] Create the initramfs

There are two ways to do this, you can use genkernel, or you can use my bliss initramfs creator. I will show you both.

[edit] genkernel

# emerge -av sys-kernel/genkernel
# genkernel --zfs initramfs

Example: kernel name is: vmlinuz-3.8.5-ALL
initramfs name is: initramfs-genkernel-x86_64-3.8.5-ALL
/boot partition is: /dev/sda1 (on GPT)
pool name is: rpool

genkernel entries need verification grub.cfg:

set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
        insmod part_gpt
        insmod ext2

        set root=(hd0,gpt1)

        linux /boot/vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
        initrd /boot/initramfs-genkernel-x86_64-3.8.5-ALL
}

If you followed the way to set up a separate partition to boot of (/dev/sda1 in this guid) you need to modify the entries in your grub.cfg, since grub will now not search inside zfs:

set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {  
  insmod zfs
  linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet
  initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}

extlinux.conf:

LABEL funtoo
  MENU LABEL Funtoo 3.8.5-ALL
  KERNEL /boot/vmlinuz-3.8.5-ALL
  INITRD /boot/initramfs-genkernel-x86_64-3.8.5-ALL
  APPEND real_root=ZFS=rpool/ROOT/funtoo dozfs=force

[edit] Bliss Initramfs Creator

I've written an ebuild to install the creator for you on your machine. The ebuild is in my overlay so we will first add my overlay to your machine.

First we will clone it to a directory on your machine, let's say "/home/example/overlays/fearedbliss":

# Make the overlays directory if it doesn't exist
# mkdir /home/example/overlays

# Clone my overlay into this directory
# git clone git://github.com/fearedbliss/funtoo-overlay.git

# Rename the "funtoo-overlay" folder to "fearedbliss"
# mv funtoo-overlay fearedbliss

# Add the overlay to your /etc/portage/make.conf so portage knows its existence.
# echo 'PORTDIR_OVERLAY="/home/example/overlays/fearedbliss ${PORTDIR_OVERLAY}"' >> /etc/portage/make.conf

Now you can install the creator with the following command:

# emerge bliss-initramfs

Then go into the install directory, run the script as root, and place it into /boot:

# cd /opt/bliss-initramfs
# ./createInit
# mv initrd-<kernel_name>.img /boot

<kernel_name> is the name of what you selected in the initramfs creator, and the name of the outputted file. Once you do this just go to your bootloader config, and add it in there.

Example: Kernel name is: vmlinuz-3.8.5-ALL
initramfs name is: initrd-3.8.5-ALL.img
/boot partition is: /dev/sda1 (on GPT)
Pool root is: rpool/ROOT/funtoo

grub.cfg:

set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
        insmod part_gpt
        insmod ext2

        set root=(hd0,gpt1)

        linux /boot/vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet
        initrd /boot/initrd-3.8.5-ALL.img
}

extlinux.conf:

LABEL funtoo  
  MENU LABEL Funtoo 3.8.5-ALL  
  KERNEL /boot/vmlinuz-3.8.5-ALL  
  INITRD /boot/initrd-3.8.5-ALL.img  
  APPEND root=rpool/ROOT/funtoo quiet

[edit] Final configuration

[edit] Add the zfs tools to openrc

# rc-update add zfs boot

[edit] Add filesystems to /etc/fstab

# nano /etc/fstab

# <fs>                  <mountpoint>    <type>          <opts>          <dump/pass>
# Do not add the /boot line below if you are using whole-disk zfs
/dev/sda1               /boot           ext2            defaults        0 2
/dev/zvol/rpool/swap    none            swap            sw              0 0

[edit] Clean up and reboot

We are almost done, we are just going to clean up, set our root password, and unmount whatever we mounted and get out.

Delete the stage3/portage tarballs you downloaded earlier so they don't take up space.
# cd /
# rm stage3-latest.tar.xz
# rm /usr/portage-latest.tar.xz

Set your root password
# passwd
>> Enter your password, you won't see what you are writing (for security reasons), but it is there!

Get out of the chroot environment
# exit

Unmount all the kernel filesystem stuff and boot (if you have a separate /boot)
# cd /mnt/funtoo
# umount -l proc dev sys boot

Turn off the swap
# swapoff /dev/zvol/rpool/swap

Export the zpool
# cd /
# zpool export -f rpool

Reboot
# reboot

and that should be enough to get your system to boot on ZFS.

[edit] Extra: After reboot

After you restart your machine and your inside your desktop, continue to set up anything you need in terms of /etc configurations. Once you have everything the way you like it, take a snapshot of your system. You will be using this snapshot to revert back to this state if anything ever happens to your system down the road. The snapshots are cheap, and almost instant.

To take the snapshot of your rootfs, type the following:

# zfs snapshot rpool/ROOT/funtoo@install

To see if your snapshot was taken, type:

# zfs list -t snapshot

If your machine ever fails and you need to get back to this state, just type:

# zfs rollback rpool/ROOT/funtoo@install

[edit] Recovery Environment

On ZFS it is extremely easy to create a recovery environment using an already working snapshot. So that's what we will be doing. Create a clone of the @install snapshot which you will use for recovery purposes. If something happens to your main install, you can boot into this clone and fix the main one. One of the differences (maybe the only difference) between a clone and a snapshot is that a clone is rewritable while a snapshot is only read-only.

# zfs clone rpool/ROOT/funtoo@install rpool/ROOT/recovery

[edit] Add the clone to your grub.cfg

set timeout=3
set default=0

# Funtoo Recovery
menuentry "Funtoo Recovery - 3.7.3" {  
  insmod zfs
  linux /ROOT/funtoo/@/boot/vmlinuz-3.7.3-ALL root=rpool/ROOT/recovery quiet
  initrd /ROOT/funtoo/@/boot/initrd-3.7.3-ALL.img
}

[edit] Add the clone to your extlinux.conf

LABEL funtoo-recovery    
  MENU LABEL Funtoo Recovery    
  KERNEL /boot/vmlinuz-3.7.3-ALL    
  INITRD /boot/initrd-3.7.3-ALL.img    
  APPEND root=rpool/ROOT/recovery

[edit] Things to watch out for

Since your recovery clone will tend to get old as you use your main system, and since your recovery and other stuff are on the same pool, we don't want the new pool stuff to be mounted when we launch recovery. We also don't want video drivers to be conflicting.

1. Make sure that nvidia/nouveau stuff are blacklisted.
2. Make sure that your /boot and /lib/modules for the kernel in your 'recovery' are matching.
3. Disable the zfs openrc script so that nothing else gets automatically mounted. Only your rootfs.

You can do the above stuff by mounting your copy and chrooting into it.

Mount the recovery clone
# mkdir /mnt/recovery
# mount -t zfs -o zfsutil rpool/ROOT/recovery /mnt/recovery
# cd /mnt/recovery

Mount the kernel devices
# mount --rbind /proc ./proc
# mount --rbind /dev ./dev
# mount --rbind /sys ./sys

Copy zpool.cache
# cp /etc/zfs/zpool.cache etc/zfs

Chroot into the new environment
# env -i HOME=/root TERM=$TERM chroot . bash --login

Disable zfs/zfs-shutdown openrc scripts
# rc-config delete zfs boot

Blacklist nouveau/nvidia drivers
# echo "blacklist nouveau" >> /etc/modprobe.d/blacklist.conf
# echo "blacklist nvidia" >> /etc/modprobe.d/blacklist.conf

Once you are done doing your changes, just umount and exit the chroot:

# cd /
# umount -l proc dev sys
# exit

[edit] Getting into the recovery

Just start your machine and pick the Funtoo Recovery option from the Boot Menu.

Enjoy your new install on ZFS :)