Funtoo Linux - User contributions [en]

ZFS Install Guide

2013-06-17T20:03:33Z

Fearedbliss: /* Create the zfs datasets */ - removed rpool/HOME/root

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 SLAX with ZFS SBs (SLAX Bundle) already included.

This is just a file that when combined with SLAX, gives you those tools.

<pre>
Name: SLAX-English-US-7.0.8-x86_64_ZFS.iso (229 MB)
Release Date: 2013-06-15
md5sum 358e4b3cbec9110de83e5d1779200eeb
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/slax/SLAX-English-US-7.0.8-x86_64_ZFS.iso Download SLAX 7.0.8 with ZFS]''' 

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

Optional, but recommended dataset: /home
# ##i##zfs create -o mountpoint=/home rpool/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, /var
# ##i##zfs create -o mountpoint=/usr/src rpool/FUNTOO/src
# ##i##zfs create -o mountpoint=/var rpool/FUNTOO/var
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

Make a directory for /boot
# ##i##mkdir /mnt/funtoo/boot

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

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

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet refresh
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

{{fancyimportant|We are using the 'refresh' option because the current cachefile that was generated in SLAX won't work when the system is live. We will generate a new cachefile on the fly. You will need to recreate the initramfs once you are in the system so that the initramfs can have the new cachefile inside of it!}}

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

<console>
Delete the stage3 tarball that you downloaded earlier so it doesn't take up space.
# ##i##cd /
# ##i##rm stage3-latest.tar.xz

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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 ==

=== Recreate initramfs ===
After you restart your machine and your inside the live system, remake a new initrd if you are using "Bliss Initramfs Creator". This is because the old cachefile that was used inside SLAX won't work for booting (At least not the first time). Now that our system is up, we will recreate the cache.

<console>
# ##i##cd /opt/bliss-initramfs
# ##i##./createInit

Pick your desired option

Once your initrd is made, move it to /boot
# ##i##mv initrd* /boot

Now edit grub.cfg and remove the "refresh" option
nano /boot/grub/grub.cfg
</console>

=== 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:
<console># ##i##zfs snapshot -r rpool@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

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>

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

__NOTOC__
__NOTITLE__

Welcome

2013-06-16T07:32:12Z

Fearedbliss: funtoo zfs install video v3

<div style="float:right; width: 35%">
{{#widget:Donate|blurb=Your support helps Funtoo grow! Donate Today.}}
<div class="boxy">
== Get on the UserMap! ==
{{#compound_query:[[Category:People]] [[Role type::Staff]];?Geoloc;icon=Purplemarker.png;limit=9999
|[[Category:People]][[Role type::Contributor]];?Geoloc;icon=Orangemarker.png;limit=9999
|[[Category:People]][[Role type::User]];?Geoloc;icon=Greenmarker.png;limit=9999
|format=googlemaps3|height=275|zoom=1|type=hybrid|markercluster=yes}}
See our full-size [[Usermap]] and find out how to become part of the Funtoo Universe!
</div>
{{Litecoin|blurb=Check it out: Mine litecoins for Funtoo!}}
<div class="boxy">
=== Latest Commits: ===
<ul>
<feed entries=7 url="https://github.com/funtoo/funtoo-overlay/commits/master.atom">
<li>[{PERMALINK} <nowiki>{TITLE}</nowiki>]
</feed>
</ul>
</div>

<div class="boxy">
=== Featured Resources: ===
<DynamicPageList>
category = Featured
</DynamicPageList>
</div>

<div class="boxy2">
=== [[image:Feed-icon-28x28.png|link=http://forums.funtoo.org/extern.php?action=feed&type=atom]] Latest Forum Posts ===
<ul>
<feed entries=6 url="http://forums.funtoo.org/extern.php?action=feed&type=atom">
<li>[{PERMALINK} <nowiki>{TITLE}</nowiki>]
</feed>
</ul>
</div>

<div class="boxy2">
=== [[image:Feed-icon-28x28.png|link=http://feeds.feedburner.com/planet_larry]] Planet Larry ===
<ul>
<feed type="planet" entries=6 url="http://feeds.feedburner.com/planet_larry">
<li>[{PERMALINK} <nowiki>{TITLE}</nowiki>]
</feed>
</ul>
</div>

</div>

= Welcome to the Funtoo Wiki! =

[[Funtoo Linux]] is a Linux-based operating system created by [[user:Drobbins|Daniel Robbins]], the creator and former Chief Architect of Gentoo Linux. Funtoo Linux is a Free software, or "Open Source" operating system. All distribution source code is freely available, and it can be used and distributed free of charge.

Who develops and improves Funtoo Linux? '''You do.''' We are a completely open meta-distribution that is run by our users and a small group of support staff. Our development centers around the needs of our users. Any user can contribute code and help improve Funtoo Linux functionality on our [http://bugs.funtoo.org bug tracker].

== Featured Video ==

In this video, Jonathan Vasquez ([[User:Fearedbliss|fearedbliss]]) walks you through the process of installing Funtoo Linux with ZFS. See the [[ZFS Install Guide]] for detailed instructions.

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

== Meta-Distribution, Optimized ==

Funtoo Linux is also a ''meta''-distribution, which means that it is built automatically from source code and is customized with the functionality that ''you'' want it to have, and ''without'' the unnecessary features and "bloat" that you want to avoid.

In addition, a Funtoo Linux system is [[Download|optimized for your CPU]], and we offer optimized versions for ''Intel Core i7'', ''Intel Atom'', ''AMD Opteron'', and other processors and architectures.

These combination of factors work together to create an extremely high-performance and flexible computing platform -- a platform where ''you'' are in control, and your system performs optimally. We believe that Funtoo Linux is the most ideal expression of how operating system technology "should" work, and we continually strive to make it better.

== The Gentoo Ecosystem ==

We are committed to maintaining high-levels of compatibility and collaboration with the Gentoo Linux project, and challenge ourselves to innovate while providing new approaches that can be easily leveraged by the Gentoo Community. We appreciate the support we receive from members of the Gentoo Community and strive to contribute back to the larger [[Gentoo Ecosystem]].

== Ultimate Flexibility for Developers ==

Does your Linux distribution allow multiple versions of <tt>php</tt>, <tt>[[python]]</tt> or <tt>ruby</tt> installed happily alongside each other? Funtoo Linux does. Are you tired of hand-building key packages from source to configure them exactly the way you want? Funtoo Linux allows you to tweak the build-time features of packages using handy things called USE variables. Other distributions are forced to either leave stuff out that you want, or include stuff you don't want.

== Virtualization ==

We support the [[OpenVZ]] project and build up-to-date Funtoo Linux OpenVZ containers that you can [[Download|download]]. Also see [[VagrantUp]] for a nice way to deploy VirtualBox-based Funtoo Linux systems. [[Metro]], our automated distro build tool, is capable of building OpenVZ, Linux VServer and [[Linux Containers]] (LXC) images. Funtoo Linux also makes an excellent virtualization host system for [[Xen]].

== Features ==

[[Funtoo Linux]] features native [[wikipedia:UTF-8|UTF-8]] support enabled by default, a [[wikipedia:Git (software)|git]]-based, [[Portage Tree|distributed Portage Tree]] and funtoo overlay, an enhanced [[Portage]] with more compact mini-manifest tree, automated imports of new [http://www.gentoo.org Gentoo] changes every 12 hours, [[GUID Booting Guide|GPT/GUID boot support]] and [[Boot-Update|streamlined boot configuration]], [[Funtoo Linux Networking|enhanced network configuration]], up-to-date [http://ftp.osuosl.org/pub/funtoo/funtoo-stable/ stable] and [http://ftp.osuosl.org/pub/funtoo/funtoo-current/ current] Funtoo [[Stage Tarball|stages]], all built using Funtoo's [[Metro]] build tool. We also offer Ubuntu Server, Debian, RHEL and Fedora-based [[Funtoo Linux Kernels|kernels]].

Funtoo is currently supported on the following processor families :
* PC-compatible, both 32 and 64-bit (''x86-32bit'', ''x86-64bit'')

== Resources ==

* Learn more about [[Funtoo Linux]].
* Why you should [[Choose Funtoo]]: ...and how its different than other distros.
* Visit [[:Category:Projects|Funtoo Linux Projects]] and also look at the stuff online for [[Metro]].
* Learn [[:Category:Linux Core Concepts| Core Linux concepts]] from articles originally written by Daniel Robbins.

__NOTOC__
__NOTITLE__
__NOEDITSECTION__

[[Category:Funtoo|*]]

ZFS Install Guide

2013-06-16T07:31:43Z

Fearedbliss: funtoo install video v3

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 SLAX with ZFS SBs (SLAX Bundle) already included.

This is just a file that when combined with SLAX, gives you those tools.

<pre>
Name: SLAX-English-US-7.0.8-x86_64_ZFS.iso (229 MB)
Release Date: 2013-06-15
md5sum 358e4b3cbec9110de83e5d1779200eeb
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/slax/SLAX-English-US-7.0.8-x86_64_ZFS.iso Download SLAX 7.0.8 with ZFS]''' 

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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, /var
# ##i##zfs create -o mountpoint=/usr/src rpool/FUNTOO/src
# ##i##zfs create -o mountpoint=/var rpool/FUNTOO/var
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

Make a directory for /boot
# ##i##mkdir /mnt/funtoo/boot

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

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

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet refresh
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

{{fancyimportant|We are using the 'refresh' option because the current cachefile that was generated in SLAX won't work when the system is live. We will generate a new cachefile on the fly. You will need to recreate the initramfs once you are in the system so that the initramfs can have the new cachefile inside of it!}}

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

<console>
Delete the stage3 tarball that you downloaded earlier so it doesn't take up space.
# ##i##cd /
# ##i##rm stage3-latest.tar.xz

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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 ==

=== Recreate initramfs ===
After you restart your machine and your inside the live system, remake a new initrd if you are using "Bliss Initramfs Creator". This is because the old cachefile that was used inside SLAX won't work for booting (At least not the first time). Now that our system is up, we will recreate the cache.

<console>
# ##i##cd /opt/bliss-initramfs
# ##i##./createInit

Pick your desired option

Once your initrd is made, move it to /boot
# ##i##mv initrd* /boot

Now edit grub.cfg and remove the "refresh" option
nano /boot/grub/grub.cfg
</console>

=== 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:
<console># ##i##zfs snapshot -r rpool@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

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>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-16T05:31:53Z

Fearedbliss: /* Installing Funtoo */

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 SLAX with ZFS SBs (SLAX Bundle) already included.

This is just a file that when combined with SLAX, gives you those tools.

<pre>
Name: SLAX-English-US-7.0.8-x86_64_ZFS.iso (229 MB)
Release Date: 2013-06-15
md5sum 358e4b3cbec9110de83e5d1779200eeb
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/slax/SLAX-English-US-7.0.8-x86_64_ZFS.iso Download SLAX 7.0.8 with ZFS]''' 

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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, /var
# ##i##zfs create -o mountpoint=/usr/src rpool/FUNTOO/src
# ##i##zfs create -o mountpoint=/var rpool/FUNTOO/var
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

Make a directory for /boot
# ##i##mkdir /mnt/funtoo/boot

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

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

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet refresh
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

{{fancyimportant|We are using the 'refresh' option because the current cachefile that was generated in SLAX won't work when the system is live. We will generate a new cachefile on the fly. You will need to recreate the initramfs once you are in the system so that the initramfs can have the new cachefile inside of it!}}

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

<console>
Delete the stage3 tarball that you downloaded earlier so it doesn't take up space.
# ##i##cd /
# ##i##rm stage3-latest.tar.xz

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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 ==

=== Recreate initramfs ===
After you restart your machine and your inside the live system, remake a new initrd if you are using "Bliss Initramfs Creator". This is because the old cachefile that was used inside SLAX won't work for booting (At least not the first time). Now that our system is up, we will recreate the cache.

<console>
# ##i##cd /opt/bliss-initramfs
# ##i##./createInit

Pick your desired option

Once your initrd is made, move it to /boot
# ##i##mv initrd* /boot

Now edit grub.cfg and remove the "refresh" option
nano /boot/grub/grub.cfg
</console>

=== 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:
<console># ##i##zfs snapshot -r rpool@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

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>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-16T04:28:52Z

Fearedbliss: /* After reboot */ nocache -> refresh option

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 SLAX with ZFS SBs (SLAX Bundle) already included.

This is just a file that when combined with SLAX, gives you those tools.

<pre>
Name: SLAX-English-US-7.0.8-x86_64_ZFS.iso (229 MB)
Release Date: 2013-06-15
md5sum 358e4b3cbec9110de83e5d1779200eeb
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/slax/SLAX-English-US-7.0.8-x86_64_ZFS.iso Download SLAX 7.0.8 with ZFS]''' 

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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, /var
# ##i##zfs create -o mountpoint=/usr/src rpool/FUNTOO/src
# ##i##zfs create -o mountpoint=/var rpool/FUNTOO/var
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

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

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet refresh
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

{{fancyimportant|We are using the 'refresh' option because the current cachefile that was generated in SLAX won't work when the system is live. We will generate a new cachefile on the fly. You will need to recreate the initramfs once you are in the system so that the initramfs can have the new cachefile inside of it!}}

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

<console>
Delete the stage3 tarball that you downloaded earlier so it doesn't take up space.
# ##i##cd /
# ##i##rm stage3-latest.tar.xz

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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 ==

=== Recreate initramfs ===
After you restart your machine and your inside the live system, remake a new initrd if you are using "Bliss Initramfs Creator". This is because the old cachefile that was used inside SLAX won't work for booting (At least not the first time). Now that our system is up, we will recreate the cache.

<console>
# ##i##cd /opt/bliss-initramfs
# ##i##./createInit

Pick your desired option

Once your initrd is made, move it to /boot
# ##i##mv initrd* /boot

Now edit grub.cfg and remove the "refresh" option
nano /boot/grub/grub.cfg
</console>

=== 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:
<console># ##i##zfs snapshot -r rpool@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

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>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-16T04:27:28Z

Fearedbliss: /* Bliss Initramfs Creator */

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 SLAX with ZFS SBs (SLAX Bundle) already included.

This is just a file that when combined with SLAX, gives you those tools.

<pre>
Name: SLAX-English-US-7.0.8-x86_64_ZFS.iso (229 MB)
Release Date: 2013-06-15
md5sum 358e4b3cbec9110de83e5d1779200eeb
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/slax/SLAX-English-US-7.0.8-x86_64_ZFS.iso Download SLAX 7.0.8 with ZFS]''' 

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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, /var
# ##i##zfs create -o mountpoint=/usr/src rpool/FUNTOO/src
# ##i##zfs create -o mountpoint=/var rpool/FUNTOO/var
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

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

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet refresh
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

{{fancyimportant|We are using the 'refresh' option because the current cachefile that was generated in SLAX won't work when the system is live. We will generate a new cachefile on the fly. You will need to recreate the initramfs once you are in the system so that the initramfs can have the new cachefile inside of it!}}

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

<console>
Delete the stage3 tarball that you downloaded earlier so it doesn't take up space.
# ##i##cd /
# ##i##rm stage3-latest.tar.xz

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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 ==

=== Recreate initramfs ===
After you restart your machine and your inside the live system, remake a new initrd if you are using "Bliss Initramfs Creator". This is because the old cachefile that was used inside SLAX won't work for booting (At least not the first time). Now that our system is up, we will recreate the cache.

<console>
# ##i##cd /opt/bliss-initramfs
# ##i##./createInit

Pick your desired option

Once your initrd is made, move it to /boot
# ##i##mv initrd* /boot

Now edit grub.cfg and remove the "nocache" option
nano /boot/grub/grub.cfg
</console>

=== 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:
<console># ##i##zfs snapshot -r rpool@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

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>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-16T03:31:23Z

Fearedbliss: /* Extra: After reboot */

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 SLAX with ZFS SBs (SLAX Bundle) already included.

This is just a file that when combined with SLAX, gives you those tools.

<pre>
Name: SLAX-English-US-7.0.8-x86_64_ZFS.iso (229 MB)
Release Date: 2013-06-15
md5sum 358e4b3cbec9110de83e5d1779200eeb
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/slax/SLAX-English-US-7.0.8-x86_64_ZFS.iso Download SLAX 7.0.8 with ZFS]''' 

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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, /var
# ##i##zfs create -o mountpoint=/usr/src rpool/FUNTOO/src
# ##i##zfs create -o mountpoint=/var rpool/FUNTOO/var
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

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

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet nocache
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

{{fancyimportant|We are using the 'nocache' option because the current cachefile that was generated in SLAX won't work when the system is live. We will ignore the cachefile and make a new one once we are fully booted.}}

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

<console>
Delete the stage3 tarball that you downloaded earlier so it doesn't take up space.
# ##i##cd /
# ##i##rm stage3-latest.tar.xz

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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 ==

=== Recreate initramfs ===
After you restart your machine and your inside the live system, remake a new initrd if you are using "Bliss Initramfs Creator". This is because the old cachefile that was used inside SLAX won't work for booting (At least not the first time). Now that our system is up, we will recreate the cache.

<console>
# ##i##cd /opt/bliss-initramfs
# ##i##./createInit

Pick your desired option

Once your initrd is made, move it to /boot
# ##i##mv initrd* /boot

Now edit grub.cfg and remove the "nocache" option
nano /boot/grub/grub.cfg
</console>

=== 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:
<console># ##i##zfs snapshot -r rpool@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

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>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-16T03:26:40Z

Fearedbliss: /* Create the initramfs */ - warning about old cachefile

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 SLAX with ZFS SBs (SLAX Bundle) already included.

This is just a file that when combined with SLAX, gives you those tools.

<pre>
Name: SLAX-English-US-7.0.8-x86_64_ZFS.iso (229 MB)
Release Date: 2013-06-15
md5sum 358e4b3cbec9110de83e5d1779200eeb
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/slax/SLAX-English-US-7.0.8-x86_64_ZFS.iso Download SLAX 7.0.8 with ZFS]''' 

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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, /var
# ##i##zfs create -o mountpoint=/usr/src rpool/FUNTOO/src
# ##i##zfs create -o mountpoint=/var rpool/FUNTOO/var
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

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

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet nocache
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

{{fancyimportant|We are using the 'nocache' option because the current cachefile that was generated in SLAX won't work when the system is live. We will ignore the cachefile and make a new one once we are fully booted.}}

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

<console>
Delete the stage3 tarball that you downloaded earlier so it doesn't take up space.
# ##i##cd /
# ##i##rm stage3-latest.tar.xz

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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.

== 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:
<console># ##i##zfs snapshot rpool/ROOT/funtoo@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

If your machine ever fails and you need to get back to this state, just type:
<console># ##i##zfs rollback rpool/ROOT/funtoo@install</console>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-16T03:19:10Z

Fearedbliss: /* Clean up and reboot */

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 SLAX with ZFS SBs (SLAX Bundle) already included.

This is just a file that when combined with SLAX, gives you those tools.

<pre>
Name: SLAX-English-US-7.0.8-x86_64_ZFS.iso (229 MB)
Release Date: 2013-06-15
md5sum 358e4b3cbec9110de83e5d1779200eeb
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/slax/SLAX-English-US-7.0.8-x86_64_ZFS.iso Download SLAX 7.0.8 with ZFS]''' 

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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, /var
# ##i##zfs create -o mountpoint=/usr/src rpool/FUNTOO/src
# ##i##zfs create -o mountpoint=/var rpool/FUNTOO/var
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

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

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

<console>
Delete the stage3 tarball that you downloaded earlier so it doesn't take up space.
# ##i##cd /
# ##i##rm stage3-latest.tar.xz

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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.

== 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:
<console># ##i##zfs snapshot rpool/ROOT/funtoo@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

If your machine ever fails and you need to get back to this state, just type:
<console># ##i##zfs rollback rpool/ROOT/funtoo@install</console>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-16T03:13:40Z

Fearedbliss: removed depmod bullshit. No longer needed.

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 SLAX with ZFS SBs (SLAX Bundle) already included.

This is just a file that when combined with SLAX, gives you those tools.

<pre>
Name: SLAX-English-US-7.0.8-x86_64_ZFS.iso (229 MB)
Release Date: 2013-06-15
md5sum 358e4b3cbec9110de83e5d1779200eeb
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/slax/SLAX-English-US-7.0.8-x86_64_ZFS.iso Download SLAX 7.0.8 with ZFS]''' 

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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, /var
# ##i##zfs create -o mountpoint=/usr/src rpool/FUNTOO/src
# ##i##zfs create -o mountpoint=/var rpool/FUNTOO/var
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

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

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

<console>
Delete the stage3 tarball that you downloaded earlier so it doesn't take up space.
# ##i##cd /
# ##i##rm stage3-latest.tar.xz

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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.

== 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:
<console># ##i##zfs snapshot rpool/ROOT/funtoo@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

If your machine ever fails and you need to get back to this state, just type:
<console># ##i##zfs rollback rpool/ROOT/funtoo@install</console>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-16T03:12:09Z

Fearedbliss: /* Downloading the ISO (With ZFS) */ - switched to slax

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 the premade System Rescue CD with ZFS SRMs (System Rescue Modules) already included.

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

<pre>
Name: SLAX-English-US-7.0.8-x86_64_ZFS.iso (229 MB)
Release Date: 2013-06-15
md5sum 358e4b3cbec9110de83e5d1779200eeb
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/slax/SLAX-English-US-7.0.8-x86_64_ZFS.iso Download SLAX 7.0.8 with ZFS]''' 

== Inside the ISO (Loading the ZFS Modules) ==
Once you boot into your System Rescue CD environment, you will need to update the kernel's dependency list so that the kernel knows that the zfs modules are available. This is extremely easy and it only takes one second. Just type the following two commands:

<console>
# ##i##depmod
# ##i##modprobe -v zfs
</console>

You should now see 6 modules load. Example:

<console>
root@sysresccd /root % ##i##depmod
root@sysresccd /root % ##i##modprobe -v zfs
insmod /lib/modules/3.9.4-alt370-amd64/extra/spl/spl.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/nvpair/znvpair.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/zcommon/zcommon.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/avl/zavl.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/unicode/zunicode.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/zfs/zfs.ko.gz
</console>

If you don't do the depmod first, you will see the following error:

<console>
root@sysresccd /root % ##i##modprobe -v zfs
modprobe: FATAL: Module zfs not found.

# OR You will see this if you try to run a zfs command without having the modules loaded

root@sysresccd /root % ##i##zpool status
Failed to load ZFS module stack.
Load the module manually by running 'insmod <location>/zfs.ko' as root.
Failed to load ZFS module stack.
Load the module manually by running 'insmod <location>/zfs.ko' as root.
</console>

So make sure to run '''depmod''' first!

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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, /var
# ##i##zfs create -o mountpoint=/usr/src rpool/FUNTOO/src
# ##i##zfs create -o mountpoint=/var rpool/FUNTOO/var
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

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

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

<console>
Delete the stage3 tarball that you downloaded earlier so it doesn't take up space.
# ##i##cd /
# ##i##rm stage3-latest.tar.xz

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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.

== 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:
<console># ##i##zfs snapshot rpool/ROOT/funtoo@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

If your machine ever fails and you need to get back to this state, just type:
<console># ##i##zfs rollback rpool/ROOT/funtoo@install</console>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-16T03:06:48Z

Fearedbliss: /* Clean up and reboot */ - removed portage_tarball from instruction.

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 the premade System Rescue CD with ZFS SRMs (System Rescue Modules) already included.

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

<pre>
Name: systemrescuecd-x86-3.7.0-zfs (402 MiB)
Release Date: 2013-06-09
md5sum 62605474641ce2b1a07fec8330377208
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/sysresccd/systemrescuecd-x86-3.7.0-zfs.iso Download System Rescue CD 3.7.0 with ZFS]''' 

== Inside the ISO (Loading the ZFS Modules) ==
Once you boot into your System Rescue CD environment, you will need to update the kernel's dependency list so that the kernel knows that the zfs modules are available. This is extremely easy and it only takes one second. Just type the following two commands:

<console>
# ##i##depmod
# ##i##modprobe -v zfs
</console>

You should now see 6 modules load. Example:

<console>
root@sysresccd /root % ##i##depmod
root@sysresccd /root % ##i##modprobe -v zfs
insmod /lib/modules/3.9.4-alt370-amd64/extra/spl/spl.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/nvpair/znvpair.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/zcommon/zcommon.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/avl/zavl.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/unicode/zunicode.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/zfs/zfs.ko.gz
</console>

If you don't do the depmod first, you will see the following error:

<console>
root@sysresccd /root % ##i##modprobe -v zfs
modprobe: FATAL: Module zfs not found.

# OR You will see this if you try to run a zfs command without having the modules loaded

root@sysresccd /root % ##i##zpool status
Failed to load ZFS module stack.
Load the module manually by running 'insmod <location>/zfs.ko' as root.
Failed to load ZFS module stack.
Load the module manually by running 'insmod <location>/zfs.ko' as root.
</console>

So make sure to run '''depmod''' first!

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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, /var
# ##i##zfs create -o mountpoint=/usr/src rpool/FUNTOO/src
# ##i##zfs create -o mountpoint=/var rpool/FUNTOO/var
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

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

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

<console>
Delete the stage3 tarball that you downloaded earlier so it doesn't take up space.
# ##i##cd /
# ##i##rm stage3-latest.tar.xz

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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.

== 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:
<console># ##i##zfs snapshot rpool/ROOT/funtoo@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

If your machine ever fails and you need to get back to this state, just type:
<console># ##i##zfs rollback rpool/ROOT/funtoo@install</console>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-16T02:14:29Z

Fearedbliss: /* Create the zfs datasets */

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 the premade System Rescue CD with ZFS SRMs (System Rescue Modules) already included.

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

<pre>
Name: systemrescuecd-x86-3.7.0-zfs (402 MiB)
Release Date: 2013-06-09
md5sum 62605474641ce2b1a07fec8330377208
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/sysresccd/systemrescuecd-x86-3.7.0-zfs.iso Download System Rescue CD 3.7.0 with ZFS]''' 

== Inside the ISO (Loading the ZFS Modules) ==
Once you boot into your System Rescue CD environment, you will need to update the kernel's dependency list so that the kernel knows that the zfs modules are available. This is extremely easy and it only takes one second. Just type the following two commands:

<console>
# ##i##depmod
# ##i##modprobe -v zfs
</console>

You should now see 6 modules load. Example:

<console>
root@sysresccd /root % ##i##depmod
root@sysresccd /root % ##i##modprobe -v zfs
insmod /lib/modules/3.9.4-alt370-amd64/extra/spl/spl.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/nvpair/znvpair.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/zcommon/zcommon.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/avl/zavl.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/unicode/zunicode.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/zfs/zfs.ko.gz
</console>

If you don't do the depmod first, you will see the following error:

<console>
root@sysresccd /root % ##i##modprobe -v zfs
modprobe: FATAL: Module zfs not found.

# OR You will see this if you try to run a zfs command without having the modules loaded

root@sysresccd /root % ##i##zpool status
Failed to load ZFS module stack.
Load the module manually by running 'insmod <location>/zfs.ko' as root.
Failed to load ZFS module stack.
Load the module manually by running 'insmod <location>/zfs.ko' as root.
</console>

So make sure to run '''depmod''' first!

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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, /var
# ##i##zfs create -o mountpoint=/usr/src rpool/FUNTOO/src
# ##i##zfs create -o mountpoint=/var rpool/FUNTOO/var
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

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

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

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

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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.

== 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:
<console># ##i##zfs snapshot rpool/ROOT/funtoo@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

If your machine ever fails and you need to get back to this state, just type:
<console># ##i##zfs rollback rpool/ROOT/funtoo@install</console>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-16T02:13:12Z

Fearedbliss: /* Create the zfs datasets */ - removed portage section, added it on top, taking advantage of inheritance properties for -m none and compression.

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 the premade System Rescue CD with ZFS SRMs (System Rescue Modules) already included.

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

<pre>
Name: systemrescuecd-x86-3.7.0-zfs (402 MiB)
Release Date: 2013-06-09
md5sum 62605474641ce2b1a07fec8330377208
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/sysresccd/systemrescuecd-x86-3.7.0-zfs.iso Download System Rescue CD 3.7.0 with ZFS]''' 

== Inside the ISO (Loading the ZFS Modules) ==
Once you boot into your System Rescue CD environment, you will need to update the kernel's dependency list so that the kernel knows that the zfs modules are available. This is extremely easy and it only takes one second. Just type the following two commands:

<console>
# ##i##depmod
# ##i##modprobe -v zfs
</console>

You should now see 6 modules load. Example:

<console>
root@sysresccd /root % ##i##depmod
root@sysresccd /root % ##i##modprobe -v zfs
insmod /lib/modules/3.9.4-alt370-amd64/extra/spl/spl.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/nvpair/znvpair.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/zcommon/zcommon.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/avl/zavl.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/unicode/zunicode.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/zfs/zfs.ko.gz
</console>

If you don't do the depmod first, you will see the following error:

<console>
root@sysresccd /root % ##i##modprobe -v zfs
modprobe: FATAL: Module zfs not found.

# OR You will see this if you try to run a zfs command without having the modules loaded

root@sysresccd /root % ##i##zpool status
Failed to load ZFS module stack.
Load the module manually by running 'insmod <location>/zfs.ko' as root.
Failed to load ZFS module stack.
Load the module manually by running 'insmod <location>/zfs.ko' as root.
</console>

So make sure to run '''depmod''' first!

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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, /var
# ##i##zfs create -o mountpoint=/usr/src rpool/FUNTOO/src
# ##i##zfs create -o mountpoint=/var rpool/FUNTOO/var
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

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

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

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

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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.

== 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:
<console># ##i##zfs snapshot rpool/ROOT/funtoo@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

If your machine ever fails and you need to get back to this state, just type:
<console># ##i##zfs rollback rpool/ROOT/funtoo@install</console>

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

__NOTOC__
__NOTITLE__

Creating System Rescue CD ZFS Modules

2013-06-15T21:25:41Z

Fearedbliss: /* Using the prebuilt srm */ - removed more overlay leftovers

This HOWTO will show you how to create your own zfs srm or download the prebuilt zfs srm module from my website.

== Compiling a compatible kernel ==

The first thing you need to do is decide for which version of System Rescue CD you will be building for. Each System Rescue CD version has a different set of kernels. Specifically each version has a Stable kernel and an Alternate Kernel. The stable kernels get minor version increments every release (Sometimes major ones but usually doesn't happen too quickly), the Alternate kernels tend to move up much faster. For example System Rescue CD had the following stable/alternate kernels:

{| class="wikitable"
|-
! Version !! Stable !! Alternate
|-
| 3.7.0 || 3.4.47 || 3.9.4
|-
| 3.5.0 || 3.4.37 || 3.8.4
|}

===Download kernel and patches===
Once you decide which version you want to use, you can go to http://kernel.sysresccd.org/ and pick the version you want. After you do this, download all the stuff in that directory and put them in their own folder (a work directory). The files that are named std-sources are the patches for the regular stable kernel, the patches named alt-sources are the patches for the alternate kernel. Once you have the patches, go to kernel.org and also download the initial release of the kernel sources you want. For example, if you want to build an srm for 3.4.2 which uses the 3.4.35 kernel, just download the 3.4 (3.4.0) kernel. You just need to download the initial release because one of the patches you downloaded earlier is the patch to update the 3.4.0 to 3.4.35.

Once you download the kernel you want, let's extract and patch it.

<console>
# ##i##tar xf linux-3.4.tar.bz2
# ##i##mv linux-3.4 linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-01-stable-3.4.35.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-02-fc16.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-03-aufs.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
</console>

===Retrieve kernel configuration===
Once that is complete, you will need to get the kernel config specifically for the kernel and architecture you want. The easiest way I found to do this was to download the System Rescue CD you want, and then boot it inside a VM. Once you are inside the VM, go to the /root directory, and it will be a file named kernel-<version>.conf. Copy this file over SSH and put it in a safe location. Also copy it over into the linux kernel directory and rename it to .config.

===Build the kernel===
Once you copy the kernel config over, do a make menuconfig to begin. You will only need to change two settings inside the config, add the proper kernel name, and remove the old initramfs source files directory. This directory doesn't exist locally. This is a remnant of upstream's build process.

Follow the below tree structure, and make it equal to what is below:

<console>
General Setup ->
(-std342-amd64) Local version - append to kernel release
[*] Initial RAM filesystem and RAM disk (initramfs/initrd) support () Initramfs source file(s)
</console>

The Local version above will end up making the kernel modules directory be 3.4.35-std342-amd64. The reason the kernel modules directory has to be equal to this is because our directory will be merged into the System Rescue CD later on, so the names need to be exactly the same so that the System Rescue CD system can find our kernel modules.

If you want to build an srm (which you do), you also need to change the following inside the kernel config so that squashfs-tools can work later on:

<console>
File Systems ->
Miscellaneous Filesystems ->
<*> SquashFS 4.0 - Squashed file system support
[*] Squashfs XATTR support
[*] Include support for ZLIB compressed file systems
[*] Include support for LZO compressed file systems
[*] Include support for XZ compressed file systems
[ ] Use 4K device block size?
[ ] Additional option for memory-constrained systems
</console>

Now save and exit, and continue to build your kernel.

<console>
# ##i##make bzImage modules
# ##i##make modules_install
</console>

{{fancynote|If you have multiple cores, do a make -j<# of processors+1> to build faster. Example: '''make -j9''' for an 8 core machine.}}

=== Using the portage tree ===
Inside the portage tree, there are ebuilds already prepared that will download the kernel, patch it, and perform any required substitutions. Afterwards you literally just go into your /usr/src/<kernel> directory, and run make. To see the available versions, run the following:

<console>
Versions available for standard kernel
# ##i##equery y std-sources

[I]3.4.37-r1 | o ~ o o o o o o o o o o o | o 3.4.37 | gentoo

Versions available for alternate kernel
# ##i##equery y alt-sources

[I]3.8.4 | o ~ o o o o o o o o o o o | o 3.8.4 | gentoo
</console>

I haven't written the ebuilds in a way where it's easy to tell (at first glance) what System Rescue CD version you need. However, you can check the ebuild and you will see the version of the CD inside there. You can also check the chart above.

If you wanted to install the standard kernel sources, you just emerge it like any other application:

<console>
# ##i##emerge std-sources
</console>

Once the kernel and the kernel module are installed, you need to make the SRM.

== Creating the SRM ==
It's time to gather the required files and pack them together in order for it to become an SRM. An SRM is nothing more than a directory that has been compressed with squashfs. You can emerge the "Bliss Initramfs Creator" which has a feature that will automagically build the srm for you.

You also need to have spl, zfs, and zfs-kmod installed on your system before you try to make the srm. Emerging '''"bliss-initramfs"''' should automatically pull those packages. If it doesn't, make sure you install them.

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

You should now have the following directory layout inside the '''/opt/bliss-initramfs''' folder:

<console>
octopus bliss-initramfs # ls -l
total 117
-rw-r--r-- 1 root root 6718 May 23 18:05 CHANGES
-rw-r--r-- 1 root root 176 May 23 18:05 CREDITS
-rw-r--r-- 1 root root 431 May 23 18:05 HELP
-rw-r--r-- 1 root root 1397 May 23 18:05 LICENSE
-rw-r--r-- 1 root root 1852 May 23 18:05 README
-rw-r--r-- 1 root root 3194 May 23 18:05 USAGE
-rwxr-xr-x 1 root root 2891 May 23 18:05 createInit
drwxr-xr-x 3 root root 4 May 23 18:11 files
drwxr-xr-x 3 root root 6 May 23 18:11 hooks
drwxr-xr-x 2 root root 5 May 23 22:01 resources
</console>

Then run the '''createInit''' script and follow the instructions for the kernel you want to make the srm for (In this case it's '''3.4.37-std350-amd64'''):

<console>
-----------------------------------
| Bliss Initramfs Creator - v1.8.1
| Author: Jonathan Vasquez <jvasquez1011@gmail.com>
| Distributed under the Simplified BSD License
-----------------------------------

>>> Which initramfs would you like to generate:
>> 1. ZFS
>> 2. Encrypted ZFS (LUKS + ZFS)
>> 3. More Options
>> 4. Exit Program

>>> Current choice [1]: ##i##3 ↵

>>> More Options:

>> 1. ZFS - System Rescue Module
>> 2. Back
>> 3. Exit Program

>>> Current choice [1]: ##i##↵

>>> Creating a ZFS System Rescue Module!

>>> Do you want to use the current kernel: 3.8.13-ALL? [Y/n]: ##i##n ↵

>>> Please enter the kernel name: ##i##3.4.37-std350-amd64 ↵

>>> Detected 64 bit platform
>>> Checking to see if modules directory exists for 3.4.37-std350-amd64...
>>> Creating SRMs for 3.4.37-std350-amd64...
>>> Creating directory structure for initramfs...
>>> Checking preliminary binaries...
>>> Checking binaries...
>>> Using ZFS
>>> Checking modules...
>>> Copying binaries...
>>> Copying modules...
>>> Copying documentation...
>>> Copying udev rules...
>>> Compressing kernel modules...
>>> Getting dependencies...
>>> Copying dependencies...
>>> Configuring files...
>>> Creating and Packing SRMs...
>>> Complete :)
</console>

Now you should have two new files:

<console>
-rw-r--r-- 1 root root 2068480 May 24 01:05 zfs-core-3.4.37-std350-amd64.srm
-rw-r--r-- 1 root root 483328 May 24 01:05 zfs-kmod-3.4.37-std350-amd64.srm
</console>

Now all you need to do is put those two files in the root of your USB directory.

If you are making srms for both the standard and alternate kernels, you will end up with two zfs-core files and two zfs-kmod files (1 set for each kernel). You don't need to put the zfs-core that it makes for one of the kernels. The zfs-core srm only has zfs program binaries, man pages, udev rules, and a few other things. The zfs-kmod is the srm that has the kernel modules (and only the kernel modules). So you can easily just put two zfs-kmods (one for each kernel version) and just re-use the same zfs-core for both of them.

== Using the prebuilt srm ==

=== Download the SRM ===
If you didn't build your own srm and want to use the prebuilt one, just emerge '''"zfs-srm"''' from the tree:

<console>
# ##i##emerge zfs-srm
</console>

You can check available versions just as you did above for the kernels:

<console>
Available versions of the zfs-srm
# ##i##equery y zfs-srm

[I]3.5.0 | o ~ o o o o o o o o o o o | o 3.5.0 | gentoo
</console>

(These versions match the version of the System Rescue CD).

Installing the zfs-srm will automatically pull the '''"bliss-isomaker"''' package which is just a script that assists you with rebuilding the System Rescue CD ISO so that the ISO includes the ZFS srms. The script lets you make a bootable ISO or a bootable USB.

Once it's installed, switch to the /opt/bliss-isomaker folder

<console>
# ##i##cd /opt/bliss-isomaker
</console>

You should now see a directory layout that looks similar to this:

<console>
octopus bliss-isomaker # ls -l
total 100
drwxr-xr-x 2 root root 5 May 24 01:41 3.5.0
-rw-r--r-- 1 root root 1397 May 24 01:31 LICENSE
-rw-r--r-- 1 root root 312 May 24 01:31 README
-rw-r--r-- 1 root root 576 May 24 01:31 USAGE
-rwxr-xr-x 1 root root 3228 May 24 01:31 create
drwxr-xr-x 2 root root 3 May 24 01:41 iso
drwxr-xr-x 2 root root 4 May 24 01:41 resources
drwxr-xr-x 2 root root 3 May 24 01:41 srm
</console>

The layout is as follows:
* 3.5.0 - This folder contains the System Rescue CD 3.5.0 specific srms for both the standard and alternate kernel that were installed by emerge.
* create - A script to automatically recreate the system rescue cd iso or usb with the zfs stuff included
* iso - directory to place your system rescue cd iso in
* srm - directory that has the srms
* resources - the files in this folder contain function calls that the 'create' script uses. You don't need to worry about these.

=== Installing the SRM ===
There are a few ways to do this, you can either use one of the scripts, or you can do it manually. Before anything, make sure to copy the SRMs from the <Version> folder to the srm folder if you are using a prebuilt one:

<console>
# ##i##cp 3.5.0/* srm
</console>

==== Generating a new iso ====
If you just want to remake a new iso so that you can burn onto a cd or use in a virtual machine, just copy your iso over to the iso directory, and run the 'create' script. The new iso will be located in the iso directory as well with a -zfs ending.

<console>
Running the script with 1 (or iso) chooses to make an iso. You can also pass the version as well.
# ##i##./create 1

or

# ##i##./create iso 3.5.0
</console>

==== Creating a fresh usb ====
If you want to have zfs on a usb with system rescue cd, put the iso in your iso dir, and then run the usb script. It will ask you what usb you want to format (This will delete everything), and then install system rescue cd onto it. Once that is done it will copy the zfs stuff over.

<console>
Running the script with 2 (or usb) chooses to make an usb. You can also pass the version as well.
# ##i##./create 2

or

# ##i##./create usb 3.5.0
</console>

==== Manual installation onto a usb ====
Assuming that your installing to a flash drive and that the flash drive is mounted in /mnt

1. Mount your usb drive

<console>
# ##i##mount /dev/sdX# /mnt/usbstick
</console>

'''Where X# is the letter and number of your device. Immediately after you plug your usb in, type `dmesg | tail` in the console and you should see it.'''

