Difference between revisions of "ZFS Install Guide"

(Install the bootloader)
(Installing the ZFS userspace tools and kernel modules)
 
(166 intermediate revisions by 9 users not shown)
Line 33: Line 33:
 
to obtain similar benefits (with arguably better data integrity) when
 
to obtain similar benefits (with arguably better data integrity) when
 
dealing with many small files (e.g. the portage tree).
 
dealing with many small files (e.g. the portage tree).
 +
 +
For a quick tour of ZFS and have a big picture of its common operations you can consult the page [[ZFS Fun]].
  
 
=== Disclaimers ===
 
=== Disclaimers ===
  
{{fancywarning|This guide is a work in progress. Expect some quirks.}}
+
{{fancywarning|This guide is a work in progress. Expect some quirks.  
{{fancyimportant|'''Since ZFS was really designed for 64 bit systems, we are only recommending and supporting 64 bit platforms and installations. We will not be supporting 32 bit platforms'''!}}
+
  
== Video Tutorial ==
+
Today is 2015-05-12. ZFS has undertaken an upgrade - from 0.6.3 to 0.6.4. Please ensure that you use a RescueCD with ZFS 0.6.3. At present date grub 2.02 is not able to deal with those new ZFS parameters. If you want to use ZFS 0.6.4 for pool creation, you should use the compatability mode.
  
As a companion to the installation instructions below, a YouTube video tutorial is now available:
+
You should upgrade an existing pool only when grub is able to deal with - in a future version ... If not, you will not be able to boot into your system, and no rollback will help!
  
{{#widget:YouTube|id=SWyThdxNoP8|width=640|height=360}}
+
Please inform yourself!}}
  
{{fancyimportant|'''The video and guide are currently out of sync. The video has newer instructions. The guide needs to be updated.'''}}
+
{{fancyimportant|'''Since ZFS was really designed for 64 bit systems, we are only recommending and supporting 64 bit platforms and installations. We will not be supporting 32 bit platforms'''!}}
  
 
== Downloading the ISO (With ZFS) ==
 
== Downloading the ISO (With ZFS) ==
Line 51: Line 52:
  
 
<pre>
 
<pre>
Name: sysresccd-4.0.1_zfs_0.6.2.iso  (545 MB)
+
Name: sysresccd-4.2.0_zfs_0.6.2.iso  (545 MB)
 
Release Date: 2014-02-25
 
Release Date: 2014-02-25
 
md5sum 01f4e6929247d54db77ab7be4d156d85
 
md5sum 01f4e6929247d54db77ab7be4d156d85
Line 67: Line 68:
  
 
Mount the iso
 
Mount the iso
# ##i##mount -o ro,loop /root/sysresccd-4.0.1_zfs_0.6.2.iso /tmp/loop
+
# ##i##mount -o ro,loop /root/sysresccd-4.2.0_zfs_0.6.2.iso /tmp/loop
  
 
Run the usb installer
 
Run the usb installer
Line 145: Line 146:
 
# ##i##mkfs.ext2 -m 1 /dev/sda1
 
# ##i##mkfs.ext2 -m 1 /dev/sda1
 
</console>
 
</console>
 
=== Encryption (Optional) ===
 
If you want encryption, then create your encrypted vault(s) now by doing the following:
 
 
<console>
 
# ##i##cryptsetup luksFormat /dev/sda3
 
# ##i##cryptsetup luksOpen /dev/sda3 vault_1
 
</console>
 
 
{{fancywarning|On some machines, a combination of ZFS and LUKS has caused instability and system crashes.}}
 
  
 
=== Create the zpool ===
 
=== Create the zpool ===
We will first create the pool. The pool will be named `tank` and the disk will be aligned to 4096 (using ashift=12)
+
We will first create the pool. The pool will be named <code>tank</code>. Feel free to name your pool as you want.  We will use <code>ashift=12</code> option  which is used for a hard drives with a 4096 sector size.
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo tank /dev/sda3</console>
+
<console># ##i## zpool create -f -o ashift=12 -o cachefile=/tmp/zpool.cache -O normalization=formD -m none -R /mnt/funtoo tank /dev/sda3 </console>
 
+
{{fancyimportant|If you are using encrypted root, change '''/dev/sda3 to /dev/mapper/vault_1'''.}}
+
 
+
{{fancynote| If you have a previous pool that you would like to import, you can do a: '''zpool import -f -R /mnt/funtoo <pool_name>'''.}}
+
  
 
=== Create the zfs datasets ===
 
=== 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: <tt>/home</tt>, <tt>/var</tt>, <tt>/usr/src</tt>, and <tt>/usr/portage</tt>.
+
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: <code>/home</code>, <code>/usr/src</code>, and <code>/usr/portage</code>.  Notice, datasets are examples only and not strictly required.
  
 
<console>
 
<console>
 
Create some empty containers for organization purposes, and make the dataset that will hold /
 
Create some empty containers for organization purposes, and make the dataset that will hold /
# ##i##zfs create -p tank/funtoo
+
# ##i## zfs create -p tank/funtoo
# ##i##zfs create -o mountpoint=/ tank/funtoo/root
+
# ##i## zfs create -o mountpoint=/ tank/funtoo/root
  
 
Optional, but recommended datasets: /home
 
Optional, but recommended datasets: /home
# ##i##zfs create -o mountpoint=/home tank/funtoo/home
+
# ##i## zfs create -o mountpoint=/home tank/funtoo/home
  
 
Optional datasets: /usr/src, /usr/portage/{distfiles,packages}
 
Optional datasets: /usr/src, /usr/portage/{distfiles,packages}
# ##i##zfs create -o mountpoint=/usr/src tank/funtoo/src
+
# ##i## zfs create -o mountpoint=/usr/src tank/funtoo/src
# ##i##zfs create -o mountpoint=/usr/portage -o compression=off tank/funtoo/portage
+
# ##i## zfs create -o mountpoint=/usr/portage -o compression=off tank/funtoo/portage
# ##i##zfs create -o mountpoint=/usr/portage/distfiles tank/funtoo/portage/distfiles
+
# ##i## zfs create -o mountpoint=/usr/portage/distfiles tank/funtoo/portage/distfiles
# ##i##zfs create -o mountpoint=/usr/portage/packages tank/funtoo/portage/packages
+
# ##i## zfs create -o mountpoint=/usr/portage/packages tank/funtoo/portage/packages
 
</console>
 
</console>
 
=== Create your swap zvol ===
 
For modern machines that have greater than 4 GB of RAM, A swap size of 2G should be enough. However if your machine doesn't have a lot of RAM, the rule of thumb is either 2x the RAM or RAM + 1 GB.
 
 
For this tutorial we will assume that it is a newer machine and make a 2 GB swap.
 
 
<console>
 
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 2G tank/swap
 
</console>
 
 
=== Format your swap zvol ===
 
<console>
 
# ##i##mkswap -f /dev/zvol/tank/swap
 
# ##i##swapon /dev/zvol/tank/swap
 
</console>
 
 
Now we will continue to install funtoo.
 
  
 
== Installing Funtoo ==
 
== Installing Funtoo ==
Line 213: Line 183:
  
 
[[Funtoo_Linux_Installation|Now download and extract the Funtoo stage3 ...]]
 
[[Funtoo_Linux_Installation|Now download and extract the Funtoo stage3 ...]]
 +
 +
 +
{{fancynote|It is trully recommended to use the current version and generic64. That reduces the risk of a broken build.
 +
 +
After successfull ZFS installation and successfull first boot, the kernel may be changed using the <code> eselect profile set ... </code> command. If you create a snapshot before, you may allways come back to your previous installation, with some simple steps ... (rollback your pool and in the worst case configure and install the bootloader again)}}
 +
 +
  
 
Once you've extracted the stage3, do a few more preparations and chroot into your new funtoo environment:
 
Once you've extracted the stage3, do a few more preparations and chroot into your new funtoo environment:
Line 227: Line 204:
 
Make the zfs folder in 'etc' and copy your zpool.cache
 
Make the zfs folder in 'etc' and copy your zpool.cache
 
# ##i##mkdir etc/zfs
 
# ##i##mkdir etc/zfs
# ##i##cp /etc/zfs/zpool.cache etc/zfs
+
# ##i##cp /tmp/zpool.cache etc/zfs
  
 
Chroot into Funtoo
 
Chroot into Funtoo
Line 233: Line 210:
 
</console>
 
</console>
  
=== In Chroot ===
+
{{fancynote|How to create zpool.cache file?}}
 
+
If no <code>zpool.cache</code> file is available, the following command will create one:
 
<console>
 
<console>
Create a symbolic link to your mountpoints
+
# ##i##zpool set cachefile=/etc/zfs/zpool.cache tank
# ##i##ln -sf /proc/mounts /etc/mtab
+
 
+
Sync your tree
+
# ##i##emerge --sync
+
 
</console>
 
</console>
 +
 +
{{:Install/PortageTree}}
  
 
=== Add filesystems to /etc/fstab ===
 
=== Add filesystems to /etc/fstab ===
  
Before we continue to compile and or install our kernel in the next step, we will edit the <tt>/etc/fstab</tt> file because if we decide to install our kernel through portage, portage will need to know where our <tt>/boot</tt> is, so that it can place the files in there.  
+
Before we continue to compile and or install our kernel in the next step, we will edit the <code>/etc/fstab</code> file because if we decide to install our kernel through portage, portage will need to know where our <code>/boot</code> is, so that it can place the files in there.  
  
Edit <tt>/etc/fstab</tt>:
+
Edit <code>/etc/fstab</code>:
  
<pre>
+
{{file|name=/etc/fstab|desc= |body=
 
# <fs>                  <mountpoint>    <type>          <opts>          <dump/pass>
 
# <fs>                  <mountpoint>    <type>          <opts>          <dump/pass>
  
 
/dev/sda1              /boot          ext2            defaults        0 2
 
/dev/sda1              /boot          ext2            defaults        0 2
/dev/zvol/tank/swap    none            swap            sw              0 0
+
}}
</pre>
+
  
== Kernel Configuration ==
+
== Building kernel, initramfs and grub to work with zfs==
To speed up this step, you can install a pre-configured/compiled kernel called '''bliss-kernel'''. This kernel already has the correct configurations for ZFS and a variety of other scenarios. It's a vanilla kernel from kernel.org without any external patches.
+
=== Install genkernel and initial kernel build ===
 
+
To install {{Package|sys-kernel/bliss-kernel}} type the following:
+
  
 +
We need to build a genkernel initially:
 
<console>
 
<console>
# ##i##emerge bliss-kernel
+
# ##i##emerge genkernel
</console>
+
  
Now make sure that your <tt>/usr/src/linux symlink</tt> is pointing to this kernel by typing the following:
+
Build initial kernel (required for checks in sys-kernel/spl and sys-fs/zfs):
 +
# ##i##genkernel kernel --no-clean --no-mountboot
  
<console>
 
# ##i##eselect kernel list
 
Available kernel symlink targets:
 
[1]  linux-3.12.13-KS.02 *
 
 
</console>
 
</console>
  
You should see a star next to the version you installed. In this case it was 3.12.13-KS.02. If it's not set, you can type '''eselect kernel set #'''.
+
=== Installing the ZFS userspace tools and kernel modules ===
 
+
== Installing the ZFS userspace tools and kernel modules ==
+
 
Emerge {{Package|sys-fs/zfs}}. This package will bring in {{Package|sys-kernel/spl}}, and {{Package|sys-fs/zfs-kmod}} as its dependencies:
 
Emerge {{Package|sys-fs/zfs}}. This package will bring in {{Package|sys-kernel/spl}}, and {{Package|sys-fs/zfs-kmod}} as its dependencies:
  
Line 289: Line 256:
 
</console>
 
</console>
  
If everything worked, continue.
+
{{fancynote|If /etc/mtab is missing, these two commands will complaine.  
 +
In that case solve that with:
 +
<console>
 +
# ##i##grep -v rootfs /proc/mounts > /etc/mtab
 +
</console>}}
  
== Installing & Configuring the Bootloader ==
+
Add the zfs tools to openrc.
 +
<console># ##i##rc-update add zfs boot</console>
  
For the bootloader and its configuration we will use '''bliss-boot'''. This is a new program that is designed to generate a simple, human-readable/editable, configuration file for a variety of bootloaders. It currently supports grub2, extlinux, and lilo.
+
If everything worked, continue.
  
Depending which bootloader you want ('''grub2''', '''extlinux''', '''lilo'''), add a use flag for it and emerge bliss-boot:
+
=== Install GRUB 2  ===
  
 +
Install grub2:
 
<console>
 
<console>
# ##i##echo "sys-boot/bliss-boot grub2" >> /etc/portage/package.use
+
# ##i##echo "sys-boot/grub libzfs -truetype" >> /etc/portage/package.use
# ##i##emerge bliss-boot
+
# ##i##emerge grub
</console>
+
 
+
=== GRUB 2 ===
+
If you enabled the '''grub2''' flag in '''bliss-boot''', then grub has now been installed.
+
You can check that grub is version 2.00 by doing the following command:
+
 
+
<console>
+
# ##i##grub-install --version
+
grub-install (GRUB) 2.00
+
 
</console>
 
</console>
  
Line 316: Line 280:
 
</console>
 
</console>
  
You should receive the following message:
+
=== Emerge genkernel and initial kernel build ===
 
+
Install genkernel using:
 
<console>
 
<console>
Installation finished. No error reported.
+
# ##i##echo "sys-kernel/genkernel zfs" >> /etc/portage/package.use
</console>
+
# ##i##emerge genkernel
  
You should now see some a grub directory with some files inside your /boot folder:
+
Build now kernel and initramfs with --zfs
 
+
# ##i##genkernel all --zfs --no-clean --no-mountboot --callback="emerge @module-rebuild"
<console>
+
# ##i##ls -l /boot/grub
+
total 2520
+
-rw-r--r-- 1 root root    1024 Jan  4 16:09 grubenv
+
drwxr-xr-x 2 root root    8192 Jan 12 14:29 i386-pc
+
drwxr-xr-x 2 root root    4096 Jan 12 14:28 locale
+
-rw-r--r-- 1 root root 2555597 Feb  4 11:50 unifont.pf2
+
 
</console>
 
</console>
  
==== Configuring GRUB 2 ====
+
=== Configuring the Bootloader ===
In order to generate our grub2.cfg file, we will first configure bliss-boot so that it knows what we want.
+
The 'bliss-boot' configuration file is located in '''/etc/bliss-boot/conf.py'''. Open that file and make sure that the following variables are set appropriately:
+
  
<pre>
+
Using the genkernel you must add 'real_root=ZFS=<root>' and 'dozfs' to your params.
# This should be set to the bootloader you installed earlier
+
Edit  <code>/etc/boot.conf</code>:
bootloader = "grub2"
+
  
# This should be set to the kernel you installed earlier
+
{{file|name=/etc/boot.conf|desc= |body=
default = "3.12.13-KS.02"
+
"Funtoo ZFS" {
</pre>
+
        kernel kernel[-v]
 
+
        initrd initramfs-genkernel-x86_64[-v]
Scroll all the way down until you find 'kernels'. You will need to add the kernels and the options
+
        params real_root=ZFS=tank/funtoo/root
you want for these kernels here. Below are a few configuration options depending if you are using
+
        params += dozfs=force
'''bliss-initramfs''' or '''genkernel'''.
+
 
+
===== Bliss Initramfs Creator =====
+
<pre>
+
kernel = {
+
    '3.12.13-KS.02' : 'root=tank/funtoo/root quiet',
+
 
}
 
}
</pre>
+
}}
  
'''If you are using encryption then you would let the initramfs know:'''
+
The command <code>boot-update</code> should take care of grub configuration:
 
+
#"What type of encryption authentication you want to use? ('''enc_type=''')
+
::* pass = will ask for passphrase directly
+
::* key = a plain unencrypted key file
+
::* key_gpg = an encrypted key file
+
#"Where is the encrypted drive?" ('''enc_root=''')
+
#"Where is the root pool after it has been decrypted?" ('''root=''')
+
 
+
<pre>
+
kernel = {
+
    '3.12.13-KS.02' : 'root=tank/funtoo/root enc_root=/dev/sda3 enc_type=pass quiet',
+
}
+
</pre>
+
 
+
===== genkernel =====
+
<pre>
+
kernel = {
+
    '3.12.13-KS.02' : 'real_root=ZFS=tank/funtoo/root dozfs=force quiet',
+
}
+
</pre>
+
 
+
'''If you are using encryption you can add the crypt_root option:'''
+
 
+
<pre>
+
kernel = {
+
    '3.12.13-KS.02' : 'real_root=ZFS=tank/funtoo/root dozfs=force crypt_root=/dev/sda3 quiet',
+
}
+
</pre>
+
 
+
 
+
=== LILO ===
+
If you enabled the '''lilo''' flag in '''bliss-boot''', then lilo has now been installed.
+
 
+
We first need to generate a '''lilo.conf''' file before we can install this bootloader.
+
 
+
 
+
<pre>
+
boot=/dev/sda
+
prompt
+
timeout=4
+
default=Funtoo
+
 
+
image=/boot/bzImage
+
      label=Funtoo
+
      read-only
+
      append="root=tank/os/funtoo/root"
+
      initrd=/boot/initramfs
+
</pre>
+
All that is left now is to install the bootcode to the MBR.
+
  
This can be accomplished by running:
 
<console># ##i##/sbin/lilo</console>
 
If it is successful you should see:
 
 
<console>
 
<console>
Warning: LBA32 addressing assumed
+
Install boot-update (if it is missing):
Added Funtoo + *
+
###i## emerge boot-update
One warning was issued
+
</console>
+
  
== Create the initramfs ==
+
Run boot-update to update grub.cfg
There are two ways to do this, you can use genkernel, or you can use my bliss initramfs creator. I will show you both.
+
###i## boot-update
 
+
=== genkernel ===
+
<console>
+
# ##i##emerge sys-kernel/genkernel
+
# You only need to add --luks if you used encryption
+
# ##i##genkernel --zfs --luks initramfs
+
 
</console>
 
</console>
  
=== Bliss Initramfs Creator ===
+
{{fancynote|If <code>boot-update</code>fails, try this:
If you are encrypting your drives, then add the "luks" use flag to your package.use before emerging:
+
 
+
 
<console>
 
<console>
# ##i##echo "sys-kernel/bliss-initramfs luks" >> /etc/portage/package.use
+
# ##i##grub-mkconfig -o /boot/grub/grub.cfg
 
</console>
 
</console>
 +
}}
 +
Now you should have a new installation of the kernel, initramfs and grub which are zfs capable. The configuration files should be updated, and the system should come up during the next reboot.
  
Now install the creator:
+
{{fancynote|If The <code>luks</code> integration works basically the same way.}}
 
+
<console>
+
# ##i##emerge bliss-initramfs
+
</console>
+
 
+
 
+
Then go into the install directory, run the script as root, and place it into /boot:
+
<console># ##i##cd /opt/bliss-initramfs
+
# ##i##./createInit
+
# ##i##mv initrd-<kernel_name> /boot
+
</console>
+
'''<kernel_name>''' is the name of what you selected in the initramfs creator, and the name of the outputted file.
+
  
 
== Final configuration ==
 
== Final configuration ==
=== Add the zfs tools to openrc ===
 
<console># ##i##rc-update add zfs boot</console>
 
 
 
=== Clean up and reboot ===
 
=== 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.
 
We are almost done, we are just going to clean up, '''set our root password''', and unmount whatever we mounted and get out.
Line 485: Line 358:
  
 
== After reboot ==
 
== After reboot ==
 +
 +
=== Forgot to reset password? ===
 +
==== System Rescue CD ====
 +
If you aren't using bliss-initramfs, then you can reboot back into your sysresccd and reset through there by mounting your drive, chrooting, and then typing passwd.
 +
 +
Example:
 +
<console>
 +
# ##i##zpool import -f -R /mnt/funtoo tank
 +
# ##i##chroot /mnt/funtoo bash -l
 +
# ##i##passwd
 +
# ##i##exit
 +
# ##i##zpool export -f tank
 +
# ##i##reboot
 +
</console>
 +
 
=== Create initial ZFS Snapshot ===
 
=== Create initial ZFS Snapshot ===
 
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.  
 
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.  
Line 495: Line 383:
  
 
If your machine ever fails and you need to get back to this state, just type (This will only revert your / dataset while keeping the rest of your data intact):
 
If your machine ever fails and you need to get back to this state, just type (This will only revert your / dataset while keeping the rest of your data intact):
<console># ##i##zfs rollback tank/os/funtoo/root@install</console>
+
<console># ##i##zfs rollback tank/funtoo/root@install</console>
  
 
{{fancyimportant|'''For a detailed overview, presentation of ZFS' capabilities, as well as usage examples, please refer to the [[ZFS_Fun|ZFS Fun]] page.'''}}
 
{{fancyimportant|'''For a detailed overview, presentation of ZFS' capabilities, as well as usage examples, please refer to the [[ZFS_Fun|ZFS Fun]] page.'''}}
 +
 +
== Troubleshooting ==
 +
 +
=== Starting from scratch ===
 +
If your installation has gotten screwed up for whatever reason and you need a fresh restart, you can do the following from sysresccd to start fresh:
 +
 +
<console>
 +
Destroy the pool and any snapshots and datasets it has
 +
# ##i##zpool destroy -R -f tank
 +
 +
This deletes the files from /dev/sda1 so that even after we zap, recreating the drive in the exact sector
 +
position and size will not give us access to the old files in this partition.
 +
# ##i##mkfs.ext2 /dev/sda1
 +
# ##i##sgdisk -Z /dev/sda
 +
</console>
 +
 +
Now start the guide again :).
 +
 +
 +
=== Starting again reusing the same disk partitions and the same pool ===
 +
 +
If your installation has gotten screwed up for whatever reason and you want to keep your pole named tank than you should boou into the Rescue CD / USB as done before.
 +
 +
<console>import the pool reusing all existing datasets:
 +
# ##i##zpool import -f -R /mnt/funtoo tank
 +
</console>
 +
 +
Now you should wipe the previous installation off:
 +
 +
<console>
 +
let's go to our base installation directory:
 +
# ##i##cd /mnt/funtoo
 +
 +
and delete the old installation:
 +
# ##i##rm -rf *
 +
</console>
 +
 +
Now start the guide again, at "Pre-Chroot"
 +
  
 
[[Category:HOWTO]]
 
[[Category:HOWTO]]
 
[[Category:Filesystems]]
 
[[Category:Filesystems]]
 
[[Category:Featured]]
 
[[Category:Featured]]
 +
[[Category:Install]]
  
 
__NOTITLE__
 
__NOTITLE__

Latest revision as of 19:14, May 14, 2015

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.

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).

