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="bcapabilities">
172 <description>[experimental; name is subject of possible change] Contains the system capabilities.</description>
175 <file name="ccapabilities">
176 <description>[experimental; name is subject of possible change] Contains the context capabilities.</description>
179 <file name="schedule">
180 <description>[experimental; name is subject of possible change] Contains the scheduler
181 parameters: fill-rate, interval, tokens, tokens-min, tokens-max and cpu-mask. One parameter
182 per line.</description>
186 <file name="hostname">
187 <description>Contains the hostname of the vserver. Same as uts/nodename.</description>
191 <description>Contains the name of the vserver. When not given, the basename of the directory
192 will be assumed as this name.</description>
195 <file name="domainname">
196 <description>The domainname of the vserver. Same as uts/domainname.</description>
200 <description>The nice-level on which the vserver will be started.</description>
203 <file name="capabilities">
204 <description>Contains per line a capability.</description>
208 <description>Contains the pathname of the shell which will be used by the "vserver ... enter"
209 command.</description>
213 <description>Contains per line a flag.</description>
216 <file name="context">
217 <description>Contains the context which shall be used for the vserver.</description>
221 <description>The fstab file for the vserver. Entries in this file will be mounted within the
222 network context of the vserver; this means that mount will be called as 'chbind <options>
223 mount ...'. Use the 'fstab.local' file when you do not want this behavior, but in most cases
224 the 'fstab' file should be used.</description>
227 <file name="fstab.local">
228 <description>The fstab file for the vserver. In opposite to the normal 'fstab' file, the
229 mounting happens in the local network context. Currently there is no way to mix entries of
230 both files; 'fstab' will be always processed before 'fstab.local'.</description>
233 <dir name="apps" type="fixed">
234 <dir name="init" type="fixed">
236 <description>The initial-mtab which will be used for the vserver.</description>
240 <description>Contains the init-style; possible values are 'sysv', 'plain', 'minit' and
241 'gentoo'.</description>
244 <file name="runlevel">
245 <description>The start runlevel.</description>
248 <file name="runlevel.start">
249 <description>The start runlevel.</description>
252 <file name="runlevel.stop">
253 <description>The stop runlevel.</description>
256 <file name="killseq">
257 <description>Contains the 'signal [wait signal]*' sequence which is used to stop the
258 vserver.</description>
261 <file name="cmd.start">
262 <description>The command which is used to start the vserver. Each option must be on a
263 separate line.</description>
266 <file name="cmd.start-sync">
267 <description>The command which is used to wait on the vserver after it has been
268 started. Each option must be on a separate line. This file will be ignored when the
269 'sync' does not exist and the '--sync' option was not used.</description>
272 <file name="cmd.stop">
273 <description>The command which is used to stop the vserver. Each option must be on a
274 separate line.</description>
277 <file name="cmd.stop-sync">
278 <description>The command which is used to wait on the vserver after it has been
279 stopped. Each option must be on a separate line. This file will be ignored when the
280 'sync' does not exist and the '--sync' option was not used.</description>
283 <file name="cmd.prepare">
284 <description>The command which is used to setup the init-system (e.g. to set the runlevel
285 in the utmp-file). Each option must be on a separate line.</description>
289 <description>Without this file, the 'cmd.*-sync' files will be ignored.</description>
293 <description>A symlink to the TTY device where input/output will be redirected from/to
294 at startup via initscript.</description>
298 <description>This file is used to mark group of vservers which shall be started/stopped
299 together by the initscript. Content is a simple string like 'default'.</description>
302 <file name="depends">
303 <description>This file is used to configure vservers which must be running before the
304 current vserver can be started. At shutdown, the current vserver will be stopped before
305 its dependencies. Content of this file are vserver ids (one name per line).</description>
307 </dir> <!-- ...apps/init -->
309 <dir name="vshelper" type="fixed">
310 <file name="sync-timeout">
311 <description>The timeout in seconds which is used when synchronising vserver startup/shutdown
312 with the vshelper. When no set, 30 seconds will be assumed.</description>
316 <description>The action which is going to be executed when a vshelper event occurs. The
317 default value is 'restart', but there can be defined own methods by placing scripts into
318 the 'vshelper-methods' directories. These scripts are fed with the same arguments as the
319 'vshelper' script.</description>
322 <script type="symbolic" name="event">
323 <description>When existing. these scripts will be executed *instead* of the default
324 handler defined in 'action'. Their name must match the event which caused the execution
325 of 'vshelper'; e.g. 'restart' or 'poweroff'. See the vs_reboot() function in the kernel
326 for more details.</description>
329 <description>The xid of the context calling the vshelper</description>
332 <description>The reboot-event</description>
337 <file name="disabled">
338 <description>When existing, the vshelper functionality will be disabled for this
339 vserver.</description>
342 <file name="warning-disabled">
343 <description>When existing, sanity checks for the vshelper functionality will be
344 skipped.</description>
347 <symlink name="logfile">
348 <description>The file where output will be logged to when 'vshelper' is invoked from the
349 kernel. This should point somewhere e.g. into /var/log.</description>
353 <dir name="vshelper-methods" type="fixed">
354 <script type="symbolic" name="handler">
355 <description>See vshelper/action.</description>
361 <dir name="vunify" type="fixed">
362 <description>This directory contains configuration data required for vserver
363 unification.</description>
365 <file name="exclude">
366 <description>Static list of excluded files. This list supports an rsync syntax: when a
367 file is prefixed by '+', it is a candidate for unification; when there is no prefix or a
368 '-' it will be excluded. Shell-wildcards are allowed for the filenames.</description>
371 <symlink name="refserver.X">
372 <description>These are symlinks to the configuration directory
373 (e.g. CONFDIR/vservers/<idgt;) of a refserver. There may be multiple such symlinks
374 but they must be prefixed by 'refserver.' and will be processed in alphanumerical
380 <dir name="scripts" type="fixed">
381 <description>A directory for scripts. By default, when one of these scripts will be executed,
382 the execution of defaultscripts (within .../.defaults/scripts) will be skipped. To execute
383 them nevertheless, the $DONT_SKIP_DEFAULTS environment variable must be set by one of the
384 in-shellcontext scripts (the non-executable ones).</description>
386 <script name="prepre-start">
387 <description>&init-script-text; &init-prepre-start;</description>
388 &init-scriptlet-params;
390 <dir name="prepre-start.d" type="fixed">
391 <description>&init-dir-text; &init-prepre-start;</description>
393 <script name="script">
394 <description>&init-dir-script-text; &init-prepre-start;</description>
395 &init-scriptlet-params;
399 <script name="pre-start">
400 <description>&init-script-text; &init-pre-start;</description>
401 &init-scriptlet-params;
404 <dir name="pre-start.d">
405 <description>&init-dir-text; &init-pre-start;</description>
407 <script name="script">
408 <description>&init-dir-script-text; &init-pre-start;</description>
409 &init-scriptlet-params;
413 <script name="post-start">
414 <description>&init-script-text; &init-post-start;</description>
415 &init-scriptlet-params;
418 <dir name="post-start.d">
419 <description>&init-dir-text; &init-post-start;</description>
421 <script name="script">
422 <description>&init-dir-script-text; &init-post-start;</description>
423 &init-scriptlet-params;
427 <script name="pre-stop">
428 <description>&init-script-text; &init-pre-stop;</description>
429 &init-scriptlet-params;
432 <dir name="pre-stop.d" type="fixed">
433 <description>&init-dir-text; &init-pre-stop;</description>
434 <script name="script">
435 <description>&init-dir-script-text; &init-pre-stop;</description>
436 &init-scriptlet-params;
440 <script name="post-stop">
441 <description>&init-script-text; &init-post-stop;</description>
442 &init-scriptlet-params;
445 <dir name="post-stop.d" type="fixed">
446 <description>&init-dir-text; &init-post-stop;</description>
447 <script name="script">
448 <description>&init-dir-script-text; &init-post-stop;</description>
449 &init-scriptlet-params;
453 <script name="postpost-stop">
454 <description>&init-script-text; &init-postpost-stop;</description>
455 &init-scriptlet-params;
458 <dir name="postpost-stop.d" type="fixed">
459 <description>&init-dir-text; &init-postpost-stop;</description>
460 <script name="script">
461 <description>&init-dir-script-text; &init-postpost-stop;</description>
462 &init-scriptlet-params;
469 <dir name="interfaces" type="fixed">
471 <description>The deafult broadcast address.</description>
474 <description>The default network-device.</description>
477 <description>The default network-prefix.</description>
480 <description>The default network-mask.</description>
483 <description>The default scope of the network interfaces.</description>
486 <dir name="iface" type="symbolic">
487 <description>'iface' is an arbitrary name for the interface; the value itself is not important
488 but may be interesting regarding interface-creation and usage with 'chbind'. Both happens in
489 alphabetical order and numbers like '00' are good names for these directories.</description>
491 <file name="disabled">
492 <description>When this file exists, this interface will be ignored.</description>
496 <description>The ip which will be assigned to this interface.</description>
499 <description>The broadcast address.</description>
502 <description>The network-device.</description>
505 <description>The network-prefix.</description>
508 <description>The network-mask.</description>
511 <description>The scope of the network interface.</description>
514 <description>When this file exists, the interface will be named with the text in this file.</description>
517 <description>When this file exists, the interface will be assumed to exist already. A
518 former name for this flag was 'only_ip' which is deprecated now.</description>
523 <dir name="ulimits" type="fixed">
524 <description>A directory with ulimits. Possible resources are cpu, data, fsize, locks,
525 memlock, nofile, nproc, rss and/or stack.</description>
527 <file name="resource" type="symbolic">
528 <description>A file which contains the hard- and soft-limit of the given resource in the
529 first line. The special keyword 'inf' is recognized.</description>
532 <file name="resource.hard" type="symbolic">
533 <description>A file which contains the hard- of the given resource in the first line. The
534 special keyword 'inf' is recognized.</description>
537 <file name="resource.soft" type="symbolic">
538 <description>A file which contains the soft- of the given resource in the first line. The
539 special keyword 'inf' is recognized.</description>
543 <dir name="rlimits" type="fixed">
544 <description>see ulimits</description>
547 <dir name="uts" type="fixed">
548 <file name="context">
549 <description>The context-name of the vserver. This file is listed for completeness only;
550 the 'context' name is used and set internally by the util-vserver tools and can *not* be
551 modified.</description>
553 <file name="sysname">
554 <description>The sysname of the vserver</description>
556 <file name="nodename">
557 <description>The node-/hostname of the vserver</description>
559 <file name="release">
560 <description>The OS-release of the vserver</description>
562 <file name="version">
563 <description>The OS-version of the vserver</description>
565 <file name="machine">
566 <description>The machine-type of the vserver</description>
568 <file name="domainname">
569 <description>The NIS domainname of the vserver</description>