2. Copy the zfs .srms to /mnt/usbstick

<console>
# ##i##cp zfs-core-3.4.37-std350-amd64.srm zfs-kmod-3.4.37-std350-amd64.srm zfs-kmod-3.8.4-alt350-amd64.srm /mnt/usbstick
</console>

3. List your /mnt/usbstick directory and you should see something similar to the following in your /mnt/usbstick

<console>
octopus 3.5.0 # ls -l /mnt/usbstick
total 305028
drwxr-xr-x 3 root root 4096 May 23 20:51 boot
drwxr-xr-x 2 root root 4096 May 23 20:51 bootdisk
drwxr-xr-x 2 root root 4096 May 23 20:51 bootprog
drwxr-xr-x 3 root root 4096 May 23 20:51 efi
drwxr-xr-x 2 root root 4096 May 23 20:51 ntpasswd
-rwxr-xr-x 1 root root 2349 May 23 20:51 readme.txt
drwxr-xr-x 3 root root 4096 May 23 20:52 syslinux
-rwxr-xr-x 1 root root 309252096 May 23 20:51 sysrcd.dat
-rwxr-xr-x 1 root root 45 May 23 20:51 sysrcd.md5
drwxr-xr-x 2 root root 4096 May 23 20:51 usb_inst
-rwxr-xr-x 1 root root 15889 May 23 20:51 usb_inst.sh
-rwxr-xr-x 1 root root 877 May 23 20:51 usbstick.htm
-rwxr-xr-x 1 root root 6 May 23 20:51 version
-rwxr-xr-x 1 root root 2068480 May 23 20:51 zfs-core-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.8.4-alt350-amd64.srm
</console>

Now un-mount your flash drive and boot it into the machine that you want to use ZFS on.

<console>
# ##i##umount /mnt/usbstick
</console>

== Booting into the correct kernel ==
'''If you are using the standard srm:'''
<console>
C) Standard 64bit kernel (rescue64) with more choice... >
1. SystemRescueCd with default options
</console>

'''If you are using the alternative srm:'''
<console>
E) Alternative 64bit kernel (altker64) with more choice... >
1. SystemRescueCd with default options
</console>

2. Run 'depmod' so that the new modules can be seen by the kernel.

<console>
# ##i##depmod
</console>

{{fancywarning|You must run '''depmod'''. If you don't, then you will get failed to load the ZFS stack error!}}

3. Use ZFS as usual. If you type '''zpool status''' and then type '''dmesg | tail''',

you should see something that says:

<console>
ZFS: Loaded module v0.6.1-1, ZFS pool version 5000, ZFS filesystem version 5
</console>

If you see the above, then the modules loaded successfully!

Enjoy System Rescue CD with ZFS :)

== Using the premade iso ==

<big>If you don't want to do any of the above stuff but just want the ISO with the ZFS SRMs already included, simply [http://ftp.osuosl.org/pub/funtoo/distfiles/sysresccd/systemrescuecd-x86-3.7.0-zfs.iso/ Download the ISO].</big>

[[Category:HOWTO]]

Creating System Rescue CD ZFS Modules

2013-06-15T21:24:05Z

Fearedbliss: removed overlay stuff

This HOWTO will show you how to create your own zfs srm or download the prebuilt zfs srm module from my website.

== Compiling a compatible kernel ==

The first thing you need to do is decide for which version of System Rescue CD you will be building for. Each System Rescue CD version has a different set of kernels. Specifically each version has a Stable kernel and an Alternate Kernel. The stable kernels get minor version increments every release (Sometimes major ones but usually doesn't happen too quickly), the Alternate kernels tend to move up much faster. For example System Rescue CD had the following stable/alternate kernels:

{| class="wikitable"
|-
! Version !! Stable !! Alternate
|-
| 3.7.0 || 3.4.47 || 3.9.4
|-
| 3.5.0 || 3.4.37 || 3.8.4
|}

===Download kernel and patches===
Once you decide which version you want to use, you can go to http://kernel.sysresccd.org/ and pick the version you want. After you do this, download all the stuff in that directory and put them in their own folder (a work directory). The files that are named std-sources are the patches for the regular stable kernel, the patches named alt-sources are the patches for the alternate kernel. Once you have the patches, go to kernel.org and also download the initial release of the kernel sources you want. For example, if you want to build an srm for 3.4.2 which uses the 3.4.35 kernel, just download the 3.4 (3.4.0) kernel. You just need to download the initial release because one of the patches you downloaded earlier is the patch to update the 3.4.0 to 3.4.35.

Once you download the kernel you want, let's extract and patch it.

<console>
# ##i##tar xf linux-3.4.tar.bz2
# ##i##mv linux-3.4 linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-01-stable-3.4.35.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-02-fc16.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-03-aufs.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
</console>

===Retrieve kernel configuration===
Once that is complete, you will need to get the kernel config specifically for the kernel and architecture you want. The easiest way I found to do this was to download the System Rescue CD you want, and then boot it inside a VM. Once you are inside the VM, go to the /root directory, and it will be a file named kernel-<version>.conf. Copy this file over SSH and put it in a safe location. Also copy it over into the linux kernel directory and rename it to .config.

===Build the kernel===
Once you copy the kernel config over, do a make menuconfig to begin. You will only need to change two settings inside the config, add the proper kernel name, and remove the old initramfs source files directory. This directory doesn't exist locally. This is a remnant of upstream's build process.

Follow the below tree structure, and make it equal to what is below:

<console>
General Setup ->
(-std342-amd64) Local version - append to kernel release
[*] Initial RAM filesystem and RAM disk (initramfs/initrd) support () Initramfs source file(s)
</console>

The Local version above will end up making the kernel modules directory be 3.4.35-std342-amd64. The reason the kernel modules directory has to be equal to this is because our directory will be merged into the System Rescue CD later on, so the names need to be exactly the same so that the System Rescue CD system can find our kernel modules.

If you want to build an srm (which you do), you also need to change the following inside the kernel config so that squashfs-tools can work later on:

<console>
File Systems ->
Miscellaneous Filesystems ->
<*> SquashFS 4.0 - Squashed file system support
[*] Squashfs XATTR support
[*] Include support for ZLIB compressed file systems
[*] Include support for LZO compressed file systems
[*] Include support for XZ compressed file systems
[ ] Use 4K device block size?
[ ] Additional option for memory-constrained systems
</console>

Now save and exit, and continue to build your kernel.

<console>
# ##i##make bzImage modules
# ##i##make modules_install
</console>

{{fancynote|If you have multiple cores, do a make -j<# of processors+1> to build faster. Example: '''make -j9''' for an 8 core machine.}}

=== Using the portage tree ===
Inside the portage tree, there are ebuilds already prepared that will download the kernel, patch it, and perform any required substitutions. Afterwards you literally just go into your /usr/src/<kernel> directory, and run make. To see the available versions, run the following:

<console>
Versions available for standard kernel
# ##i##equery y std-sources

[I]3.4.37-r1 | o ~ o o o o o o o o o o o | o 3.4.37 | gentoo

Versions available for alternate kernel
# ##i##equery y alt-sources

[I]3.8.4 | o ~ o o o o o o o o o o o | o 3.8.4 | gentoo
</console>

I haven't written the ebuilds in a way where it's easy to tell (at first glance) what System Rescue CD version you need. However, you can check the ebuild and you will see the version of the CD inside there. You can also check the chart above.

If you wanted to install the standard kernel sources, you just emerge it like any other application:

<console>
# ##i##emerge std-sources
</console>

Once the kernel and the kernel module are installed, you need to make the SRM.

== Creating the SRM ==
It's time to gather the required files and pack them together in order for it to become an SRM. An SRM is nothing more than a directory that has been compressed with squashfs. You can emerge the "Bliss Initramfs Creator" which has a feature that will automagically build the srm for you.

You also need to have spl, zfs, and zfs-kmod installed on your system before you try to make the srm. Emerging '''"bliss-initramfs"''' should automatically pull those packages. If it doesn't, make sure you install them.

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

You should now have the following directory layout inside the '''/opt/bliss-initramfs''' folder:

<console>
octopus bliss-initramfs # ls -l
total 117
-rw-r--r-- 1 root root 6718 May 23 18:05 CHANGES
-rw-r--r-- 1 root root 176 May 23 18:05 CREDITS
-rw-r--r-- 1 root root 431 May 23 18:05 HELP
-rw-r--r-- 1 root root 1397 May 23 18:05 LICENSE
-rw-r--r-- 1 root root 1852 May 23 18:05 README
-rw-r--r-- 1 root root 3194 May 23 18:05 USAGE
-rwxr-xr-x 1 root root 2891 May 23 18:05 createInit
drwxr-xr-x 3 root root 4 May 23 18:11 files
drwxr-xr-x 3 root root 6 May 23 18:11 hooks
drwxr-xr-x 2 root root 5 May 23 22:01 resources
</console>

Then run the '''createInit''' script and follow the instructions for the kernel you want to make the srm for (In this case it's '''3.4.37-std350-amd64'''):

<console>
-----------------------------------
| Bliss Initramfs Creator - v1.8.1
| Author: Jonathan Vasquez <jvasquez1011@gmail.com>
| Distributed under the Simplified BSD License
-----------------------------------

>>> Which initramfs would you like to generate:
>> 1. ZFS
>> 2. Encrypted ZFS (LUKS + ZFS)
>> 3. More Options
>> 4. Exit Program

>>> Current choice [1]: ##i##3 ↵

>>> More Options:

>> 1. ZFS - System Rescue Module
>> 2. Back
>> 3. Exit Program

>>> Current choice [1]: ##i##↵

>>> Creating a ZFS System Rescue Module!

>>> Do you want to use the current kernel: 3.8.13-ALL? [Y/n]: ##i##n ↵

>>> Please enter the kernel name: ##i##3.4.37-std350-amd64 ↵

>>> Detected 64 bit platform
>>> Checking to see if modules directory exists for 3.4.37-std350-amd64...
>>> Creating SRMs for 3.4.37-std350-amd64...
>>> Creating directory structure for initramfs...
>>> Checking preliminary binaries...
>>> Checking binaries...
>>> Using ZFS
>>> Checking modules...
>>> Copying binaries...
>>> Copying modules...
>>> Copying documentation...
>>> Copying udev rules...
>>> Compressing kernel modules...
>>> Getting dependencies...
>>> Copying dependencies...
>>> Configuring files...
>>> Creating and Packing SRMs...
>>> Complete :)
</console>

Now you should have two new files:

<console>
-rw-r--r-- 1 root root 2068480 May 24 01:05 zfs-core-3.4.37-std350-amd64.srm
-rw-r--r-- 1 root root 483328 May 24 01:05 zfs-kmod-3.4.37-std350-amd64.srm
</console>

Now all you need to do is put those two files in the root of your USB directory.

If you are making srms for both the standard and alternate kernels, you will end up with two zfs-core files and two zfs-kmod files (1 set for each kernel). You don't need to put the zfs-core that it makes for one of the kernels. The zfs-core srm only has zfs program binaries, man pages, udev rules, and a few other things. The zfs-kmod is the srm that has the kernel modules (and only the kernel modules). So you can easily just put two zfs-kmods (one for each kernel version) and just re-use the same zfs-core for both of them.

== Using the prebuilt srm ==

=== Download the SRM ===
If you didn't build your own srm and want to use the prebuilt one, just emerge '''"zfs-srm"''' from the overlay:

(Instructions on [[Creating_System_Rescue_CD_ZFS_Modules#Adding_the_overlay|adding the overlay]] can be found at the top of this page)

<console>
# ##i##emerge zfs-srm
</console>

You can check available versions just as you did above for the kernels:

<console>
Available versions of the zfs-srm
# ##i##equery y -O zfs-srm

[I]3.5.0 | o ~ o o o o o o o o o o o | o 3.5.0 | fearedbliss
</console>

(These versions match the version of the System Rescue CD).

Installing the zfs-srm will automatically pull the '''"bliss-isomaker"''' package which is just a script that assists you with rebuilding the System Rescue CD ISO so that the ISO includes the ZFS srms. The script lets you make a bootable ISO or a bootable USB.

Once it's installed, switch to the /opt/bliss-isomaker folder

<console>
# ##i##cd /opt/bliss-isomaker
</console>

You should now see a directory layout that looks similar to this:

<console>
octopus bliss-isomaker # ls -l
total 100
drwxr-xr-x 2 root root 5 May 24 01:41 3.5.0
-rw-r--r-- 1 root root 1397 May 24 01:31 LICENSE
-rw-r--r-- 1 root root 312 May 24 01:31 README
-rw-r--r-- 1 root root 576 May 24 01:31 USAGE
-rwxr-xr-x 1 root root 3228 May 24 01:31 create
drwxr-xr-x 2 root root 3 May 24 01:41 iso
drwxr-xr-x 2 root root 4 May 24 01:41 resources
drwxr-xr-x 2 root root 3 May 24 01:41 srm
</console>

The layout is as follows:
* 3.5.0 - This folder contains the System Rescue CD 3.5.0 specific srms for both the standard and alternate kernel that were installed by emerge.
* create - A script to automatically recreate the system rescue cd iso or usb with the zfs stuff included
* iso - directory to place your system rescue cd iso in
* srm - directory that has the srms
* resources - the files in this folder contain function calls that the 'create' script uses. You don't need to worry about these.

=== Installing the SRM ===
There are a few ways to do this, you can either use one of the scripts, or you can do it manually. Before anything, make sure to copy the SRMs from the <Version> folder to the srm folder if you are using a prebuilt one:

<console>
# ##i##cp 3.5.0/* srm
</console>

==== Generating a new iso ====
If you just want to remake a new iso so that you can burn onto a cd or use in a virtual machine, just copy your iso over to the iso directory, and run the 'create' script. The new iso will be located in the iso directory as well with a -zfs ending.

<console>
Running the script with 1 (or iso) chooses to make an iso. You can also pass the version as well.
# ##i##./create 1

or

# ##i##./create iso 3.5.0
</console>

==== Creating a fresh usb ====
If you want to have zfs on a usb with system rescue cd, put the iso in your iso dir, and then run the usb script. It will ask you what usb you want to format (This will delete everything), and then install system rescue cd onto it. Once that is done it will copy the zfs stuff over.

<console>
Running the script with 2 (or usb) chooses to make an usb. You can also pass the version as well.
# ##i##./create 2

or

# ##i##./create usb 3.5.0
</console>

==== Manual installation onto a usb ====
Assuming that your installing to a flash drive and that the flash drive is mounted in /mnt

1. Mount your usb drive

<console>
# ##i##mount /dev/sdX# /mnt/usbstick
</console>

'''Where X# is the letter and number of your device. Immediately after you plug your usb in, type `dmesg | tail` in the console and you should see it.'''

2. Copy the zfs .srms to /mnt/usbstick

<console>
# ##i##cp zfs-core-3.4.37-std350-amd64.srm zfs-kmod-3.4.37-std350-amd64.srm zfs-kmod-3.8.4-alt350-amd64.srm /mnt/usbstick
</console>

3. List your /mnt/usbstick directory and you should see something similar to the following in your /mnt/usbstick

<console>
octopus 3.5.0 # ls -l /mnt/usbstick
total 305028
drwxr-xr-x 3 root root 4096 May 23 20:51 boot
drwxr-xr-x 2 root root 4096 May 23 20:51 bootdisk
drwxr-xr-x 2 root root 4096 May 23 20:51 bootprog
drwxr-xr-x 3 root root 4096 May 23 20:51 efi
drwxr-xr-x 2 root root 4096 May 23 20:51 ntpasswd
-rwxr-xr-x 1 root root 2349 May 23 20:51 readme.txt
drwxr-xr-x 3 root root 4096 May 23 20:52 syslinux
-rwxr-xr-x 1 root root 309252096 May 23 20:51 sysrcd.dat
-rwxr-xr-x 1 root root 45 May 23 20:51 sysrcd.md5
drwxr-xr-x 2 root root 4096 May 23 20:51 usb_inst
-rwxr-xr-x 1 root root 15889 May 23 20:51 usb_inst.sh
-rwxr-xr-x 1 root root 877 May 23 20:51 usbstick.htm
-rwxr-xr-x 1 root root 6 May 23 20:51 version
-rwxr-xr-x 1 root root 2068480 May 23 20:51 zfs-core-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.8.4-alt350-amd64.srm
</console>

Now un-mount your flash drive and boot it into the machine that you want to use ZFS on.

<console>
# ##i##umount /mnt/usbstick
</console>

== Booting into the correct kernel ==
'''If you are using the standard srm:'''
<console>
C) Standard 64bit kernel (rescue64) with more choice... >
1. SystemRescueCd with default options
</console>

'''If you are using the alternative srm:'''
<console>
E) Alternative 64bit kernel (altker64) with more choice... >
1. SystemRescueCd with default options
</console>

2. Run 'depmod' so that the new modules can be seen by the kernel.

<console>
# ##i##depmod
</console>

{{fancywarning|You must run '''depmod'''. If you don't, then you will get failed to load the ZFS stack error!}}

3. Use ZFS as usual. If you type '''zpool status''' and then type '''dmesg | tail''',

you should see something that says:

<console>
ZFS: Loaded module v0.6.1-1, ZFS pool version 5000, ZFS filesystem version 5
</console>

If you see the above, then the modules loaded successfully!

Enjoy System Rescue CD with ZFS :)

== Using the premade iso ==

<big>If you don't want to do any of the above stuff but just want the ISO with the ZFS SRMs already included, simply [http://ftp.osuosl.org/pub/funtoo/distfiles/sysresccd/systemrescuecd-x86-3.7.0-zfs.iso/ Download the ISO].</big>

[[Category:HOWTO]]

ZFS Install Guide

2013-06-15T21:19:52Z

Fearedbliss: /* Bliss Initramfs Creator */ - removed overlay stuff

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 the premade System Rescue CD with ZFS SRMs (System Rescue Modules) already included.

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

<pre>
Name: systemrescuecd-x86-3.7.0-zfs (402 MiB)
Release Date: 2013-06-09
md5sum 62605474641ce2b1a07fec8330377208
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/sysresccd/systemrescuecd-x86-3.7.0-zfs.iso Download System Rescue CD 3.7.0 with ZFS]''' 

== Inside the ISO (Loading the ZFS Modules) ==
Once you boot into your System Rescue CD environment, you will need to update the kernel's dependency list so that the kernel knows that the zfs modules are available. This is extremely easy and it only takes one second. Just type the following two commands:

<console>
# ##i##depmod
# ##i##modprobe -v zfs
</console>

You should now see 6 modules load. Example:

<console>
root@sysresccd /root % ##i##depmod
root@sysresccd /root % ##i##modprobe -v zfs
insmod /lib/modules/3.9.4-alt370-amd64/extra/spl/spl.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/nvpair/znvpair.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/zcommon/zcommon.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/avl/zavl.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/unicode/zunicode.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/zfs/zfs.ko.gz
</console>

If you don't do the depmod first, you will see the following error:

<console>
root@sysresccd /root % ##i##modprobe -v zfs
modprobe: FATAL: Module zfs not found.

# OR You will see this if you try to run a zfs command without having the modules loaded

root@sysresccd /root % ##i##zpool status
Failed to load ZFS module stack.
Load the module manually by running 'insmod <location>/zfs.ko' as root.
Failed to load ZFS module stack.
Load the module manually by running 'insmod <location>/zfs.ko' as root.
</console>

So make sure to run '''depmod''' first!

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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

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

Create the datasets:

<console>
# ##i##zfs create -o mountpoint=/usr/portage -o compression=off rpool/FUNTOO/portage
# ##i##zfs create -o mountpoint=/usr/portage/distfiles -o compression=off rpool/FUNTOO/distfiles
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

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

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

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

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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.

== 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:
<console># ##i##zfs snapshot rpool/ROOT/funtoo@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

If your machine ever fails and you need to get back to this state, just type:
<console># ##i##zfs rollback rpool/ROOT/funtoo@install</console>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-14T05:00:55Z

Fearedbliss: /* Inside the ISO */

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 the premade System Rescue CD with ZFS SRMs (System Rescue Modules) already included.

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

<pre>
Name: systemrescuecd-x86-3.7.0-zfs (402 MiB)
Release Date: 2013-06-09
md5sum 62605474641ce2b1a07fec8330377208
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/sysresccd/systemrescuecd-x86-3.7.0-zfs.iso Download System Rescue CD 3.7.0 with ZFS]''' 

== Inside the ISO (Loading the ZFS Modules) ==
Once you boot into your System Rescue CD environment, you will need to update the kernel's dependency list so that the kernel knows that the zfs modules are available. This is extremely easy and it only takes one second. Just type the following two commands:

<console>
# ##i##depmod
# ##i##modprobe -v zfs
</console>

You should now see 6 modules load. Example:

<console>
root@sysresccd /root % ##i##depmod
root@sysresccd /root % ##i##modprobe -v zfs
insmod /lib/modules/3.9.4-alt370-amd64/extra/spl/spl.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/nvpair/znvpair.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/zcommon/zcommon.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/avl/zavl.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/unicode/zunicode.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/zfs/zfs.ko.gz
</console>

If you don't do the depmod first, you will see the following error:

<console>
root@sysresccd /root % ##i##modprobe -v zfs
modprobe: FATAL: Module zfs not found.

# OR You will see this if you try to run a zfs command without having the modules loaded

root@sysresccd /root % ##i##zpool status
Failed to load ZFS module stack.
Load the module manually by running 'insmod <location>/zfs.ko' as root.
Failed to load ZFS module stack.
Load the module manually by running 'insmod <location>/zfs.ko' as root.
</console>

So make sure to run '''depmod''' first!

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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

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

Create the datasets:

<console>
# ##i##zfs create -o mountpoint=/usr/portage -o compression=off rpool/FUNTOO/portage
# ##i##zfs create -o mountpoint=/usr/portage/distfiles -o compression=off rpool/FUNTOO/distfiles
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

=== 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":

<console>
# Make the overlays directory if it doesn't exist
# ##i##mkdir /home/example/overlays

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

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

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

Now you can install the creator, but before we do that, if you are encrypting your drives, then add the "luks" use flag to your package.use:

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

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

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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.

== 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:
<console># ##i##zfs snapshot rpool/ROOT/funtoo@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

If your machine ever fails and you need to get back to this state, just type:
<console># ##i##zfs rollback rpool/ROOT/funtoo@install</console>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-14T05:00:34Z

Fearedbliss: /* Inside the ISO */

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 the premade System Rescue CD with ZFS SRMs (System Rescue Modules) already included.

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

<pre>
Name: systemrescuecd-x86-3.7.0-zfs (402 MiB)
Release Date: 2013-06-09
md5sum 62605474641ce2b1a07fec8330377208
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/sysresccd/systemrescuecd-x86-3.7.0-zfs.iso Download System Rescue CD 3.7.0 with ZFS]''' 

== Inside the ISO ==
Once you boot into your System Rescue CD environment, you will need to update the kernel's dependency list so that the kernel knows that the zfs modules are available. This is extremely easy and it only takes one second. Just type the following two commands:

<console>
# ##i##depmod
# ##i##modprobe -v zfs
</console>

You should now see 6 modules load. Example:

<console>
root@sysresccd /root % ##i##depmod
root@sysresccd /root % ##i##modprobe -v zfs
insmod /lib/modules/3.9.4-alt370-amd64/extra/spl/spl.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/nvpair/znvpair.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/zcommon/zcommon.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/avl/zavl.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/unicode/zunicode.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/zfs/zfs.ko.gz
</console>

If you don't do the depmod first, you will see the following error:

<console>
root@sysresccd /root % ##i##modprobe -v zfs
modprobe: FATAL: Module zfs not found.

# OR You will see this if you try to run a zfs command without having the modules loaded

root@sysresccd /root % ##i##zpool status
Failed to load ZFS module stack.
Load the module manually by running 'insmod <location>/zfs.ko' as root.
Failed to load ZFS module stack.
Load the module manually by running 'insmod <location>/zfs.ko' as root.
</console>

So make sure to run '''depmod''' first!

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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

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

Create the datasets:

<console>
# ##i##zfs create -o mountpoint=/usr/portage -o compression=off rpool/FUNTOO/portage
# ##i##zfs create -o mountpoint=/usr/portage/distfiles -o compression=off rpool/FUNTOO/distfiles
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

=== 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":

<console>
# Make the overlays directory if it doesn't exist
# ##i##mkdir /home/example/overlays

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

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

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

Now you can install the creator, but before we do that, if you are encrypting your drives, then add the "luks" use flag to your package.use:

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

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

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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.

== 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:
<console># ##i##zfs snapshot rpool/ROOT/funtoo@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

If your machine ever fails and you need to get back to this state, just type:
<console># ##i##zfs rollback rpool/ROOT/funtoo@install</console>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-14T04:59:16Z

Fearedbliss: added how to load zfs modules section

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 the premade System Rescue CD with ZFS SRMs (System Rescue Modules) already included.

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

<pre>
Name: systemrescuecd-x86-3.7.0-zfs (402 MiB)
Release Date: 2013-06-09
md5sum 62605474641ce2b1a07fec8330377208
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/sysresccd/systemrescuecd-x86-3.7.0-zfs.iso Download System Rescue CD 3.7.0 with ZFS]''' 

== Inside the ISO ==
Once you boot into your System Rescue CD environment, you will need to update the kernel's dependency list so that the kernel knows that the zfs modules are available. This is extremely easy and it only takes one second. Just type the following two commands:

<console>
# ##i##depmod
# ##i##modprobe -v zfs
</console>

You should now see 6 modules load. Example:

<console>
root@sysresccd /root % ##i##depmod
root@sysresccd /root % ##i##modprobe -v zfs
insmod /lib/modules/3.9.4-alt370-amd64/extra/spl/spl.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/nvpair/znvpair.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/zcommon/zcommon.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/avl/zavl.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/unicode/zunicode.ko.gz
insmod /lib/modules/3.9.4-alt370-amd64/extra/zfs/zfs.ko.gz
root@sysresccd /root %
</console>

If you don't do the depmod first, you will see the following error:

<console>
root@sysresccd /root % modprobe -v zfs
modprobe: FATAL: Module zfs not found.
root@sysresccd /root %
OR You will see this if you try to run a zfs command without having the modules loaded
root@sysresccd /root % zpool statusFailed to load ZFS module stack.Load the module manually by running 'insmod <location>/zfs.ko' as root.Failed to load ZFS module stack.Load the module manually by running 'insmod <location>/zfs.ko' as root.root@sysresccd /root %
</console>

So make sure to run '''depmod''' first!

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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

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

Create the datasets:

<console>
# ##i##zfs create -o mountpoint=/usr/portage -o compression=off rpool/FUNTOO/portage
# ##i##zfs create -o mountpoint=/usr/portage/distfiles -o compression=off rpool/FUNTOO/distfiles
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

=== 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":

<console>
# Make the overlays directory if it doesn't exist
# ##i##mkdir /home/example/overlays

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

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

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

Now you can install the creator, but before we do that, if you are encrypting your drives, then add the "luks" use flag to your package.use:

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

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

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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.

== 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:
<console># ##i##zfs snapshot rpool/ROOT/funtoo@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

If your machine ever fails and you need to get back to this state, just type:
<console># ##i##zfs rollback rpool/ROOT/funtoo@install</console>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-14T04:20:34Z

Fearedbliss: /* Create the initramfs */ - removed extlinux sections

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 the premade System Rescue CD with ZFS SRMs (System Rescue Modules) already included.

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

<pre>
Name: systemrescuecd-x86-3.7.0-zfs (402 MiB)
Release Date: 2013-06-09
md5sum 62605474641ce2b1a07fec8330377208
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/sysresccd/systemrescuecd-x86-3.7.0-zfs.iso Download System Rescue CD 3.7.0 with ZFS]''' 

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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

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

Create the datasets:

<console>
# ##i##zfs create -o mountpoint=/usr/portage -o compression=off rpool/FUNTOO/portage
# ##i##zfs create -o mountpoint=/usr/portage/distfiles -o compression=off rpool/FUNTOO/distfiles
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

=== 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":

<console>
# Make the overlays directory if it doesn't exist
# ##i##mkdir /home/example/overlays

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

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

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

Now you can install the creator, but before we do that, if you are encrypting your drives, then add the "luks" use flag to your package.use:

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

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

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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.

== 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:
<console># ##i##zfs snapshot rpool/ROOT/funtoo@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

If your machine ever fails and you need to get back to this state, just type:
<console># ##i##zfs rollback rpool/ROOT/funtoo@install</console>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-14T04:19:54Z

Fearedbliss: /* Install the bootloader */ - removed extlinux section

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 the premade System Rescue CD with ZFS SRMs (System Rescue Modules) already included.

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

<pre>
Name: systemrescuecd-x86-3.7.0-zfs (402 MiB)
Release Date: 2013-06-09
md5sum 62605474641ce2b1a07fec8330377208
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/sysresccd/systemrescuecd-x86-3.7.0-zfs.iso Download System Rescue CD 3.7.0 with ZFS]''' 

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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

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

Create the datasets:

<console>
# ##i##zfs create -o mountpoint=/usr/portage -o compression=off rpool/FUNTOO/portage
# ##i##zfs create -o mountpoint=/usr/portage/distfiles -o compression=off rpool/FUNTOO/distfiles
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

'''extlinux.conf''':
<console>
LABEL funtoo
MENU LABEL Funtoo 3.8.5-ALL
KERNEL /vmlinuz-3.8.5-ALL
INITRD /initramfs-genkernel-x86_64-3.8.5-ALL
APPEND real_root=ZFS=rpool/ROOT/funtoo dozfs=force
</console>

=== 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":

<console>
# Make the overlays directory if it doesn't exist
# ##i##mkdir /home/example/overlays

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

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

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

Now you can install the creator, but before we do that, if you are encrypting your drives, then add the "luks" use flag to your package.use:

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

'''extlinux.conf:'''
<console>
LABEL funtoo
MENU LABEL Funtoo 3.8.5-ALL
KERNEL /vmlinuz-3.8.5-ALL
INITRD /initrd-3.8.5-ALL.img
APPEND root=rpool/ROOT/funtoo quiet
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# APPEND root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
</console>

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

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

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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.

== 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:
<console># ##i##zfs snapshot rpool/ROOT/funtoo@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

If your machine ever fails and you need to get back to this state, just type:
<console># ##i##zfs rollback rpool/ROOT/funtoo@install</console>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-11T01:02:52Z

Fearedbliss: /* Video Tutorial */ - updated video to zfs install v2

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 the premade System Rescue CD with ZFS SRMs (System Rescue Modules) already included.

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

<pre>
Name: systemrescuecd-x86-3.7.0-zfs (402 MiB)
Release Date: 2013-06-09
md5sum 62605474641ce2b1a07fec8330377208
</pre>

'''[http://ftp.osuosl.org/pub/funtoo/distfiles/sysresccd/systemrescuecd-x86-3.7.0-zfs.iso Download System Rescue CD 3.7.0 with ZFS]''' 

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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

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

Create the datasets:

<console>
# ##i##zfs create -o mountpoint=/usr/portage -o compression=off rpool/FUNTOO/portage
# ##i##zfs create -o mountpoint=/usr/portage/distfiles -o compression=off rpool/FUNTOO/distfiles
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

=== Extlinux ===
There are four things we need to do for extlinux:

# Install extlinux bootloader
# Write the .bin to the front of the target disk
# Toggle BIOS partition flag
# Write a extlinux configuration file

First emerge extlinux:
<console># ##i##emerge -av syslinux</console>

Then create a /boot/extlinux directory:
<console>
# ##i##cd /boot
# ##i##mkdir /boot/extlinux
</console>

Change into the extlinux dir and install the bootloader:
<console>
# ##i##cd /boot/extlinux
# ##i##extlinux --install .
</console>

==== MBR ====
<console>
# ##i##fdisk /dev/sda

Command: ##i##a ↵
Partition number: ##i##1 ↵
Command: ##i##w ↵
</console>

Printing the <tt>fdisk</tt> partition layout should show a star next to <tt>/dev/sda1</tt>:
<console>/dev/sda * 2048 514047 256000 83 Linux</console>

Flash the .bin to the front of the disk:
<console># ##i##dd conv=notrunc bs=440 count=1 if=/usr/share/syslinux/mbr.bin of=/dev/sda</console>

=== GPT ===
<console># ##i##sgdisk /dev/sda --attributes=1:set:2</console>

Flash the .bin to the front of the disk:
<console># ##i##dd conv=notrunc bs=440 count=1 if=/usr/share/syslinux/gptmbr.bin of=/dev/sda</console>

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

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

'''extlinux.conf''':
<console>
LABEL funtoo
MENU LABEL Funtoo 3.8.5-ALL
KERNEL /vmlinuz-3.8.5-ALL
INITRD /initramfs-genkernel-x86_64-3.8.5-ALL
APPEND real_root=ZFS=rpool/ROOT/funtoo dozfs=force
</console>

=== 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":

<console>
# Make the overlays directory if it doesn't exist
# ##i##mkdir /home/example/overlays

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

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

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

Now you can install the creator, but before we do that, if you are encrypting your drives, then add the "luks" use flag to your package.use:

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

'''extlinux.conf:'''
<console>
LABEL funtoo
MENU LABEL Funtoo 3.8.5-ALL
KERNEL /vmlinuz-3.8.5-ALL
INITRD /initrd-3.8.5-ALL.img
APPEND root=rpool/ROOT/funtoo quiet
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# APPEND root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
</console>

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

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

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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.

== 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:
<console># ##i##zfs snapshot rpool/ROOT/funtoo@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

If your machine ever fails and you need to get back to this state, just type:
<console># ##i##zfs rollback rpool/ROOT/funtoo@install</console>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-10T04:32:20Z

Fearedbliss: /* Create the initramfs */

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 the premade System Rescue CD with ZFS SRMs (System Rescue Modules) already included.

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

<pre>
Name: systemrescuecd-x86-3.7.0-zfs (402 MiB)
Release Date: 2013-06-09
md5sum 62605474641ce2b1a07fec8330377208
</pre>

'''[http://jonathanvasquez.com/files/sysresccd/3.7.0/iso/systemrescuecd-x86-3.7.0-zfs.iso Download System Rescue CD 3.7.0 with ZFS]''' 

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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

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

Create the datasets:

<console>
# ##i##zfs create -o mountpoint=/usr/portage -o compression=off rpool/FUNTOO/portage
# ##i##zfs create -o mountpoint=/usr/portage/distfiles -o compression=off rpool/FUNTOO/distfiles
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

=== Extlinux ===
There are four things we need to do for extlinux:

# Install extlinux bootloader
# Write the .bin to the front of the target disk
# Toggle BIOS partition flag
# Write a extlinux configuration file

First emerge extlinux:
<console># ##i##emerge -av syslinux</console>

Then create a /boot/extlinux directory:
<console>
# ##i##cd /boot
# ##i##mkdir /boot/extlinux
</console>

Change into the extlinux dir and install the bootloader:
<console>
# ##i##cd /boot/extlinux
# ##i##extlinux --install .
</console>

==== MBR ====
<console>
# ##i##fdisk /dev/sda

Command: ##i##a ↵
Partition number: ##i##1 ↵
Command: ##i##w ↵
</console>

Printing the <tt>fdisk</tt> partition layout should show a star next to <tt>/dev/sda1</tt>:
<console>/dev/sda * 2048 514047 256000 83 Linux</console>

Flash the .bin to the front of the disk:
<console># ##i##dd conv=notrunc bs=440 count=1 if=/usr/share/syslinux/mbr.bin of=/dev/sda</console>

=== GPT ===
<console># ##i##sgdisk /dev/sda --attributes=1:set:2</console>

Flash the .bin to the front of the disk:
<console># ##i##dd conv=notrunc bs=440 count=1 if=/usr/share/syslinux/gptmbr.bin of=/dev/sda</console>

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

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

'''extlinux.conf''':
<console>
LABEL funtoo
MENU LABEL Funtoo 3.8.5-ALL
KERNEL /vmlinuz-3.8.5-ALL
INITRD /initramfs-genkernel-x86_64-3.8.5-ALL
APPEND real_root=ZFS=rpool/ROOT/funtoo dozfs=force
</console>

=== 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":

<console>
# Make the overlays directory if it doesn't exist
# ##i##mkdir /home/example/overlays

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

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

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

Now you can install the creator, but before we do that, if you are encrypting your drives, then add the "luks" use flag to your package.use:

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo quiet
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

'''extlinux.conf:'''
<console>
LABEL funtoo
MENU LABEL Funtoo 3.8.5-ALL
KERNEL /vmlinuz-3.8.5-ALL
INITRD /initrd-3.8.5-ALL.img
APPEND root=rpool/ROOT/funtoo quiet
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# APPEND root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
</console>

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

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

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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.

== 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:
<console># ##i##zfs snapshot rpool/ROOT/funtoo@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

If your machine ever fails and you need to get back to this state, just type:
<console># ##i##zfs rollback rpool/ROOT/funtoo@install</console>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-10T04:25:01Z

Fearedbliss: /* Create the initramfs */ removed /boot prefix from boot lines

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 the premade System Rescue CD with ZFS SRMs (System Rescue Modules) already included.

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

<pre>
Name: systemrescuecd-x86-3.7.0-zfs (402 MiB)
Release Date: 2013-06-09
md5sum 62605474641ce2b1a07fec8330377208
</pre>

'''[http://jonathanvasquez.com/files/sysresccd/3.7.0/iso/systemrescuecd-x86-3.7.0-zfs.iso Download System Rescue CD 3.7.0 with ZFS]''' 

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

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

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

Create the datasets:

<console>
# ##i##zfs create -o mountpoint=/usr/portage -o compression=off rpool/FUNTOO/portage
# ##i##zfs create -o mountpoint=/usr/portage/distfiles -o compression=off rpool/FUNTOO/distfiles
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

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

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

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

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

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

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

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

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

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

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

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

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

=== Extlinux ===
There are four things we need to do for extlinux:

# Install extlinux bootloader
# Write the .bin to the front of the target disk
# Toggle BIOS partition flag
# Write a extlinux configuration file

First emerge extlinux:
<console># ##i##emerge -av syslinux</console>

Then create a /boot/extlinux directory:
<console>
# ##i##cd /boot
# ##i##mkdir /boot/extlinux
</console>

Change into the extlinux dir and install the bootloader:
<console>
# ##i##cd /boot/extlinux
# ##i##extlinux --install .
</console>

==== MBR ====
<console>
# ##i##fdisk /dev/sda

Command: ##i##a ↵
Partition number: ##i##1 ↵
Command: ##i##w ↵
</console>

Printing the <tt>fdisk</tt> partition layout should show a star next to <tt>/dev/sda1</tt>:
<console>/dev/sda * 2048 514047 256000 83 Linux</console>

Flash the .bin to the front of the disk:
<console># ##i##dd conv=notrunc bs=440 count=1 if=/usr/share/syslinux/mbr.bin of=/dev/sda</console>

=== GPT ===
<console># ##i##sgdisk /dev/sda --attributes=1:set:2</console>

Flash the .bin to the front of the disk:
<console># ##i##dd conv=notrunc bs=440 count=1 if=/usr/share/syslinux/gptmbr.bin of=/dev/sda</console>

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

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

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

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

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

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
set timeout=3
set default=0

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

set root=(hd0,gpt1)

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

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

'''extlinux.conf''':
<console>
LABEL funtoo
MENU LABEL Funtoo 3.8.5-ALL
KERNEL /vmlinuz-3.8.5-ALL
INITRD /initramfs-genkernel-x86_64-3.8.5-ALL
APPEND real_root=ZFS=rpool/ROOT/funtoo dozfs=force
</console>

=== 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":

<console>
# Make the overlays directory if it doesn't exist
# ##i##mkdir /home/example/overlays

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

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

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

Now you can install the creator, but before we do that, if you are encrypting your drives, then add the "luks" use flag to your package.use:

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

Now install the creator:

<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>.img /boot
</console>

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

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
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
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /initrd-3.8.5-ALL.img
}
</console>

