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