xref: /freebsd/sys/contrib/openzfs/etc/init.d/README.md (revision 59c8e88e72633afbc47a4ace0d2170d00d51f7dc)
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-load-key start 02 2 3 4 5 . stop 06 0 1 6 .
47    update-rc.d zfs-mount    start 02 S       . stop 06 0 1 6 .
48    update-rc.d zfs-zed      start 07 2 3 4 5 . stop 08 0 1 6 .
49    update-rc.d zfs-share    start 27 2 3 4 5 . stop 05 0 1 6 .
50
51  To do the same on RedHat, Fedora and/or CentOS:
52
53    chkconfig zfs-import
54    chkconfig zfs-load-key
55    chkconfig zfs-mount
56    chkconfig zfs-zed
57    chkconfig zfs-share
58
59  On Gentoo:
60
61    rc-update add zfs-import boot
62    rc-update add zfs-load-key boot
63    rc-update add zfs-mount boot
64    rc-update add zfs-zed default
65    rc-update add zfs-share default
66
67  The idea here is to make sure all of the ZFS filesystems, including possibly
68  separate datasets like /var, are mounted before anything else is started.
69
70  Then, ZED, which depends on /var, can be started.  It will consume and act
71  on events that occurred before it started.  ZED may also play a role in
72  sharing filesystems in the future, so it is important to start before the
73  'share' service.
74
75  Finally, we share filesystems configured with the share\* property.
76