'''extlinux.conf:'''
<console>
LABEL funtoo
MENU LABEL Funtoo 3.8.5-ALL
KERNEL /vmlinuz-3.8.5-ALL
INITRD /initrd-3.8.5-ALL.img
APPEND root=rpool/ROOT/funtoo quiet
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# APPEND root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
</console>

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

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

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

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

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

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

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

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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.

== 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:
<console># ##i##zfs snapshot rpool/ROOT/funtoo@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

If your machine ever fails and you need to get back to this state, just type:
<console># ##i##zfs rollback rpool/ROOT/funtoo@install</console>

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

__NOTOC__
__NOTITLE__

ZFS Install Guide

2013-06-10T00:37:23Z

Fearedbliss: cleaned up and renamed the "downloading the iso" section

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

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

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

== 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 the premade System Rescue CD with ZFS SRMs (System Rescue Modules) already included.

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

<pre>
Name: systemrescuecd-x86-3.7.0-zfs (402 MiB)
Release Date: 2013-06-09
md5sum 62605474641ce2b1a07fec8330377208
</pre>

'''[http://jonathanvasquez.com/files/sysresccd/3.7.0/iso/systemrescuecd-x86-3.7.0-zfs.iso Download System Rescue CD 3.7.0 with ZFS]''' 

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

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

Command: ##i##p ↵

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

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

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

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

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

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

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

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

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

Optional datasets: /usr/src, /var
# ##i##zfs create -o mountpoint=none rpool/FUNTOO
# ##i##zfs create -o mountpoint=/usr/src rpool/FUNTOO/src
# ##i##zfs create -o mountpoint=/var rpool/FUNTOO/var
</console>

==== 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).

Create the datasets:

<console>
# ##i##zfs create -o mountpoint=/usr/portage -o compression=off rpool/FUNTOO/portage
# ##i##zfs create -o mountpoint=/usr/portage/distfiles -o compression=off rpool/FUNTOO/distfiles
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

=== Format your swap zvol ===
<console>
# ##i##mkswap -f /dev/zvol/rpool/swap
# ##i##swapon /dev/zvol/rpool/swap
</console>

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

Mount your boot drive
# ##i##mount /dev/sda1 /mnt/funtoo/boot

Bind the kernel related directories
# ##i##mount --rbind /proc proc
# ##i##mount --rbind /dev dev
# ##i##mount --rbind /sys sys

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

* All other drivers required to see your PATA/SATA drives must be compiled in.

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

Check to make sure that the zfs tools are working, the zpool.cache file that you copied before should be displayed.

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

=== 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.

<console># ##i##echo "sys-boot/grub libzfs" >> /etc/portage/package.use</console>

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

=== Extlinux ===
There are four things we need to do for extlinux:

# Install extlinux bootloader
# Write the .bin to the front of the target disk
# Toggle BIOS partition flag
# Write a extlinux configuration file

First emerge extlinux:
<console># ##i##emerge -av syslinux</console>

Then create a /boot/extlinux directory:
<console>
# ##i##cd /boot
# ##i##mkdir /boot/extlinux
</console>

Change into the extlinux dir and install the bootloader:
<console>
# ##i##cd /boot/extlinux
# ##i##extlinux --install .
</console>

==== MBR ====
<console>
# ##i##fdisk /dev/sda

Command: ##i##a ↵
Partition number: ##i##1 ↵
Command: ##i##w ↵
</console>

Printing the <tt>fdisk</tt> partition layout should show a star next to <tt>/dev/sda1</tt>:
<console>/dev/sda * 2048 514047 256000 83 Linux</console>

Flash the .bin to the front of the disk:
<console># ##i##dd conv=notrunc bs=440 count=1 if=/usr/share/syslinux/mbr.bin of=/dev/sda</console>

=== GPT ===
<console># ##i##sgdisk /dev/sda --attributes=1:set:2</console>

Flash the .bin to the front of the disk:
<console># ##i##dd conv=notrunc bs=440 count=1 if=/usr/share/syslinux/gptmbr.bin of=/dev/sda</console>

We will write the extlinux/grub configuration file in the next section.

=== Create a boot symlink ===
We will create a boot symlink so that we can have "consistent" boot configurations without any errors.

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

You should now have a symlink called 'boot' inside /boot that points to /boot :).

== 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.

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
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
}
</console>

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

'''extlinux.conf''':
<console>
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
</console>

=== 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":

<console>
# Make the overlays directory if it doesn't exist
# ##i##mkdir /home/example/overlays

# Clone my overlay into this directory
# ##i##git clone git://github.com/fearedbliss/funtoo-overlay.git

# Rename the "funtoo-overlay" folder to "fearedbliss"
# ##i##mv funtoo-overlay fearedbliss

# Add the overlay to your /etc/portage/make.conf so portage knows its existence.
# ##i##echo 'PORTDIR_OVERLAY="/home/example/overlays/fearedbliss ${PORTDIR_OVERLAY}"' >> /etc/portage/make.conf
</console>

Now you can install the creator, but before we do that, if you are encrypting your drives, then add the "luks" use flag to your package.use:

<console>
# ##i##echo "sys-kernel/bliss-initramfs luks" >> /etc/portage/package.use
</console>

Now install the creator:

<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>.img /boot
</console>

'''<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.

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
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
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /boot/vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /boot/initrd-3.8.5-ALL.img
}
</console>

'''extlinux.conf:'''
<console>
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
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# APPEND root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
</console>

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

=== 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.

<console>
Delete the stage3/portage tarballs you downloaded earlier so they don't take up space.
# ##i##cd /
# ##i##rm stage3-latest.tar.xz
# ##i##rm /usr/portage-latest.tar.xz

Set your root password
# ##i##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
# ##i##exit

Unmount all the kernel filesystem stuff and boot (if you have a separate /boot)
# ##i##cd /mnt/funtoo
# ##i##umount -l proc dev sys boot

Turn off the swap
# ##i##swapoff /dev/zvol/rpool/swap

Export the zpool
# ##i##cd /
# ##i##zpool export -f rpool

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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.

== 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:
<console># ##i##zfs snapshot rpool/ROOT/funtoo@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

If your machine ever fails and you need to get back to this state, just type:
<console># ##i##zfs rollback rpool/ROOT/funtoo@install</console>

[[Category:HOWTO]]
[[Category:Filesystems]]
[[Category:Featured]]

__NOTOC__
__NOTITLE__

Creating System Rescue CD ZFS Modules

2013-06-10T00:29:17Z

Fearedbliss:

This HOWTO will show you how to create your own zfs srm or download the prebuilt zfs srm module from my website.

== Adding the overlay ==
There are scripts that I've written that will make this process much easier for you. So we will first set up the overlay to a directory on your machine, let's say '''"/home/example/overlays/fearedbliss"''':

<console>
# Make the overlays directory if it doesn't exist
# ##i##mkdir /home/example/overlays

# Clone my overlay into this directory
# ##i##git clone git://github.com/fearedbliss/funtoo-overlay.git

# Rename the "funtoo-overlay" folder to "fearedbliss"
# ##i##mv funtoo-overlay fearedbliss

# Add the overlay to your /etc/portage/make.conf so portage knows its existence.
# ##i##echo 'PORTDIR_OVERLAY="/home/example/overlays/fearedbliss ${PORTDIR_OVERLAY}"' >> /etc/portage/make.conf
</console>

Now that the overlay has been added, let's continue.

== Compiling a compatible kernel ==

The first thing you need to do is decide for which version of System Rescue CD you will be building for. Each System Rescue CD version has a different set of kernels. Specifically each version has a Stable kernel and an Alternate Kernel. The stable kernels get minor version increments every release (Sometimes major ones but usually doesn't happen too quickly), the Alternate kernels tend to move up much faster. For example System Rescue CD had the following stable/alternate kernels:

{| class="wikitable"
|-
! Version !! Stable !! Alternate
|-
| 3.7.0 || 3.4.47 || 3.9.4
|-
| 3.5.0 || 3.4.37 || 3.8.4
|}

===Download kernel and patches===
Once you decide which version you want to use, you can go to http://kernel.sysresccd.org/ and pick the version you want. After you do this, download all the stuff in that directory and put them in their own folder (a work directory). The files that are named std-sources are the patches for the regular stable kernel, the patches named alt-sources are the patches for the alternate kernel. Once you have the patches, go to kernel.org and also download the initial release of the kernel sources you want. For example, if you want to build an srm for 3.4.2 which uses the 3.4.35 kernel, just download the 3.4 (3.4.0) kernel. You just need to download the initial release because one of the patches you downloaded earlier is the patch to update the 3.4.0 to 3.4.35.

Once you download the kernel you want, let's extract and patch it.

<console>
# ##i##tar xf linux-3.4.tar.bz2
# ##i##mv linux-3.4 linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-01-stable-3.4.35.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-02-fc16.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-03-aufs.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
</console>

===Retrieve kernel configuration===
Once that is complete, you will need to get the kernel config specifically for the kernel and architecture you want. The easiest way I found to do this was to download the System Rescue CD you want, and then boot it inside a VM. Once you are inside the VM, go to the /root directory, and it will be a file named kernel-<version>.conf. Copy this file over SSH and put it in a safe location. Also copy it over into the linux kernel directory and rename it to .config.

===Build the kernel===
Once you copy the kernel config over, do a make menuconfig to begin. You will only need to change two settings inside the config, add the proper kernel name, and remove the old initramfs source files directory. This directory doesn't exist locally. This is a remnant of upstream's build process.

Follow the below tree structure, and make it equal to what is below:

<console>
General Setup ->
(-std342-amd64) Local version - append to kernel release
[*] Initial RAM filesystem and RAM disk (initramfs/initrd) support () Initramfs source file(s)
</console>

The Local version above will end up making the kernel modules directory be 3.4.35-std342-amd64. The reason the kernel modules directory has to be equal to this is because our directory will be merged into the System Rescue CD later on, so the names need to be exactly the same so that the System Rescue CD system can find our kernel modules.

If you want to build an srm (which you do), you also need to change the following inside the kernel config so that squashfs-tools can work later on:

<console>
File Systems ->
Miscellaneous Filesystems ->
<*> SquashFS 4.0 - Squashed file system support
[*] Squashfs XATTR support
[*] Include support for ZLIB compressed file systems
[*] Include support for LZO compressed file systems
[*] Include support for XZ compressed file systems
[ ] Use 4K device block size?
[ ] Additional option for memory-constrained systems
</console>

Now save and exit, and continue to build your kernel.

<console>
# ##i##make bzImage modules
# ##i##make modules_install
</console>

{{fancynote|If you have multiple cores, do a make -j<# of processors+1> to build faster. Example: '''make -j9''' for an 8 core machine.}}

=== Using the overlay ===
Inside the overlay, there are ebuilds already prepared that will download the kernel, patch it, and perform any required substitutions. Afterwards you literally just go into your /usr/src/<kernel> directory, and run make. To see the available versions, run the following:

<console>
Versions available for standard kernel
# ##i##equery y -O std-sources

[I]3.4.37-r1 | o ~ o o o o o o o o o o o | o 3.4.37 | fearedbliss

Versions available for alternate kernel
# ##i##equery y -O alt-sources

[I]3.8.4 | o ~ o o o o o o o o o o o | o 3.8.4 | fearedbliss
</console>

I haven't written the ebuilds in a way where it's easy to tell (at first glance) what System Rescue CD version you need. However, you can check the ebuild and you will see the version of the CD inside there. You can also check the chart above.

If you wanted to install the standard kernel sources, you just emerge it like any other application:

<console>
# ##i##emerge std-sources
</console>

Once the kernel and the kernel module are installed, you need to make the SRM.

== Creating the SRM ==
It's time to gather the required files and pack them together in order for it to become an SRM. An SRM is nothing more than a directory that has been compressed with squashfs. Thankfully I've written a script that will build it for you, and you can install it from the overlay.

You also need to have spl, zfs, and zfs-kmod installed on your system before you try to make the srm. Emerging '''"bliss-initramfs"''' should automatically pull those packages. If it doesn't, make sure you install them.

<console>
# ##i##echo "sys-kernel/bliss-initramfs srm" >> /etc/portage/package.use
# ##i##emerge bliss-initramfs
</console>

You should now have the following directory layout inside the '''/opt/bliss-initramfs''' folder:

<console>
octopus bliss-initramfs # ls -l
total 117
-rw-r--r-- 1 root root 6718 May 23 18:05 CHANGES
-rw-r--r-- 1 root root 176 May 23 18:05 CREDITS
-rw-r--r-- 1 root root 431 May 23 18:05 HELP
-rw-r--r-- 1 root root 1397 May 23 18:05 LICENSE
-rw-r--r-- 1 root root 1852 May 23 18:05 README
-rw-r--r-- 1 root root 3194 May 23 18:05 USAGE
-rwxr-xr-x 1 root root 2891 May 23 18:05 createInit
drwxr-xr-x 3 root root 4 May 23 18:11 files
drwxr-xr-x 3 root root 6 May 23 18:11 hooks
drwxr-xr-x 2 root root 5 May 23 22:01 resources
</console>

Then run the '''createInit''' script and follow the instructions for the kernel you want to make the srm for (In this case it's '''3.4.37-std350-amd64'''):

<console>
-----------------------------------
| Bliss Initramfs Creator - v1.8.1
| Author: Jonathan Vasquez <jvasquez1011@gmail.com>
| Distributed under the Simplified BSD License
-----------------------------------

>>> Which initramfs would you like to generate:
>> 1. ZFS
>> 2. Encrypted ZFS (LUKS + ZFS)
>> 3. More Options
>> 4. Exit Program

>>> Current choice [1]: ##i##3 ↵

>>> More Options:

>> 1. ZFS - System Rescue Module
>> 2. Back
>> 3. Exit Program

>>> Current choice [1]: ##i##↵

>>> Creating a ZFS System Rescue Module!

>>> Do you want to use the current kernel: 3.8.13-ALL? [Y/n]: ##i##n ↵

>>> Please enter the kernel name: ##i##3.4.37-std350-amd64 ↵

>>> Detected 64 bit platform
>>> Checking to see if modules directory exists for 3.4.37-std350-amd64...
>>> Creating SRMs for 3.4.37-std350-amd64...
>>> Creating directory structure for initramfs...
>>> Checking preliminary binaries...
>>> Checking binaries...
>>> Using ZFS
>>> Checking modules...
>>> Copying binaries...
>>> Copying modules...
>>> Copying documentation...
>>> Copying udev rules...
>>> Compressing kernel modules...
>>> Getting dependencies...
>>> Copying dependencies...
>>> Configuring files...
>>> Creating and Packing SRMs...
>>> Complete :)
</console>

Now you should have two new files:

<console>
-rw-r--r-- 1 root root 2068480 May 24 01:05 zfs-core-3.4.37-std350-amd64.srm
-rw-r--r-- 1 root root 483328 May 24 01:05 zfs-kmod-3.4.37-std350-amd64.srm
</console>

Now all you need to do is put those two files in the root of your USB directory.

If you are making srms for both the standard and alternate kernels, you will end up with two zfs-core files and two zfs-kmod files (1 set for each kernel). You don't need to put the zfs-core that it makes for one of the kernels. The zfs-core srm only has zfs program binaries, man pages, udev rules, and a few other things. The zfs-kmod is the srm that has the kernel modules (and only the kernel modules). So you can easily just put two zfs-kmods (one for each kernel version) and just re-use the same zfs-core for both of them.

== Using the prebuilt srm ==

=== Download the SRM ===
If you didn't build your own srm and want to use the prebuilt one, just emerge '''"zfs-srm"''' from the overlay:

(Instructions on [[Creating_System_Rescue_CD_ZFS_Modules#Adding_the_overlay|adding the overlay]] can be found at the top of this page)

<console>
# ##i##emerge zfs-srm
</console>

You can check available versions just as you did above for the kernels:

<console>
Available versions of the zfs-srm
# ##i##equery y -O zfs-srm

[I]3.5.0 | o ~ o o o o o o o o o o o | o 3.5.0 | fearedbliss
</console>

(These versions match the version of the System Rescue CD).

Installing the zfs-srm will automatically pull the '''"bliss-isomaker"''' package which is just a script that assists you with rebuilding the System Rescue CD ISO so that the ISO includes the ZFS srms. The script lets you make a bootable ISO or a bootable USB.

Once it's installed, switch to the /opt/bliss-isomaker folder

<console>
# ##i##cd /opt/bliss-isomaker
</console>

You should now see a directory layout that looks similar to this:

<console>
octopus bliss-isomaker # ls -l
total 100
drwxr-xr-x 2 root root 5 May 24 01:41 3.5.0
-rw-r--r-- 1 root root 1397 May 24 01:31 LICENSE
-rw-r--r-- 1 root root 312 May 24 01:31 README
-rw-r--r-- 1 root root 576 May 24 01:31 USAGE
-rwxr-xr-x 1 root root 3228 May 24 01:31 create
drwxr-xr-x 2 root root 3 May 24 01:41 iso
drwxr-xr-x 2 root root 4 May 24 01:41 resources
drwxr-xr-x 2 root root 3 May 24 01:41 srm
</console>

The layout is as follows:
* 3.5.0 - This folder contains the System Rescue CD 3.5.0 specific srms for both the standard and alternate kernel that were installed by emerge.
* create - A script to automatically recreate the system rescue cd iso or usb with the zfs stuff included
* iso - directory to place your system rescue cd iso in
* srm - directory that has the srms
* resources - the files in this folder contain function calls that the 'create' script uses. You don't need to worry about these.

=== Installing the SRM ===
There are a few ways to do this, you can either use one of the scripts, or you can do it manually. Before anything, make sure to copy the SRMs from the <Version> folder to the srm folder if you are using a prebuilt one:

<console>
# ##i##cp 3.5.0/* srm
</console>

==== Generating a new iso ====
If you just want to remake a new iso so that you can burn onto a cd or use in a virtual machine, just copy your iso over to the iso directory, and run the 'create' script. The new iso will be located in the iso directory as well with a -zfs ending.

<console>
Running the script with 1 (or iso) chooses to make an iso. You can also pass the version as well.
# ##i##./create 1

or

# ##i##./create iso 3.5.0
</console>

==== Creating a fresh usb ====
If you want to have zfs on a usb with system rescue cd, put the iso in your iso dir, and then run the usb script. It will ask you what usb you want to format (This will delete everything), and then install system rescue cd onto it. Once that is done it will copy the zfs stuff over.

<console>
Running the script with 2 (or usb) chooses to make an usb. You can also pass the version as well.
# ##i##./create 2

or

# ##i##./create usb 3.5.0
</console>

==== Manual installation onto a usb ====
Assuming that your installing to a flash drive and that the flash drive is mounted in /mnt

1. Mount your usb drive

<console>
# ##i##mount /dev/sdX# /mnt/usbstick
</console>

'''Where X# is the letter and number of your device. Immediately after you plug your usb in, type `dmesg | tail` in the console and you should see it.'''