For a quick tour of ZFS and have a big picture of its common operations you can consult the page ZFS Fun.

Disclaimers

Warning

This guide is a work in progress. Expect some quirks.

Today is 2015-05-12. ZFS has undertaken an upgrade - from 0.6.3 to 0.6.4. Please ensure that you use a RescueCD with ZFS 0.6.3. At present date grub 2.02 is not able to deal with those new ZFS parameters. If you want to use ZFS 0.6.4 for pool creation, you should use the compatability mode.

You should upgrade an existing pool only when grub is able to deal with - in a future version ... If not, you will not be able to boot into your system, and no rollback will help!

Please inform yourself!

Important

Since ZFS was really designed for 64 bit systems, we are only recommending and supporting 64 bit platforms and installations. We will not be supporting 32 bit platforms!

Downloading the ISO (With ZFS)

In order for us to install Funtoo on ZFS, you will need an environment that already provides the ZFS tools. Therefore we will download a customized version of System Rescue CD with ZFS included.

Name: sysresccd-4.2.0_zfs_0.6.2.iso  (545 MB)
Release Date: 2014-02-25
md5sum 01f4e6929247d54db77ab7be4d156d85


Download System Rescue CD with ZFS

Creating a bootable USB from ISO (From a Linux Environment)

After you download the iso, you can do the following steps to create a bootable USB:

