README.md
1DESCRIPTION
2 These script were written with the primary intention of being portable and
3 usable on as many systems as possible.
4
5 This is, in practice, usually not possible. But the intention is there.
6 And it is a good one.
7
8 They have been tested successfully on:
9
10 * Debian GNU/Linux Wheezy
11 * Debian GNU/Linux Jessie
12 * Ubuntu Trusty
13 * CentOS 6.0
14 * CentOS 6.6
15 * Gentoo
16
17SUPPORT
18 If you find that they don't work for your platform, please report this
19 at the OpenZFS issue tracker at https://github.com/openzfs/zfs/issues.
20
21 Please include:
22
23 * Distribution name
24 * Distribution version
25 * Where to find an install CD image
26 * Architecture
27
28 If you have code to share that fixes the problem, that is much better.
29 But please remember to try your best keep portability in mind. If you
30 suspect that what you're writing/modifying won't work on anything else
31 than your distribution, please make sure to put that code in appropriate
32 if/else/fi code.
33
34 It currently MUST be bash (or fully compatible) for this to work.
35
36 If you're making your own distribution and you want the scripts to
37 work on that, the biggest problem you'll (probably) have is the part
38 at the beginning of the "zfs-functions" file which sets up the
39 logging output.
40
41INSTALLING INIT SCRIPT LINKS
42 To setup the init script links in /etc/rc?.d manually on a Debian GNU/Linux
43 (or derived) system, run the following commands (the order is important!):
44
45 update-rc.d zfs-import start 07 S . stop 07 0 1 6 .
46 update-rc.d zfs-mount start 02 2 3 4 5 . stop 06 0 1 6 .
47 update-rc.d zfs-zed start 07 2 3 4 5 . stop 08 0 1 6 .
48 update-rc.d zfs-share start 27 2 3 4 5 . stop 05 0 1 6 .
49
50 To do the same on RedHat, Fedora and/or CentOS:
51
52 chkconfig zfs-import
53 chkconfig zfs-mount
54 chkconfig zfs-zed
55 chkconfig zfs-share
56
57 On Gentoo:
58
59 rc-update add zfs-import boot
60 rc-update add zfs-mount boot
61 rc-update add zfs-zed default
62 rc-update add zfs-share default
63
64 The idea here is to make sure all of the ZFS filesystems, including possibly
65 separate datasets like /var, are mounted before anything else is started.
66
67 Then, ZED, which depends on /var, can be started. It will consume and act
68 on events that occurred before it started. ZED may also play a role in
69 sharing filesystems in the future, so it is important to start before the
70 'share' service.
71
72 Finally, we share filesystems configured with the share\* property.
73