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. The entries there must be
78 absolute filenames inclusive the leading '/proc'.</description>
82 <dir name="init" type="fixed">
84 <description>A symlink to the TTY device where input/output will be redirected from/to
85 at startup via initscript.</description>
89 <dir name="vunify" type="fixed">
91 <description>Static list of excluded files.</description>
97 <dir name=".distributions" type="fixed" optional="yes">
98 <dir name="dist" type="symbolic">
100 <description></description>
103 <file name="apt.conf">
104 <description>The default apt.conf which is going to be used. It overrides the apt.conf
105 from CONFDIR/.defaults/apps/pkgmgmt.</description>
108 <script name="initpre">
109 <description>Script which will be executed before packages will be installed.</description>
112 <description>The configuration directory of the vserver which is going to be set
117 <description>The pathname of the vserver binary.</description>
122 <script name="initpost">
123 <description>Script which will be executed after packages are installed.</description>
126 <description>The configuration directory of the vserver which is going to be set
131 <description>The pathname of the vserver binary.</description>
136 <dir name="pkgs" type="fixed">
137 <description>Contains files with packages.</description>
138 <file name="list" type="symbolic">
139 <description>File which contains the name of packages. On top of file the special
140 keywords '--reinstall' and '--can-fail' are possible.</description>
144 <dir name="pubkeys" type="fixed">
145 <description>Directory with GPG pubkeys which are used to sign the packages of this
146 distribution.</description>
149 <dir name="apt" type="fixed">
150 <description>Default content of the /etc/apt/ directory.</description>
153 <dir name="rpm" type="fixed">
154 <description>Default content of the /etc/rpm directory.</description>
157 <symlink name="rpmlib">
158 <description>Directory which overrides /usr/lib/rpm.</description>
161 <symlink name="execdir">
162 <description>Directory with all executables and libraries which are required for this
163 distribution.</description>
166 </dir> <!-- .distributions -->
168 <dir name="vserver-name" type="symbolic">
169 <description>The configuration directory for the vserver vserver-name.</description>
171 <file name="hostname">
172 <description>Contains the hostname of the vserver.</description>
176 <description>Contains the name of the vserver. When not given, the basename of the directory
177 will be assumed as this name.</description>
180 <file name="domainname">
181 <description>The domainname of the vserver.</description>
185 <description>The nice-level on which the vserver will be started.</description>
188 <file name="capabilities">
189 <description>Contains per line a capability.</description>
193 <description>Contains the pathname of the shell which will be used by the "vserver ... enter"
194 command.</description>
198 <description>Contains per line a flag.</description>
201 <file name="context">
202 <description>Contains the context which shall be used for the vserver.</description>
206 <description>The fstab file for the vserver.</description>
209 <dir name="apps" type="fixed">
210 <dir name="init" type="fixed">
212 <description>The initial-mtab which will be used for the vserver.</description>
216 <description>Contains the init-style; possible values are 'sysv', 'plain' and
217 'minit'.</description>
220 <file name="runlevel">
221 <description>The start runlevel.</description>
224 <file name="runlevel.start">
225 <description>The start runlevel.</description>
228 <file name="runlevel.stop">
229 <description>The stop runlevel.</description>
232 <file name="killseq">
233 <description>Contains the 'signal [wait signal]*' sequence which is used to stop the
234 vserver.</description>
237 <file name="cmd.start">
238 <description>The command which is used to start the vserver. Each option must be on a
239 separate line.</description>
242 <file name="cmd.start-sync">
243 <description>The command which is used to wait on the vserver after it has been
244 started. Each option must be on a separate line. This file will be ignored when the
245 'sync' does not exist and the '--sync' option was not used.</description>
248 <file name="cmd.stop">
249 <description>The command which is used to stop the vserver. Each option must be on a
250 separate line.</description>
253 <file name="cmd.stop-sync">
254 <description>The command which is used to wait on the vserver after it has been
255 stopped. Each option must be on a separate line. This file will be ignored when the
256 'sync' does not exist and the '--sync' option was not used.</description>
259 <file name="cmd.prepare">
260 <description>The command which is used to setup the init-system (e.g. to set the runlevel
261 in the utmp-file). Each option must be on a separate line.</description>
265 <description>Without this file, the 'cmd.*-sync' files will be ignored.</description>
269 <description>A symlink to the TTY device where input/output will be redirected from/to
270 at startup via initscript.</description>
272 </dir> <!-- ...apps/init -->
274 <dir name="vunify" type="fixed">
275 <description>This directory contains configuration data required for vserver
276 unification.</description>
278 <file name="exclude">
279 <description>Static list of excluded files. This list supports an rsync syntax: when a
280 file is prefixed by '+', it is a candidate for unification; when there is no prefix or a
281 '-' it will be excluded. Shell-wildcards are allowed for the filenames.</description>
284 <symlink name="refserver.X">
285 <description>These are symlinks to the configuration directory
286 (e.g. CONFDIR/vservers/<idgt;) of a refserver. There may be multiple such symlinks
287 but they must be prefixed by 'refserver.' and will be processed in alphanumerical
293 <dir name="scripts" type="fixed">
294 <script name="prepre-start">
295 <description>&init-script-text; &init-prepre-start;</description>
296 &init-scriptlet-params;
298 <dir name="prepre-start.d" type="fixed">
299 <description>&init-dir-text; &init-prepre-start;</description>
301 <script name="script">
302 <description>&init-dir-script-text; &init-prepre-start;</description>
303 &init-scriptlet-params;
307 <script name="pre-start">
308 <description>&init-script-text; &init-pre-start;</description>
309 &init-scriptlet-params;
312 <dir name="pre-start.d">
313 <description>&init-dir-text; &init-pre-start;</description>
315 <script name="script">
316 <description>&init-dir-script-text; &init-pre-start;</description>
317 &init-scriptlet-params;
321 <script name="post-start">
322 <description>&init-script-text; &init-post-start;</description>
323 &init-scriptlet-params;
326 <dir name="post-start.d">
327 <description>&init-dir-text; &init-post-start;</description>
329 <script name="script">
330 <description>&init-dir-script-text; &init-post-start;</description>
331 &init-scriptlet-params;
335 <script name="pre-stop">
336 <description>&init-script-text; &init-pre-stop;</description>
337 &init-scriptlet-params;
340 <dir name="pre-stop.d" type="fixed">
341 <description>&init-dir-text; &init-pre-stop;</description>
342 <script name="script">
343 <description>&init-dir-script-text; &init-pre-stop;</description>
344 &init-scriptlet-params;
348 <script name="post-stop">
349 <description>&init-script-text; &init-post-stop;</description>
350 &init-scriptlet-params;
353 <dir name="post-stop.d" type="fixed">
354 <description>&init-dir-text; &init-post-stop;</description>
355 <script name="script">
356 <description>&init-dir-script-text; &init-post-stop;</description>
357 &init-scriptlet-params;
361 <script name="postpost-stop">
362 <description>&init-script-text; &init-postpost-stop;</description>
363 &init-scriptlet-params;
366 <dir name="postpost-stop.d" type="fixed">
367 <description>&init-dir-text; &init-postpost-stop;</description>
368 <script name="script">
369 <description>&init-dir-script-text; &init-postpost-stop;</description>
370 &init-scriptlet-params;
377 <dir name="interfaces" type="fixed">
379 <description>The deafult broadcast address.</description>
382 <description>The default network-device.</description>
385 <description>The default network-prefix.</description>
388 <description>The default network-mask.</description>
391 <description>The default scope of the network interfaces.</description>
394 <dir name="iface" type="symbolic">
395 <description>'iface' is an arbitrary name for the interface; the value itself is not important
396 but may be interesting regarding interface-creation and usage with 'chbind'. Both happens in
397 alphabetical order and numbers like '00' are good names for these directories.</description>
399 <file name="disabled">
400 <description>When this file exists, this interface will be ignored.</description>
404 <description>The ip which will be assigned to this interface.</description>
407 <description>The broadcast address.</description>
410 <description>The network-device.</description>
413 <description>The network-prefix.</description>
416 <description>The network-mask.</description>
419 <description>The scope of the network interface.</description>
422 <description>When this file exists, the interface will be named with the text in this file.</description>
425 <description>When this file exists, the interface will be assumed to exist already. A
426 former name for this flag was 'only_ip' which is deprecated now.</description>
431 <dir name="ulimits" type="fixed">
432 <description>A directory with ulimits. Possible resources are cpu, data, fsize, locks,
433 memlock, nofile, nproc, rss and/or stack.</description>
435 <file name="resource" type="symbolic">
436 <description>A file which contains the hard- and soft-limit of the given resource in the
437 first line. The special keyword 'inf' is recognized.</description>
440 <file name="resource.hard" type="symbolic">
441 <description>A file which contains the hard- of the given resource in the first line. The
442 special keyword 'inf' is recognized.</description>
445 <file name="resource.soft" type="symbolic">
446 <description>A file which contains the soft- of the given resource in the first line. The
447 special keyword 'inf' is recognized.</description>
451 <dir name="rlimits" type="fixed">
452 <description>see ulimits</description>
455 <dir name="uts" type="fixed">
456 <file name="context">
457 <description>The context-name of the vserver</description>
459 <file name="sysname">
460 <description>The sysname of the vserver</description>
462 <file name="nodename">
463 <description>The node-/hostname of the vserver</description>
465 <file name="release">
466 <description>The OS-release of the vserver</description>
468 <file name="version">
469 <description>The OS-version of the vserver</description>
471 <file name="machine">
472 <description>The machine-type of the vserver</description>
474 <file name="domainname">
475 <description>The NIS domainname of the vserver</description>