2 <!DOCTYPE cfgdirdoc SYSTEM "configuration.dtd" [
3 <!ENTITY init-scriptlet-params
5 <param id='vserver-dir'>
6 <description>The configuration directory of the current vserver</description>
8 <param id='vserver-name'>
9 <description>The name of the current vserver</description>
12 <description>The fixed value of the current action (e.g. 'prepre-start', 'post-stop', ...).</description>
15 <!ENTITY init-script-text "The scriptlet">
16 <!ENTITY init-dir-text "A directory with scriptlets">
17 <!ENTITY init-dir-script-text "A scriptlet">
19 <!ENTITY init-prepre-start "which will be executed before the network-interfaces are enabled
20 and the directories are mounted.">
21 <!ENTITY init-pre-start "which will be executed after network-interfaces were enabled and
22 the directories mounted, but before the vserver itself has been
24 <!ENTITY init-post-start "which will be executed after the vserver has been started.">
25 <!ENTITY init-pre-stop "which will be executed before the vserver will be stopped.">
26 <!ENTITY init-post-stop "which will be executed after the vserver has been stopped, but
27 before the directories will be umounted and the the interfaces
29 <!ENTITY init-postpost-stop "which will be executed after the vserver has been stopped
34 <topleveldir type="confdir">
35 <description>The base configuration directory.</description>
37 <dir name=".defaults" type="fixed" optional="yes">
38 <dir name="init" type="fixed">
40 <description>Default mtab-file</description>
44 <symlink name="vdirbase">
45 <description></description>
46 <default>/vservers</default>
49 <dir name="apps" type="fixed">
50 <dir name="pkgmgmt" type="fixed">
52 <description></description>
53 <default>/vservers/.pkg</default>
56 <file name="apt.conf">
57 <description>The default apt.conf which is going to be used. It is overridden by
58 distribution specific configuration file.</description>
62 <dir name="debootstrap" type="fixed">
64 <description>The Debian mirror which is used for 'debootstrap'.</description>
68 <description>When the 'debootstrap' package is not installed; fetch it from this uri and
69 install it at a temporary place.</description>
73 <dir name="vprocunhide" type="fixed">
75 <description>A list of files which will be made visibly by vprocunhide. Wildcards are
76 allowed and anything ending in '/' will be processed recursively. When this file exists,
77 it overrides the defaults in SYSDEFAULTDIR/vprocunhide-files.</description>
81 <dir name="init" type="fixed">
83 <description>A symlink to the TTY device where input/output will be redirected from/to
84 at startup via initscript.</description>
88 <dir name="vunify" type="fixed">
90 <description>Static list of excluded files.</description>
96 <dir name=".distributions" type="fixed" optional="yes">
97 <dir name="dist" type="symbolic">
99 <description></description>
102 <file name="apt.conf">
103 <description>The default apt.conf which is going to be used. It overrides the apt.conf
104 from CONFDIR/.defaults/apps/pkgmgmt.</description>
107 <script name="initpre">
108 <description>Script which will be executed before packages will be installed.</description>
111 <description>The configuration directory of the vserver which is going to be set
116 <description>The pathname of the vserver binary.</description>
121 <script name="initpost">
122 <description>Script which will be executed after packages are installed.</description>
125 <description>The configuration directory of the vserver which is going to be set
130 <description>The pathname of the vserver binary.</description>
135 <dir name="pkgs" type="fixed">
136 <description>Contains files with packages.</description>
137 <file name="list" type="symbolic">
138 <description>File which contains the name of packages. On top of file the special
139 keywords '--reinstall' and '--can-fail' are possible.</description>
143 <dir name="pubkeys" type="fixed">
144 <description>Directory with GPG pubkeys which are used to sign the packages of this
145 distribution.</description>
148 <dir name="apt" type="fixed">
149 <description>Default content of the /etc/apt/ directory.</description>
152 <dir name="rpm" type="fixed">
153 <description>Default content of the /etc/rpm directory.</description>
156 <symlink name="rpmlib">
157 <description>Directory which overrides /usr/lib/rpm.</description>
160 <symlink name="execdir">
161 <description>Directory with all executables and libraries which are required for this
162 distribution.</description>
165 </dir> <!-- .distributions -->
167 <dir name="vserver-name" type="symbolic">
168 <description>The configuration directory for the vserver vserver-name.</description>
170 <file name="hostname">
171 <description>Contains the hostname of the vserver.</description>
175 <description>Contains the name of the vserver. When not given, the basename of the directory
176 will be assumed as this name.</description>
179 <file name="domainname">
180 <description>The domainname of the vserver.</description>
184 <description>The nice-level on which the vserver will be started.</description>
187 <file name="capabilities">
188 <description>Contains per line a capability.</description>
192 <description>Contains the pathname of the shell which will be used by the "vserver ... enter"
193 command.</description>
197 <description>Contains per line a flag.</description>
200 <file name="context">
201 <description>Contains the context which shall be used for the vserver.</description>
205 <description>The fstab file for the vserver.</description>
208 <dir name="apps" type="fixed">
209 <dir name="init" type="fixed">
211 <description>The initial-mtab which will be used for the vserver.</description>
215 <description>Contains the init-style; possible values are 'sysv', 'plain' and
216 'minit'.</description>
219 <file name="runlevel">
220 <description>The start runlevel.</description>
223 <file name="runlevel.start">
224 <description>The start runlevel.</description>
227 <file name="runlevel.stop">
228 <description>The stop runlevel.</description>
231 <file name="killseq">
232 <description>Contains the 'signal [wait signal]*' sequence which is used to stop the
233 vserver.</description>
236 <file name="cmd.start">
237 <description>The command which is used to start the vserver. Each option must be on a
238 separate line.</description>
241 <file name="cmd.start-sync">
242 <description>The command which is used to wait on the vserver after it has been
243 started. Each option must be on a separate line. This file will be ignored when the
244 'sync' does not exist and the '--sync' option was not used.</description>
247 <file name="cmd.stop">
248 <description>The command which is used to stop the vserver. Each option must be on a
249 separate line.</description>
252 <file name="cmd.stop-sync">
253 <description>The command which is used to wait on the vserver after it has been
254 stopped. Each option must be on a separate line. This file will be ignored when the
255 'sync' does not exist and the '--sync' option was not used.</description>
258 <file name="cmd.prepare">
259 <description>The command which is used to setup the init-system (e.g. to set the runlevel
260 in the utmp-file). Each option must be on a separate line.</description>
264 <description>Without this file, the 'cmd.*-sync' files will be ignored.</description>
268 <description>A symlink to the TTY device where input/output will be redirected from/to
269 at startup via initscript.</description>
271 </dir> <!-- ...apps/init -->
273 <dir name="vunify" type="fixed">
274 <description>This directory contains configuration data required for vserver
275 unification.</description>
277 <file name="exclude">
278 <description>Static list of excluded files. This list supports an rsync syntax: when a
279 file is prefixed by '+', it is a candidate for unification; when there is no prefix or a
280 '-' it will be excluded. Shell-wildcards are allowed for the filenames.</description>
283 <symlink name="refserver.X">
284 <description>These are symlinks to the configuration directory
285 (e.g. CONFDIR/vservers/<idgt;) of a refserver. There may be multiple such symlinks
286 but they must be prefixed by 'refserver.' and will be processed in alphanumerical
292 <dir name="scripts" type="fixed">
293 <script name="prepre-start">
294 <description>&init-script-text; &init-prepre-start;</description>
295 &init-scriptlet-params;
297 <dir name="prepre-start.d" type="fixed">
298 <description>&init-dir-text; &init-prepre-start;</description>
300 <script name="script">
301 <description>&init-dir-script-text; &init-prepre-start;</description>
302 &init-scriptlet-params;
306 <script name="pre-start">
307 <description>&init-script-text; &init-pre-start;</description>
308 &init-scriptlet-params;
311 <dir name="pre-start.d">
312 <description>&init-dir-text; &init-pre-start;</description>
314 <script name="script">
315 <description>&init-dir-script-text; &init-pre-start;</description>
316 &init-scriptlet-params;
320 <script name="post-start">
321 <description>&init-script-text; &init-post-start;</description>
322 &init-scriptlet-params;
325 <dir name="post-start.d">
326 <description>&init-dir-text; &init-post-start;</description>
328 <script name="script">
329 <description>&init-dir-script-text; &init-post-start;</description>
330 &init-scriptlet-params;
334 <script name="pre-stop">
335 <description>&init-script-text; &init-pre-stop;</description>
336 &init-scriptlet-params;
339 <dir name="pre-stop.d" type="fixed">
340 <description>&init-dir-text; &init-pre-stop;</description>
341 <script name="script">
342 <description>&init-dir-script-text; &init-pre-stop;</description>
343 &init-scriptlet-params;
347 <script name="post-stop">
348 <description>&init-script-text; &init-post-stop;</description>
349 &init-scriptlet-params;
352 <dir name="post-stop.d" type="fixed">
353 <description>&init-dir-text; &init-post-stop;</description>
354 <script name="script">
355 <description>&init-dir-script-text; &init-post-stop;</description>
356 &init-scriptlet-params;
360 <script name="postpost-stop">
361 <description>&init-script-text; &init-postpost-stop;</description>
362 &init-scriptlet-params;
365 <dir name="postpost-stop.d" type="fixed">
366 <description>&init-dir-text; &init-postpost-stop;</description>
367 <script name="script">
368 <description>&init-dir-script-text; &init-postpost-stop;</description>
369 &init-scriptlet-params;
376 <dir name="interfaces" type="fixed">
378 <description>The deafult broadcast address.</description>
381 <description>The default network-device.</description>
384 <description>The default network-prefix.</description>
387 <description>The default network-mask.</description>
390 <description>The default scope of the network interfaces.</description>
393 <dir name="iface" type="symbolic">
394 <file name="disabled">
395 <description>When this file exists, this interface will be ignored.</description>
399 <description>The ip which will be assigned to this interface.</description>
402 <description>The broadcast address.</description>
405 <description>The network-device.</description>
408 <description>The network-prefix.</description>
411 <description>The network-mask.</description>
414 <description>The scope of the network interfaces.</description>
417 <description>When this file exists, the interface will be named with the text in this file.</description>
420 <description>When this file exists, the interface will be assumed to exist already. A
421 former name for this flag was 'only_ip' which is deprecated now.</description>
426 <dir name="ulimits" type="fixed">
427 <description>A directory with ulimits. Possible resources are cpu, data, fsize, locks,
428 memlock, nofile, nproc, rss and/or stack.</description>
430 <file name="resource" type="symbolic">
431 <description>A file which contains the hard- and soft-limit of the given resource in the
432 first line. The special keyword 'inf' is recognized.</description>
435 <file name="resource.hard" type="symbolic">
436 <description>A file which contains the hard- of the given resource in the first line. The
437 special keyword 'inf' is recognized.</description>
440 <file name="resource.soft" type="symbolic">
441 <description>A file which contains the soft- of the given resource in the first line. The
442 special keyword 'inf' is recognized.</description>
446 <dir name="rlimits" type="fixed">
447 <description>see ulimits</description>
450 <dir name="uts" type="fixed">
451 <file name="context">
452 <description>The context-name of the vserver</description>
454 <file name="sysname">
455 <description>The sysname of the vserver</description>
457 <file name="nodename">
458 <description>The node-/hostname of the vserver</description>
460 <file name="release">
461 <description>The OS-release of the vserver</description>
463 <file name="version">
464 <description>The OS-version of the vserver</description>
466 <file name="machine">
467 <description>The machine-type of the vserver</description>
469 <file name="domainname">
470 <description>The NIS domainname of the vserver</description>