Make a temporary directory
# mkdir /tmp/loop

Mount the iso
# mount -o ro,loop /root/sysresccd-4.2.0_zfs_0.6.2.iso /tmp/loop

Run the usb installer
# /tmp/loop/usb_inst.sh

That should be all you need to do to get your flash drive working.

Booting the ISO

Warning

When booting into the ISO, Make sure that you select the "Alternate 64 bit kernel (altker64)". The ZFS modules have been built specifically for this kernel rather than the standard kernel. If you select a different kernel, you will get a fail to load module stack error message.

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.

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.

# sgdisk -Z /dev/sda
Warning

This is a destructive operation and the program will not ask you for confirmation! Make sure you really don't want anything on this disk.

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

First open up the application:

# gdisk /dev/sda

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 ↵


Format your /boot partition

# mkfs.ext2 -m 1 /dev/sda1

Create the zpool

We will first create the pool. The pool will be named tank. Feel free to name your pool as you want. We will use ashift=12 option which is used for a hard drives with a 4096 sector size.

#   zpool create -f -o ashift=12 -o cachefile=/tmp/zpool.cache -O normalization=formD -m none -R /mnt/funtoo tank /dev/sda3 

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, /usr/src, and /usr/portage. Notice, datasets are examples only and not strictly required.

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

