Difference between revisions of "ZFS as Root Filesystem"

From Funtoo
Jump to navigation Jump to search
(don't forget to install kernel modules)
 
(Fixed issue with chronological flow.)
(146 intermediate revisions by 5 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 ===
Line 41: Line 43:
== Video Tutorial ==
== Video Tutorial ==


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


{{#widget:YouTube|id=kxEdSXwU0ZI|width=640|height=360}}
{{#widget:YouTube|id=SWyThdxNoP8|width=640|height=360}}


== Downloading the ISO (With ZFS) ==
== Downloading the ISO (With ZFS) ==
In order for us to install Funtoo on ZFS, you will need an environment that provides the ZFS tools. Therefore we will download a customized version of System Rescue CD with ZFS already included. When booting, use the "alternate"-kernel. The ZFS-module won't work with the default kernel.  
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.  


<pre>
<pre>
Name: sysresccd-3.8.1_zfs_0.6.2.iso   (510 MB)
Name: sysresccd-4.0.1_zfs_0.6.2.iso (545 MB)
Release Date: 2013-11-03
Release Date: 2014-02-25
md5sum aa33ef61c5d85ad564372327940498c3
md5sum 01f4e6929247d54db77ab7be4d156d85
</pre>
</pre>


Line 57: Line 59:
'''[http://ftp.osuosl.org/pub/funtoo/distfiles/sysresccd/ Download System Rescue CD with ZFS]'''<br />
'''[http://ftp.osuosl.org/pub/funtoo/distfiles/sysresccd/ Download System Rescue CD with ZFS]'''<br />


== Creating a bootable USB from ISO ==
== 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:
After you download the iso, you can do the following steps to create a bootable USB:


Line 65: Line 67:


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


Run the usb installer
Run the usb installer
Line 73: Line 75:
That should be all you need to do to get your flash drive working.
That should be all you need to do to get your flash drive working.


When you are booting into system rescue cd, make sure you select the '''alternative 64 bit kernel'''. ZFS support was specifically added to the alternative 64 bit kernel rather than the standard 64 bit kernel.
== Booting the ISO ==
 
{{fancywarning|'''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 ==
== Creating partitions ==
Line 88: Line 92:


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


{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}
{{fancywarning|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.
Now that we have a clean drive, we will create the new layout.
First open up the application:
<console>
# ##i##gdisk /dev/sda
</console>


'''Create Partition 1''' (boot):
'''Create Partition 1''' (boot):
Line 136: Line 140:




=== Format your boot volume ===
=== Format your /boot partition ===
Format your separate /boot partition:
 
<console># ##i##mkfs.ext2 /dev/sda1</console>
<console>
# ##i##mkfs.ext2 -m 1 /dev/sda1
</console>


=== Encryption (Optional) ===
=== Encryption (Optional) ===
Line 147: Line 153:
# ##i##cryptsetup luksOpen /dev/sda3 vault_1
# ##i##cryptsetup luksOpen /dev/sda3 vault_1
</console>
</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 `rpool` and the disk will be aligned to 4096 (using ashift=12)
We will first create the pool. The pool will be named `tank` and the disk will be aligned to 4096 (using ashift=12)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda3</console>
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo tank /dev/sda3</console>


{{fancyimportant|If you are using encrypted root, change '''/dev/sda3 to /dev/mapper/vault_1'''.}}
{{fancyimportant|If you are using encrypted root, change '''/dev/sda3 to /dev/mapper/vault_1'''.}}


{{fancynote|'''ashift<nowiki>=</nowiki>12''' should be use if you have a newer, advanced format disk that has a sector size of 4096 bytes. If you have an older disk with 512 byte sectors, you should use '''ashift<nowiki>=</nowiki>9''' or don't add the option for auto detection}}
{{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>'''.}}
 
{{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: /home, /var, /usr/src, and /usr/portage.
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>.


<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 rpool/ROOT
# ##i##zfs create -p tank/funtoo
# ##i##zfs create -o mountpoint=/ rpool/ROOT/funtoo
# ##i##zfs create -o mountpoint=/ tank/funtoo/root


Optional, but recommended datasets: /home
Optional, but recommended datasets: /home
# ##i##zfs create -o mountpoint=/home rpool/HOME
# ##i##zfs create -o mountpoint=/home tank/funtoo/home
 
Optional, portage tree, distfiles, and binary packages:
# ##i##zfs create rpool/FUNTOO
# ##i##zfs create -o mountpoint=/usr/portage -o compression=off rpool/FUNTOO/portage
# ##i##zfs create -o mountpoint=/usr/portage/distfiles rpool/FUNTOO/portage/distfiles
# ##i##zfs create -o mountpoint=/usr/portage/packages rpool/FUNTOO/portage/packages


Optional datasets: /usr/src
Optional datasets: /usr/src, /usr/portage/{distfiles,packages}
# ##i##zfs create -o mountpoint=/usr/src rpool/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/distfiles tank/funtoo/portage/distfiles
# ##i##zfs create -o mountpoint=/usr/portage/packages tank/funtoo/portage/packages
</console>
</console>


=== Create your swap zvol ===
=== 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). For machines with this much memory, You could just make it 2G if you don't have any problems.'''
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>
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 1G rpool/swap
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 2G tank/swap
</console>
</console>


=== Format your swap zvol ===
=== Format your swap zvol ===
<console>
<console>
# ##i##mkswap -f /dev/zvol/rpool/swap
# ##i##mkswap -f /dev/zvol/tank/swap
# ##i##swapon /dev/zvol/rpool/swap
# ##i##swapon /dev/zvol/tank/swap
</console>
</console>


Now we will continue to install funtoo.


=== Last minute checks and touches ===
== Installing Funtoo ==
Check to make sure everything appears fine. Your output may differ depending on the choices you made above:
<console>
# ##i##zpool status
  pool: rpool
state: ONLINE
  scan: none requested
config:


        NAME        STATE    READ WRITE CKSUM
=== Pre-Chroot ===
        rpool      ONLINE      0    0    0
          sda2      ONLINE      0    0    0


errors: No known data errors
<console>
Go into the directory that you will chroot into
# ##i##cd /mnt/funtoo


# ##i##zfs list
Make a boot folder and mount your boot drive
rpool              3.10G  15.5G  136K  none
# ##i##mkdir boot
rpool/HOME          136K  15.5G  136K  /mnt/funtoo/home
# ##i##mount /dev/sda1 boot
rpool/ROOT          308K  15.5G  136K  none
rpool/ROOT/funtoo  172K  15.5G  172K  /mnt/funtoo
rpool/swap        3.09G  18.6G    76K  -
</console>
</console>


Now we will continue to install funtoo.
[[Funtoo_Linux_Installation|Now download and extract the Funtoo stage3 ...]]


== Installing Funtoo ==
Once you've extracted the stage3, do a few more preparations and chroot into your new funtoo environment:
[[Funtoo_Linux_Installation|Download and extract the Funtoo stage3 and continue installation as normal.]]


Then once you've extracted the stage3, chroot into your new funtoo environment:
<console>
<console>
Go into the directory that you will chroot into
Bind the kernel related directories
# ##i##cd /mnt/funtoo
# ##i##mount -t proc none proc
# ##i##mount --rbind /dev dev
# ##i##mount --rbind /sys sys


Mount your boot drive
Copy network settings
# ##i##mount /dev/sda1 /mnt/funtoo/boot
# ##i##cp -f /etc/resolv.conf etc


Bind the kernel related directories
Make the zfs folder in 'etc' and copy your zpool.cache
# ##i##mount -t proc none /mnt/funtoo/proc
# ##i##mkdir etc/zfs
# ##i##mount --rbind /dev /mnt/funtoo/dev
# ##i##cp /etc/zfs/zpool.cache etc/zfs
# ##i##mount --rbind /sys /mnt/funtoo/sys


Copy network settings
Chroot into Funtoo
# ##i##cp /etc/resolv.conf /mnt/funtoo/etc/
# ##i##env -i HOME=/root TERM=$TERM chroot . bash -l
</console>


chroot into your new funtoo environment
=== In Chroot ===
# ##i##env -i HOME=/root TERM=$TERM chroot /mnt/funtoo /bin/bash --login


Place your mountpoints into your /etc/mtab file
<console>
# ##i##cat /proc/mounts > /etc/mtab
Create a symbolic link to your mountpoints
# ##i##ln -sf /proc/mounts /etc/mtab


Sync your tree
Sync your tree
Line 248: Line 245:
=== 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 /etc/fstab file because if we decide to install our kernel through portage, portage will need to know where is your /boot so that it can place the files in there. We also need to update /etc/mtab so our system knows what is mounted
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.  


<console>
Edit <tt>/etc/fstab</tt>:
# ##i##nano /etc/fstab


<pre>
# <fs>                  <mountpoint>    <type>          <opts>          <dump/pass>
# <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/sda1              /boot          ext2            defaults        0 2
/dev/zvol/rpool/swap   none            swap            sw              0 0
/dev/zvol/tank/swap     none            swap            sw              0 0
</console>
</pre>


== Kernel Configuration ==
== Kernel Configuration ==
To speed up this step, you can install "bliss-kernel" since it's already properly configured for ZFS and a lot of other configurations. The kernel is also compiled and ready to go. To install 'bliss-kernel' type the following:
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.
 
To install {{Package|sys-kernel/bliss-kernel}} type the following:


<console>
<console>
Line 266: Line 265:
</console>
</console>


Now make sure that your /usr/src/linux symlink is pointing to this kernel by typing the following:
Now make sure that your <tt>/usr/src/linux symlink</tt> is pointing to this kernel by typing the following:


<console>
<console>
# ##i##eselect kernel list
# ##i##eselect kernel list
Available kernel symlink targets:
Available kernel symlink targets:
[1]  linux-3.10.10-FB.01 *
[1]  linux-3.12.13-KS.02 *
</console>
</console>


You should see a star next to the bliss-kernel version you installed. In this case it was 3.10.10-FB.01. If it's not set, you can type '''eselect kernel set #'''.
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:


<console># ##i##emerge -av zfs spl zfs-kmod</console>
<console>
 
# ##i##emerge zfs
(spl = Solaris Porting Layer)
</console>


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


<console>
<console>
Line 291: Line 291:
If everything worked, continue.
If everything worked, continue.


== Install the bootloader ==
== Create the initramfs ==
=== GRUB 2 ===
There are two ways to do this, you can use "genkernel" or "bliss-initramfs". Both will be shown.
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.
=== genkernel ===
Install genkernel and run it:
<console>
# ##i##emerge genkernel


<console># ##i##echo "sys-boot/grub libzfs" >> /etc/portage/package.use</console>
You only need to add --luks if you used encryption
# ##i##genkernel --zfs --luks initramfs
</console>


Then we will compile grub2:
=== Bliss Initramfs Creator ===
If you are encrypting your drives, then add the "luks" use flag to your package.use before emerging:


<console># ##i##emerge -av grub</console>
<console>
# ##i##echo "sys-kernel/bliss-initramfs luks" >> /etc/portage/package.use
</console>


Once this is done, you can check that grub is version 2.00 by doing the following command:
Now install the program and run it:
<console>
<console>
# ##i##grub-install --version
# ##i##emerge bliss-initramfs
grub-install (GRUB) 2.00
 
You can either run it without any parameters to get an interactive menu
or you can pass the parameters directly. 1 = zfs, 6 = encrypted zfs, and the kernel name.
# ##i##bliss-initramfs 1 3.12.13-KS.02
</console>
</console>


Now try to install grub2:
=== Moving into the correct location ===
<console># ##i##grub-install --no-floppy /dev/sda</console>
Place the file that was generated by the above applications into either your /boot folder (If you are using boot-update) or into your /boot/kernels/3.12.13-KS.02 folder (If you are using bliss-boot). For bliss-boot, the file needs to be called 'initrd' rather than 'initrd-3.12.13-KS.02'.


You should receive the following message
==== boot-update ====
<console>Installation finished. No error reported.</console>
<console>
# ##i##mv initrd-3.12.13-KS.02 /boot
</console>


If not, then go back to the above checklist.
==== bliss-boot ====
<console>
# ##i##mv initrd-3.12.13-KS.02 /boot/kernels/3.12.13-KS.02/initrd
</console>


=== LILO ===
== Installing & Configuring the Bootloader ==
Before you do this, make sure the following checklist is followed:
 
* /dev/, /proc and /sys are mounted.
=== GRUB 2 (Optional if you are using another bootloader) ===
* Installed the sys-fs/zfs package from the tree.
<console>
Once the above requirements are met, LILO can be installed.
# ##i##emerge grub
</console>


Now we will install LILO.
You can check that grub is version 2.00 by typing the following command:
<console># ##i##emerge -av sys-boot/lilo</console>
Once the installation of LILO is complete we will need to edit the lilo.conf file.
<console># ##i##nano /etc/lilo.conf
boot=/dev/sda
prompt
timeout=4
default=Funtoo


image=/boot/bzImage
<console>
      label=Funtoo
# ##i##grub-install --version
      read-only
grub-install (GRUB) 2.00
      append="root=rpool/ROOT/funtoo"
      initrd=/boot/initramfs
</console>
</console>
All that is left now is to install the bootcode to the MBR.


This can be accomplished by running:
Now install grub to the drive itself (not a partition):
<console># ##i##/sbin/lilo</console>
If it is successful you should see:
<console>
<console>
Warning: LBA32 addressing assumed
# ##i##grub-install /dev/sda
Added Funtoo + *
One warning was issued
</console>
</console>


== Create the initramfs ==
You should receive the following message:
There are two ways to do this, you can use genkernel, or you can use my bliss initramfs creator. I will show you both.


=== genkernel ===
<console>
<console>
# ##i##emerge -av sys-kernel/genkernel
Installation finished. No error reported.
# You only need to add --luks if you used encryption
# ##i##genkernel --zfs --luks initramfs
</console>
</console>


=== Bliss Initramfs Creator ===
You should now see some a grub directory with some files inside your /boot folder:
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##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>


Now install the creator:
=== Extlinux (Optional if you are using another bootloader) ===
To install extlinux, you can follow the guide here: [[Extlinux|Link to Extlinux Guide]].
 
=== LILO (Optional if you are using another bootloader) ===
To install lilo you can type the following:


<console>
<console>
# ##i##emerge bliss-initramfs
# ##i##emerge lilo
</console>
</console>


=== boot-update ===
boot-update comes as a dependency of grub2, so if you already installed grub, it's already on your system!


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.
== Using boot-update ==
=== /boot on separate partition ===
If you created a separate non-zfs partition for boot then configuring boot-update is almost exactly the same as a normal install except that auto detection for root does not work. You must tell boot-update what your root is.
==== Genkernel ====
==== Genkernel ====
If your using genkernel you must add 'real_root=ZFS=<root>' and 'dozfs' to your params.
If your using genkernel you must add 'real_root=ZFS=<root>' and 'dozfs' to your params.
Example entry for boot.conf:
Example entry for <tt>/etc/boot.conf</tt>:
<console>
 
<pre>
"Funtoo ZFS" {
"Funtoo ZFS" {
         kernel vmlinuz[-v]
         kernel vmlinuz[-v]
         initrd initramfs-genkernel-x86_64[-v]
         initrd initramfs-genkernel-x86_64[-v]
         params real_root=ZFS=rpool/ROOT/funtoo
         params real_root=ZFS=tank/funtoo/root
         params += dozfs
         params += dozfs=force
         # Also add 'params += crypt_root=/dev/sda2' if you used encryption
         # Also add 'params += crypt_root=/dev/sda3' if you used encryption
         # Adjust the above setting to your system if needed
         # Adjust the above setting to your system if needed
}
}
</console>
</pre>


==== Bliss Initramfs Creator ====
==== Bliss Initramfs Creator ====
If you used the Bliss Initramfs Creator then all you need to do is add 'root=<root>' to your params.
If you used Bliss Initramfs Creator then all you need to do is add 'root=<root>' to your params.
Example entry for boot.conf:
Example entry for <tt>/etc/boot.conf</tt>:
<console>
 
<pre>
"Funtoo ZFS" {
"Funtoo ZFS" {
         kernel vmlinuz[-v]
         kernel vmlinuz[-v]
         initrd initrd[-v]
         initrd initrd[-v]
         params root=rpool/ROOT/funtoo quiet
         params root=tank/funtoo/root quiet
         # If you have an encrypted device with a regular passphrase,
         # If you have an encrypted device with a regular passphrase,
         # you can add the following line
         # you can add the following line
         params += enc_root=/dev/sda3 enc_type=pass
         params += enc_root=/dev/sda3 enc_type=pass
}
}
</pre>
After editing /etc/boot.conf, you just need to run boot-update to update grub.cfg
<console>
###i## boot-update
</console>
</console>


After editing /etc/boot.conf, you just need to run boot-update to update grub.cfg
=== bliss-boot ===
<console># ##i##boot-update</console>
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.
 
You can install it via the following command:
<console>
# ##i##emerge bliss-boot
</console>
 
==== Bootloader Configuration ====
In order to generate our bootloader configuration 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>
# This should be set to the bootloader you installed earlier: (grub2, extlinux, and lilo are the available options)
bootloader = "grub2"
 
# This should be set to the kernel you installed earlier
default = "3.12.13-KS.02"
</pre>
 
Scroll all the way down until you find 'kernels'. You will need to add the kernels and the options
you want for these kernels here. Below are a few configuration options depending if you are using
'''bliss-initramfs''' or '''genkernel'''.
 
===== 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>
 
===== 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:'''
 
#"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>
 
==== Generate the configuration ====
Now that we have configure our '''/etc/bliss-boot/conf.py''' file, we can generate our config. Simply run the following command:
 
<console>
# ##i##bliss-boot
</console>
 
This will generate a configuration file for the bootloader you specified previously in your current directory. You can check your config file before hand to make sure it doesn't have any errors. Simply open either: grub.cfg, extlinux.conf, or lilo.conf.
 
Once you have checked it for errors, place this file in the correct directory:
 
* grub2 = /boot/grub/
* extlinux = /boot/extlinux/
* lilo = /etc/lilo.conf
 
=== LILO (Optional if you are using another bootloader) ===
Now that bliss-boot generated the lilo.conf file, move that config file to its appropriate location
and install lilo to the MBR:
 
<console>
# ##i##mv lilo.conf /etc
# ##i##lilo
 
You should see the following:


=== /boot on ZFS ===
Warning: LBA32 addressing assumed
TBC - pending update to boot-update to support this
Added Funtoo + *
One warning was issued
</console>


== Final configuration ==
== Final configuration ==
Line 443: Line 531:


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


Export the zpool
Export the zpool
# ##i##cd /
# ##i##cd /
# ##i##zpool export rpool
# ##i##zpool export tank


Reboot
Reboot
Line 458: Line 546:


== 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>
==== Using bliss-initramfs ====
If you forgot to reset your password and are using '''bliss-initramfs''', you can add the '''su''' option to your bootloader parameters and the initramfs will throw you into the rootfs of your drive. In there you can run 'passwd' and then type 'exit'. Once you type 'exit', the initramfs will continue to boot your system as normal.
=== 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.  


To take the snapshot of your system, type the following:
To take the snapshot of your system, type the following:
<console># ##i##zfs snapshot -r rpool@install</console>
<console># ##i##zfs snapshot -r tank@install</console>


To see if your snapshot was taken, type:
To see if your snapshot was taken, type:
Line 468: Line 574:


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 rpool/ROOT/funtoo@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 :).


[[Category:HOWTO]]
[[Category:HOWTO]]
[[Category:Filesystems]]
[[Category:Filesystems]]
[[Category:Featured]]
[[Category:Featured]]
[[Category:Install]]


__NOTITLE__
__NOTITLE__

Revision as of 06:08, July 24, 2014

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.

   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!

Video Tutorial

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

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.0.1_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
root # mkdir /tmp/loop

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

Run the usb installer
root # /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.

root # 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:

root # 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

root # mkfs.ext2 -m 1 /dev/sda1

Encryption (Optional)

If you want encryption, then create your encrypted vault(s) now by doing the following:

root # cryptsetup luksFormat /dev/sda3
root # cryptsetup luksOpen /dev/sda3 vault_1
   Warning

On some machines, a combination of ZFS and LUKS has caused instability and system crashes.

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)

root # zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo tank /dev/sda3
   Important

If you are using encrypted root, change /dev/sda3 to /dev/mapper/vault_1.

   Note
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

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 /
root # zfs create -p tank/funtoo
root # zfs create -o mountpoint=/ tank/funtoo/root

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

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

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.

root # zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 2G tank/swap

Format your swap zvol

root # mkswap -f /dev/zvol/tank/swap
root # swapon /dev/zvol/tank/swap

Now we will continue to install funtoo.

Installing Funtoo

Pre-Chroot

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

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

Now download and extract the Funtoo stage3 ...

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

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

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

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

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

In Chroot

Create a symbolic link to your mountpoints
root # ln -sf /proc/mounts /etc/mtab

Sync your tree
root # emerge --sync

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:

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

/dev/sda1               /boot           ext2            defaults        0 2
/dev/zvol/tank/swap     none            swap            sw              0 0

Kernel Configuration

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.

To install No results type the following:

root # emerge bliss-kernel

Now make sure that your /usr/src/linux symlink is pointing to this kernel by typing the following:

root # eselect kernel list
Available kernel symlink targets:
[1]   linux-3.12.13-KS.02 *

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

Emerge No results. This package will bring in No results, and No results as its dependencies:

root # emerge zfs

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

root # zpool status
root # zfs list

If everything worked, continue.

Create the initramfs

There are two ways to do this, you can use "genkernel" or "bliss-initramfs". Both will be shown.

genkernel

Install genkernel and run it:

root # emerge genkernel

You only need to add --luks if you used encryption
root # genkernel --zfs --luks initramfs

Bliss Initramfs Creator

If you are encrypting your drives, then add the "luks" use flag to your package.use before emerging:

root # echo "sys-kernel/bliss-initramfs luks" >> /etc/portage/package.use

Now install the program and run it:

root # emerge bliss-initramfs

You can either run it without any parameters to get an interactive menu
or you can pass the parameters directly. 1 = zfs, 6 = encrypted zfs, and the kernel name.
root # bliss-initramfs 1 3.12.13-KS.02

Moving into the correct location

Place the file that was generated by the above applications into either your /boot folder (If you are using boot-update) or into your /boot/kernels/3.12.13-KS.02 folder (If you are using bliss-boot). For bliss-boot, the file needs to be called 'initrd' rather than 'initrd-3.12.13-KS.02'.

boot-update

root # mv initrd-3.12.13-KS.02 /boot

bliss-boot

root # mv initrd-3.12.13-KS.02 /boot/kernels/3.12.13-KS.02/initrd

Installing & Configuring the Bootloader

GRUB 2 (Optional if you are using another bootloader)

root # emerge grub

You can check that grub is version 2.00 by typing the following command:

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

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

root # grub-install /dev/sda

You should receive the following message:

Installation finished. No error reported.

You should now see some a grub directory with some files inside your /boot folder:

root # 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

Extlinux (Optional if you are using another bootloader)

To install extlinux, you can follow the guide here: Link to Extlinux Guide.

LILO (Optional if you are using another bootloader)

To install lilo you can type the following:

root # emerge lilo

boot-update

boot-update comes as a dependency of grub2, so if you already installed grub, it's already on your system!

Genkernel

If your using genkernel you must add 'real_root=ZFS=<root>' and 'dozfs' to your params. Example entry for /etc/boot.conf:

"Funtoo ZFS" {
        kernel vmlinuz[-v]
        initrd initramfs-genkernel-x86_64[-v]
        params real_root=ZFS=tank/funtoo/root
        params += dozfs=force
        # Also add 'params += crypt_root=/dev/sda3' if you used encryption
        # Adjust the above setting to your system if needed
}

Bliss Initramfs Creator

If you used Bliss Initramfs Creator then all you need to do is add 'root=<root>' to your params. Example entry for /etc/boot.conf:

"Funtoo ZFS" {
        kernel vmlinuz[-v]
        initrd initrd[-v]
        params root=tank/funtoo/root quiet
        # If you have an encrypted device with a regular passphrase,
        # you can add the following line
        params += enc_root=/dev/sda3 enc_type=pass
}

After editing /etc/boot.conf, you just need to run boot-update to update grub.cfg

root # boot-update

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.

You can install it via the following command:

root # emerge bliss-boot

Bootloader Configuration

In order to generate our bootloader configuration 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:

# This should be set to the bootloader you installed earlier: (grub2, extlinux, and lilo are the available options)
bootloader = "grub2"

# This should be set to the kernel you installed earlier
default = "3.12.13-KS.02" 

Scroll all the way down until you find 'kernels'. You will need to add the kernels and the options you want for these kernels here. Below are a few configuration options depending if you are using bliss-initramfs or genkernel.

Genkernel
kernel = {
    '3.12.13-KS.02' : 'real_root=ZFS=tank/funtoo/root dozfs=force quiet',
}

If you are using encryption you can add the crypt_root option:

kernel = {
    '3.12.13-KS.02' : 'real_root=ZFS=tank/funtoo/root dozfs=force crypt_root=/dev/sda3 quiet',
}
Bliss Initramfs Creator
kernel = {
    '3.12.13-KS.02' : 'root=tank/funtoo/root quiet',
}

If you are using encryption then you would let the initramfs know:

  1. "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
  1. "Where is the encrypted drive?" (enc_root=)
  2. "Where is the root pool after it has been decrypted?" (root=)
kernel = {
    '3.12.13-KS.02' : 'root=tank/funtoo/root enc_root=/dev/sda3 enc_type=pass quiet',
}

Generate the configuration

Now that we have configure our /etc/bliss-boot/conf.py file, we can generate our config. Simply run the following command:

root # bliss-boot

This will generate a configuration file for the bootloader you specified previously in your current directory. You can check your config file before hand to make sure it doesn't have any errors. Simply open either: grub.cfg, extlinux.conf, or lilo.conf.

Once you have checked it for errors, place this file in the correct directory:

  • grub2 = /boot/grub/
  • extlinux = /boot/extlinux/
  • lilo = /etc/lilo.conf

LILO (Optional if you are using another bootloader)

Now that bliss-boot generated the lilo.conf file, move that config file to its appropriate location and install lilo to the MBR:

root # mv lilo.conf /etc
root # lilo

You should see the following:

Warning: LBA32 addressing assumed
Added Funtoo + *
One warning was issued

Final configuration

Add the zfs tools to openrc

root # rc-update add zfs boot

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.
root # cd /
root # rm stage3-latest.tar.xz

Set your root password
root # 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
root # exit

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

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

Export the zpool
root # cd /
root # zpool export tank

Reboot
root # 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:

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

Using bliss-initramfs

If you forgot to reset your password and are using bliss-initramfs, you can add the su option to your bootloader parameters and the initramfs will throw you into the rootfs of your drive. In there you can run 'passwd' and then type 'exit'. Once you type 'exit', the initramfs will continue to boot your system as normal.

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:

root # zfs snapshot -r tank@install

To see if your snapshot was taken, type:

root # 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):

root # 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
root # 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.
root # mkfs.ext2 /dev/sda1
root # sgdisk -Z /dev/sda

Now start the guide again :).