2. Copy the zfs .srms to /mnt/usbstick

<console>
# ##i##cp zfs-core-3.4.37-std350-amd64.srm zfs-kmod-3.4.37-std350-amd64.srm zfs-kmod-3.8.4-alt350-amd64.srm /mnt/usbstick
</console>

3. List your /mnt/usbstick directory and you should see something similar to the following in your /mnt/usbstick

<console>
octopus 3.5.0 # ls -l /mnt/usbstick
total 305028
drwxr-xr-x 3 root root 4096 May 23 20:51 boot
drwxr-xr-x 2 root root 4096 May 23 20:51 bootdisk
drwxr-xr-x 2 root root 4096 May 23 20:51 bootprog
drwxr-xr-x 3 root root 4096 May 23 20:51 efi
drwxr-xr-x 2 root root 4096 May 23 20:51 ntpasswd
-rwxr-xr-x 1 root root 2349 May 23 20:51 readme.txt
drwxr-xr-x 3 root root 4096 May 23 20:52 syslinux
-rwxr-xr-x 1 root root 309252096 May 23 20:51 sysrcd.dat
-rwxr-xr-x 1 root root 45 May 23 20:51 sysrcd.md5
drwxr-xr-x 2 root root 4096 May 23 20:51 usb_inst
-rwxr-xr-x 1 root root 15889 May 23 20:51 usb_inst.sh
-rwxr-xr-x 1 root root 877 May 23 20:51 usbstick.htm
-rwxr-xr-x 1 root root 6 May 23 20:51 version
-rwxr-xr-x 1 root root 2068480 May 23 20:51 zfs-core-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.8.4-alt350-amd64.srm
</console>

Now un-mount your flash drive and boot it into the machine that you want to use ZFS on.

<console>
# ##i##umount /mnt/usbstick
</console>

== Booting into the correct kernel ==
'''If you are using the standard srm:'''
<console>
C) Standard 64bit kernel (rescue64) with more choice... >
1. SystemRescueCd with default options
</console>

'''If you are using the alternative srm:'''
<console>
E) Alternative 64bit kernel (altker64) with more choice... >
1. SystemRescueCd with default options
</console>

2. Run 'depmod' so that the new modules can be seen by the kernel.

<console>
# ##i##depmod
</console>