Optional, but recommended datasets: /home
#  zfs create -o mountpoint=/home tank/funtoo/home

Optional datasets: /usr/src, /usr/portage/{distfiles,packages}
#  zfs create -o mountpoint=/usr/src tank/funtoo/src
#  zfs create -o mountpoint=/usr/portage -o compression=off tank/funtoo/portage
#  zfs create -o mountpoint=/usr/portage/distfiles tank/funtoo/portage/distfiles
#  zfs create -o mountpoint=/usr/portage/packages tank/funtoo/portage/packages

Installing Funtoo

Pre-Chroot

Go into the directory that you will chroot into
# cd /mnt/funtoo

Make a boot folder and mount your boot drive
# mkdir boot
# mount /dev/sda1 boot

Now download and extract the Funtoo stage3 ...


Note

It is trully recommended to use the current version and generic64. That reduces the risk of a broken build.

After successfull ZFS installation and successfull first boot, the kernel may be changed using the eselect profile set ... command. If you create a snapshot before, you may allways come back to your previous installation, with some simple steps ... (rollback your pool and in the worst case configure and install the bootloader again)


Once you've extracted the stage3, do a few more preparations and chroot into your new funtoo environment:

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

Copy network settings
# cp -f /etc/resolv.conf etc

Make the zfs folder in 'etc' and copy your zpool.cache
# mkdir etc/zfs
# cp /tmp/zpool.cache etc/zfs

