mirror of
https://github.com/openzfs/zfs.git
synced 2025-10-01 11:26:49 +00:00
84c7c5fb58
Updated README to reflect the current state of the project and to be less developer focused. It now simply includes basic build instructions for packages and little example of some of the cool things you can do. Also remove the out of data TODO file. This sort of thing can and be tracked on the GitHub issue tracker.
96 lines
3.4 KiB
Plaintext
96 lines
3.4 KiB
Plaintext
============================ ZFS QUICK START ============================
|
|
|
|
1) Build the SPL (Solaris Porting Layer) and install it. This package
|
|
provides several Solaris APIs used by ZFS and is a required dependency.
|
|
Before building ZFS build this package and install the resulting rpms.
|
|
|
|
> tar -xzf spl-x.y.z.tgz
|
|
> cd spl-x.y.z
|
|
> ./configure --with-linux=<kernel src>
|
|
> make
|
|
> make rpm
|
|
|
|
> sudo rpm -Uvh *.<arch>.rpm
|
|
Preparing... ########################################### [100%]
|
|
1:spl ########################################### [ 33%]
|
|
2:spl-modules-devel ########################################### [ 67%]
|
|
3:spl-modules ########################################### [100%]
|
|
|
|
|
|
2) Build ZFS and install it. This package provides the native port of
|
|
ZFS for Linux including all kernel modules and command line utilities.
|
|
Note it is important that you have installed spl-module-devel package
|
|
from step 1) before attempting to build ZFS.
|
|
|
|
> tar -xzf zfs-x.y.z.tgz
|
|
> cd zfs-x.y.z
|
|
> ./configure --with-linux=<kernel src>
|
|
> make
|
|
> make rpm
|
|
|
|
> sudo rpm -Uvh *.<arch>.rpm
|
|
Preparing... ########################################### [100%]
|
|
1:zfs ########################################### [ 20%]
|
|
2:zfs-test ########################################### [ 40%]
|
|
3:zfs-modules-devel ########################################### [ 60%]
|
|
4:zfs-modules ########################################### [ 80%]
|
|
|
|
|
|
3) Enjoy ZFS on Linux! Currently only the ZVOL is fully functional
|
|
but work on the ZPL is underway. Why is just having the ZVOL still
|
|
useful you ask? Well here's an example of what you can do today using
|
|
just the ZVOL:
|
|
|
|
> # Create the 'tank' zpool containing a raidz vdev spread over 4 devices.
|
|
> zpool create tank raidz /dev/sdb /dev/sdc /dev/sdd /dev/sde
|
|
> zpool list
|
|
NAME SIZE USED AVAIL CAP HEALTH ALTROOT
|
|
tank 1.81T 132K 1.81T 0% ONLINE -
|
|
|
|
> # Create a 100G block device named 'fish' in the 'tank' zpool.
|
|
> zfs create -V 100G tank/fish
|
|
> zfs list
|
|
NAME USED AVAIL REFER MOUNTPOINT
|
|
tank 100G 1.24T 26.9K /tank
|
|
tank/fish 100G 1.33T 23.9K -
|
|
|
|
> # Partition 'tank/fish' as if it were a normal block device.
|
|
> sfdisk /dev/tank/fish << EOF
|
|
0,
|
|
EOF
|
|
> sfdisk -l /dev/tank/fish
|
|
|
|
Disk /dev/tank/fish: 208050 cylinders, 16 heads, 63 sectors/track
|
|
Units = cylinders of 516096 bytes, blocks of 1024 bytes, counting from 0
|
|
|
|
Device Boot Start End #cyls #blocks Id System
|
|
/dev/tank/fish1 0+ 208049 208050- 104857199+ 83 Linux
|
|
/dev/tank/fish2 0 - 0 0 0 Empty
|
|
/dev/tank/fish3 0 - 0 0 0 Empty
|
|
/dev/tank/fish4 0 - 0 0 0 Empty
|
|
|
|
> # Format the new /dev/tank/fish1 partition with ext2 and mount it.
|
|
> mkfs.ext2 -q /dev/tank/fish1
|
|
> mkdir -p /mnt/tank/fish1
|
|
> mount /dev/tank/fish1 /mnt/tank/fish1
|
|
> ls /mnt/tank/fish1
|
|
lost+found
|
|
|
|
> # Take a snapshot of the pristine ext2 filesystem and mount it read-only.
|
|
> zfs snapshot tank/fish@pristine
|
|
> mkdir /mnt/tank/fish@pristine1
|
|
> mount /dev/tank/fish@pristine1 /mnt/tank/fish@pristine1
|
|
> ls /mnt/tank/fish\@pristine1
|
|
lost+found
|
|
|
|
> # Changes made to tank/fish1 do not appear in tank/fish@pristine1
|
|
> touch /mnt/tank/fish1/foo
|
|
> ls /mnt/tank/fish1/
|
|
foo lost+found
|
|
> ls /mnt/tank/fish\@pristine1
|
|
lost+found
|
|
|
|
|
|
Enjoy,
|
|
Brian Behlendorf <behlendorf1@llnl.gov>
|