summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorerdgeist <erdgeist@erdgeist.org>2006-02-08 11:13:58 +0000
committererdgeist <erdgeist@erdgeist.org>2006-02-08 11:13:58 +0000
commit0e2bb6a9ec73da8ef90e8e7cce2bff8ce0f135e2 (patch)
tree5afe1edfc0ef36dfa42b5f0cdbbfa97ad507ee9a
parentbe3bfa65bead5c5cf7c540c876240b2b11285b85 (diff)
Tightening up documentation.
-rwxr-xr-xman1/ezjail-admin.188
-rwxr-xr-xman5/ezjail.57
-rwxr-xr-xman5/ezjail.conf.52
3 files changed, 48 insertions, 49 deletions
diff --git a/man1/ezjail-admin.1 b/man1/ezjail-admin.1
index 85a8ed8..aaa40d2 100755
--- a/man1/ezjail-admin.1
+++ b/man1/ezjail-admin.1
@@ -24,38 +24,38 @@ The
24tool is used to manage jails inside the ezjail scope. It is not used 24tool is used to manage jails inside the ezjail scope. It is not used
25to start or stop ezjails jails. Refer to ezjail(5) for more details. 25to start or stop ezjails jails. Refer to ezjail(5) for more details.
26.SH ezjail-admin create 26.SH ezjail-admin create
27makes a copy of the ezjail template jail to the standard jail directory, 27copies the template jail to the root of a new jail, whose name and IP
28using either the name specified with the -r option or a name derived from 28address are provided as mandatory parameters.
29the given hostname. 29
30 30If no jail root is specified via the -r option, it is derived from
31If the jailroot does not start with a /, it is 31the jails name. In this case or, if a jail root is given and does not
32interpreted relative to ezjails root dir (default: /usr/jails). If the 32start with a '/', it is interpreted relative to ezjails root dir
33given jailroot lies outside ezjails root dir, a soft link is created 33(default:
34inside ezjails root dir pointing to the newly created jails location. 34.I /usr/jails
35 35). If a specified jail root lies outside ezjail root dir, a soft link
36If the -x (jail exists) option is given, 36is created inside this root dir pointing to the newly created jails
37.B the first step is skipped (an existing jail is used) 37location.
38useful in situations where you just want to alter some of a jail properties and 38
39called ezjail-admin delete without the -w option before. However, sanity 39The -x (jail exists) option indicates, that an ezjail already exists
40checks are being performed. 40at the jail root.
41 41.B In this case nothing is copied. ezjail only updates its config.
42It then creates an entry in its 42This is useful in situations where you just want to alter some of a
43.I EZJAIL_PREFIX/etc/ezjail/ 43jail properties and called ezjail-admin delete without the -w option
44resource directory allowing the jail to be brought up after next reboot. 44before. However, sanity checks are being performed.
45 45
46If the ezjail_mount_enable option is set, a 46The script creates an entry in its config and a
47.I /etc/fstab.hostname 47.I /etc/fstab.hostname
48is generated, allowing the basejail to be auto-mounted when the jail starts 48file allowing the jail to be brought up after next reboot (or) via
49up. 49the EZJAIL_PREFIX/etc/rc.d/ezjail.sh script.
50 50
51The newly created Jail can perform some initializiation actions, if the 51The newly created jail can perform some initializiation actions, if the
52-f 52-f
53.I flavour 53.I flavour
54option is given, where 54option is given, where
55.I flavour 55.I flavour
56is a directory directory tree under ezjails root dir (default: 56is a directory tree under ezjails root dir (default:
57.I /usr/jails/flavours). 57.I /usr/jails/flavours
58See section 58). See section
59.B FLAVOURS 59.B FLAVOURS
60below for more details. 60below for more details.
61 61
@@ -63,29 +63,26 @@ Options for newly created jails are read from
63.B ezjail.conf, 63.B ezjail.conf,
64refer to ezjail.conf(5) for more information. 64refer to ezjail.conf(5) for more information.
65.SH ezjail-admin delete 65.SH ezjail-admin delete
66removes a jail from ezjails 66removes a jail from ezjails config and the corresponding
67.I EZJAIL_PREFIX/etc/ezjail/
68resource directory thus preventing
69it from being brought up on next reboot.
70
71It then removes the
72.I /etc/fstab.hostname 67.I /etc/fstab.hostname
73entry, if it exists. 68file, thus preventing the jail from being brought
69up on next reboot.
74 70
75If the -w (wipe) option is given, the directory pointed to by the jail 71If the -w (wipe) option is given, the directory pointed to by the jail
76root entry is removed as well as the soft link in ezjails root dir. 72root entry is removed as well as the soft link in ezjails root dir.
77.SH ezjail-admin list 73.SH ezjail-admin list
78lists all jails inside ezjails scope, together with some information on 74lists all jails inside ezjails scope, together with some information on
79them. 75them.
80.SH ezjail-admin update 76.SH ezjail-admin update
81is used to create or update ezjails basejail. Depending on the parameters 77creates or update ezjails basejail. Depending on the parameters
82given it will install a FreeBSD system from a source tree whose location 78given it will install a FreeBSD system from a source tree whose location
83is either provided in the 79is either provided in the
84.B ezjail.conf 80.B ezjail.conf
85config file or via the -s option. 81config file or via the -s option.
86 82
87If the -p or -P options are given, the base jail is given a copy of FreeBSDs 83If the -p or -P options are given, the base jail also is given a copy of
88ports tree, which is in turn linked into all newly created ezjails. 84FreeBSDs ports tree, which is in turn linked into all newly created
85ezjails.
89 86
90If the -P option is given, 87If the -P option is given,
91.B only the ports tree will be checked out/updated, 88.B only the ports tree will be checked out/updated,
@@ -116,7 +113,7 @@ When a ports tree exists in base jail, a make.conf containing reasonable
116values for having ports in jails is created in the template jail. 113values for having ports in jails is created in the template jail.
117.SH FLAVOURS 114.SH FLAVOURS
118.B ezjail-admin 115.B ezjail-admin
119provides an easy way to create many Jails with similar or identical 116provides an easy way to create many jails with similar or identical
120properties. Currently it supports creating users, installing files and 117properties. Currently it supports creating users, installing files and
121installing packages. 118installing packages.
122 119
@@ -125,7 +122,7 @@ A sample flavour config directory resides under
125Some typical Jail initialization actions are demonstrated and you are 122Some typical Jail initialization actions are demonstrated and you are
126encouraged to use it as a template for your flavours. 123encouraged to use it as a template for your flavours.
127 124
128If a flavour is selected on Jail creation, the flavour root is being 125If a flavour is selected on jail creation, the flavour root is being
129copied to the new Jails root, mostly containing an 126copied to the new Jails root, mostly containing an
130.I /ezjail.flavour . 127.I /ezjail.flavour .
131If the Jail starts up for the first time it runs a setup script found 128If the Jail starts up for the first time it runs a setup script found
@@ -133,11 +130,11 @@ at
133.I /etc/rc.d/ezjail-config.sh. 130.I /etc/rc.d/ezjail-config.sh.
134 131
135This script will create some users specified in the flavour config. 132This script will create some users specified in the flavour config.
136It will then chown files specified in the flavour config. (This is to allow 133It will then chown files specified in the flavour config. (This allows
137giving file to users that didn't exist on Jail creation time.) All 134chown-ing files to users only created by the config script.) All
138packages residing under 135packages residing under
139.I /pkg 136.I /pkg
140will be installed. Finally the script 137will be pkg_install-ed. Finally the script
141.I /ezjail.postinstall 138.I /ezjail.postinstall
142is being sourced, if it exists. 139is being sourced, if it exists.
143 140
@@ -156,8 +153,11 @@ ezjail-admin delete ns.test.org
156.br 153.br
157ezjail-admin create -x -r /jails/ns ns.test.org 10.0.2.1 154ezjail-admin create -x -r /jails/ns ns.test.org 10.0.2.1
158.SH BUGS 155.SH BUGS
159.B ezjail-admin 156Due to the way ezjail handles jail config files it is not possible to
160does not perform paranoid checks on its variables. 157create multiple jails if their names are identical when piped through
158.B tr -C [:alnum:] _
159
160Sure to be others.
161.SH FILES 161.SH FILES
162.T4 162.T4
163EZJAIL_PREFIX/etc/ezjail.conf 163EZJAIL_PREFIX/etc/ezjail.conf
diff --git a/man5/ezjail.5 b/man5/ezjail.5
index 1f84ffa..27fdade 100755
--- a/man5/ezjail.5
+++ b/man5/ezjail.5
@@ -26,11 +26,10 @@ and
26.I stop. 26.I stop.
27It may be passed an additional list of jails. If no jail name is 27It may be passed an additional list of jails. If no jail name is
28specified (usually when the script is being called by rc.local at boot 28specified (usually when the script is being called by rc.local at boot
29and shutdown time), all jails in ezjails config directory are being 29and shutdown time), all jails in ezjails scope are being started/stopped.
30started/stopped.
31 30
32The script then examines its config directory, sets config variables 31The script examines its config, sets variables for each jail in the
33for each jail in the jail_list before passing its command on to the 32jail_list before passing its command on to the
34.B /etc/rc.d/jail 33.B /etc/rc.d/jail
35script. 34script.
36.SH NOTES 35.SH NOTES
diff --git a/man5/ezjail.conf.5 b/man5/ezjail.conf.5
index c7f10f6..8a04177 100755
--- a/man5/ezjail.conf.5
+++ b/man5/ezjail.conf.5
@@ -44,7 +44,7 @@ utility. Be careful about disabling ezjail_mount_enable. (Refer to
44for more information). 44for more information).
45.TP 45.TP
46.B ezjail_mount_enable (bool) 46.B ezjail_mount_enable (bool)
47Controls, wheter /etc/fstab.JAILNAME should be executed at jail startup 47Controls, wheter /etc/fstab.hostname should be executed at jail startup
48time. 48time.
49.br 49.br
50.I default: "YES" 50.I default: "YES"