Chroot into Funtoo
# env -i HOME=/root TERM=$TERM chroot . bash -l
Note

How to create zpool.cache file?

If no zpool.cache file is available, the following command will create one:

# zpool set cachefile=/etc/zfs/zpool.cache tank

Downloading the Portage tree

Note

For an alternative way to do this, see Installing Portage From Snapshot.

Now it's time to install a copy of the Portage repository, which contains package scripts (ebuilds) that tell portage how to build and install thousands of different software packages. To create the Portage repository, simply run emerge --sync from within the chroot. This will automatically clone the portage tree from GitHub:

(chroot) # emerge --sync
Important

If you receive the error with initial emerge --sync due to git protocol restrictions, change SYNC variable in /etc/portage/make.conf:

SYNC="https://github.com/funtoo/ports-2012.git"
Note

To update the Funtoo Linux system just type:

(chroot) # emerge -auDN @world


Add filesystems to /etc/fstab

Before we continue to compile and or install our kernel in the next step, we will edit the /etc/fstab file because if we decide to install our kernel through portage, portage will need to know where our /boot is, so that it can place the files in there.

Edit /etc/fstab:

/etc/fstab
# <fs>                  <mountpoint>    <type>          <opts>          <dump/pass>

/dev/sda1               /boot           ext2            defaults        0 2