{{fancywarning|You must run '''depmod'''. If you don't, then you will get failed to load the ZFS stack error!}}

3. Use ZFS as usual. If you type '''zpool status''' and then type '''dmesg | tail''',

you should see something that says:

<console>
ZFS: Loaded module v0.6.1-1, ZFS pool version 5000, ZFS filesystem version 5
</console>

If you see the above, then the modules loaded successfully!

Enjoy System Rescue CD with ZFS :)

== Using the premade iso ==

<big>If you don't want to do any of the above stuff but just want the ISO with the ZFS SRMs already included, simply [http://jonathanvasquez.com/files/sysresccd/3.7.0/iso/ Download the ISO].</big>

[[Category:HOWTO]]

Creating System Rescue CD ZFS Modules

2013-06-10T00:26:42Z

Fearedbliss: added "Download the prebuilt iso link and info"

This HOWTO will show you how to create your own zfs srm or download the prebuilt zfs srm module from my website.

== Adding the overlay ==
There are scripts that I've written that will make this process much easier for you. So we will first set up the overlay to a directory on your machine, let's say '''"/home/example/overlays/fearedbliss"''':

<console>
# Make the overlays directory if it doesn't exist
# ##i##mkdir /home/example/overlays

# Clone my overlay into this directory
# ##i##git clone git://github.com/fearedbliss/funtoo-overlay.git

# Rename the "funtoo-overlay" folder to "fearedbliss"
# ##i##mv funtoo-overlay fearedbliss

# Add the overlay to your /etc/portage/make.conf so portage knows its existence.
# ##i##echo 'PORTDIR_OVERLAY="/home/example/overlays/fearedbliss ${PORTDIR_OVERLAY}"' >> /etc/portage/make.conf
</console>

Now that the overlay has been added, let's continue.

== Compiling a compatible kernel ==

The first thing you need to do is decide for which version of System Rescue CD you will be building for. Each System Rescue CD version has a different set of kernels. Specifically each version has a Stable kernel and an Alternate Kernel. The stable kernels get minor version increments every release (Sometimes major ones but usually doesn't happen too quickly), the Alternate kernels tend to move up much faster. For example System Rescue CD had the following stable/alternate kernels:

{| class="wikitable"
|-
! Version !! Stable !! Alternate
|-
| 3.7.0 || 3.4.47 || 3.9.4
|-
| 3.5.0 || 3.4.37 || 3.8.4
|}

===Download kernel and patches===
Once you decide which version you want to use, you can go to http://kernel.sysresccd.org/ and pick the version you want. After you do this, download all the stuff in that directory and put them in their own folder (a work directory). The files that are named std-sources are the patches for the regular stable kernel, the patches named alt-sources are the patches for the alternate kernel. Once you have the patches, go to kernel.org and also download the initial release of the kernel sources you want. For example, if you want to build an srm for 3.4.2 which uses the 3.4.35 kernel, just download the 3.4 (3.4.0) kernel. You just need to download the initial release because one of the patches you downloaded earlier is the patch to update the 3.4.0 to 3.4.35.

Once you download the kernel you want, let's extract and patch it.

<console>
# ##i##tar xf linux-3.4.tar.bz2
# ##i##mv linux-3.4 linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-01-stable-3.4.35.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-02-fc16.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-03-aufs.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
</console>

===Retrieve kernel configuration===
Once that is complete, you will need to get the kernel config specifically for the kernel and architecture you want. The easiest way I found to do this was to download the System Rescue CD you want, and then boot it inside a VM. Once you are inside the VM, go to the /root directory, and it will be a file named kernel-<version>.conf. Copy this file over SSH and put it in a safe location. Also copy it over into the linux kernel directory and rename it to .config.

===Build the kernel===
Once you copy the kernel config over, do a make menuconfig to begin. You will only need to change two settings inside the config, add the proper kernel name, and remove the old initramfs source files directory. This directory doesn't exist locally. This is a remnant of upstream's build process.

Follow the below tree structure, and make it equal to what is below:

<console>
General Setup ->
(-std342-amd64) Local version - append to kernel release
[*] Initial RAM filesystem and RAM disk (initramfs/initrd) support () Initramfs source file(s)
</console>

The Local version above will end up making the kernel modules directory be 3.4.35-std342-amd64. The reason the kernel modules directory has to be equal to this is because our directory will be merged into the System Rescue CD later on, so the names need to be exactly the same so that the System Rescue CD system can find our kernel modules.

If you want to build an srm (which you do), you also need to change the following inside the kernel config so that squashfs-tools can work later on:

<console>
File Systems ->
Miscellaneous Filesystems ->
<*> SquashFS 4.0 - Squashed file system support
[*] Squashfs XATTR support
[*] Include support for ZLIB compressed file systems
[*] Include support for LZO compressed file systems
[*] Include support for XZ compressed file systems
[ ] Use 4K device block size?
[ ] Additional option for memory-constrained systems
</console>

Now save and exit, and continue to build your kernel.

<console>
# ##i##make bzImage modules
# ##i##make modules_install
</console>

{{fancynote|If you have multiple cores, do a make -j<# of processors+1> to build faster. Example: '''make -j9''' for an 8 core machine.}}

=== Using the overlay ===
Inside the overlay, there are ebuilds already prepared that will download the kernel, patch it, and perform any required substitutions. Afterwards you literally just go into your /usr/src/<kernel> directory, and run make. To see the available versions, run the following:

<console>
Versions available for standard kernel
# ##i##equery y -O std-sources

[I]3.4.37-r1 | o ~ o o o o o o o o o o o | o 3.4.37 | fearedbliss

Versions available for alternate kernel
# ##i##equery y -O alt-sources

[I]3.8.4 | o ~ o o o o o o o o o o o | o 3.8.4 | fearedbliss
</console>

I haven't written the ebuilds in a way where it's easy to tell (at first glance) what System Rescue CD version you need. However, you can check the ebuild and you will see the version of the CD inside there. You can also check the chart above.

If you wanted to install the standard kernel sources, you just emerge it like any other application:

<console>
# ##i##emerge std-sources
</console>

Once the kernel and the kernel module are installed, you need to make the SRM.

== Creating the SRM ==
It's time to gather the required files and pack them together in order for it to become an SRM. An SRM is nothing more than a directory that has been compressed with squashfs. Thankfully I've written a script that will build it for you, and you can install it from the overlay.

You also need to have spl, zfs, and zfs-kmod installed on your system before you try to make the srm. Emerging '''"bliss-initramfs"''' should automatically pull those packages. If it doesn't, make sure you install them.

<console>
# ##i##echo "sys-kernel/bliss-initramfs srm" >> /etc/portage/package.use
# ##i##emerge bliss-initramfs
</console>

You should now have the following directory layout inside the '''/opt/bliss-initramfs''' folder:

<console>
octopus bliss-initramfs # ls -l
total 117
-rw-r--r-- 1 root root 6718 May 23 18:05 CHANGES
-rw-r--r-- 1 root root 176 May 23 18:05 CREDITS
-rw-r--r-- 1 root root 431 May 23 18:05 HELP
-rw-r--r-- 1 root root 1397 May 23 18:05 LICENSE
-rw-r--r-- 1 root root 1852 May 23 18:05 README
-rw-r--r-- 1 root root 3194 May 23 18:05 USAGE
-rwxr-xr-x 1 root root 2891 May 23 18:05 createInit
drwxr-xr-x 3 root root 4 May 23 18:11 files
drwxr-xr-x 3 root root 6 May 23 18:11 hooks
drwxr-xr-x 2 root root 5 May 23 22:01 resources
</console>

Then run the '''createInit''' script and follow the instructions for the kernel you want to make the srm for (In this case it's '''3.4.37-std350-amd64'''):

<console>
-----------------------------------
| Bliss Initramfs Creator - v1.8.1
| Author: Jonathan Vasquez <jvasquez1011@gmail.com>
| Distributed under the Simplified BSD License
-----------------------------------

>>> Which initramfs would you like to generate:
>> 1. ZFS
>> 2. Encrypted ZFS (LUKS + ZFS)
>> 3. More Options
>> 4. Exit Program

>>> Current choice [1]: ##i##3 ↵

>>> More Options:

>> 1. ZFS - System Rescue Module
>> 2. Back
>> 3. Exit Program

>>> Current choice [1]: ##i##↵

>>> Creating a ZFS System Rescue Module!

>>> Do you want to use the current kernel: 3.8.13-ALL? [Y/n]: ##i##n ↵

>>> Please enter the kernel name: ##i##3.4.37-std350-amd64 ↵

>>> Detected 64 bit platform
>>> Checking to see if modules directory exists for 3.4.37-std350-amd64...
>>> Creating SRMs for 3.4.37-std350-amd64...
>>> Creating directory structure for initramfs...
>>> Checking preliminary binaries...
>>> Checking binaries...
>>> Using ZFS
>>> Checking modules...
>>> Copying binaries...
>>> Copying modules...
>>> Copying documentation...
>>> Copying udev rules...
>>> Compressing kernel modules...
>>> Getting dependencies...
>>> Copying dependencies...
>>> Configuring files...
>>> Creating and Packing SRMs...
>>> Complete :)
</console>

Now you should have two new files:

<console>
-rw-r--r-- 1 root root 2068480 May 24 01:05 zfs-core-3.4.37-std350-amd64.srm
-rw-r--r-- 1 root root 483328 May 24 01:05 zfs-kmod-3.4.37-std350-amd64.srm
</console>

Now all you need to do is put those two files in the root of your USB directory.

If you are making srms for both the standard and alternate kernels, you will end up with two zfs-core files and two zfs-kmod files (1 set for each kernel). You don't need to put the zfs-core that it makes for one of the kernels. The zfs-core srm only has zfs program binaries, man pages, udev rules, and a few other things. The zfs-kmod is the srm that has the kernel modules (and only the kernel modules). So you can easily just put two zfs-kmods (one for each kernel version) and just re-use the same zfs-core for both of them.

== Using the prebuilt srm ==

=== Download the SRM ===
If you didn't build your own srm and want to use the prebuilt one, just emerge '''"zfs-srm"''' from the overlay:

(Instructions on [[Creating_System_Rescue_CD_ZFS_Modules#Adding_the_overlay|adding the overlay]] can be found at the top of this page)

<console>
# ##i##emerge zfs-srm
</console>

You can check available versions just as you did above for the kernels:

<console>
Available versions of the zfs-srm
# ##i##equery y -O zfs-srm

[I]3.5.0 | o ~ o o o o o o o o o o o | o 3.5.0 | fearedbliss
</console>

(These versions match the version of the System Rescue CD).

Installing the zfs-srm will automatically pull the '''"bliss-isomaker"''' package which is just a script that assists you with rebuilding the System Rescue CD ISO so that the ISO includes the ZFS srms. The script lets you make a bootable ISO or a bootable USB.

Once it's installed, switch to the /opt/bliss-isomaker folder

<console>
# ##i##cd /opt/bliss-isomaker
</console>

You should now see a directory layout that looks similar to this:

<console>
octopus bliss-isomaker # ls -l
total 100
drwxr-xr-x 2 root root 5 May 24 01:41 3.5.0
-rw-r--r-- 1 root root 1397 May 24 01:31 LICENSE
-rw-r--r-- 1 root root 312 May 24 01:31 README
-rw-r--r-- 1 root root 576 May 24 01:31 USAGE
-rwxr-xr-x 1 root root 3228 May 24 01:31 create
drwxr-xr-x 2 root root 3 May 24 01:41 iso
drwxr-xr-x 2 root root 4 May 24 01:41 resources
drwxr-xr-x 2 root root 3 May 24 01:41 srm
</console>

The layout is as follows:
* 3.5.0 - This folder contains the System Rescue CD 3.5.0 specific srms for both the standard and alternate kernel that were installed by emerge.
* create - A script to automatically recreate the system rescue cd iso or usb with the zfs stuff included
* iso - directory to place your system rescue cd iso in
* srm - directory that has the srms
* resources - the files in this folder contain function calls that the 'create' script uses. You don't need to worry about these.

=== Installing the SRM ===
There are a few ways to do this, you can either use one of the scripts, or you can do it manually. Before anything, make sure to copy the SRMs from the <Version> folder to the srm folder if you are using a prebuilt one:

<console>
# ##i##cp 3.5.0/* srm
</console>

==== Generating a new iso ====
If you just want to remake a new iso so that you can burn onto a cd or use in a virtual machine, just copy your iso over to the iso directory, and run the 'create' script. The new iso will be located in the iso directory as well with a -zfs ending.

<console>
Running the script with 1 (or iso) chooses to make an iso. You can also pass the version as well.
# ##i##./create 1

or

# ##i##./create iso 3.5.0
</console>

==== Creating a fresh usb ====
If you want to have zfs on a usb with system rescue cd, put the iso in your iso dir, and then run the usb script. It will ask you what usb you want to format (This will delete everything), and then install system rescue cd onto it. Once that is done it will copy the zfs stuff over.

<console>
Running the script with 2 (or usb) chooses to make an usb. You can also pass the version as well.
# ##i##./create 2

or

# ##i##./create usb 3.5.0
</console>

==== Manual installation onto a usb ====
Assuming that your installing to a flash drive and that the flash drive is mounted in /mnt

1. Mount your usb drive

<console>
# ##i##mount /dev/sdX# /mnt/usbstick
</console>

'''Where X# is the letter and number of your device. Immediately after you plug your usb in, type `dmesg | tail` in the console and you should see it.'''

2. Copy the zfs .srms to /mnt/usbstick

<console>
# ##i##cp zfs-core-3.4.37-std350-amd64.srm zfs-kmod-3.4.37-std350-amd64.srm zfs-kmod-3.8.4-alt350-amd64.srm /mnt/usbstick
</console>

3. List your /mnt/usbstick directory and you should see something similar to the following in your /mnt/usbstick

<console>
octopus 3.5.0 # ls -l /mnt/usbstick
total 305028
drwxr-xr-x 3 root root 4096 May 23 20:51 boot
drwxr-xr-x 2 root root 4096 May 23 20:51 bootdisk
drwxr-xr-x 2 root root 4096 May 23 20:51 bootprog
drwxr-xr-x 3 root root 4096 May 23 20:51 efi
drwxr-xr-x 2 root root 4096 May 23 20:51 ntpasswd
-rwxr-xr-x 1 root root 2349 May 23 20:51 readme.txt
drwxr-xr-x 3 root root 4096 May 23 20:52 syslinux
-rwxr-xr-x 1 root root 309252096 May 23 20:51 sysrcd.dat
-rwxr-xr-x 1 root root 45 May 23 20:51 sysrcd.md5
drwxr-xr-x 2 root root 4096 May 23 20:51 usb_inst
-rwxr-xr-x 1 root root 15889 May 23 20:51 usb_inst.sh
-rwxr-xr-x 1 root root 877 May 23 20:51 usbstick.htm
-rwxr-xr-x 1 root root 6 May 23 20:51 version
-rwxr-xr-x 1 root root 2068480 May 23 20:51 zfs-core-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.8.4-alt350-amd64.srm
</console>

Now un-mount your flash drive and boot it into the machine that you want to use ZFS on.

<console>
# ##i##umount /mnt/usbstick
</console>

== Booting into the correct kernel ==
'''If you are using the standard srm:'''
<console>
C) Standard 64bit kernel (rescue64) with more choice... >
1. SystemRescueCd with default options
</console>

'''If you are using the alternative srm:'''
<console>
E) Alternative 64bit kernel (altker64) with more choice... >
1. SystemRescueCd with default options
</console>

2. Run 'depmod' so that the new modules can be seen by the kernel.

<console>
# ##i##depmod
</console>

{{fancywarning|You must run '''depmod'''. If you don't, then you will get failed to load the ZFS stack error!}}

3. Use ZFS as usual. If you type '''zpool status''' and then type '''dmesg | tail''',

you should see something that says:

<console>
ZFS: Loaded module v0.6.1-1, ZFS pool version 5000, ZFS filesystem version 5
</console>

If you see the above, then the modules loaded successfully!

Enjoy System Rescue CD with ZFS :)

== Using the premade iso ==
If you don't want to do any of the above stuff but you just want the iso with the zfs srms already included, simply [http://jonathanvasquez.com/files/sysresccd/3.7.0/iso/ Download the ISO].

[[Category:HOWTO]]

Creating System Rescue CD ZFS Modules

2013-06-10T00:18:12Z

Fearedbliss: /* Compiling a compatible kernel */

Creating System Rescue CD ZFS Modules

2013-06-10T00:17:36Z

Fearedbliss: /* Compiling a compatible kernel */

This HOWTO will show you how to create your own zfs srm or download the prebuilt zfs srm module from my website.

== Adding the overlay ==
There are scripts that I've written that will make this process much easier for you. So we will first set up the overlay to a directory on your machine, let's say '''"/home/example/overlays/fearedbliss"''':

<console>
# Make the overlays directory if it doesn't exist
# ##i##mkdir /home/example/overlays

# Clone my overlay into this directory
# ##i##git clone git://github.com/fearedbliss/funtoo-overlay.git

# Rename the "funtoo-overlay" folder to "fearedbliss"
# ##i##mv funtoo-overlay fearedbliss

# Add the overlay to your /etc/portage/make.conf so portage knows its existence.
# ##i##echo 'PORTDIR_OVERLAY="/home/example/overlays/fearedbliss ${PORTDIR_OVERLAY}"' >> /etc/portage/make.conf
</console>

Now that the overlay has been added, let's continue.

== Compiling a compatible kernel ==

The first thing you need to do is decide for which version of System Rescue CD you will be building for. Each System Rescue CD version has a different set of kernels. Specifically each version has a Stable kernel and an Alternate Kernel. The stable kernels get minor version increments every release (Sometimes major ones but usually doesn't happen too quickly), the Alternate kernels tend to move up much faster. For example System Rescue CD had the following stable/alternate kernels:

{| class="wikitable"
|-
! Version !! Stable !! Alternate
|-
| 3.7.0 || 3.4.47 || 3.9.4
|-
| 3.5.0 || 3.4.37 || 3.8.4
|-
| 3.4.2 || 3.4.35 || 3.7.10
|-
| 3.4.1 || 3.4.32 || 3.7.9
|-
| 3.4.0 || 3.4.30 || 3.7.8
|-
| 3.3.0 || 3.4.27 || 3.7.4
|}

===Download kernel and patches===
Once you decide which version you want to use, you can go to http://kernel.sysresccd.org/ and pick the version you want. After you do this, download all the stuff in that directory and put them in their own folder (a work directory). The files that are named std-sources are the patches for the regular stable kernel, the patches named alt-sources are the patches for the alternate kernel. Once you have the patches, go to kernel.org and also download the initial release of the kernel sources you want. For example, if you want to build an srm for 3.4.2 which uses the 3.4.35 kernel, just download the 3.4 (3.4.0) kernel. You just need to download the initial release because one of the patches you downloaded earlier is the patch to update the 3.4.0 to 3.4.35.

Once you download the kernel you want, let's extract and patch it.

<console>
# ##i##tar xf linux-3.4.tar.bz2
# ##i##mv linux-3.4 linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-01-stable-3.4.35.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-02-fc16.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-03-aufs.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
</console>

===Retrieve kernel configuration===
Once that is complete, you will need to get the kernel config specifically for the kernel and architecture you want. The easiest way I found to do this was to download the System Rescue CD you want, and then boot it inside a VM. Once you are inside the VM, go to the /root directory, and it will be a file named kernel-<version>.conf. Copy this file over SSH and put it in a safe location. Also copy it over into the linux kernel directory and rename it to .config.

===Build the kernel===
Once you copy the kernel config over, do a make menuconfig to begin. You will only need to change two settings inside the config, add the proper kernel name, and remove the old initramfs source files directory. This directory doesn't exist locally. This is a remnant of upstream's build process.

Follow the below tree structure, and make it equal to what is below:

<console>
General Setup ->
(-std342-amd64) Local version - append to kernel release
[*] Initial RAM filesystem and RAM disk (initramfs/initrd) support () Initramfs source file(s)
</console>

The Local version above will end up making the kernel modules directory be 3.4.35-std342-amd64. The reason the kernel modules directory has to be equal to this is because our directory will be merged into the System Rescue CD later on, so the names need to be exactly the same so that the System Rescue CD system can find our kernel modules.

If you want to build an srm (which you do), you also need to change the following inside the kernel config so that squashfs-tools can work later on:

<console>
File Systems ->
Miscellaneous Filesystems ->
<*> SquashFS 4.0 - Squashed file system support
[*] Squashfs XATTR support
[*] Include support for ZLIB compressed file systems
[*] Include support for LZO compressed file systems
[*] Include support for XZ compressed file systems
[ ] Use 4K device block size?
[ ] Additional option for memory-constrained systems
</console>

Now save and exit, and continue to build your kernel.

<console>
# ##i##make bzImage modules
# ##i##make modules_install
</console>

{{fancynote|If you have multiple cores, do a make -j<# of processors+1> to build faster. Example: '''make -j9''' for an 8 core machine.}}

=== Using the overlay ===
Inside the overlay, there are ebuilds already prepared that will download the kernel, patch it, and perform any required substitutions. Afterwards you literally just go into your /usr/src/<kernel> directory, and run make. To see the available versions, run the following:

<console>
Versions available for standard kernel
# ##i##equery y -O std-sources

[I]3.4.37-r1 | o ~ o o o o o o o o o o o | o 3.4.37 | fearedbliss

Versions available for alternate kernel
# ##i##equery y -O alt-sources

[I]3.8.4 | o ~ o o o o o o o o o o o | o 3.8.4 | fearedbliss
</console>

I haven't written the ebuilds in a way where it's easy to tell (at first glance) what System Rescue CD version you need. However, you can check the ebuild and you will see the version of the CD inside there. You can also check the chart above.

If you wanted to install the standard kernel sources, you just emerge it like any other application:

<console>
# ##i##emerge std-sources
</console>

Once the kernel and the kernel module are installed, you need to make the SRM.

== Creating the SRM ==
It's time to gather the required files and pack them together in order for it to become an SRM. An SRM is nothing more than a directory that has been compressed with squashfs. Thankfully I've written a script that will build it for you, and you can install it from the overlay.

You also need to have spl, zfs, and zfs-kmod installed on your system before you try to make the srm. Emerging '''"bliss-initramfs"''' should automatically pull those packages. If it doesn't, make sure you install them.

<console>
# ##i##echo "sys-kernel/bliss-initramfs srm" >> /etc/portage/package.use
# ##i##emerge bliss-initramfs
</console>

You should now have the following directory layout inside the '''/opt/bliss-initramfs''' folder:

<console>
octopus bliss-initramfs # ls -l
total 117
-rw-r--r-- 1 root root 6718 May 23 18:05 CHANGES
-rw-r--r-- 1 root root 176 May 23 18:05 CREDITS
-rw-r--r-- 1 root root 431 May 23 18:05 HELP
-rw-r--r-- 1 root root 1397 May 23 18:05 LICENSE
-rw-r--r-- 1 root root 1852 May 23 18:05 README
-rw-r--r-- 1 root root 3194 May 23 18:05 USAGE
-rwxr-xr-x 1 root root 2891 May 23 18:05 createInit
drwxr-xr-x 3 root root 4 May 23 18:11 files
drwxr-xr-x 3 root root 6 May 23 18:11 hooks
drwxr-xr-x 2 root root 5 May 23 22:01 resources
</console>

Then run the '''createInit''' script and follow the instructions for the kernel you want to make the srm for (In this case it's '''3.4.37-std350-amd64'''):

<console>
-----------------------------------
| Bliss Initramfs Creator - v1.8.1
| Author: Jonathan Vasquez <jvasquez1011@gmail.com>
| Distributed under the Simplified BSD License
-----------------------------------

>>> Which initramfs would you like to generate:
>> 1. ZFS
>> 2. Encrypted ZFS (LUKS + ZFS)
>> 3. More Options
>> 4. Exit Program

>>> Current choice [1]: ##i##3 ↵

>>> More Options:

>> 1. ZFS - System Rescue Module
>> 2. Back
>> 3. Exit Program

>>> Current choice [1]: ##i##↵

>>> Creating a ZFS System Rescue Module!

>>> Do you want to use the current kernel: 3.8.13-ALL? [Y/n]: ##i##n ↵

>>> Please enter the kernel name: ##i##3.4.37-std350-amd64 ↵

>>> Detected 64 bit platform
>>> Checking to see if modules directory exists for 3.4.37-std350-amd64...
>>> Creating SRMs for 3.4.37-std350-amd64...
>>> Creating directory structure for initramfs...
>>> Checking preliminary binaries...
>>> Checking binaries...
>>> Using ZFS
>>> Checking modules...
>>> Copying binaries...
>>> Copying modules...
>>> Copying documentation...
>>> Copying udev rules...
>>> Compressing kernel modules...
>>> Getting dependencies...
>>> Copying dependencies...
>>> Configuring files...
>>> Creating and Packing SRMs...
>>> Complete :)
</console>

Now you should have two new files:

<console>
-rw-r--r-- 1 root root 2068480 May 24 01:05 zfs-core-3.4.37-std350-amd64.srm
-rw-r--r-- 1 root root 483328 May 24 01:05 zfs-kmod-3.4.37-std350-amd64.srm
</console>

Now all you need to do is put those two files in the root of your USB directory.

If you are making srms for both the standard and alternate kernels, you will end up with two zfs-core files and two zfs-kmod files (1 set for each kernel). You don't need to put the zfs-core that it makes for one of the kernels. The zfs-core srm only has zfs program binaries, man pages, udev rules, and a few other things. The zfs-kmod is the srm that has the kernel modules (and only the kernel modules). So you can easily just put two zfs-kmods (one for each kernel version) and just re-use the same zfs-core for both of them.

== Using the prebuilt srm ==

=== Download the SRM ===
If you didn't build your own srm and want to use the prebuilt one, just emerge '''"zfs-srm"''' from the overlay:

(Instructions on [[Creating_System_Rescue_CD_ZFS_Modules#Adding_the_overlay|adding the overlay]] can be found at the top of this page)

<console>
# ##i##emerge zfs-srm
</console>

You can check available versions just as you did above for the kernels:

<console>
Available versions of the zfs-srm
# ##i##equery y -O zfs-srm

[I]3.5.0 | o ~ o o o o o o o o o o o | o 3.5.0 | fearedbliss
</console>

(These versions match the version of the System Rescue CD).

Installing the zfs-srm will automatically pull the '''"bliss-isomaker"''' package which is just a script that assists you with rebuilding the System Rescue CD ISO so that the ISO includes the ZFS srms. The script lets you make a bootable ISO or a bootable USB.

Once it's installed, switch to the /opt/bliss-isomaker folder

<console>
# ##i##cd /opt/bliss-isomaker
</console>

You should now see a directory layout that looks similar to this:

<console>
octopus bliss-isomaker # ls -l
total 100
drwxr-xr-x 2 root root 5 May 24 01:41 3.5.0
-rw-r--r-- 1 root root 1397 May 24 01:31 LICENSE
-rw-r--r-- 1 root root 312 May 24 01:31 README
-rw-r--r-- 1 root root 576 May 24 01:31 USAGE
-rwxr-xr-x 1 root root 3228 May 24 01:31 create
drwxr-xr-x 2 root root 3 May 24 01:41 iso
drwxr-xr-x 2 root root 4 May 24 01:41 resources
drwxr-xr-x 2 root root 3 May 24 01:41 srm
</console>

The layout is as follows:
* 3.5.0 - This folder contains the System Rescue CD 3.5.0 specific srms for both the standard and alternate kernel that were installed by emerge.
* create - A script to automatically recreate the system rescue cd iso or usb with the zfs stuff included
* iso - directory to place your system rescue cd iso in
* srm - directory that has the srms
* resources - the files in this folder contain function calls that the 'create' script uses. You don't need to worry about these.

=== Installing the SRM ===
There are a few ways to do this, you can either use one of the scripts, or you can do it manually. Before anything, make sure to copy the SRMs from the <Version> folder to the srm folder if you are using a prebuilt one:

<console>
# ##i##cp 3.5.0/* srm
</console>

==== Generating a new iso ====
If you just want to remake a new iso so that you can burn onto a cd or use in a virtual machine, just copy your iso over to the iso directory, and run the 'create' script. The new iso will be located in the iso directory as well with a -zfs ending.

<console>
Running the script with 1 (or iso) chooses to make an iso. You can also pass the version as well.
# ##i##./create 1

or

# ##i##./create iso 3.5.0
</console>

==== Creating a fresh usb ====
If you want to have zfs on a usb with system rescue cd, put the iso in your iso dir, and then run the usb script. It will ask you what usb you want to format (This will delete everything), and then install system rescue cd onto it. Once that is done it will copy the zfs stuff over.

<console>
Running the script with 2 (or usb) chooses to make an usb. You can also pass the version as well.
# ##i##./create 2

or

# ##i##./create usb 3.5.0
</console>

==== Manual installation onto a usb ====
Assuming that your installing to a flash drive and that the flash drive is mounted in /mnt

1. Mount your usb drive

<console>
# ##i##mount /dev/sdX# /mnt/usbstick
</console>

'''Where X# is the letter and number of your device. Immediately after you plug your usb in, type `dmesg | tail` in the console and you should see it.'''

2. Copy the zfs .srms to /mnt/usbstick

<console>
# ##i##cp zfs-core-3.4.37-std350-amd64.srm zfs-kmod-3.4.37-std350-amd64.srm zfs-kmod-3.8.4-alt350-amd64.srm /mnt/usbstick
</console>

3. List your /mnt/usbstick directory and you should see something similar to the following in your /mnt/usbstick

<console>
octopus 3.5.0 # ls -l /mnt/usbstick
total 305028
drwxr-xr-x 3 root root 4096 May 23 20:51 boot
drwxr-xr-x 2 root root 4096 May 23 20:51 bootdisk
drwxr-xr-x 2 root root 4096 May 23 20:51 bootprog
drwxr-xr-x 3 root root 4096 May 23 20:51 efi
drwxr-xr-x 2 root root 4096 May 23 20:51 ntpasswd
-rwxr-xr-x 1 root root 2349 May 23 20:51 readme.txt
drwxr-xr-x 3 root root 4096 May 23 20:52 syslinux
-rwxr-xr-x 1 root root 309252096 May 23 20:51 sysrcd.dat
-rwxr-xr-x 1 root root 45 May 23 20:51 sysrcd.md5
drwxr-xr-x 2 root root 4096 May 23 20:51 usb_inst
-rwxr-xr-x 1 root root 15889 May 23 20:51 usb_inst.sh
-rwxr-xr-x 1 root root 877 May 23 20:51 usbstick.htm
-rwxr-xr-x 1 root root 6 May 23 20:51 version
-rwxr-xr-x 1 root root 2068480 May 23 20:51 zfs-core-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.8.4-alt350-amd64.srm
</console>

Now un-mount your flash drive and boot it into the machine that you want to use ZFS on.

<console>
# ##i##umount /mnt/usbstick
</console>

== Booting into the correct kernel ==
'''If you are using the standard srm:'''
<console>
C) Standard 64bit kernel (rescue64) with more choice... >
1. SystemRescueCd with default options
</console>

'''If you are using the alternative srm:'''
<console>
E) Alternative 64bit kernel (altker64) with more choice... >
1. SystemRescueCd with default options
</console>

2. Run 'depmod' so that the new modules can be seen by the kernel.

<console>
# ##i##depmod
</console>

{{fancywarning|You must run '''depmod'''. If you don't, then you will get failed to load the ZFS stack error!}}

3. Use ZFS as usual. If you type '''zpool status''' and then type '''dmesg | tail''',

you should see something that says:

<console>
ZFS: Loaded module v0.6.1-1, ZFS pool version 5000, ZFS filesystem version 5
</console>

If you see the above, then the modules loaded successfully!

Enjoy System Rescue CD with ZFS :)

[[Category:HOWTO]]

Creating System Rescue CD ZFS Modules

2013-06-10T00:17:05Z

Fearedbliss: /* Extra */ - removed this section

This HOWTO will show you how to create your own zfs srm or download the prebuilt zfs srm module from my website.

== Adding the overlay ==
There are scripts that I've written that will make this process much easier for you. So we will first set up the overlay to a directory on your machine, let's say '''"/home/example/overlays/fearedbliss"''':

<console>
# Make the overlays directory if it doesn't exist
# ##i##mkdir /home/example/overlays

# Clone my overlay into this directory
# ##i##git clone git://github.com/fearedbliss/funtoo-overlay.git

# Rename the "funtoo-overlay" folder to "fearedbliss"
# ##i##mv funtoo-overlay fearedbliss

# Add the overlay to your /etc/portage/make.conf so portage knows its existence.
# ##i##echo 'PORTDIR_OVERLAY="/home/example/overlays/fearedbliss ${PORTDIR_OVERLAY}"' >> /etc/portage/make.conf
</console>

Now that the overlay has been added, let's continue.

== Compiling a compatible kernel ==

The first thing you need to do is decide for which version of System Rescue CD you will be building for. Each System Rescue CD version has a different set of kernels. Specifically each version has a Stable kernel and an Alternate Kernel. The stable kernels get minor version increments every release (Sometimes major ones but usually doesn't happen too quickly), the Alternate kernels tend to move up much faster. For example System Rescue CD had the following stable/alternate kernels:

{| class="wikitable"
|-
! Version !! Stable !! Alternate
|-
| 3.5.0 || 3.4.37 || 3.8.4
|-
| 3.4.2 || 3.4.35 || 3.7.10
|-
| 3.4.1 || 3.4.32 || 3.7.9
|-
| 3.4.0 || 3.4.30 || 3.7.8
|-
| 3.3.0 || 3.4.27 || 3.7.4
|}

===Download kernel and patches===
Once you decide which version you want to use, you can go to http://kernel.sysresccd.org/ and pick the version you want. After you do this, download all the stuff in that directory and put them in their own folder (a work directory). The files that are named std-sources are the patches for the regular stable kernel, the patches named alt-sources are the patches for the alternate kernel. Once you have the patches, go to kernel.org and also download the initial release of the kernel sources you want. For example, if you want to build an srm for 3.4.2 which uses the 3.4.35 kernel, just download the 3.4 (3.4.0) kernel. You just need to download the initial release because one of the patches you downloaded earlier is the patch to update the 3.4.0 to 3.4.35.

Once you download the kernel you want, let's extract and patch it.

<console>
# ##i##tar xf linux-3.4.tar.bz2
# ##i##mv linux-3.4 linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-01-stable-3.4.35.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-02-fc16.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-03-aufs.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
</console>

===Retrieve kernel configuration===
Once that is complete, you will need to get the kernel config specifically for the kernel and architecture you want. The easiest way I found to do this was to download the System Rescue CD you want, and then boot it inside a VM. Once you are inside the VM, go to the /root directory, and it will be a file named kernel-<version>.conf. Copy this file over SSH and put it in a safe location. Also copy it over into the linux kernel directory and rename it to .config.

===Build the kernel===
Once you copy the kernel config over, do a make menuconfig to begin. You will only need to change two settings inside the config, add the proper kernel name, and remove the old initramfs source files directory. This directory doesn't exist locally. This is a remnant of upstream's build process.

Follow the below tree structure, and make it equal to what is below:

<console>
General Setup ->
(-std342-amd64) Local version - append to kernel release
[*] Initial RAM filesystem and RAM disk (initramfs/initrd) support () Initramfs source file(s)
</console>

The Local version above will end up making the kernel modules directory be 3.4.35-std342-amd64. The reason the kernel modules directory has to be equal to this is because our directory will be merged into the System Rescue CD later on, so the names need to be exactly the same so that the System Rescue CD system can find our kernel modules.

If you want to build an srm (which you do), you also need to change the following inside the kernel config so that squashfs-tools can work later on:

<console>
File Systems ->
Miscellaneous Filesystems ->
<*> SquashFS 4.0 - Squashed file system support
[*] Squashfs XATTR support
[*] Include support for ZLIB compressed file systems
[*] Include support for LZO compressed file systems
[*] Include support for XZ compressed file systems
[ ] Use 4K device block size?
[ ] Additional option for memory-constrained systems
</console>

Now save and exit, and continue to build your kernel.

<console>
# ##i##make bzImage modules
# ##i##make modules_install
</console>

{{fancynote|If you have multiple cores, do a make -j<# of processors+1> to build faster. Example: '''make -j9''' for an 8 core machine.}}

=== Using the overlay ===
Inside the overlay, there are ebuilds already prepared that will download the kernel, patch it, and perform any required substitutions. Afterwards you literally just go into your /usr/src/<kernel> directory, and run make. To see the available versions, run the following:

<console>
Versions available for standard kernel
# ##i##equery y -O std-sources

[I]3.4.37-r1 | o ~ o o o o o o o o o o o | o 3.4.37 | fearedbliss

Versions available for alternate kernel
# ##i##equery y -O alt-sources

[I]3.8.4 | o ~ o o o o o o o o o o o | o 3.8.4 | fearedbliss
</console>

I haven't written the ebuilds in a way where it's easy to tell (at first glance) what System Rescue CD version you need. However, you can check the ebuild and you will see the version of the CD inside there. You can also check the chart above.

If you wanted to install the standard kernel sources, you just emerge it like any other application:

<console>
# ##i##emerge std-sources
</console>

Once the kernel and the kernel module are installed, you need to make the SRM.

== Creating the SRM ==
It's time to gather the required files and pack them together in order for it to become an SRM. An SRM is nothing more than a directory that has been compressed with squashfs. Thankfully I've written a script that will build it for you, and you can install it from the overlay.

You also need to have spl, zfs, and zfs-kmod installed on your system before you try to make the srm. Emerging '''"bliss-initramfs"''' should automatically pull those packages. If it doesn't, make sure you install them.

<console>
# ##i##echo "sys-kernel/bliss-initramfs srm" >> /etc/portage/package.use
# ##i##emerge bliss-initramfs
</console>

You should now have the following directory layout inside the '''/opt/bliss-initramfs''' folder:

<console>
octopus bliss-initramfs # ls -l
total 117
-rw-r--r-- 1 root root 6718 May 23 18:05 CHANGES
-rw-r--r-- 1 root root 176 May 23 18:05 CREDITS
-rw-r--r-- 1 root root 431 May 23 18:05 HELP
-rw-r--r-- 1 root root 1397 May 23 18:05 LICENSE
-rw-r--r-- 1 root root 1852 May 23 18:05 README
-rw-r--r-- 1 root root 3194 May 23 18:05 USAGE
-rwxr-xr-x 1 root root 2891 May 23 18:05 createInit
drwxr-xr-x 3 root root 4 May 23 18:11 files
drwxr-xr-x 3 root root 6 May 23 18:11 hooks
drwxr-xr-x 2 root root 5 May 23 22:01 resources
</console>

Then run the '''createInit''' script and follow the instructions for the kernel you want to make the srm for (In this case it's '''3.4.37-std350-amd64'''):

<console>
-----------------------------------
| Bliss Initramfs Creator - v1.8.1
| Author: Jonathan Vasquez <jvasquez1011@gmail.com>
| Distributed under the Simplified BSD License
-----------------------------------

>>> Which initramfs would you like to generate:
>> 1. ZFS
>> 2. Encrypted ZFS (LUKS + ZFS)
>> 3. More Options
>> 4. Exit Program

>>> Current choice [1]: ##i##3 ↵

>>> More Options:

>> 1. ZFS - System Rescue Module
>> 2. Back
>> 3. Exit Program

>>> Current choice [1]: ##i##↵

>>> Creating a ZFS System Rescue Module!

>>> Do you want to use the current kernel: 3.8.13-ALL? [Y/n]: ##i##n ↵

>>> Please enter the kernel name: ##i##3.4.37-std350-amd64 ↵

>>> Detected 64 bit platform
>>> Checking to see if modules directory exists for 3.4.37-std350-amd64...
>>> Creating SRMs for 3.4.37-std350-amd64...
>>> Creating directory structure for initramfs...
>>> Checking preliminary binaries...
>>> Checking binaries...
>>> Using ZFS
>>> Checking modules...
>>> Copying binaries...
>>> Copying modules...
>>> Copying documentation...
>>> Copying udev rules...
>>> Compressing kernel modules...
>>> Getting dependencies...
>>> Copying dependencies...
>>> Configuring files...
>>> Creating and Packing SRMs...
>>> Complete :)
</console>

Now you should have two new files:

<console>
-rw-r--r-- 1 root root 2068480 May 24 01:05 zfs-core-3.4.37-std350-amd64.srm
-rw-r--r-- 1 root root 483328 May 24 01:05 zfs-kmod-3.4.37-std350-amd64.srm
</console>

Now all you need to do is put those two files in the root of your USB directory.

If you are making srms for both the standard and alternate kernels, you will end up with two zfs-core files and two zfs-kmod files (1 set for each kernel). You don't need to put the zfs-core that it makes for one of the kernels. The zfs-core srm only has zfs program binaries, man pages, udev rules, and a few other things. The zfs-kmod is the srm that has the kernel modules (and only the kernel modules). So you can easily just put two zfs-kmods (one for each kernel version) and just re-use the same zfs-core for both of them.

== Using the prebuilt srm ==

=== Download the SRM ===
If you didn't build your own srm and want to use the prebuilt one, just emerge '''"zfs-srm"''' from the overlay:

(Instructions on [[Creating_System_Rescue_CD_ZFS_Modules#Adding_the_overlay|adding the overlay]] can be found at the top of this page)

<console>
# ##i##emerge zfs-srm
</console>

You can check available versions just as you did above for the kernels:

<console>
Available versions of the zfs-srm
# ##i##equery y -O zfs-srm

[I]3.5.0 | o ~ o o o o o o o o o o o | o 3.5.0 | fearedbliss
</console>

(These versions match the version of the System Rescue CD).

Installing the zfs-srm will automatically pull the '''"bliss-isomaker"''' package which is just a script that assists you with rebuilding the System Rescue CD ISO so that the ISO includes the ZFS srms. The script lets you make a bootable ISO or a bootable USB.

Once it's installed, switch to the /opt/bliss-isomaker folder

<console>
# ##i##cd /opt/bliss-isomaker
</console>

You should now see a directory layout that looks similar to this:

<console>
octopus bliss-isomaker # ls -l
total 100
drwxr-xr-x 2 root root 5 May 24 01:41 3.5.0
-rw-r--r-- 1 root root 1397 May 24 01:31 LICENSE
-rw-r--r-- 1 root root 312 May 24 01:31 README
-rw-r--r-- 1 root root 576 May 24 01:31 USAGE
-rwxr-xr-x 1 root root 3228 May 24 01:31 create
drwxr-xr-x 2 root root 3 May 24 01:41 iso
drwxr-xr-x 2 root root 4 May 24 01:41 resources
drwxr-xr-x 2 root root 3 May 24 01:41 srm
</console>

The layout is as follows:
* 3.5.0 - This folder contains the System Rescue CD 3.5.0 specific srms for both the standard and alternate kernel that were installed by emerge.
* create - A script to automatically recreate the system rescue cd iso or usb with the zfs stuff included
* iso - directory to place your system rescue cd iso in
* srm - directory that has the srms
* resources - the files in this folder contain function calls that the 'create' script uses. You don't need to worry about these.

=== Installing the SRM ===
There are a few ways to do this, you can either use one of the scripts, or you can do it manually. Before anything, make sure to copy the SRMs from the <Version> folder to the srm folder if you are using a prebuilt one:

<console>
# ##i##cp 3.5.0/* srm
</console>

==== Generating a new iso ====
If you just want to remake a new iso so that you can burn onto a cd or use in a virtual machine, just copy your iso over to the iso directory, and run the 'create' script. The new iso will be located in the iso directory as well with a -zfs ending.

<console>
Running the script with 1 (or iso) chooses to make an iso. You can also pass the version as well.
# ##i##./create 1

or

# ##i##./create iso 3.5.0
</console>

==== Creating a fresh usb ====
If you want to have zfs on a usb with system rescue cd, put the iso in your iso dir, and then run the usb script. It will ask you what usb you want to format (This will delete everything), and then install system rescue cd onto it. Once that is done it will copy the zfs stuff over.

<console>
Running the script with 2 (or usb) chooses to make an usb. You can also pass the version as well.
# ##i##./create 2

or

# ##i##./create usb 3.5.0
</console>

==== Manual installation onto a usb ====
Assuming that your installing to a flash drive and that the flash drive is mounted in /mnt

1. Mount your usb drive

<console>
# ##i##mount /dev/sdX# /mnt/usbstick
</console>

'''Where X# is the letter and number of your device. Immediately after you plug your usb in, type `dmesg | tail` in the console and you should see it.'''

2. Copy the zfs .srms to /mnt/usbstick

<console>
# ##i##cp zfs-core-3.4.37-std350-amd64.srm zfs-kmod-3.4.37-std350-amd64.srm zfs-kmod-3.8.4-alt350-amd64.srm /mnt/usbstick
</console>

3. List your /mnt/usbstick directory and you should see something similar to the following in your /mnt/usbstick

<console>
octopus 3.5.0 # ls -l /mnt/usbstick
total 305028
drwxr-xr-x 3 root root 4096 May 23 20:51 boot
drwxr-xr-x 2 root root 4096 May 23 20:51 bootdisk
drwxr-xr-x 2 root root 4096 May 23 20:51 bootprog
drwxr-xr-x 3 root root 4096 May 23 20:51 efi
drwxr-xr-x 2 root root 4096 May 23 20:51 ntpasswd
-rwxr-xr-x 1 root root 2349 May 23 20:51 readme.txt
drwxr-xr-x 3 root root 4096 May 23 20:52 syslinux
-rwxr-xr-x 1 root root 309252096 May 23 20:51 sysrcd.dat
-rwxr-xr-x 1 root root 45 May 23 20:51 sysrcd.md5
drwxr-xr-x 2 root root 4096 May 23 20:51 usb_inst
-rwxr-xr-x 1 root root 15889 May 23 20:51 usb_inst.sh
-rwxr-xr-x 1 root root 877 May 23 20:51 usbstick.htm
-rwxr-xr-x 1 root root 6 May 23 20:51 version
-rwxr-xr-x 1 root root 2068480 May 23 20:51 zfs-core-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.8.4-alt350-amd64.srm
</console>

Now un-mount your flash drive and boot it into the machine that you want to use ZFS on.

<console>
# ##i##umount /mnt/usbstick
</console>

== Booting into the correct kernel ==
'''If you are using the standard srm:'''
<console>
C) Standard 64bit kernel (rescue64) with more choice... >
1. SystemRescueCd with default options
</console>

'''If you are using the alternative srm:'''
<console>
E) Alternative 64bit kernel (altker64) with more choice... >
1. SystemRescueCd with default options
</console>

2. Run 'depmod' so that the new modules can be seen by the kernel.

<console>
# ##i##depmod
</console>

{{fancywarning|You must run '''depmod'''. If you don't, then you will get failed to load the ZFS stack error!}}

3. Use ZFS as usual. If you type '''zpool status''' and then type '''dmesg | tail''',

you should see something that says:

<console>
ZFS: Loaded module v0.6.1-1, ZFS pool version 5000, ZFS filesystem version 5
</console>

If you see the above, then the modules loaded successfully!

Enjoy System Rescue CD with ZFS :)

[[Category:HOWTO]]

Creating System Rescue CD ZFS Modules

2013-06-10T00:16:34Z

Fearedbliss: /* Booting into the correct kernel */

This HOWTO will show you how to create your own zfs srm or download the prebuilt zfs srm module from my website.

== Adding the overlay ==
There are scripts that I've written that will make this process much easier for you. So we will first set up the overlay to a directory on your machine, let's say '''"/home/example/overlays/fearedbliss"''':

<console>
# Make the overlays directory if it doesn't exist
# ##i##mkdir /home/example/overlays

# Clone my overlay into this directory
# ##i##git clone git://github.com/fearedbliss/funtoo-overlay.git

# Rename the "funtoo-overlay" folder to "fearedbliss"
# ##i##mv funtoo-overlay fearedbliss

# Add the overlay to your /etc/portage/make.conf so portage knows its existence.
# ##i##echo 'PORTDIR_OVERLAY="/home/example/overlays/fearedbliss ${PORTDIR_OVERLAY}"' >> /etc/portage/make.conf
</console>

Now that the overlay has been added, let's continue.

== Compiling a compatible kernel ==

The first thing you need to do is decide for which version of System Rescue CD you will be building for. Each System Rescue CD version has a different set of kernels. Specifically each version has a Stable kernel and an Alternate Kernel. The stable kernels get minor version increments every release (Sometimes major ones but usually doesn't happen too quickly), the Alternate kernels tend to move up much faster. For example System Rescue CD had the following stable/alternate kernels:

{| class="wikitable"
|-
! Version !! Stable !! Alternate
|-
| 3.5.0 || 3.4.37 || 3.8.4
|-
| 3.4.2 || 3.4.35 || 3.7.10
|-
| 3.4.1 || 3.4.32 || 3.7.9
|-
| 3.4.0 || 3.4.30 || 3.7.8
|-
| 3.3.0 || 3.4.27 || 3.7.4
|}

===Download kernel and patches===
Once you decide which version you want to use, you can go to http://kernel.sysresccd.org/ and pick the version you want. After you do this, download all the stuff in that directory and put them in their own folder (a work directory). The files that are named std-sources are the patches for the regular stable kernel, the patches named alt-sources are the patches for the alternate kernel. Once you have the patches, go to kernel.org and also download the initial release of the kernel sources you want. For example, if you want to build an srm for 3.4.2 which uses the 3.4.35 kernel, just download the 3.4 (3.4.0) kernel. You just need to download the initial release because one of the patches you downloaded earlier is the patch to update the 3.4.0 to 3.4.35.

Once you download the kernel you want, let's extract and patch it.

<console>
# ##i##tar xf linux-3.4.tar.bz2
# ##i##mv linux-3.4 linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-01-stable-3.4.35.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-02-fc16.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-03-aufs.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
</console>

===Retrieve kernel configuration===
Once that is complete, you will need to get the kernel config specifically for the kernel and architecture you want. The easiest way I found to do this was to download the System Rescue CD you want, and then boot it inside a VM. Once you are inside the VM, go to the /root directory, and it will be a file named kernel-<version>.conf. Copy this file over SSH and put it in a safe location. Also copy it over into the linux kernel directory and rename it to .config.

===Build the kernel===
Once you copy the kernel config over, do a make menuconfig to begin. You will only need to change two settings inside the config, add the proper kernel name, and remove the old initramfs source files directory. This directory doesn't exist locally. This is a remnant of upstream's build process.

Follow the below tree structure, and make it equal to what is below:

<console>
General Setup ->
(-std342-amd64) Local version - append to kernel release
[*] Initial RAM filesystem and RAM disk (initramfs/initrd) support () Initramfs source file(s)
</console>

The Local version above will end up making the kernel modules directory be 3.4.35-std342-amd64. The reason the kernel modules directory has to be equal to this is because our directory will be merged into the System Rescue CD later on, so the names need to be exactly the same so that the System Rescue CD system can find our kernel modules.

If you want to build an srm (which you do), you also need to change the following inside the kernel config so that squashfs-tools can work later on:

<console>
File Systems ->
Miscellaneous Filesystems ->
<*> SquashFS 4.0 - Squashed file system support
[*] Squashfs XATTR support
[*] Include support for ZLIB compressed file systems
[*] Include support for LZO compressed file systems
[*] Include support for XZ compressed file systems
[ ] Use 4K device block size?
[ ] Additional option for memory-constrained systems
</console>

Now save and exit, and continue to build your kernel.

<console>
# ##i##make bzImage modules
# ##i##make modules_install
</console>

{{fancynote|If you have multiple cores, do a make -j<# of processors+1> to build faster. Example: '''make -j9''' for an 8 core machine.}}

=== Using the overlay ===
Inside the overlay, there are ebuilds already prepared that will download the kernel, patch it, and perform any required substitutions. Afterwards you literally just go into your /usr/src/<kernel> directory, and run make. To see the available versions, run the following:

<console>
Versions available for standard kernel
# ##i##equery y -O std-sources

[I]3.4.37-r1 | o ~ o o o o o o o o o o o | o 3.4.37 | fearedbliss

Versions available for alternate kernel
# ##i##equery y -O alt-sources

[I]3.8.4 | o ~ o o o o o o o o o o o | o 3.8.4 | fearedbliss
</console>

I haven't written the ebuilds in a way where it's easy to tell (at first glance) what System Rescue CD version you need. However, you can check the ebuild and you will see the version of the CD inside there. You can also check the chart above.

If you wanted to install the standard kernel sources, you just emerge it like any other application:

<console>
# ##i##emerge std-sources
</console>

Once the kernel and the kernel module are installed, you need to make the SRM.

== Creating the SRM ==
It's time to gather the required files and pack them together in order for it to become an SRM. An SRM is nothing more than a directory that has been compressed with squashfs. Thankfully I've written a script that will build it for you, and you can install it from the overlay.

You also need to have spl, zfs, and zfs-kmod installed on your system before you try to make the srm. Emerging '''"bliss-initramfs"''' should automatically pull those packages. If it doesn't, make sure you install them.

<console>
# ##i##echo "sys-kernel/bliss-initramfs srm" >> /etc/portage/package.use
# ##i##emerge bliss-initramfs
</console>

You should now have the following directory layout inside the '''/opt/bliss-initramfs''' folder:

<console>
octopus bliss-initramfs # ls -l
total 117
-rw-r--r-- 1 root root 6718 May 23 18:05 CHANGES
-rw-r--r-- 1 root root 176 May 23 18:05 CREDITS
-rw-r--r-- 1 root root 431 May 23 18:05 HELP
-rw-r--r-- 1 root root 1397 May 23 18:05 LICENSE
-rw-r--r-- 1 root root 1852 May 23 18:05 README
-rw-r--r-- 1 root root 3194 May 23 18:05 USAGE
-rwxr-xr-x 1 root root 2891 May 23 18:05 createInit
drwxr-xr-x 3 root root 4 May 23 18:11 files
drwxr-xr-x 3 root root 6 May 23 18:11 hooks
drwxr-xr-x 2 root root 5 May 23 22:01 resources
</console>

Then run the '''createInit''' script and follow the instructions for the kernel you want to make the srm for (In this case it's '''3.4.37-std350-amd64'''):

<console>
-----------------------------------
| Bliss Initramfs Creator - v1.8.1
| Author: Jonathan Vasquez <jvasquez1011@gmail.com>
| Distributed under the Simplified BSD License
-----------------------------------

>>> Which initramfs would you like to generate:
>> 1. ZFS
>> 2. Encrypted ZFS (LUKS + ZFS)
>> 3. More Options
>> 4. Exit Program

>>> Current choice [1]: ##i##3 ↵

>>> More Options:

>> 1. ZFS - System Rescue Module
>> 2. Back
>> 3. Exit Program

>>> Current choice [1]: ##i##↵

>>> Creating a ZFS System Rescue Module!

>>> Do you want to use the current kernel: 3.8.13-ALL? [Y/n]: ##i##n ↵

>>> Please enter the kernel name: ##i##3.4.37-std350-amd64 ↵

>>> Detected 64 bit platform
>>> Checking to see if modules directory exists for 3.4.37-std350-amd64...
>>> Creating SRMs for 3.4.37-std350-amd64...
>>> Creating directory structure for initramfs...
>>> Checking preliminary binaries...
>>> Checking binaries...
>>> Using ZFS
>>> Checking modules...
>>> Copying binaries...
>>> Copying modules...
>>> Copying documentation...
>>> Copying udev rules...
>>> Compressing kernel modules...
>>> Getting dependencies...
>>> Copying dependencies...
>>> Configuring files...
>>> Creating and Packing SRMs...
>>> Complete :)
</console>

Now you should have two new files:

<console>
-rw-r--r-- 1 root root 2068480 May 24 01:05 zfs-core-3.4.37-std350-amd64.srm
-rw-r--r-- 1 root root 483328 May 24 01:05 zfs-kmod-3.4.37-std350-amd64.srm
</console>

Now all you need to do is put those two files in the root of your USB directory.

If you are making srms for both the standard and alternate kernels, you will end up with two zfs-core files and two zfs-kmod files (1 set for each kernel). You don't need to put the zfs-core that it makes for one of the kernels. The zfs-core srm only has zfs program binaries, man pages, udev rules, and a few other things. The zfs-kmod is the srm that has the kernel modules (and only the kernel modules). So you can easily just put two zfs-kmods (one for each kernel version) and just re-use the same zfs-core for both of them.

== Using the prebuilt srm ==

=== Download the SRM ===
If you didn't build your own srm and want to use the prebuilt one, just emerge '''"zfs-srm"''' from the overlay:

(Instructions on [[Creating_System_Rescue_CD_ZFS_Modules#Adding_the_overlay|adding the overlay]] can be found at the top of this page)

<console>
# ##i##emerge zfs-srm
</console>

You can check available versions just as you did above for the kernels:

<console>
Available versions of the zfs-srm
# ##i##equery y -O zfs-srm

[I]3.5.0 | o ~ o o o o o o o o o o o | o 3.5.0 | fearedbliss
</console>

(These versions match the version of the System Rescue CD).

Installing the zfs-srm will automatically pull the '''"bliss-isomaker"''' package which is just a script that assists you with rebuilding the System Rescue CD ISO so that the ISO includes the ZFS srms. The script lets you make a bootable ISO or a bootable USB.

Once it's installed, switch to the /opt/bliss-isomaker folder

<console>
# ##i##cd /opt/bliss-isomaker
</console>

You should now see a directory layout that looks similar to this:

<console>
octopus bliss-isomaker # ls -l
total 100
drwxr-xr-x 2 root root 5 May 24 01:41 3.5.0
-rw-r--r-- 1 root root 1397 May 24 01:31 LICENSE
-rw-r--r-- 1 root root 312 May 24 01:31 README
-rw-r--r-- 1 root root 576 May 24 01:31 USAGE
-rwxr-xr-x 1 root root 3228 May 24 01:31 create
drwxr-xr-x 2 root root 3 May 24 01:41 iso
drwxr-xr-x 2 root root 4 May 24 01:41 resources
drwxr-xr-x 2 root root 3 May 24 01:41 srm
</console>

The layout is as follows:
* 3.5.0 - This folder contains the System Rescue CD 3.5.0 specific srms for both the standard and alternate kernel that were installed by emerge.
* create - A script to automatically recreate the system rescue cd iso or usb with the zfs stuff included
* iso - directory to place your system rescue cd iso in
* srm - directory that has the srms
* resources - the files in this folder contain function calls that the 'create' script uses. You don't need to worry about these.

=== Installing the SRM ===
There are a few ways to do this, you can either use one of the scripts, or you can do it manually. Before anything, make sure to copy the SRMs from the <Version> folder to the srm folder if you are using a prebuilt one:

<console>
# ##i##cp 3.5.0/* srm
</console>

==== Generating a new iso ====
If you just want to remake a new iso so that you can burn onto a cd or use in a virtual machine, just copy your iso over to the iso directory, and run the 'create' script. The new iso will be located in the iso directory as well with a -zfs ending.

<console>
Running the script with 1 (or iso) chooses to make an iso. You can also pass the version as well.
# ##i##./create 1

or

# ##i##./create iso 3.5.0
</console>

==== Creating a fresh usb ====
If you want to have zfs on a usb with system rescue cd, put the iso in your iso dir, and then run the usb script. It will ask you what usb you want to format (This will delete everything), and then install system rescue cd onto it. Once that is done it will copy the zfs stuff over.

<console>
Running the script with 2 (or usb) chooses to make an usb. You can also pass the version as well.
# ##i##./create 2

or

# ##i##./create usb 3.5.0
</console>

==== Manual installation onto a usb ====
Assuming that your installing to a flash drive and that the flash drive is mounted in /mnt

1. Mount your usb drive

<console>
# ##i##mount /dev/sdX# /mnt/usbstick
</console>

'''Where X# is the letter and number of your device. Immediately after you plug your usb in, type `dmesg | tail` in the console and you should see it.'''

2. Copy the zfs .srms to /mnt/usbstick

<console>
# ##i##cp zfs-core-3.4.37-std350-amd64.srm zfs-kmod-3.4.37-std350-amd64.srm zfs-kmod-3.8.4-alt350-amd64.srm /mnt/usbstick
</console>

3. List your /mnt/usbstick directory and you should see something similar to the following in your /mnt/usbstick

<console>
octopus 3.5.0 # ls -l /mnt/usbstick
total 305028
drwxr-xr-x 3 root root 4096 May 23 20:51 boot
drwxr-xr-x 2 root root 4096 May 23 20:51 bootdisk
drwxr-xr-x 2 root root 4096 May 23 20:51 bootprog
drwxr-xr-x 3 root root 4096 May 23 20:51 efi
drwxr-xr-x 2 root root 4096 May 23 20:51 ntpasswd
-rwxr-xr-x 1 root root 2349 May 23 20:51 readme.txt
drwxr-xr-x 3 root root 4096 May 23 20:52 syslinux
-rwxr-xr-x 1 root root 309252096 May 23 20:51 sysrcd.dat
-rwxr-xr-x 1 root root 45 May 23 20:51 sysrcd.md5
drwxr-xr-x 2 root root 4096 May 23 20:51 usb_inst
-rwxr-xr-x 1 root root 15889 May 23 20:51 usb_inst.sh
-rwxr-xr-x 1 root root 877 May 23 20:51 usbstick.htm
-rwxr-xr-x 1 root root 6 May 23 20:51 version
-rwxr-xr-x 1 root root 2068480 May 23 20:51 zfs-core-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.8.4-alt350-amd64.srm
</console>

Now un-mount your flash drive and boot it into the machine that you want to use ZFS on.

<console>
# ##i##umount /mnt/usbstick
</console>

== Booting into the correct kernel ==
'''If you are using the standard srm:'''
<console>
C) Standard 64bit kernel (rescue64) with more choice... >
1. SystemRescueCd with default options
</console>

'''If you are using the alternative srm:'''
<console>
E) Alternative 64bit kernel (altker64) with more choice... >
1. SystemRescueCd with default options
</console>

2. Run 'depmod' so that the new modules can be seen by the kernel.

<console>
# ##i##depmod
</console>

{{fancywarning|You must run '''depmod'''. If you don't, then you will get failed to load the ZFS stack error!}}

3. Use ZFS as usual. If you type '''zpool status''' and then type '''dmesg | tail''',

you should see something that says:

<console>
ZFS: Loaded module v0.6.1-1, ZFS pool version 5000, ZFS filesystem version 5
</console>

If you see the above, then the modules loaded successfully!

Enjoy System Rescue CD with ZFS :)

== Extra ==

=== A more accurate kernel build setup ===
If you want to have a more accurate setup to upstream, you can check out the git repo he has for the target release. Example: [http://sourceforge.net/p/systemrescuecd/code/ci/74e7a9712a019958fbe099386c9fb6bd7813d907/tree/ Upstream Git Repo]

If you navigate to portage-overlay/sys-kernel/std-sources, you can see the ebuild there and the files directory with the patches for the std-sources kernel.

I also keep my own modified ebuilds for when I make my own srms in my overlay:
https://github.com/fearedbliss/funtoo-overlay

You can see the ebuilds in the sys-kernel/std-sources directory.
[[Category:HOWTO]]

Creating System Rescue CD ZFS Modules

2013-06-10T00:16:10Z

Fearedbliss: /* Booting into the correct kernel */

This HOWTO will show you how to create your own zfs srm or download the prebuilt zfs srm module from my website.

== Adding the overlay ==
There are scripts that I've written that will make this process much easier for you. So we will first set up the overlay to a directory on your machine, let's say '''"/home/example/overlays/fearedbliss"''':

<console>
# Make the overlays directory if it doesn't exist
# ##i##mkdir /home/example/overlays

# Clone my overlay into this directory
# ##i##git clone git://github.com/fearedbliss/funtoo-overlay.git

# Rename the "funtoo-overlay" folder to "fearedbliss"
# ##i##mv funtoo-overlay fearedbliss

# Add the overlay to your /etc/portage/make.conf so portage knows its existence.
# ##i##echo 'PORTDIR_OVERLAY="/home/example/overlays/fearedbliss ${PORTDIR_OVERLAY}"' >> /etc/portage/make.conf
</console>

Now that the overlay has been added, let's continue.

== Compiling a compatible kernel ==

The first thing you need to do is decide for which version of System Rescue CD you will be building for. Each System Rescue CD version has a different set of kernels. Specifically each version has a Stable kernel and an Alternate Kernel. The stable kernels get minor version increments every release (Sometimes major ones but usually doesn't happen too quickly), the Alternate kernels tend to move up much faster. For example System Rescue CD had the following stable/alternate kernels:

{| class="wikitable"
|-
! Version !! Stable !! Alternate
|-
| 3.5.0 || 3.4.37 || 3.8.4
|-
| 3.4.2 || 3.4.35 || 3.7.10
|-
| 3.4.1 || 3.4.32 || 3.7.9
|-
| 3.4.0 || 3.4.30 || 3.7.8
|-
| 3.3.0 || 3.4.27 || 3.7.4
|}

===Download kernel and patches===
Once you decide which version you want to use, you can go to http://kernel.sysresccd.org/ and pick the version you want. After you do this, download all the stuff in that directory and put them in their own folder (a work directory). The files that are named std-sources are the patches for the regular stable kernel, the patches named alt-sources are the patches for the alternate kernel. Once you have the patches, go to kernel.org and also download the initial release of the kernel sources you want. For example, if you want to build an srm for 3.4.2 which uses the 3.4.35 kernel, just download the 3.4 (3.4.0) kernel. You just need to download the initial release because one of the patches you downloaded earlier is the patch to update the 3.4.0 to 3.4.35.

Once you download the kernel you want, let's extract and patch it.

<console>
# ##i##tar xf linux-3.4.tar.bz2
# ##i##mv linux-3.4 linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-01-stable-3.4.35.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-02-fc16.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-03-aufs.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
</console>

===Retrieve kernel configuration===
Once that is complete, you will need to get the kernel config specifically for the kernel and architecture you want. The easiest way I found to do this was to download the System Rescue CD you want, and then boot it inside a VM. Once you are inside the VM, go to the /root directory, and it will be a file named kernel-<version>.conf. Copy this file over SSH and put it in a safe location. Also copy it over into the linux kernel directory and rename it to .config.

===Build the kernel===
Once you copy the kernel config over, do a make menuconfig to begin. You will only need to change two settings inside the config, add the proper kernel name, and remove the old initramfs source files directory. This directory doesn't exist locally. This is a remnant of upstream's build process.

Follow the below tree structure, and make it equal to what is below:

<console>
General Setup ->
(-std342-amd64) Local version - append to kernel release
[*] Initial RAM filesystem and RAM disk (initramfs/initrd) support () Initramfs source file(s)
</console>

The Local version above will end up making the kernel modules directory be 3.4.35-std342-amd64. The reason the kernel modules directory has to be equal to this is because our directory will be merged into the System Rescue CD later on, so the names need to be exactly the same so that the System Rescue CD system can find our kernel modules.

If you want to build an srm (which you do), you also need to change the following inside the kernel config so that squashfs-tools can work later on:

<console>
File Systems ->
Miscellaneous Filesystems ->
<*> SquashFS 4.0 - Squashed file system support
[*] Squashfs XATTR support
[*] Include support for ZLIB compressed file systems
[*] Include support for LZO compressed file systems
[*] Include support for XZ compressed file systems
[ ] Use 4K device block size?
[ ] Additional option for memory-constrained systems
</console>

Now save and exit, and continue to build your kernel.

<console>
# ##i##make bzImage modules
# ##i##make modules_install
</console>

{{fancynote|If you have multiple cores, do a make -j<# of processors+1> to build faster. Example: '''make -j9''' for an 8 core machine.}}

=== Using the overlay ===
Inside the overlay, there are ebuilds already prepared that will download the kernel, patch it, and perform any required substitutions. Afterwards you literally just go into your /usr/src/<kernel> directory, and run make. To see the available versions, run the following:

<console>
Versions available for standard kernel
# ##i##equery y -O std-sources

[I]3.4.37-r1 | o ~ o o o o o o o o o o o | o 3.4.37 | fearedbliss

Versions available for alternate kernel
# ##i##equery y -O alt-sources

[I]3.8.4 | o ~ o o o o o o o o o o o | o 3.8.4 | fearedbliss
</console>

I haven't written the ebuilds in a way where it's easy to tell (at first glance) what System Rescue CD version you need. However, you can check the ebuild and you will see the version of the CD inside there. You can also check the chart above.

If you wanted to install the standard kernel sources, you just emerge it like any other application:

<console>
# ##i##emerge std-sources
</console>

Once the kernel and the kernel module are installed, you need to make the SRM.

== Creating the SRM ==
It's time to gather the required files and pack them together in order for it to become an SRM. An SRM is nothing more than a directory that has been compressed with squashfs. Thankfully I've written a script that will build it for you, and you can install it from the overlay.

You also need to have spl, zfs, and zfs-kmod installed on your system before you try to make the srm. Emerging '''"bliss-initramfs"''' should automatically pull those packages. If it doesn't, make sure you install them.

<console>
# ##i##echo "sys-kernel/bliss-initramfs srm" >> /etc/portage/package.use
# ##i##emerge bliss-initramfs
</console>

You should now have the following directory layout inside the '''/opt/bliss-initramfs''' folder:

<console>
octopus bliss-initramfs # ls -l
total 117
-rw-r--r-- 1 root root 6718 May 23 18:05 CHANGES
-rw-r--r-- 1 root root 176 May 23 18:05 CREDITS
-rw-r--r-- 1 root root 431 May 23 18:05 HELP
-rw-r--r-- 1 root root 1397 May 23 18:05 LICENSE
-rw-r--r-- 1 root root 1852 May 23 18:05 README
-rw-r--r-- 1 root root 3194 May 23 18:05 USAGE
-rwxr-xr-x 1 root root 2891 May 23 18:05 createInit
drwxr-xr-x 3 root root 4 May 23 18:11 files
drwxr-xr-x 3 root root 6 May 23 18:11 hooks
drwxr-xr-x 2 root root 5 May 23 22:01 resources
</console>

Then run the '''createInit''' script and follow the instructions for the kernel you want to make the srm for (In this case it's '''3.4.37-std350-amd64'''):

<console>
-----------------------------------
| Bliss Initramfs Creator - v1.8.1
| Author: Jonathan Vasquez <jvasquez1011@gmail.com>
| Distributed under the Simplified BSD License
-----------------------------------

>>> Which initramfs would you like to generate:
>> 1. ZFS
>> 2. Encrypted ZFS (LUKS + ZFS)
>> 3. More Options
>> 4. Exit Program

>>> Current choice [1]: ##i##3 ↵

>>> More Options:

>> 1. ZFS - System Rescue Module
>> 2. Back
>> 3. Exit Program

>>> Current choice [1]: ##i##↵

>>> Creating a ZFS System Rescue Module!

>>> Do you want to use the current kernel: 3.8.13-ALL? [Y/n]: ##i##n ↵

>>> Please enter the kernel name: ##i##3.4.37-std350-amd64 ↵

>>> Detected 64 bit platform
>>> Checking to see if modules directory exists for 3.4.37-std350-amd64...
>>> Creating SRMs for 3.4.37-std350-amd64...
>>> Creating directory structure for initramfs...
>>> Checking preliminary binaries...
>>> Checking binaries...
>>> Using ZFS
>>> Checking modules...
>>> Copying binaries...
>>> Copying modules...
>>> Copying documentation...
>>> Copying udev rules...
>>> Compressing kernel modules...
>>> Getting dependencies...
>>> Copying dependencies...
>>> Configuring files...
>>> Creating and Packing SRMs...
>>> Complete :)
</console>

Now you should have two new files:

<console>
-rw-r--r-- 1 root root 2068480 May 24 01:05 zfs-core-3.4.37-std350-amd64.srm
-rw-r--r-- 1 root root 483328 May 24 01:05 zfs-kmod-3.4.37-std350-amd64.srm
</console>

Now all you need to do is put those two files in the root of your USB directory.

If you are making srms for both the standard and alternate kernels, you will end up with two zfs-core files and two zfs-kmod files (1 set for each kernel). You don't need to put the zfs-core that it makes for one of the kernels. The zfs-core srm only has zfs program binaries, man pages, udev rules, and a few other things. The zfs-kmod is the srm that has the kernel modules (and only the kernel modules). So you can easily just put two zfs-kmods (one for each kernel version) and just re-use the same zfs-core for both of them.

== Using the prebuilt srm ==

=== Download the SRM ===
If you didn't build your own srm and want to use the prebuilt one, just emerge '''"zfs-srm"''' from the overlay:

(Instructions on [[Creating_System_Rescue_CD_ZFS_Modules#Adding_the_overlay|adding the overlay]] can be found at the top of this page)

<console>
# ##i##emerge zfs-srm
</console>

You can check available versions just as you did above for the kernels:

<console>
Available versions of the zfs-srm
# ##i##equery y -O zfs-srm

[I]3.5.0 | o ~ o o o o o o o o o o o | o 3.5.0 | fearedbliss
</console>

(These versions match the version of the System Rescue CD).

Installing the zfs-srm will automatically pull the '''"bliss-isomaker"''' package which is just a script that assists you with rebuilding the System Rescue CD ISO so that the ISO includes the ZFS srms. The script lets you make a bootable ISO or a bootable USB.

Once it's installed, switch to the /opt/bliss-isomaker folder

<console>
# ##i##cd /opt/bliss-isomaker
</console>

You should now see a directory layout that looks similar to this:

<console>
octopus bliss-isomaker # ls -l
total 100
drwxr-xr-x 2 root root 5 May 24 01:41 3.5.0
-rw-r--r-- 1 root root 1397 May 24 01:31 LICENSE
-rw-r--r-- 1 root root 312 May 24 01:31 README
-rw-r--r-- 1 root root 576 May 24 01:31 USAGE
-rwxr-xr-x 1 root root 3228 May 24 01:31 create
drwxr-xr-x 2 root root 3 May 24 01:41 iso
drwxr-xr-x 2 root root 4 May 24 01:41 resources
drwxr-xr-x 2 root root 3 May 24 01:41 srm
</console>

The layout is as follows:
* 3.5.0 - This folder contains the System Rescue CD 3.5.0 specific srms for both the standard and alternate kernel that were installed by emerge.
* create - A script to automatically recreate the system rescue cd iso or usb with the zfs stuff included
* iso - directory to place your system rescue cd iso in
* srm - directory that has the srms
* resources - the files in this folder contain function calls that the 'create' script uses. You don't need to worry about these.

=== Installing the SRM ===
There are a few ways to do this, you can either use one of the scripts, or you can do it manually. Before anything, make sure to copy the SRMs from the <Version> folder to the srm folder if you are using a prebuilt one:

<console>
# ##i##cp 3.5.0/* srm
</console>

==== Generating a new iso ====
If you just want to remake a new iso so that you can burn onto a cd or use in a virtual machine, just copy your iso over to the iso directory, and run the 'create' script. The new iso will be located in the iso directory as well with a -zfs ending.

<console>
Running the script with 1 (or iso) chooses to make an iso. You can also pass the version as well.
# ##i##./create 1

or

# ##i##./create iso 3.5.0
</console>

==== Creating a fresh usb ====
If you want to have zfs on a usb with system rescue cd, put the iso in your iso dir, and then run the usb script. It will ask you what usb you want to format (This will delete everything), and then install system rescue cd onto it. Once that is done it will copy the zfs stuff over.

<console>
Running the script with 2 (or usb) chooses to make an usb. You can also pass the version as well.
# ##i##./create 2

or

# ##i##./create usb 3.5.0
</console>

==== Manual installation onto a usb ====
Assuming that your installing to a flash drive and that the flash drive is mounted in /mnt

1. Mount your usb drive

<console>
# ##i##mount /dev/sdX# /mnt/usbstick
</console>

'''Where X# is the letter and number of your device. Immediately after you plug your usb in, type `dmesg | tail` in the console and you should see it.'''

2. Copy the zfs .srms to /mnt/usbstick

<console>
# ##i##cp zfs-core-3.4.37-std350-amd64.srm zfs-kmod-3.4.37-std350-amd64.srm zfs-kmod-3.8.4-alt350-amd64.srm /mnt/usbstick
</console>

3. List your /mnt/usbstick directory and you should see something similar to the following in your /mnt/usbstick

<console>
octopus 3.5.0 # ls -l /mnt/usbstick
total 305028
drwxr-xr-x 3 root root 4096 May 23 20:51 boot
drwxr-xr-x 2 root root 4096 May 23 20:51 bootdisk
drwxr-xr-x 2 root root 4096 May 23 20:51 bootprog
drwxr-xr-x 3 root root 4096 May 23 20:51 efi
drwxr-xr-x 2 root root 4096 May 23 20:51 ntpasswd
-rwxr-xr-x 1 root root 2349 May 23 20:51 readme.txt
drwxr-xr-x 3 root root 4096 May 23 20:52 syslinux
-rwxr-xr-x 1 root root 309252096 May 23 20:51 sysrcd.dat
-rwxr-xr-x 1 root root 45 May 23 20:51 sysrcd.md5
drwxr-xr-x 2 root root 4096 May 23 20:51 usb_inst
-rwxr-xr-x 1 root root 15889 May 23 20:51 usb_inst.sh
-rwxr-xr-x 1 root root 877 May 23 20:51 usbstick.htm
-rwxr-xr-x 1 root root 6 May 23 20:51 version
-rwxr-xr-x 1 root root 2068480 May 23 20:51 zfs-core-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.8.4-alt350-amd64.srm
</console>

Now un-mount your flash drive and boot it into the machine that you want to use ZFS on.

<console>
# ##i##umount /mnt/usbstick
</console>

== Booting into the correct kernel ==
'''If you are using the standard srm:'''
<console>
C) Standard 64bit kernel (rescue64) with more choice... >
1. SystemRescueCd with default options
</console>

'''If you are using the alternative srm:'''
<console>
E) Alternative 64bit kernel (altker64) with more choice... >
1. SystemRescueCd with default options
</console>

2. Run 'depmod' so that the new modules can be seen by the kernel.

<console>
# ##i##depmod
</console>

{{fancywarning|You must run '''depmod'''. If you don't, then you will get failed to load the ZFS stack error! And after modprobe you can check with 'lsmod' if the 6 modules where loaded.}}

3. Use ZFS as usual. If you type '''zpool status''' and then type '''dmesg | tail''',

you should see something that says:

<console>
ZFS: Loaded module v0.6.1-1, ZFS pool version 5000, ZFS filesystem version 5
</console>

If you see the above, then the modules loaded successfully!

Enjoy System Rescue CD with ZFS :)

== Extra ==

=== A more accurate kernel build setup ===
If you want to have a more accurate setup to upstream, you can check out the git repo he has for the target release. Example: [http://sourceforge.net/p/systemrescuecd/code/ci/74e7a9712a019958fbe099386c9fb6bd7813d907/tree/ Upstream Git Repo]

If you navigate to portage-overlay/sys-kernel/std-sources, you can see the ebuild there and the files directory with the patches for the std-sources kernel.

I also keep my own modified ebuilds for when I make my own srms in my overlay:
https://github.com/fearedbliss/funtoo-overlay

You can see the ebuilds in the sys-kernel/std-sources directory.
[[Category:HOWTO]]

Creating System Rescue CD ZFS Modules

2013-06-10T00:16:03Z

Fearedbliss: /* Booting into the correct kernel */

This HOWTO will show you how to create your own zfs srm or download the prebuilt zfs srm module from my website.

== Adding the overlay ==
There are scripts that I've written that will make this process much easier for you. So we will first set up the overlay to a directory on your machine, let's say '''"/home/example/overlays/fearedbliss"''':

<console>
# Make the overlays directory if it doesn't exist
# ##i##mkdir /home/example/overlays

# Clone my overlay into this directory
# ##i##git clone git://github.com/fearedbliss/funtoo-overlay.git

# Rename the "funtoo-overlay" folder to "fearedbliss"
# ##i##mv funtoo-overlay fearedbliss

# Add the overlay to your /etc/portage/make.conf so portage knows its existence.
# ##i##echo 'PORTDIR_OVERLAY="/home/example/overlays/fearedbliss ${PORTDIR_OVERLAY}"' >> /etc/portage/make.conf
</console>

Now that the overlay has been added, let's continue.

== Compiling a compatible kernel ==

The first thing you need to do is decide for which version of System Rescue CD you will be building for. Each System Rescue CD version has a different set of kernels. Specifically each version has a Stable kernel and an Alternate Kernel. The stable kernels get minor version increments every release (Sometimes major ones but usually doesn't happen too quickly), the Alternate kernels tend to move up much faster. For example System Rescue CD had the following stable/alternate kernels:

{| class="wikitable"
|-
! Version !! Stable !! Alternate
|-
| 3.5.0 || 3.4.37 || 3.8.4
|-
| 3.4.2 || 3.4.35 || 3.7.10
|-
| 3.4.1 || 3.4.32 || 3.7.9
|-
| 3.4.0 || 3.4.30 || 3.7.8
|-
| 3.3.0 || 3.4.27 || 3.7.4
|}

===Download kernel and patches===
Once you decide which version you want to use, you can go to http://kernel.sysresccd.org/ and pick the version you want. After you do this, download all the stuff in that directory and put them in their own folder (a work directory). The files that are named std-sources are the patches for the regular stable kernel, the patches named alt-sources are the patches for the alternate kernel. Once you have the patches, go to kernel.org and also download the initial release of the kernel sources you want. For example, if you want to build an srm for 3.4.2 which uses the 3.4.35 kernel, just download the 3.4 (3.4.0) kernel. You just need to download the initial release because one of the patches you downloaded earlier is the patch to update the 3.4.0 to 3.4.35.

Once you download the kernel you want, let's extract and patch it.

<console>
# ##i##tar xf linux-3.4.tar.bz2
# ##i##mv linux-3.4 linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-01-stable-3.4.35.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-02-fc16.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-03-aufs.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
</console>

===Retrieve kernel configuration===
Once that is complete, you will need to get the kernel config specifically for the kernel and architecture you want. The easiest way I found to do this was to download the System Rescue CD you want, and then boot it inside a VM. Once you are inside the VM, go to the /root directory, and it will be a file named kernel-<version>.conf. Copy this file over SSH and put it in a safe location. Also copy it over into the linux kernel directory and rename it to .config.

===Build the kernel===
Once you copy the kernel config over, do a make menuconfig to begin. You will only need to change two settings inside the config, add the proper kernel name, and remove the old initramfs source files directory. This directory doesn't exist locally. This is a remnant of upstream's build process.

Follow the below tree structure, and make it equal to what is below:

<console>
General Setup ->
(-std342-amd64) Local version - append to kernel release
[*] Initial RAM filesystem and RAM disk (initramfs/initrd) support () Initramfs source file(s)
</console>

The Local version above will end up making the kernel modules directory be 3.4.35-std342-amd64. The reason the kernel modules directory has to be equal to this is because our directory will be merged into the System Rescue CD later on, so the names need to be exactly the same so that the System Rescue CD system can find our kernel modules.

If you want to build an srm (which you do), you also need to change the following inside the kernel config so that squashfs-tools can work later on:

<console>
File Systems ->
Miscellaneous Filesystems ->
<*> SquashFS 4.0 - Squashed file system support
[*] Squashfs XATTR support
[*] Include support for ZLIB compressed file systems
[*] Include support for LZO compressed file systems
[*] Include support for XZ compressed file systems
[ ] Use 4K device block size?
[ ] Additional option for memory-constrained systems
</console>

Now save and exit, and continue to build your kernel.

<console>
# ##i##make bzImage modules
# ##i##make modules_install
</console>

{{fancynote|If you have multiple cores, do a make -j<# of processors+1> to build faster. Example: '''make -j9''' for an 8 core machine.}}

=== Using the overlay ===
Inside the overlay, there are ebuilds already prepared that will download the kernel, patch it, and perform any required substitutions. Afterwards you literally just go into your /usr/src/<kernel> directory, and run make. To see the available versions, run the following:

<console>
Versions available for standard kernel
# ##i##equery y -O std-sources

[I]3.4.37-r1 | o ~ o o o o o o o o o o o | o 3.4.37 | fearedbliss

Versions available for alternate kernel
# ##i##equery y -O alt-sources

[I]3.8.4 | o ~ o o o o o o o o o o o | o 3.8.4 | fearedbliss
</console>

I haven't written the ebuilds in a way where it's easy to tell (at first glance) what System Rescue CD version you need. However, you can check the ebuild and you will see the version of the CD inside there. You can also check the chart above.

If you wanted to install the standard kernel sources, you just emerge it like any other application:

<console>
# ##i##emerge std-sources
</console>

Once the kernel and the kernel module are installed, you need to make the SRM.

== Creating the SRM ==
It's time to gather the required files and pack them together in order for it to become an SRM. An SRM is nothing more than a directory that has been compressed with squashfs. Thankfully I've written a script that will build it for you, and you can install it from the overlay.

You also need to have spl, zfs, and zfs-kmod installed on your system before you try to make the srm. Emerging '''"bliss-initramfs"''' should automatically pull those packages. If it doesn't, make sure you install them.

<console>
# ##i##echo "sys-kernel/bliss-initramfs srm" >> /etc/portage/package.use
# ##i##emerge bliss-initramfs
</console>

You should now have the following directory layout inside the '''/opt/bliss-initramfs''' folder:

<console>
octopus bliss-initramfs # ls -l
total 117
-rw-r--r-- 1 root root 6718 May 23 18:05 CHANGES
-rw-r--r-- 1 root root 176 May 23 18:05 CREDITS
-rw-r--r-- 1 root root 431 May 23 18:05 HELP
-rw-r--r-- 1 root root 1397 May 23 18:05 LICENSE
-rw-r--r-- 1 root root 1852 May 23 18:05 README
-rw-r--r-- 1 root root 3194 May 23 18:05 USAGE
-rwxr-xr-x 1 root root 2891 May 23 18:05 createInit
drwxr-xr-x 3 root root 4 May 23 18:11 files
drwxr-xr-x 3 root root 6 May 23 18:11 hooks
drwxr-xr-x 2 root root 5 May 23 22:01 resources
</console>

Then run the '''createInit''' script and follow the instructions for the kernel you want to make the srm for (In this case it's '''3.4.37-std350-amd64'''):

<console>
-----------------------------------
| Bliss Initramfs Creator - v1.8.1
| Author: Jonathan Vasquez <jvasquez1011@gmail.com>
| Distributed under the Simplified BSD License
-----------------------------------

>>> Which initramfs would you like to generate:
>> 1. ZFS
>> 2. Encrypted ZFS (LUKS + ZFS)
>> 3. More Options
>> 4. Exit Program

>>> Current choice [1]: ##i##3 ↵

>>> More Options:

>> 1. ZFS - System Rescue Module
>> 2. Back
>> 3. Exit Program

>>> Current choice [1]: ##i##↵

>>> Creating a ZFS System Rescue Module!

>>> Do you want to use the current kernel: 3.8.13-ALL? [Y/n]: ##i##n ↵

>>> Please enter the kernel name: ##i##3.4.37-std350-amd64 ↵

>>> Detected 64 bit platform
>>> Checking to see if modules directory exists for 3.4.37-std350-amd64...
>>> Creating SRMs for 3.4.37-std350-amd64...
>>> Creating directory structure for initramfs...
>>> Checking preliminary binaries...
>>> Checking binaries...
>>> Using ZFS
>>> Checking modules...
>>> Copying binaries...
>>> Copying modules...
>>> Copying documentation...
>>> Copying udev rules...
>>> Compressing kernel modules...
>>> Getting dependencies...
>>> Copying dependencies...
>>> Configuring files...
>>> Creating and Packing SRMs...
>>> Complete :)
</console>

Now you should have two new files:

<console>
-rw-r--r-- 1 root root 2068480 May 24 01:05 zfs-core-3.4.37-std350-amd64.srm
-rw-r--r-- 1 root root 483328 May 24 01:05 zfs-kmod-3.4.37-std350-amd64.srm
</console>

Now all you need to do is put those two files in the root of your USB directory.

If you are making srms for both the standard and alternate kernels, you will end up with two zfs-core files and two zfs-kmod files (1 set for each kernel). You don't need to put the zfs-core that it makes for one of the kernels. The zfs-core srm only has zfs program binaries, man pages, udev rules, and a few other things. The zfs-kmod is the srm that has the kernel modules (and only the kernel modules). So you can easily just put two zfs-kmods (one for each kernel version) and just re-use the same zfs-core for both of them.

== Using the prebuilt srm ==

=== Download the SRM ===
If you didn't build your own srm and want to use the prebuilt one, just emerge '''"zfs-srm"''' from the overlay:

(Instructions on [[Creating_System_Rescue_CD_ZFS_Modules#Adding_the_overlay|adding the overlay]] can be found at the top of this page)

<console>
# ##i##emerge zfs-srm
</console>

You can check available versions just as you did above for the kernels:

<console>
Available versions of the zfs-srm
# ##i##equery y -O zfs-srm

[I]3.5.0 | o ~ o o o o o o o o o o o | o 3.5.0 | fearedbliss
</console>

(These versions match the version of the System Rescue CD).

Installing the zfs-srm will automatically pull the '''"bliss-isomaker"''' package which is just a script that assists you with rebuilding the System Rescue CD ISO so that the ISO includes the ZFS srms. The script lets you make a bootable ISO or a bootable USB.

Once it's installed, switch to the /opt/bliss-isomaker folder

<console>
# ##i##cd /opt/bliss-isomaker
</console>

You should now see a directory layout that looks similar to this:

<console>
octopus bliss-isomaker # ls -l
total 100
drwxr-xr-x 2 root root 5 May 24 01:41 3.5.0
-rw-r--r-- 1 root root 1397 May 24 01:31 LICENSE
-rw-r--r-- 1 root root 312 May 24 01:31 README
-rw-r--r-- 1 root root 576 May 24 01:31 USAGE
-rwxr-xr-x 1 root root 3228 May 24 01:31 create
drwxr-xr-x 2 root root 3 May 24 01:41 iso
drwxr-xr-x 2 root root 4 May 24 01:41 resources
drwxr-xr-x 2 root root 3 May 24 01:41 srm
</console>

The layout is as follows:
* 3.5.0 - This folder contains the System Rescue CD 3.5.0 specific srms for both the standard and alternate kernel that were installed by emerge.
* create - A script to automatically recreate the system rescue cd iso or usb with the zfs stuff included
* iso - directory to place your system rescue cd iso in
* srm - directory that has the srms
* resources - the files in this folder contain function calls that the 'create' script uses. You don't need to worry about these.

=== Installing the SRM ===
There are a few ways to do this, you can either use one of the scripts, or you can do it manually. Before anything, make sure to copy the SRMs from the <Version> folder to the srm folder if you are using a prebuilt one:

<console>
# ##i##cp 3.5.0/* srm
</console>

==== Generating a new iso ====
If you just want to remake a new iso so that you can burn onto a cd or use in a virtual machine, just copy your iso over to the iso directory, and run the 'create' script. The new iso will be located in the iso directory as well with a -zfs ending.

<console>
Running the script with 1 (or iso) chooses to make an iso. You can also pass the version as well.
# ##i##./create 1

or

# ##i##./create iso 3.5.0
</console>

==== Creating a fresh usb ====
If you want to have zfs on a usb with system rescue cd, put the iso in your iso dir, and then run the usb script. It will ask you what usb you want to format (This will delete everything), and then install system rescue cd onto it. Once that is done it will copy the zfs stuff over.

<console>
Running the script with 2 (or usb) chooses to make an usb. You can also pass the version as well.
# ##i##./create 2

or

# ##i##./create usb 3.5.0
</console>

==== Manual installation onto a usb ====
Assuming that your installing to a flash drive and that the flash drive is mounted in /mnt

1. Mount your usb drive

<console>
# ##i##mount /dev/sdX# /mnt/usbstick
</console>

'''Where X# is the letter and number of your device. Immediately after you plug your usb in, type `dmesg | tail` in the console and you should see it.'''

2. Copy the zfs .srms to /mnt/usbstick

<console>
# ##i##cp zfs-core-3.4.37-std350-amd64.srm zfs-kmod-3.4.37-std350-amd64.srm zfs-kmod-3.8.4-alt350-amd64.srm /mnt/usbstick
</console>

3. List your /mnt/usbstick directory and you should see something similar to the following in your /mnt/usbstick

<console>
octopus 3.5.0 # ls -l /mnt/usbstick
total 305028
drwxr-xr-x 3 root root 4096 May 23 20:51 boot
drwxr-xr-x 2 root root 4096 May 23 20:51 bootdisk
drwxr-xr-x 2 root root 4096 May 23 20:51 bootprog
drwxr-xr-x 3 root root 4096 May 23 20:51 efi
drwxr-xr-x 2 root root 4096 May 23 20:51 ntpasswd
-rwxr-xr-x 1 root root 2349 May 23 20:51 readme.txt
drwxr-xr-x 3 root root 4096 May 23 20:52 syslinux
-rwxr-xr-x 1 root root 309252096 May 23 20:51 sysrcd.dat
-rwxr-xr-x 1 root root 45 May 23 20:51 sysrcd.md5
drwxr-xr-x 2 root root 4096 May 23 20:51 usb_inst
-rwxr-xr-x 1 root root 15889 May 23 20:51 usb_inst.sh
-rwxr-xr-x 1 root root 877 May 23 20:51 usbstick.htm
-rwxr-xr-x 1 root root 6 May 23 20:51 version
-rwxr-xr-x 1 root root 2068480 May 23 20:51 zfs-core-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.8.4-alt350-amd64.srm
</console>

Now un-mount your flash drive and boot it into the machine that you want to use ZFS on.

<console>
# ##i##umount /mnt/usbstick
</console>

== Booting into the correct kernel ==
'''If you are using the standard srm:'''
<console>
C) Standard 64bit kernel (rescue64) with more choice... >
1. SystemRescueCd with default options
</console>

'''If you are using the alternative srm:'''
<console>
E) Alternative 64bit kernel (altker64) with more choice... >
1. SystemRescueCd with default options
</console>

2. Run 'depmod' so that the new modules can be seen by the kernel.

<console>
# ##i##depmod
</console>

{{fancywarning|You must run '''depmod'''. If you don't, then you will get failed to load the ZFS stack error! And after modprobe you can check with 'lsmod' if the 6 modules where loaded.}}

5. Use ZFS as usual. If you type '''zpool status''' and then type '''dmesg | tail''',

you should see something that says:

<console>
ZFS: Loaded module v0.6.1-1, ZFS pool version 5000, ZFS filesystem version 5
</console>

If you see the above, then the modules loaded successfully!

Enjoy System Rescue CD with ZFS :)

== Extra ==

=== A more accurate kernel build setup ===
If you want to have a more accurate setup to upstream, you can check out the git repo he has for the target release. Example: [http://sourceforge.net/p/systemrescuecd/code/ci/74e7a9712a019958fbe099386c9fb6bd7813d907/tree/ Upstream Git Repo]

If you navigate to portage-overlay/sys-kernel/std-sources, you can see the ebuild there and the files directory with the patches for the std-sources kernel.

I also keep my own modified ebuilds for when I make my own srms in my overlay:
https://github.com/fearedbliss/funtoo-overlay

You can see the ebuilds in the sys-kernel/std-sources directory.
[[Category:HOWTO]]

Creating System Rescue CD ZFS Modules

2013-06-10T00:15:45Z

Fearedbliss: removed "modprobe -v zfs" this isn't necessary. Once the person runs "zpool status" or another zfs command, it will automatically load the modules.

This HOWTO will show you how to create your own zfs srm or download the prebuilt zfs srm module from my website.

== Adding the overlay ==
There are scripts that I've written that will make this process much easier for you. So we will first set up the overlay to a directory on your machine, let's say '''"/home/example/overlays/fearedbliss"''':

<console>
# Make the overlays directory if it doesn't exist
# ##i##mkdir /home/example/overlays

# Clone my overlay into this directory
# ##i##git clone git://github.com/fearedbliss/funtoo-overlay.git

# Rename the "funtoo-overlay" folder to "fearedbliss"
# ##i##mv funtoo-overlay fearedbliss

# Add the overlay to your /etc/portage/make.conf so portage knows its existence.
# ##i##echo 'PORTDIR_OVERLAY="/home/example/overlays/fearedbliss ${PORTDIR_OVERLAY}"' >> /etc/portage/make.conf
</console>

Now that the overlay has been added, let's continue.

== Compiling a compatible kernel ==

The first thing you need to do is decide for which version of System Rescue CD you will be building for. Each System Rescue CD version has a different set of kernels. Specifically each version has a Stable kernel and an Alternate Kernel. The stable kernels get minor version increments every release (Sometimes major ones but usually doesn't happen too quickly), the Alternate kernels tend to move up much faster. For example System Rescue CD had the following stable/alternate kernels:

{| class="wikitable"
|-
! Version !! Stable !! Alternate
|-
| 3.5.0 || 3.4.37 || 3.8.4
|-
| 3.4.2 || 3.4.35 || 3.7.10
|-
| 3.4.1 || 3.4.32 || 3.7.9
|-
| 3.4.0 || 3.4.30 || 3.7.8
|-
| 3.3.0 || 3.4.27 || 3.7.4
|}

===Download kernel and patches===
Once you decide which version you want to use, you can go to http://kernel.sysresccd.org/ and pick the version you want. After you do this, download all the stuff in that directory and put them in their own folder (a work directory). The files that are named std-sources are the patches for the regular stable kernel, the patches named alt-sources are the patches for the alternate kernel. Once you have the patches, go to kernel.org and also download the initial release of the kernel sources you want. For example, if you want to build an srm for 3.4.2 which uses the 3.4.35 kernel, just download the 3.4 (3.4.0) kernel. You just need to download the initial release because one of the patches you downloaded earlier is the patch to update the 3.4.0 to 3.4.35.

Once you download the kernel you want, let's extract and patch it.

<console>
# ##i##tar xf linux-3.4.tar.bz2
# ##i##mv linux-3.4 linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-01-stable-3.4.35.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-02-fc16.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
# ##i##bzcat std-sources-3.4-03-aufs.patch.bz2 | patch -p1 -d linux-3.4.35-std342-amd64
</console>

===Retrieve kernel configuration===
Once that is complete, you will need to get the kernel config specifically for the kernel and architecture you want. The easiest way I found to do this was to download the System Rescue CD you want, and then boot it inside a VM. Once you are inside the VM, go to the /root directory, and it will be a file named kernel-<version>.conf. Copy this file over SSH and put it in a safe location. Also copy it over into the linux kernel directory and rename it to .config.

===Build the kernel===
Once you copy the kernel config over, do a make menuconfig to begin. You will only need to change two settings inside the config, add the proper kernel name, and remove the old initramfs source files directory. This directory doesn't exist locally. This is a remnant of upstream's build process.

Follow the below tree structure, and make it equal to what is below:

<console>
General Setup ->
(-std342-amd64) Local version - append to kernel release
[*] Initial RAM filesystem and RAM disk (initramfs/initrd) support () Initramfs source file(s)
</console>

The Local version above will end up making the kernel modules directory be 3.4.35-std342-amd64. The reason the kernel modules directory has to be equal to this is because our directory will be merged into the System Rescue CD later on, so the names need to be exactly the same so that the System Rescue CD system can find our kernel modules.

If you want to build an srm (which you do), you also need to change the following inside the kernel config so that squashfs-tools can work later on:

<console>
File Systems ->
Miscellaneous Filesystems ->
<*> SquashFS 4.0 - Squashed file system support
[*] Squashfs XATTR support
[*] Include support for ZLIB compressed file systems
[*] Include support for LZO compressed file systems
[*] Include support for XZ compressed file systems
[ ] Use 4K device block size?
[ ] Additional option for memory-constrained systems
</console>

Now save and exit, and continue to build your kernel.

<console>
# ##i##make bzImage modules
# ##i##make modules_install
</console>

{{fancynote|If you have multiple cores, do a make -j<# of processors+1> to build faster. Example: '''make -j9''' for an 8 core machine.}}

=== Using the overlay ===
Inside the overlay, there are ebuilds already prepared that will download the kernel, patch it, and perform any required substitutions. Afterwards you literally just go into your /usr/src/<kernel> directory, and run make. To see the available versions, run the following:

<console>
Versions available for standard kernel
# ##i##equery y -O std-sources

[I]3.4.37-r1 | o ~ o o o o o o o o o o o | o 3.4.37 | fearedbliss

Versions available for alternate kernel
# ##i##equery y -O alt-sources

[I]3.8.4 | o ~ o o o o o o o o o o o | o 3.8.4 | fearedbliss
</console>

I haven't written the ebuilds in a way where it's easy to tell (at first glance) what System Rescue CD version you need. However, you can check the ebuild and you will see the version of the CD inside there. You can also check the chart above.

If you wanted to install the standard kernel sources, you just emerge it like any other application:

<console>
# ##i##emerge std-sources
</console>

Once the kernel and the kernel module are installed, you need to make the SRM.

== Creating the SRM ==
It's time to gather the required files and pack them together in order for it to become an SRM. An SRM is nothing more than a directory that has been compressed with squashfs. Thankfully I've written a script that will build it for you, and you can install it from the overlay.

You also need to have spl, zfs, and zfs-kmod installed on your system before you try to make the srm. Emerging '''"bliss-initramfs"''' should automatically pull those packages. If it doesn't, make sure you install them.

<console>
# ##i##echo "sys-kernel/bliss-initramfs srm" >> /etc/portage/package.use
# ##i##emerge bliss-initramfs
</console>

You should now have the following directory layout inside the '''/opt/bliss-initramfs''' folder:

<console>
octopus bliss-initramfs # ls -l
total 117
-rw-r--r-- 1 root root 6718 May 23 18:05 CHANGES
-rw-r--r-- 1 root root 176 May 23 18:05 CREDITS
-rw-r--r-- 1 root root 431 May 23 18:05 HELP
-rw-r--r-- 1 root root 1397 May 23 18:05 LICENSE
-rw-r--r-- 1 root root 1852 May 23 18:05 README
-rw-r--r-- 1 root root 3194 May 23 18:05 USAGE
-rwxr-xr-x 1 root root 2891 May 23 18:05 createInit
drwxr-xr-x 3 root root 4 May 23 18:11 files
drwxr-xr-x 3 root root 6 May 23 18:11 hooks
drwxr-xr-x 2 root root 5 May 23 22:01 resources
</console>

Then run the '''createInit''' script and follow the instructions for the kernel you want to make the srm for (In this case it's '''3.4.37-std350-amd64'''):

<console>
-----------------------------------
| Bliss Initramfs Creator - v1.8.1
| Author: Jonathan Vasquez <jvasquez1011@gmail.com>
| Distributed under the Simplified BSD License
-----------------------------------

>>> Which initramfs would you like to generate:
>> 1. ZFS
>> 2. Encrypted ZFS (LUKS + ZFS)
>> 3. More Options
>> 4. Exit Program

>>> Current choice [1]: ##i##3 ↵

>>> More Options:

>> 1. ZFS - System Rescue Module
>> 2. Back
>> 3. Exit Program

>>> Current choice [1]: ##i##↵

>>> Creating a ZFS System Rescue Module!

>>> Do you want to use the current kernel: 3.8.13-ALL? [Y/n]: ##i##n ↵

>>> Please enter the kernel name: ##i##3.4.37-std350-amd64 ↵

>>> Detected 64 bit platform
>>> Checking to see if modules directory exists for 3.4.37-std350-amd64...
>>> Creating SRMs for 3.4.37-std350-amd64...
>>> Creating directory structure for initramfs...
>>> Checking preliminary binaries...
>>> Checking binaries...
>>> Using ZFS
>>> Checking modules...
>>> Copying binaries...
>>> Copying modules...
>>> Copying documentation...
>>> Copying udev rules...
>>> Compressing kernel modules...
>>> Getting dependencies...
>>> Copying dependencies...
>>> Configuring files...
>>> Creating and Packing SRMs...
>>> Complete :)
</console>

Now you should have two new files:

<console>
-rw-r--r-- 1 root root 2068480 May 24 01:05 zfs-core-3.4.37-std350-amd64.srm
-rw-r--r-- 1 root root 483328 May 24 01:05 zfs-kmod-3.4.37-std350-amd64.srm
</console>

Now all you need to do is put those two files in the root of your USB directory.

If you are making srms for both the standard and alternate kernels, you will end up with two zfs-core files and two zfs-kmod files (1 set for each kernel). You don't need to put the zfs-core that it makes for one of the kernels. The zfs-core srm only has zfs program binaries, man pages, udev rules, and a few other things. The zfs-kmod is the srm that has the kernel modules (and only the kernel modules). So you can easily just put two zfs-kmods (one for each kernel version) and just re-use the same zfs-core for both of them.

== Using the prebuilt srm ==

=== Download the SRM ===
If you didn't build your own srm and want to use the prebuilt one, just emerge '''"zfs-srm"''' from the overlay:

(Instructions on [[Creating_System_Rescue_CD_ZFS_Modules#Adding_the_overlay|adding the overlay]] can be found at the top of this page)

<console>
# ##i##emerge zfs-srm
</console>

You can check available versions just as you did above for the kernels:

<console>
Available versions of the zfs-srm
# ##i##equery y -O zfs-srm

[I]3.5.0 | o ~ o o o o o o o o o o o | o 3.5.0 | fearedbliss
</console>

(These versions match the version of the System Rescue CD).

Installing the zfs-srm will automatically pull the '''"bliss-isomaker"''' package which is just a script that assists you with rebuilding the System Rescue CD ISO so that the ISO includes the ZFS srms. The script lets you make a bootable ISO or a bootable USB.

Once it's installed, switch to the /opt/bliss-isomaker folder

<console>
# ##i##cd /opt/bliss-isomaker
</console>

You should now see a directory layout that looks similar to this:

<console>
octopus bliss-isomaker # ls -l
total 100
drwxr-xr-x 2 root root 5 May 24 01:41 3.5.0
-rw-r--r-- 1 root root 1397 May 24 01:31 LICENSE
-rw-r--r-- 1 root root 312 May 24 01:31 README
-rw-r--r-- 1 root root 576 May 24 01:31 USAGE
-rwxr-xr-x 1 root root 3228 May 24 01:31 create
drwxr-xr-x 2 root root 3 May 24 01:41 iso
drwxr-xr-x 2 root root 4 May 24 01:41 resources
drwxr-xr-x 2 root root 3 May 24 01:41 srm
</console>

The layout is as follows:
* 3.5.0 - This folder contains the System Rescue CD 3.5.0 specific srms for both the standard and alternate kernel that were installed by emerge.
* create - A script to automatically recreate the system rescue cd iso or usb with the zfs stuff included
* iso - directory to place your system rescue cd iso in
* srm - directory that has the srms
* resources - the files in this folder contain function calls that the 'create' script uses. You don't need to worry about these.

=== Installing the SRM ===
There are a few ways to do this, you can either use one of the scripts, or you can do it manually. Before anything, make sure to copy the SRMs from the <Version> folder to the srm folder if you are using a prebuilt one:

<console>
# ##i##cp 3.5.0/* srm
</console>

==== Generating a new iso ====
If you just want to remake a new iso so that you can burn onto a cd or use in a virtual machine, just copy your iso over to the iso directory, and run the 'create' script. The new iso will be located in the iso directory as well with a -zfs ending.

<console>
Running the script with 1 (or iso) chooses to make an iso. You can also pass the version as well.
# ##i##./create 1

or

# ##i##./create iso 3.5.0
</console>

==== Creating a fresh usb ====
If you want to have zfs on a usb with system rescue cd, put the iso in your iso dir, and then run the usb script. It will ask you what usb you want to format (This will delete everything), and then install system rescue cd onto it. Once that is done it will copy the zfs stuff over.

<console>
Running the script with 2 (or usb) chooses to make an usb. You can also pass the version as well.
# ##i##./create 2

or

# ##i##./create usb 3.5.0
</console>

==== Manual installation onto a usb ====
Assuming that your installing to a flash drive and that the flash drive is mounted in /mnt

1. Mount your usb drive

<console>
# ##i##mount /dev/sdX# /mnt/usbstick
</console>

'''Where X# is the letter and number of your device. Immediately after you plug your usb in, type `dmesg | tail` in the console and you should see it.'''

2. Copy the zfs .srms to /mnt/usbstick

<console>
# ##i##cp zfs-core-3.4.37-std350-amd64.srm zfs-kmod-3.4.37-std350-amd64.srm zfs-kmod-3.8.4-alt350-amd64.srm /mnt/usbstick
</console>

3. List your /mnt/usbstick directory and you should see something similar to the following in your /mnt/usbstick

<console>
octopus 3.5.0 # ls -l /mnt/usbstick
total 305028
drwxr-xr-x 3 root root 4096 May 23 20:51 boot
drwxr-xr-x 2 root root 4096 May 23 20:51 bootdisk
drwxr-xr-x 2 root root 4096 May 23 20:51 bootprog
drwxr-xr-x 3 root root 4096 May 23 20:51 efi
drwxr-xr-x 2 root root 4096 May 23 20:51 ntpasswd
-rwxr-xr-x 1 root root 2349 May 23 20:51 readme.txt
drwxr-xr-x 3 root root 4096 May 23 20:52 syslinux
-rwxr-xr-x 1 root root 309252096 May 23 20:51 sysrcd.dat
-rwxr-xr-x 1 root root 45 May 23 20:51 sysrcd.md5
drwxr-xr-x 2 root root 4096 May 23 20:51 usb_inst
-rwxr-xr-x 1 root root 15889 May 23 20:51 usb_inst.sh
-rwxr-xr-x 1 root root 877 May 23 20:51 usbstick.htm
-rwxr-xr-x 1 root root 6 May 23 20:51 version
-rwxr-xr-x 1 root root 2068480 May 23 20:51 zfs-core-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.4.37-std350-amd64.srm
-rwxr-xr-x 1 root root 483328 May 23 20:51 zfs-kmod-3.8.4-alt350-amd64.srm
</console>

Now un-mount your flash drive and boot it into the machine that you want to use ZFS on.

<console>
# ##i##umount /mnt/usbstick
</console>

== Booting into the correct kernel ==
'''If you are using the standard srm:'''
<console>
C) Standard 64bit kernel (rescue64) with more choice... >
1. SystemRescueCd with default options
</console>

'''If you are using the alternative srm:'''
<console>
E) Alternative 64bit kernel (altker64) with more choice... >
1. SystemRescueCd with default options
</console>

2. Run 'depmod' so that the new modules can be seen by the kernel.

<console>
# ##i##depmod
</console>

{{fancywarning|You must run '''depmod'''. If you don't, then you will get failed to load the ZFS stack error! And after modprobe you can check with 'lsmod' if the 6 modules where loaded.}}

5. Use ZFS as usual. If you type '''zpool status''' and then type `dmesg | tail`,

you should see something that says:

<console>
ZFS: Loaded module v0.6.1-1, ZFS pool version 5000, ZFS filesystem version 5
</console>

If you see the above, then the modules loaded successfully!

Enjoy System Rescue CD with ZFS :)

== Extra ==

=== A more accurate kernel build setup ===
If you want to have a more accurate setup to upstream, you can check out the git repo he has for the target release. Example: [http://sourceforge.net/p/systemrescuecd/code/ci/74e7a9712a019958fbe099386c9fb6bd7813d907/tree/ Upstream Git Repo]

If you navigate to portage-overlay/sys-kernel/std-sources, you can see the ebuild there and the files directory with the patches for the std-sources kernel.

I also keep my own modified ebuilds for when I make my own srms in my overlay:
https://github.com/fearedbliss/funtoo-overlay

You can see the ebuilds in the sys-kernel/std-sources directory.
[[Category:HOWTO]]

ZFS Install Guide

2013-06-09T06:34:23Z

Fearedbliss:

== Introduction ==

This tutorial will show you how to install Funtoo on ZFS (rootfs). This tutorial is meant to be an "overlay" over the [[Funtoo_Linux_Installation|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).

=== Disclaimers ===

{{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 ==

As a companion to the install instructions below, a YouTube video ZFS install tutorial is now available:

{{#widget:YouTube|id=MXyBamArues|width=640|height=360}}

== 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:

# System Rescue CD,
# ZFS System Rescue Module (SRM)

This is just a file that when combined with System Rescue CD, gives you those tools.
<pre>
Name: SystemRescueCd-x86-3.5.0 (390 MiB)
Release Date: 2013-03-25
md5sum 48552b9e905872bd5061eb112b73ea20
</pre>

Funtoo now has mirrored copies of System Rescue CD and the ZFS SRM at the links below.

[http://ftp.osuosl.org/pub/funtoo/distfiles/sysrescuecd/systemrescuecd-x86-3.5.0.iso Download System Rescue CD 3.5.0] 
[http://ftp.osuosl.org/pub/funtoo/distfiles/sysrescuecd/zfs-3.4.37-std350-amd64_0.6.1.tar.xz Download the ZFS System Rescue Module]

[[Creating_System_Rescue_CD_ZFS_Modules|Follow the instructions here to download and place the srm into your flash drive]].

== 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.

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
Command (m for help): ##i##o ↵
Building a new DOS disklabel with disk identifier 0xbeead864.
</console>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

Now that we have a clean drive, we will create the new layout.

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
</console>

'''Create Partition 2''' (ZFS):
<console>
Command: ##i##n ↵
Partition type: ##i##↵
Partition number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵

Command: ##i##t ↵
Partition number: ##i##2 ↵
Hex code: ##i##bf ↵

Command: ##i##p ↵

Device Boot Start End Blocks Id System
/dev/sda1 2048 514047 256000 83 Linux
/dev/sda2 514048 1953525167 976505560 bf Solaris
</console>

==== 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 <tt>/dev/sda</tt> is the target drive. 

<console>
# ##i##gdisk /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>

{{fancywarning|This is a destructive operation. Make sure you really don't want anything on this disk.}}

Now that we have a clean drive, we will create the new layout.

'''Create Partition 1''' (boot):
<console>
Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+250M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (BIOS Boot Partition):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>
{{fancyimportant|Only make the above BIOS Boot Partition if you are using GRUB 2 on GPT. If you are using the extlinux bootloader, this partition is not necessary.}}

'''Create Partition 3''' (ZFS):
<console>Command: ##i##n ↵
Partition Number: ##i##↵
First sector: ##i##↵
Last sector: ##i##↵
Hex Code: ##i##bf00 ↵

Command: ##i##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: ##i##w ↵
</console>

=== Format your boot volume ===
Format your separate /boot partition:
<console># ##i##mkfs.ext2 /dev/sda1</console>

=== Encryption (Optional) ===
If you want encryption, then create your encrypted vault(s) now by doing the following:

<console>
# ##i##cryptsetup -c aes-xts-plain64 luksFormat /dev/sda2
# ##i##cryptsetup luksOpen /dev/sda2 vault_1
</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''.}}
=== 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)
<console># ##i##zpool create -f -o ashift=12 -o cachefile= -O compression=on -m none -R /mnt/funtoo rpool /dev/sda2</console>

{{fancyimportant|If you followed the manual GPT partitioning instructions, you should change '''/dev/sda2 to /dev/sda3'''. If you are using encrypted root, then change '''/dev/sda2 to 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 ===
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.

<console>
Create some empty containers for organization purposes, and make the dataset that will hold /
# ##i##zfs create -o mountpoint=none rpool/ROOT
# ##i##zfs create -o mountpoint=/ rpool/ROOT/funtoo

Optional, but recommended datasets: /home, /root
# ##i##zfs create -o mountpoint=/home rpool/HOME
# ##i##zfs create -o mountpoint=/root rpool/HOME/root

Optional datasets: /usr/src, /var
# ##i##zfs create -o mountpoint=none rpool/FUNTOO
# ##i##zfs create -o mountpoint=/usr/src rpool/FUNTOO/src
# ##i##zfs create -o mountpoint=/var rpool/FUNTOO/var
</console>

==== 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).

Create the datasets:

<console>
# ##i##zfs create -o mountpoint=/usr/portage -o compression=off rpool/FUNTOO/portage
# ##i##zfs create -o mountpoint=/usr/portage/distfiles -o compression=off rpool/FUNTOO/distfiles
</console>

=== 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).'''
<console>
# ##i##zfs create -o sync=always -o primarycache=metadata -o secondarycache=none -o volblocksize=4K -V 9G rpool/swap
</console>

=== Format your swap zvol ===
<console>
# ##i##mkswap -f /dev/zvol/rpool/swap
# ##i##swapon /dev/zvol/rpool/swap
</console>

=== Last minute checks and touches ===
Check to make sure everything appears fine:
<console>
# ##i##zpool status
# ##i##zfs list
</console>

Copy the '''zpool.cache''' file to your new environment.
<console>
# ##i##mkdir -p /mnt/funtoo/etc/zfs
# ##i##cp /etc/zfs/zpool.cache /mnt/funtoo/etc/zfs
</console>

Make an empty mtab file
<console># ##i##touch /mnt/funtoo/etc/mtab</console>

Now we will continue to install funtoo.

== Installing Funtoo ==
[[Funtoo_Linux_Installation|Download and install the Funtoo stage3 and continue installation as normal.]]

Then chroot into your new funtoo environment:
<console>
# ##i##cd /mnt/funtoo

Mount your boot drive
# ##i##mount /dev/sda1 /mnt/funtoo/boot

Bind the kernel related directories
# ##i##mount --rbind /proc proc
# ##i##mount --rbind /dev dev
# ##i##mount --rbind /sys sys

Copy network settings
# ##i##cp /etc/resolv.conf etc/

chroot into your new funtoo environment
# ##i##env -i HOME=/root TERM=$TERM chroot . /bin/bash -l

Sync your tree
# ##i##emerge --sync
</console>

== Kernel Configuration ==
{{fancynote|The below configurations are the requirements for "Bliss Initramfs Creator". Some of these might not be needed for genkernel.}}

Tested with kernels 2.6.32 - 3.9.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)

<pre>- Linux Kernel
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)

Device Drivers --->
> Generic Driver Options --->
>> [*] Maintain a devtmpfs filesystem to mount at /dev
>> [*] Automount devtmpfs at /dev, after the kernel mounted the rootfs

# Only if you want to make an SRM
> File systems --->
>> Miscellaneous filesystems --->
>>> <*> SquashFS 4.0 - Squashed file system support
>>> [*] Squashfs XATTR support
>>> [*] Include support for ZLIB compressed file systems
>>> [*] Include support for LZO compressed file systems
>>> [*] Include support for XZ compressed file systems

* All other drivers required to see your PATA/SATA drives must be compiled in.

- app-arch/cpio
- sys-apps/busybox
- sys-kernel/spl
- sys-fs/zfs
- sys-fs/zfs-kmod

For SRM creation:
- sys-fs/squashfs-tools

For LUKS support:
- sys-fs/cryptsetup

- Linux Kernel
Device Drivers --->
[*] Multiple devices driver support (RAID and LVM) --->
<*> Device mapper support
<*> Crypt target support

Cryptographic API --->
<*> XTS support
-*- AES cipher algorithms
</pre>

Continue and compile/install your kernel:

<console>
# ##i##make bzImage modules
# ##i##make install
# ##i##make modules_install
</console>

== Installing the ZFS userspace tools ==

<console># ##i##emerge -av zfs</console>

Check to make sure that the zfs tools are working, the zpool.cache file that you copied before should be displayed.

<console>
# ##i##zpool status
# ##i##zfs list
</console>

If everything worked, continue.

== Install the bootloader ==

=== 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.

<console># ##i##echo "sys-boot/grub libzfs" >> /etc/portage/package.use</console>

Then we will compile grub2:

<console># ##i##emerge -av grub</console>

Once this is done, 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>

Now try to install grub2:
<console># ##i##grub-install --no-floppy /dev/sda</console>

You should receive the following message
<console>Installation finished. No error reported.</console>

If not, then go back to the above checklist.

=== Extlinux ===
There are four things we need to do for extlinux:

# Install extlinux bootloader
# Write the .bin to the front of the target disk
# Toggle BIOS partition flag
# Write a extlinux configuration file

First emerge extlinux:
<console># ##i##emerge -av syslinux</console>

Then create a /boot/extlinux directory:
<console>
# ##i##cd /boot
# ##i##mkdir /boot/extlinux
</console>

Change into the extlinux dir and install the bootloader:
<console>
# ##i##cd /boot/extlinux
# ##i##extlinux --install .
</console>

==== MBR ====
<console>
# ##i##fdisk /dev/sda

Command: ##i##a ↵
Partition number: ##i##1 ↵
Command: ##i##w ↵
</console>

Printing the <tt>fdisk</tt> partition layout should show a star next to <tt>/dev/sda1</tt>:
<console>/dev/sda * 2048 514047 256000 83 Linux</console>

Flash the .bin to the front of the disk:
<console># ##i##dd conv=notrunc bs=440 count=1 if=/usr/share/syslinux/mbr.bin of=/dev/sda</console>

=== GPT ===
<console># ##i##sgdisk /dev/sda --attributes=1:set:2</console>

Flash the .bin to the front of the disk:
<console># ##i##dd conv=notrunc bs=440 count=1 if=/usr/share/syslinux/gptmbr.bin of=/dev/sda</console>

We will write the extlinux/grub configuration file in the next section.

=== Create a boot symlink ===
We will create a boot symlink so that we can have "consistent" boot configurations without any errors.

<console>
# ##i##cd /boot
# ##i##ln -s . boot
</console>

You should now have a symlink called 'boot' inside /boot that points to /boot :).

== 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.

=== genkernel ===
<console>
# ##i##emerge -av sys-kernel/genkernel
# ##i##genkernel --zfs initramfs
</console>

<pre>
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
</pre>

'''genkernel entries need verification'''
'''grub.cfg''':
<console>
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
}
</console>

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:
<console>
set timeout=3
set default=0

# Funtoo
menuentry "Funtoo - 3.8.5" {
insmod zfs
linux /vmlinuz-3.8.5-ALL real_root=ZFS=rpool/ROOT/funtoo dozfs=force
initrd /initramfs-genkernel-x86_64-3.8.5-ALL
}
</console>

'''extlinux.conf''':
<console>
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
</console>

=== 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":

<console>
# Make the overlays directory if it doesn't exist
# ##i##mkdir /home/example/overlays

# Clone my overlay into this directory
# ##i##git clone git://github.com/fearedbliss/funtoo-overlay.git

# Rename the "funtoo-overlay" folder to "fearedbliss"
# ##i##mv funtoo-overlay fearedbliss

# Add the overlay to your /etc/portage/make.conf so portage knows its existence.
# ##i##echo 'PORTDIR_OVERLAY="/home/example/overlays/fearedbliss ${PORTDIR_OVERLAY}"' >> /etc/portage/make.conf
</console>

Now you can install the creator, but before we do that, if you are encrypting your drives, then add the "luks" use flag to your package.use:

<console>
# ##i##echo "sys-kernel/bliss-initramfs luks" >> /etc/portage/package.use
</console>

Now install the creator:

<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>.img /boot
</console>

'''<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.

<pre>
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)
Encrypted partitions (If any, example: /dev/sda2, /dev/sdb3, /dev/sdc4)
Pool root is: rpool/ROOT/funtoo
</pre>

'''grub.cfg''':
<console>
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
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# linux /boot/vmlinuz-3.8.5-ALL root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
initrd /boot/initrd-3.8.5-ALL.img
}
</console>

'''extlinux.conf:'''
<console>
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
# Let's say you have 3 drives that are encrypted, and your pool (which also contains your root) is on here
# APPEND root=rpool/ROOT/funtoo enc_root=/dev/sda2,/dev/sdb3,/dev/sdc4 quiet
</console>

== Final configuration ==
=== Add the zfs tools to openrc ===
<console># ##i##rc-update add zfs boot</console>

=== Add filesystems to /etc/fstab ===
<console>
# ##i##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
</console>

=== 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.

<console>
Delete the stage3/portage tarballs you downloaded earlier so they don't take up space.
# ##i##cd /
# ##i##rm stage3-latest.tar.xz
# ##i##rm /usr/portage-latest.tar.xz

Set your root password
# ##i##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
# ##i##exit

Unmount all the kernel filesystem stuff and boot (if you have a separate /boot)
# ##i##cd /mnt/funtoo
# ##i##umount -l proc dev sys boot

Turn off the swap
# ##i##swapoff /dev/zvol/rpool/swap

Export the zpool
# ##i##cd /
# ##i##zpool export -f rpool

Reboot
# ##i##reboot
</console>

{{fancyimportant|'''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.

== 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:
<console># ##i##zfs snapshot rpool/ROOT/funtoo@install</console>

To see if your snapshot was taken, type:
<console># ##i##zfs list -t snapshot</console>

If your machine ever fails and you need to get back to this state, just type:
<console># ##i##zfs rollback rpool/ROOT/funtoo@install</console>

[[Category:HOWTO]]
[[Category:Filesystems]]
[[Category:Featured]]

__NOTOC__
__NOTITLE__

Funtoo Linux Installation

2013-06-09T06:31:40Z

Fearedbliss: /* Notes Before We Begin */

== Introduction ==

This document briefly explains all of the steps required to set up a typical Funtoo Linux installation on a "PC compatible" computer system. If you've had previous experience installing Gentoo Linux then a lot of steps will be familiar, but you should still read through as there are a few differences.

=== Additional Resources ===

This document was written to help you install Funtoo Linux as efficiently as possible, with a minimum number of distracting options regarding system configuration.

Those who prefer a longer, more thorough tutorial-style installation may want to check out our beta [[Installation (Tutorial)|Installation Tutorial]] instead. It explores more installation possibilities and options such as encrypted filesystems, and includes screenshots.

If you are installing Funtoo Linux on [[Funtoo Linux Installation on ARM|ARM]] architecture, please see [[Funtoo Linux Installation on ARM]] for notable differences regarding ARM support. An experimental Funtoo Linux build also exists for [[Funtoo Linux Installation on SPARC|SPARC]] platforms. See [[Funtoo Linux Installation on SPARC]]

== Installation Overview ==

This is a basic overview of the Funtoo installation process:

# [[#Live CD|Download and boot the live CD of your choice]].
# [[#Prepare Hard Disk|Prepare your disk]].
# [[#Creating filesystems|Create]] and [[#Mounting filesystems|mount]] filesystems.
# [[#Installing the Stage 3 tarball|Install the Funtoo stage tarball]] of your choice.
# [[#Chroot into Funtoo|Chroot into your new system]].
# [[#Downloading the Portage tree|Download the Portage tree]].
# [[#Configuring your system|Configure your system]] and [[#Configuring your network|network]].
# [[#Configuring and installing the Linux kernel|Install a kernel]].
# [[#Installing a Bootloader|Install a bootloader]].
# [[#Finishing Steps|Complete final steps]].
# [[#Restart your system|Reboot and enjoy]].

=== Live CD ===
Funtoo doesn't provide an "official" Funtoo Live CD, but there are plenty of good ones out there to choose from. A great choice is the Gentoo-based [http://www.sysresccd.org/ SystemRescueCd] as it contains lots of tools and utilities and supports both 32-bit and 64-bit systems.

It is also possible to install Funtoo Linux using many other Linux-based live CDs. Generally, any modern bootable Linux live CD or live USB media will work. See [[Requirements|requirements]] for an overview of what the Live Media must provide to allow a problem-free install of Funtoo Linux.

To begin a Funtoo Linux installation, download SystemRescueCD from:

* Main US mirror: [http://ftp.osuosl.org/pub/funtoo/distfiles/sysrescuecd/systemrescuecd-x86-3.4.2.iso The Oregon State University Open Source Lab]
* Main EU mirror: [http://ftp.heanet.ie/mirrors/funtoo/distfiles/sysrescuecd/systemrescuecd-x86-3.4.2.iso HEAnet] or use your preferred live media. Insert it into your disc drive, and boot from it. If using an older version of SystemRescueCd, '''be sure to select the <tt>rescue64</tt> kernel at the boot menu if you are installing a 64-bit system'''. By default, SystemRescueCd used to boot in 32-bit mode though the latest version attempts to automatically detect 64-bit processors.

=== Prepare Hard Disk ===
==== Partitions ====

Funtoo Linux fully supports traditional MBR partitions, as well as newer GPT/GUID partition formats. Funtoo Linux recommends the use of the GPT partitioning scheme, since it is newer and more flexible. Here are the various trade-offs between each partitioning scheme:

===== GPT Partitions =====

* Newer, preferred format for Linux systems
* Supports 2 TB+ hard drives for booting
* Supports hundreds of partitions per disk of any size
* Requires legacy BIOS boot partition (~32 MB) to be created if system does not use EFI
* Requires bootloader with support for GPT such as GRUB 2, EXTLINUX, or a patched version of GRUB Legacy

===== MBR Partitions =====

* Legacy, DOS partitioning scheme
* Only 4 primary partitions per disk; after that, you must use "logical" partitions
* Does not support 2 TB+ disks for booting
* Compatible with certain problematic systems (such as the HP ProBook 4520)
* Dual-boot with Windows for BIOS systems (Windows handle GPT only on true EFI systems, whatever version it is)
* Multiple boot loader options, e.g. GRUB 2, GRUB Legacy, lilo

{{fancyimportant|If you plan to use partitions of 2 TB or greater, you ''must'' partition using the GPT/GUID format. Also note that there are small percentage of PCs that will not boot properly with GPT. For these systems, using MBR partitions or a primary drive with an MBR partition may be required in order to boot.}}

==== Partitioning Using gdisk ====

===== Notes Before We Begin =====

These install instructions assume you are installing Funtoo Linux to an empty hard disk using GUID partition tables (GPT). If you are installing Funtoo Linux on a machine where another OS is installed, or there is an existing Linux distribution on your system that you want to keep, then you will need to adapt these instructions to suit your needs.

If you are going to create a legacy MBR partition table instead of GUID/GPT, you will use the <tt>fdisk</tt> command instead of <tt>gdisk</tt>, and you will not need to create the GRUB boot loader partition. See the table under [[#Partitioning Recommendations|Partitioning Recommendations]], in particular the
'''MBR Block Device (<tt>fdisk</tt>)''' and '''MBR Code''' columns. <tt>fdisk</tt> works just like <tt>gdisk</tt>, but creates legacy MBR partition tables instead of the newer GPT/GUID partition tables.

Advanced users may be interested in the following topics:

* [[GUID Booting Guide]]
* [[Rootfs over encrypted lvm]]
* [[Rootfs over encrypted lvm over raid-1 on GPT]]
* '''NEW!''' '''[[ZFS Install Guide]] (Also contains instructions for Rootfs over Encrypted ZFS!)'''

===== Using gdisk =====

The first step after booting SystemRescueCd is to use <tt>gdisk</tt> to create GPT (also known as GUID) partitions, specifying the disk you want to use, which is typically <tt>/dev/sda</tt>, the first disk in the system:

<console># ##i##gdisk /dev/sda</console>
You should find <tt>gdisk</tt> very similar to <tt>fdisk</tt>. Here is the partition table we want to end up with:

<console>Command (? for help): ##i##p
Disk /dev/sda: 234441648 sectors, 111.8 GiB
Logical sector size: 512 bytes
Disk identifier (GUID): A4E5208A-CED3-4263-BB25-7147DC426931
Partition table holds up to 128 entries
First usable sector is 34, last usable sector is 234441614
Partitions will be aligned on 2048-sector boundaries
Total free space is 2014 sectors (1007.0 KiB)

Number Start (sector) End (sector) Size Code Name
1 2048 206847 500.0 MiB 8300 Linux filesystem
2 206848 272383 32.0 MiB EF02 BIOS boot partition
3 272384 8660991 4.0 GiB 8200 Linux swap
4 8660992 234441614 107.7 GiB 8300 Linux filesystem

Command (? for help): </console>

Above, you'll see that we have a 500 MiB boot partition, a 32 MiB "BIOS boot partition" (also known as the GRUB boot loader partition), 4 GiB of swap, and the remaining disk used by a 107.7 GiB root partition.

===== For new <tt>gdisk</tt> users =====

These partitions were created using the "<tt>n</tt>" command from within <tt>gdisk</tt>. The <tt>gdisk</tt> commands to create the partition table above are as follows. Adapt sizes as necessary, although these defaults will work for most users. The partition codes entered below can be found in the [[#Partitioning Recommendations|Partitioning Recommendations]] table below, in the GPT Code column.

Within <tt>gdisk</tt>, follow these steps:

'''Create Partition 1''' (boot):

<console>
Command: ##i##n ↵
Partition Number: ##i##1 ↵
First sector: ##i##↵
Last sector: ##i##+500M ↵
Hex Code: ##i##↵
</console>

'''Create Partition 2''' (GRUB):

<console>
Command: ##i##n ↵
Partition Number: ##i##2 ↵
First sector: ##i##↵
Last sector: ##i##+32M ↵
Hex Code: ##i##EF02 ↵
</console>

'''Create Partition 3''' (swap):

<console>
Command: ##i##n ↵
Partition Number: ##i##3 ↵
First sector: ##i##↵
Last sector: ##i##+4G ↵
Hex Code: ##i##8200 ↵
</console>

'''Create Partition 4''' (root):

<console>
Command: ##i##n ↵
Partition Number: ##i##4 ↵
First sector: ##i##↵
Last sector: ##i##↵##!i## (for rest of disk)
Hex Code: ##i##↵
</console>

Along the way, you can type "<tt>p</tt>" and hit Enter to view your current partition table. If you make a mistake, you can type "<tt>d</tt>" to delete an existing partition that you created. When you are satisfied with your partition setup, type "<tt>w</tt>" to write your configuration to disk:

'''Write Partition Table To Disk''':

<console>
Command: ##i##w ↵
Do you want to proceed? (Y/N): ##i##Y ↵
</console>

The partition table will now be written to disk and <tt>gdisk</tt> will close.

Now, your GPT/GUID partitions have been created, and will show up as the following ''block devices'' under Linux:

* <tt>/dev/sda1</tt>, which will be used to hold the <tt>/boot</tt> filesystem,
* <tt>/dev/sda2</tt>, which will be used directly by the new GRUB,
* <tt>/dev/sda3</tt>, which will be used for swap space, and
* <tt>/dev/sda4</tt>, which will hold your root filesystem.

===== For Previous fdisk users =====

If you have installed Gentoo Linux before, the one thing that is likely new to you here is the GRUB boot loader partition, which is listed as "BIOS boot partition" within <tt>gdisk</tt>. This partition is required for GRUB 2 to boot GPT/GUID boot disks. What is it? In GRUB-speak, this partition is essentially the location of the meat of GRUB's boot loading code. If you've used GRUB Legacy in the past, this partition is where the new GRUB stores the equivalent of the <tt>stage1_5</tt> and <tt>stage2</tt> files in legacy GRUB. Since GPT-based partition tables have less dead space at the beginning of the disk than their MBR equivalents, an explicitly defined partition of code <tt>EF02</tt> is required to hold the guts of the boot loader.

In all other respects, the partition table is similar to that which you might create for an MBR-based disk during a Gentoo Linux installation. We have a boot and a root partition with code <tt>0700</tt>, and a Linux swap partition with code <tt>8200</tt>.

===== Partitioning Recommendations =====

Below are our partitioning recommendations in table form. For GPT-based partitions, use the GPT Block Device and GPT Code columns with <tt>gdisk</tt>. For legacy MBR-based partitions, use the MBR Block Device and MBR code columns with <tt>fdisk</tt>:

{| {{table}}
!Partition
!Size
!MBR Block Device (<tt>fdisk</tt>)
!GPT Block Device (<tt>gdisk</tt>)
!Filesystem
!MBR Code
!GPT Code
|-
|<tt>/boot</tt>
|500 MB
|<tt>/dev/sda1</tt>
|<tt>/dev/sda1</tt>
|ext2
|83
|8300
|-
|GRUB boot loader partition
|32 MB
| ''not required for MBR''
|<tt>/dev/sda2</tt>
|For GPT/GUID only, skip for MBR - no filesystem.
|''N/A''
|EF02
|-
|swap
|2x RAM for low-memory systems and production servers; otherwise 2GB.
|<tt>/dev/sda2</tt>
|<tt>/dev/sda3</tt>
|swap (default)
|82
|8200
|-
|<tt>/</tt> (root)
|Rest of the disk, minimum of 10GB.
|<tt>/dev/sda3</tt>
|<tt>/dev/sda4</tt>
|XFS recommended, alternatively ext4
|83
|8300
|-
|<tt>/home</tt> (optional)
|User storage and media. Typically most of the disk.
|<tt>/dev/sda4</tt> (if created)
|<tt>/dev/sda5</tt> (if created)
|XFS recommended, alternatively ext4
|83
|8300
|-
| LVM (optional)
| If you want to create an LVM volume.
| <tt>/dev/sda4</tt> (PV, if created)
| <tt>/dev/sda5</tt> (PV, if created)
| LVM PV
| 8E
| 8E00
|}

==== Creating filesystems ====

Before your newly-created partitions can be used, the block devices need to be initialized with filesystem ''metadata''. This process is known as ''creating a filesystem'' on the block devices. After filesystems are created on the block devices, they can be mounted and used to store files.

You will not create a filesystem on your swap partition, but will initialize it using the <tt>mkswap</tt> command so that it can be used as disk-based virtual memory. Then we'll run the <tt>swapon</tt> command to make your newly-initialized swap space active within the live CD environment, in case it is needed during the rest of the install process.

Note that we will not create a filesystem on the GRUB boot loader partition, as GRUB writes binary data directly to that partition when the boot loader is installed, which we'll do later.

You can see the commands you will need to type below. Like the rest of this document, it assumes that you are using a GPT partitioning scheme. If you are using MBR, your root filesystem will likely be created on <tt>/dev/sda3</tt> instead and you will need to adjust the target block devices. If you are following our recommendations, then simply do this:

<console>
# ##i##mke2fs -t ext2 /dev/sda1
# ##i##mkfs.xfs /dev/sda4
# ##i##mkswap /dev/sda3
# ##i##swapon /dev/sda3
</console>

==== Mounting filesystems ====

Mount the newly-created filesystems as follows, creating <tt>/mnt/funtoo</tt> as the installation mount point:

<console>
# ##i##mkdir /mnt/funtoo
# ##i##mount /dev/sda4 /mnt/funtoo
# ##i##mkdir /mnt/funtoo/boot
# ##i##mount /dev/sda1 /mnt/funtoo/boot
</console>

Optionally, if you have a separate filesystem for <tt>/home</tt> or anything else:

<console>
# ##i##mkdir /mnt/funtoo/home
# ##i##mount /dev/sda5 /mnt/funtoo/home
</console>

If you have <tt>/tmp</tt> or <tt>/var/tmp</tt> on a separate filesystem, be sure to change the permissions of the mount point to be globally-writeable after mounting, as follows:

<console>
# ##i##chmod 1777 /mnt/funtoo/tmp
</console>

=== Installing the Stage 3 tarball ===
==== Stage 3 tarball ====

After creating filesystems, the next step is downloading the initial Stage 3 tarball. The Stage 3 is a pre-compiled system used as a starting point to install Funtoo Linux. Visit the [[Download]] page and copy the URL to the Stage 3 tarball you want to use. We will download it soon.

{{fancyimportant|If your system's date and time are too far off (typically by months or years,) then it may prevent Portage from properly downloading source tarballs. This is because some of our sources are downloaded via HTTPS, which use SSL certificates and are marked with an activation and expiration date.}}

Now is a good time to verify the date and time are correctly set to UTC. Use the <tt>date</tt> command to verify the date and time:

<console>
# ##i##date
Fri Jul 15 19:47:18 UTC 2011
</console>

If the date and/or time need to be corrected, do so using <tt>date MMDDhhmmYYYY</tt>, keeping in mind <tt>hhmm</tt> are in 24-hour format. The example below changes the date and time to "July 16th, 2011 @ 8:00PM" UTC:

<console>
# ##i##date 071620002011
Fri Jul 16 20:00:00 UTC 2011
</console>

Once you are in your Funtoo Linux root filesystem, use <tt>wget</tt> to download the Stage 3 tarball you have chosen from the [[Download]] page to use as the basis for your new Funtoo Linux system. It should be saved to the <tt>/mnt/funtoo</tt> directory as follows:

<console># ##i##cd /mnt/funtoo
# ##i##wget http://ftp.osuosl.org/pub/funtoo/funtoo-current/x86-64bit/generic_64/stage3-latest.tar.xz
</console>

Note that 64-bit systems can run 32-bit or 64-bit stages, but 32-bit systems can only run 32-bit stages. Make sure that you select a Stage 3 build that is appropriate for your CPU. If you are not certain, it is a safe bet to choose the <tt>generic_64</tt> or <tt>generic_32</tt> stage. Consult the [[Download]] page for more information.

Once the stage is downloaded, extract the contents with the following command, substituting in the actual name of your stage 3 tarball:
<console>
# ##i##tar xJpf stage3-latest.tar.xz
</console>

{{fancyimportant|It is very important to use <tt>tar</tt>'s "<tt>p</tt>" option when extracting the Stage 3 tarball - it tells <tt>tar</tt> to ''preserve'' any permissions and ownership that exist within the archive. Without this option, your Funtoo Linux filesystem permissions will be incorrect.}}

=== Chroot into Funtoo ===
Before chrooting into your new system, there's a few things that need to be done first. You will need to mount /proc and /dev inside your new system. Use the following commands:
<console>
# ##i##cd /mnt/funtoo
# ##i##mount --rbind /proc proc
# ##i##mount --rbind /dev dev
</console>

You'll also want to copy over <tt>resolv.conf</tt> in order to have proper DNS name resolution from inside the chroot:
<console>
# ##i##cp /etc/resolv.conf etc
</console>

Now you can chroot into your new system. Use <tt>env</tt> before <tt>chroot</tt> to ensure that no environment variables from the installation media are used by your new system:

<console>
# ##i##env -i HOME=/root TERM=$TERM chroot . bash -l
</console>

{{fancynote|Users of live CDs with 64-bit kernels: Some software may use <tt>uname -r</tt> to check whether the system is 32 or 64-bit. You may want append linux32 to the chroot command as a workaround, but it's generally not needed.}}
{{fancyimportant|If you receive the error "<tt>chroot: failed to run command `/bin/bash': Exec format error</tt>", it is probably because you are running a 32-bit kernel and trying to execute 64-bit code. SystemRescueCd boots with a 32-bit kernel by default.}}

It's also a good idea to change the default command prompt while inside the chroot. This will avoid confusion if you have to change terminals. Use this command:
<console>
# ##i##export PS1="(chroot) $PS1"
</console>

Congratulations! You are now chrooted inside a Funtoo Linux system. Now it's time to get Funtoo Linux properly configured so that Funtoo Linux will boot successfully when your system is restarted.

=== Downloading the Portage tree ===

{{fancynote|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 <tt>emerge --sync</tt> from within the chroot. This will automatically clone the portage tree from [http://github.com/ GitHub]:

<console>
(chroot) # ##i##emerge --sync
</console>

{{fancyimportant|If you receive the error with initial <tt>emerge --sync</tt> due to git protocol restrictions, change <tt>SYNC</tt> variable in <tt>/etc/portage/make.conf</tt>}}
<pre>
SYNC="https://github.com/funtoo/ports-2012.git"
</pre>

=== Configuring your system ===
As is expected from a Linux distribution, Funtoo Linux has its share of configuration files. The one file you are absolutely required to edit in order to ensure that Funtoo Linux boots successfully is <tt>/etc/fstab</tt>. The others are optional. Here are a list of files that you should consider editing:

{| {{table}}
!File
!Do I need to change it?
!Description
|-
|<tt>/etc/fstab</tt>
|'''YES - required'''
|Mount points for all filesystems to be used at boot time. This file must reflect your disk partition setup. We'll guide you through modifying this file below.
|-
|<tt>/etc/localtime</tt>
|''Maybe - recommended''
|Your timezone, which will default to UTC if not set. This should be a symbolic link to something located under /usr/share/zoneinfo (e.g. /usr/share/zoneinfo/America/Montreal)
|-
|<tt>/etc/make.conf /etc/portage/make.conf (new location)</tt>
|''Maybe - recommended''
|Parameters used by gcc (compiler), portage, and make. It's a good idea to set MAKEOPTS. This is covered later in this document.
|-
|<tt>/etc/conf.d/hostname</tt>
|''Maybe - recommended''
|Used to set system hostname. Set to the fully-qualified (with dots) name. Defaults to <tt>localhost</tt> if not set.
|-
|<tt>/etc/hosts</tt>
|''No''
| You no longer need to manually set the hostname in this file. This file is automatically generated by <tt>/etc/init.d/hostname</tt>.
|-
|<tt>/etc/conf.d/keymaps</tt>
|Optional
|Keyboard mapping configuration file (for console pseudo-terminals). Set if you have a non-US keyboard. See [[Funtoo Linux Localization]].
|-
|<tt>/etc/conf.d/hwclock</tt>
|Optional
|How the time of the battery-backed hardware clock of the system is interpreted (UTC or local time). Linux uses the battery-backed hardware clock to initialize the system clock when the system is booted.
|-
|<tt>/etc/conf.d/modules</tt>
|Optional
|Kernel modules to load automatically at system startup. Typically not required. See [[Additional Kernel Resources]] for more info.
|-
|<tt>profiles</tt>
|Optional
|Some useful portage settings that may help speed up intial configuration.
|}

If you're installing an English version of Funtoo Linux, you're in luck as most of the configuration files can be used as-is. If you're installing for another locale, don't worry. We will walk you through the necessary configuration steps on the [[Funtoo Linux Localization]] page, and if needed, there's always plenty of friendly, helpful support. (See [[#Community portal|Community]])

Let's go ahead and see what we have to do. Use <tt>nano -w <name_of_file></tt> to edit files -- the "<tt>-w</tt>" disables word-wrapping, which is handy when editing configuration files. You can copy and paste from the examples.

{{fancywarning|It's important to edit your <tt>/etc/fstab</tt> file before you reboot! You will need to modify both the "fs" and "type" columns to match the settings for your partitions and filesystems that you created with <tt>gdisk</tt> or <tt>fdisk</tt>. Skipping this step may prevent Funtoo Linux from booting successfully.}}

==== /etc/fstab ====

<tt>/etc/fstab</tt> is used by the <tt>mount</tt> command which is ran when your system boots. Statements of this file inform <tt>mount</tt> about partitions to be mounted and how they are mounted. In order for the system to boot properly, you must edit <tt>/etc/fstab</tt> and ensure that it reflects the partition configuration you used earlier:

<console>
(chroot) # ##i##nano -w /etc/fstab
</console>

You can use arrow keys to move around and hit Control-X to exit. If you want to save your changes, type "<tt>Y</tt>" when asked if you want to save the modified buffer, or hit Control-O before closing <tt>nano</tt>. Otherwise your changes will be discarded.

<pre>
# The root filesystem should have a pass number of either 0 or 1.
# All other filesystems should have a pass number of 0 or greater than 1.
#
# NOTE: If your BOOT partition is ReiserFS, add the notail option to opts.
#
# See the manpage fstab(5) for more information.
#
# <fs> <mountpoint> <type> <opts> <dump/pass>

/dev/sda1 /boot ext2 noatime 1 2
/dev/sda3 none swap sw 0 0
/dev/sda4 / xfs noatime 0 1
#/dev/cdrom /mnt/cdrom auto noauto,ro 0 0
</pre>

==== /etc/localtime ====

<tt>/etc/localtime</tt> is used to specify the timezone that your machine is in, and defaults to UTC. If you would like your Funtoo Linux system to use local time, you should replace <tt>/etc/localtime</tt> with a symbolic link to the timezone that you wish to use.

<pre>
(chroot) # ln -sf /usr/share/zoneinfo/America/Montreal /etc/localtime
</pre>

The above sets the timezone to Eastern Time Canada. Go to <tt>/usr/share/zoneinfo</tt> to see which values to use.

==== /etc/make.conf ====

{{fancynote|This file is the symlink to /etc/portage/make.conf, new default location, edit /etc/portage/make.conf.}}

MAKEOPTS can be used to define how many parallel compilations should occur when you compile a package, which can speed up compilation significantly. A rule of thumb is the number of CPUs (or CPU threads) in your system plus one. If for example you have a dual core processor without [[wikipedia:Hyper-threading|hyper-threading]], then you would set MAKEOPTS to 3:

<pre>
MAKEOPTS="-j3"
</pre>

If you are unsure about how many processors/threads you have then use /proc/cpuinfo to help you.
<console>
(chroot) # ##i##grep "processor" /proc/cpuinfo | wc -l
16
</console>

Set MAKEOPTS to this number plus one:

<pre>
MAKEOPTS="-j17"
</pre>

USE flags define what functionality is enabled when packages are built. It is not recommended to add a lot of them during installation; you should wait until you have a working, bootable system before changing your USE flags. A USE flag prefixed with a minus ("<tt>-</tt>") sign tells Portage not to use the flag when compiling. A Funtoo guide to USE flags will be available in the future. For now, you can find out more information about USE flags in the [http://www.gentoo.org/doc/en/handbook/handbook-amd64.xml?part=2&chap=2 Gentoo Handbook].

LINGUAS tells Portage which local language to compile the system and applications in (those who use LINGUAS variable like OpenOffice). It is not usually necessary to set this if you use English. If you want another language such as French (fr) or German (de), set LINGUAS appropriately:

<pre>
LINGUAS="fr"
</pre>

==== /etc/conf.d/hwclock ====
If you dual-boot with Windows, you'll need to edit this file and change '''clock''' to '''local''', because Windows will set your hardware clock to local time every time you boot Windows. Otherwise you normally wouldn't need to edit this file.
<console>
(chroot) # ##i##nano -w /etc/conf.d/hwclock
</console>

==== Localization ====

By default, Funtoo Linux is configured with Unicode (UTF-8) enabled, and for the US English locale and keyboard. If you would like to configure your system to use a non-English locale or keyboard, see [[Funtoo Linux Localization]].

==== Profiles ====

[[Funtoo 1.0 Profile|Funtoo profiles]] are used to define defaults for Portage specific to your needs. There are 4 basic profile types: arch, build, [[Flavors and Mix-ins|flavor, and mix-ins]]:

;arch: typically <tt>x86-32bit</tt> or <tt>x86-64bit</tt>, this defines the processor type and support of your system. This is defined when your stage was built and should not be changed.
;build: defines whether your system is a <tt>current</tt>, <tt>stable</tt> or <tt>experimental</tt> build. <tt>current</tt> systems will have newer packages unmasked than <tt>stable</tt> systems.
;flavor: defines the general type of system, such as <tt>server</tt> or <tt>desktop</tt>, and will set default USE flags appropriate for your needs.
;mix-ins: define various optional settings that you may be interested in enabling.

One arch, build and flavor must be set for each Funtoo Linux system, while mix-ins are optional and you can enable more than one if desired.

Remember that profiles can often be inherited. For example, the <tt>desktop</tt> flavor inherits the <tt>workstation</tt> flavor settings, which in turn inherits the <tt>X</tt> and <tt>audio</tt> mix-ins. You can view this by inspecting the <tt>parent</tt> files defined in each profile, which can be found in <tt>/usr/portage/profiles/funtoo/1.0/linux-gnu</tt>:

<console>
(chroot) # ##i##cd /usr/portage/profiles/funtoo/1.0/linux-gnu/
(chroot) # ##i##ls
arch/ eapi make.defaults package.use/ packages.build use.force
build/ flavor/ mix-ins/ package.use.mask/ parent
(chroot) # ##i##cat flavor/desktop/parent
../workstation
../../mix-ins/print
(chroot) # ##i##cat flavor/workstation/parent
../core
../../mix-ins/X
../../mix-ins/audio
../../mix-ins/dvd
../../mix-ins/media
../../mix-ins/console-extras
(chroot) #
</console>

To view installed profiles:
<console>
(chroot) # ##i##eselect profile list
</console>

To change the profile flavor:
<console>
(chroot) # ##i##eselect profile set-flavor 7
</console>

To add a mix-in:

<console>
(chroot) # ##i##eselect profile add 10
</console>

Remember if you add by string; add a 'gentoo:' to the beginning of the profile name ie:
<console>
(chroot) # ##i## eselect profile add gentoo:funtoo/1.0/linux-gnu/mix-ins/console-extras
</console>

=== Configuring and installing the Linux kernel ===

Now it's time to build and install a Linux kernel, which is the heart of any Funtoo Linux system. In the past, the process of creating a kernel that actually booted your system could be time-consuming and require a great deal of trial and error. Fortunately, Funtoo Linux offers an option to automatically build a kernel for you that will boot nearly all systems.

If you are unfamiliar with how to manually configure your own kernel, or you simply want to get your system up and running quickly, you can emerge <tt>debian-sources</tt> with the <tt>binary</tt> USE flag set, which will automatically build the kernel and an initrd that will boot nearly all Funtoo Linux systems. This kernel is based on a linux-3.2 LTS official debian kernel package and is an easy way to get your system up and running relatively quickly.

Click [http://wiki.debian.org/DebianKernel here] for a list of all architectures the Debian kernel supports.

{{fancyimportant|<tt>debian-sources</tt> with <tt>binary</tt> USE flag requires at least 12GB in /var/tmp}}

<console>
(chroot) # ##i##echo "sys-kernel/debian-sources binary" >> /etc/portage/package.use
(chroot) # ##i##emerge debian-sources
</console>

All done!

{{fancynote|NVIDIA card users: the <tt>binary</tt> USE flag installs the Nouveau drivers which cannot be loaded at the same time as the proprietary drivers, and cannot be unloaded at runtime because of KMS. You need to blacklist it under <tt>/etc/modprobe.d/</tt>.}}

For an overview of other kernel options for Funtoo Linux, see [[Funtoo Linux Kernels]]. Also be sure to see [[:Category:Hardware Compatibility|hardware compatibility]] information. We have compiled a very good reference for [[Dell PowerEdge 11G Servers]] that includes kernel compatibility information as well.

The next step is to configure your boot loader so that your new kernel loads when the system boots.

=== Installing a Bootloader ===

==== Installing Grub ====

The boot loader is responsible for loading the kernel from disk when your computer boots. For new installations, GRUB 2 and Funtoo's boot-update tool should be used as a boot loader. GRUB supports both GPT/GUID and legacy MBR partitioning schemes.

To use this recommended boot method, first emerge <tt>boot-update</tt>. This will also cause <tt>grub-2</tt> to be merged, since it is a dependency of <tt>boot-update</tt>.

<console>
(chroot) # ##i##emerge boot-update
</console>

Then, edit <tt>/etc/boot.conf</tt> and specify "<tt>Funtoo Linux genkernel</tt>" as the <tt>default</tt> setting at the top of the file, replacing <tt>"Funtoo Linux"</tt>.

<tt>/etc/boot.conf</tt> should now look like this:

<pre>
boot {
generate grub
default "Funtoo Linux genkernel"
timeout 3
}

"Funtoo Linux" {
kernel bzImage[-v]
# params += nomodeset
}

"Funtoo Linux genkernel" {
kernel kernel[-v]
initrd initramfs[-v]
params += real_root=auto
# params += nomodeset
}
</pre>

Please read <tt>man boot.conf</tt> for further details.

===== Running grub-install and boot-update =====

Finally, we will need to actually install the GRUB boot loader to your disk, and also run <tt>boot-update</tt> which will generate your boot loader configuration file:

<console>
(chroot) # ##i##grub-install --no-floppy /dev/sda
(chroot) # ##i##boot-update
</console>

You only need to run <tt>grub-install</tt> when you first install Funtoo Linux, but you need to re-run <tt>boot-update</tt> every time you modify your <tt>/etc/boot.conf</tt> file, so your changes are applied on next boot.

OK - your system should be ready to boot! Well, there are a few more loose ends...

==== Installing Syslinux/Extlinux ====

An alternate Bootloader is Extlinux, for installing it see the [[Extlinux|extlinux Guide]].

=== Configuring your network ===

It's important to ensure that you will be able to connect to your local-area network after you reboot into Funtoo Linux. There are three approaches you can use for configuring your network: NetworkManager, dhcpcd, and the [[Funtoo Linux Networking]] scripts. Here's how to choose which one to use based on the type of network you want to set up.

==== Wi-Fi ====

For laptop/mobile systems where you will be using Wi-Fi and connecting to various networks, NetworkManager is strongly recommended. The Funtoo version of NetworkManager is fully functional even from the command-line, so you can use it even without X or without the Network Manager applet. Here are the steps involved in setting up NetworkManager:

<console>
# ##i##emerge linux-firmware
# ##i##emerge networkmanager
# ##i##rc-update add NetworkManager default
</console>

Above, we installed linux-firmware which contains a complete collection of available firmware for many hardware devices including Wi-Fi adapters, plus NetworkManager to manage our network connection. Then we added NetworkManager to the <tt>default</tt> runlevel so it will start when Funtoo Linux boots.

After you reboot into Funtoo Linux, you will be able to add a Wi-Fi connection this way:

<console>
# ##i##addwifi -S wpa -K 'wifipassword' mywifinetwork
</console>

The <tt>addwifi</tt> command is used to configure and connect to a WPA/WPA2 Wi-Fi network named <tt>mywifinetwork</tt> with the password <tt>wifipassword</tt>. This network configuration entry is stored in <tt>/etc/NetworkManager/system-connections</tt> so that it will be remembered in the future. You should only need to enter this command once for each Wi-Fi network you connect to.

==== Desktop (Wired Ethernet) ====

For a home desktop or workstation with wired Ethernet that will use DHCP, the simplest and most effective option to enable network connectivity is to simply add <tt>dhcpcd</tt> to the default runlevel:

<console>
# ##i##rc-update add dhcpcd default
</console>

When you reboot, <tt>dhcpcd</tt> will run in the background and manage all network interfaces and use DHCP to acquire network addresses from a DHCP server.

==== Server (Static IP) ====

For servers, the [[Funtoo Linux Networking]] scripts are recommended. They are optimized for static configurations and things like virtual ethernet bridging for virtualization setups. See [[Funtoo Linux Networking]] for information on how to use Funtoo Linux's template-based network configuration system.

=== Finishing Steps ===

==== Set your root password ====
It's imperative that you set your root password before rebooting so that you can log in.
<console>
(chroot) # ##i##passwd
</console>

===Restart your system ===

Now is the time to leave chroot, to unmount Funtoo Linux partitions and files and to restart your computer. When you restart, the GRUB boot loader will start, load the Linux kernel and initramfs, and your system will begin booting.

Leave the chroot, change directory to /, unmount your Funtoo partitions, and reboot.
<console>
(chroot) # ##i##exit
# ##i##cd /
# ##i##umount /mnt/funtoo/boot /mnt/funtoo/dev /mnt/funtoo/proc /mnt/funtoo
# ##i##reboot
</console>

You should now see your system reboot, the GRUB boot loader appear for a few seconds, and then see the Linux kernel and initramfs loading. After this, you should see Funtoo Linux itself start to boot, and you should be greeted with a <tt>login:</tt> prompt. Funtoo Linux has been successfully installed!

===Next Steps===

To learn how to customize and start using Funtoo Linux, see [[Funtoo Linux First Steps]].

If your system did not boot correctly, see [[Installation Troubleshooting]] for steps you can take to resolve the problem.

[[Category:HOWTO]]
[[Category:Install]]