Building kernel, initramfs and grub to work with zfs

Install genkernel and initial kernel build

We need to build a genkernel initially:

# emerge genkernel

Build initial kernel (required for checks in sys-kernel/spl and sys-fs/zfs):
# genkernel kernel --no-clean --no-mountboot 

Installing the ZFS userspace tools and kernel modules

Emerge sys-fs/zfs (package not on wiki - please add). This package will bring in sys-kernel/spl (package not on wiki - please add), and sys-fs/zfs-kmod (package not on wiki - please add) as its dependencies:

# emerge zfs

Check to make sure that the zfs tools are working. The zpool.cache file that you copied before should be displayed.

# zpool status
# zfs list
Note

If /etc/mtab is missing, these two commands will complaine. In that case solve that with:

# grep -v rootfs /proc/mounts > /etc/mtab

Add the zfs tools to openrc.

# rc-update add zfs boot

If everything worked, continue.

Install GRUB 2

Install grub2:

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

Now install grub to the drive itself (not a partition):

# grub-install /dev/sda

Emerge genkernel and initial kernel build

Install genkernel using:

# echo "sys-kernel/genkernel zfs" >> /etc/portage/package.use
# emerge genkernel

Build now kernel and initramfs with --zfs
# genkernel all --zfs --no-clean --no-mountboot --callback="emerge @module-rebuild"

Configuring the Bootloader

Using the genkernel you must add 'real_root=ZFS=<root>' and 'dozfs' to your params. Edit /etc/boot.conf:

/etc/boot.conf
"Funtoo ZFS" {
        kernel kernel[-v]
        initrd initramfs-genkernel-x86_64[-v]
        params real_root=ZFS=tank/funtoo/root
        params += dozfs=force
}

The command boot-update should take care of grub configuration:

Install boot-update (if it is missing):
# emerge boot-update

Run boot-update to update grub.cfg
# boot-update
Note

If boot-updatefails, try this:

# grub-mkconfig -o /boot/grub/grub.cfg

Now you should have a new installation of the kernel, initramfs and grub which are zfs capable. The configuration files should be updated, and the system should come up during the next reboot.

Note

If The luks integration works basically the same way.

Final configuration

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 tarball that you downloaded earlier so it doesn't take up space.
# cd /
# rm stage3-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)
# umount -l proc dev sys boot

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

Export the zpool
# cd /
# zpool export tank

Reboot
# reboot
Important

Don't forget to set your root password as stated above before exiting chroot and rebooting. If you don't set the root password, you won't be able to log into your new system.

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

After reboot

Forgot to reset password?

System Rescue CD

If you aren't using bliss-initramfs, then you can reboot back into your sysresccd and reset through there by mounting your drive, chrooting, and then typing passwd.

Example:

# zpool import -f -R /mnt/funtoo tank
# chroot /mnt/funtoo bash -l
# passwd
# exit
# zpool export -f tank
# reboot

Create initial ZFS Snapshot

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 system, type the following:

# zfs snapshot -r tank@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 (This will only revert your / dataset while keeping the rest of your data intact):

# zfs rollback tank/funtoo/root@install
Important

For a detailed overview, presentation of ZFS' capabilities, as well as usage examples, please refer to the ZFS Fun page.

Troubleshooting

Starting from scratch

If your installation has gotten screwed up for whatever reason and you need a fresh restart, you can do the following from sysresccd to start fresh:

Destroy the pool and any snapshots and datasets it has
# zpool destroy -R -f tank

This deletes the files from /dev/sda1 so that even after we zap, recreating the drive in the exact sector
position and size will not give us access to the old files in this partition.
# mkfs.ext2 /dev/sda1
# sgdisk -Z /dev/sda

Now start the guide again :).


Starting again reusing the same disk partitions and the same pool

If your installation has gotten screwed up for whatever reason and you want to keep your pole named tank than you should boou into the Rescue CD / USB as done before.

import the pool reusing all existing datasets:
# zpool import -f -R /mnt/funtoo tank

Now you should wipe the previous installation off:

let's go to our base installation directory:
# cd /mnt/funtoo

and delete the old installation: 
# rm -rf *

Now start the guide again, at "Pre-Chroot"