1 <?xml version="1.0" encoding="UTF-8"?>
2 <database xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3 xsi:noNamespaceSchemaLocation="file:configuration.xsd">
5 <!-- Global configuration -->
6 <collection name=".default" use="optional">
7 <collection name="init" type="fixed">
9 <description>Default mtab file</description>
13 <link name="vdirbase">
14 <default>/vservers</default>
17 <collection name="apps">
18 <collection name="pkgmgmt">
20 <default>/vservers/.pkg</default>
22 <data name="apt.conf">
24 The default apt.conf which is going to be used. It is overridden by
25 distribution specific configuration file.
30 <collection name="debootstrap">
31 <scalar name="mirror">
33 The Debian mirror to use with the 'debootstrap' program
38 When the 'debootstrap' package is not installed; fetch it from this uri and
39 install it at a temporary place.
44 <collection name="vprocunhide">
47 A list of files which will be made visibly by vprocunhide. Wildcards are
48 allowed and anything ending in '/' will be processed recursively. When this file exists,
49 it overrides the defaults in SYSDEFAULTDIR/vprocunhide-files. The entries there must be
50 absolute filenames inclusive the leading '/proc'.
55 <collection name="init">
58 A symlink to the TTY device where input/output will be redirected from/to
59 at startup via initscript.
64 <collection name="vunify">
67 Static list of excluded files.
73 <collection name=".distributions" use="optional">
74 <collection name="dist" type="symbolic">
79 <data name="apt.conf">
81 The default apt.conf which is going to be used. It overrides the apt.conf
82 from CONFDIR/.defaults/apps/pkgmgmt.
85 <program name="initpre">
87 Script which will be executed before packages will be installed.
90 <parameter name="confdir">
92 The configuration directory of the vserver which is going to be set up.
95 <parameter name="vserver">
97 The pathname of the vserver binary.
102 <program name="initpost">
104 Script which will be executed after packages are installed.
107 <parameter name="confdir">
109 The configuration directory of the vserver which is going to be set up.
112 <parameter name="vserver">
114 The pathname of the vserver binary.
120 <collection name="pkgs">
122 Contains files with packages.
126 File which contains the name of packages. On top of file the special
127 keywords '--reinstall' and '--can-fail' are possible.
132 <collection name="pubkeys">
134 Directory with GPG pubkeys which are used to sign the packages of this
139 <collection name="apt">
141 Default content of the /etc/apt/ directory.
145 <collection name="rpm">
147 Default content of the /etc/rpm directory.
153 Directory which overrides /usr/lib/rpm.
156 <link name="execdir">
158 Directory with all executables and libraries which are required for this
166 <!-- Vserver configuration -->
167 <collection name="vserver-name" type="symbolic">
169 The configuration directory for the vserver vserver-name.
174 Path of the vserver root directory
180 Path of the vserver run directory
184 <link name="run.rev">
186 Path of the vserver run reverse directory
190 <list name="bcapabilities">
192 [experimental; name is subject of possible change] Contains the system capabilities. See
193 <ulink url="http://savannah.nongnu.org/cgi-bin/viewcvs/util-vserver/util-vserver/lib/bcaps-v13.c?rev=HEAD">lib/bcaps-v13.c</ulink>
197 <list name="ccapabilities">
199 [experimental; name is subject of possible change] Contains the context capabilities. See
200 <ulink url="http://savannah.nongnu.org/cgi-bin/viewcvs/util-vserver/util-vserver/lib/ccaps-v13.c?rev=HEAD">lib/ccaps-v13.c</ulink>
204 <hash name="schedule">
206 [experimental; name is subject of possible change] Contains the scheduler parameters,
209 The Hard CPU limit uses a mechanism called a Token Bucket.
210 the concept is simple: you have a bucket of a certain size
211 which is filled with a specified amount R of tokens each
212 interval T until the maximum is reached (excess tokens
213 are spilled). At each timer tick, a running process consumes
214 one token from the bucket, unless the bucket is empty. If the
215 bucket is empty the process is put in the hold queue. When the
216 bucket has been refilled to at least M tokens, all on hold
217 processes are rescheduled.
220 <key name="fill-rate">
222 Amount of tokens append to the bucket each interval.
225 <key name="interval">
227 The intervall between refills of amount 'fill_rate'. This value is express in ticks.
232 Initial bucket contents.
235 <key name="tokens-min">
237 The minimum amount of tokens required to unhold processes
240 <key name="tokens-max">
245 <key name="cpu-mask">
247 Unused at the moment.
252 <scalar name="hostname">
254 Contains the hostname of the vserver. Same as uts/nodename.
259 Contains the name of the vserver. When not given, the basename of the directory
260 will be assumed as this name.
263 <scalar name="domainname">
265 The domainname of the vserver. Same as uts/domainname.
270 The nice-level on which the vserver will be started.
273 <list name="capabilities">
275 Contains per line a capability. This file is used for the 2.4
276 kernel only; for 2.6 use 'bcapabilities'.
279 <scalar name="shell">
281 Contains the pathname of the shell which will be used by the "vserver ... enter"
287 Contains per line a flag. See
288 <ulink url="http://savannah.nongnu.org/cgi-bin/viewcvs/util-vserver/util-vserver/lib/cflags-v13.c?rev=HEAD">lib/cflags-v13.c</ulink>
292 <element name="fakeinit">
294 The new process will believe it is process number 1. Useful to run a real
295 /sbin/init in a vserver.
298 <element name="lock">
300 The new process is trapped and can't use chcontext anymore.
303 <element name="sched">
305 The new process and its children will share a common
308 <element name="nproc">
310 Limit the number of process in the vserver according to
311 ulimit setting. Normally, ulimit is a per user thing.
312 With this flag, it becomes a per vserver thing.
315 <element name="private">
317 No one can join this security context once created.
320 <element name="ulimit">
322 Apply the current ulimit to the whole context
327 <scalar name="context">
329 Contains the context which shall be used for the vserver.
334 The fstab file for the vserver. Entries in this file will be mounted within the
335 network context of the vserver; this means that mount will be called as 'chbind <options>
336 mount ...'. Use the 'fstab.local' file when you do not want this behavior, but in most cases
337 the 'fstab' file should be used.
340 <data name="fstab.local">
342 The fstab file for the vserver. In opposite to the normal 'fstab' file, the
343 mounting happens in the local network context. Currently there is no way to mix entries of
344 both files; 'fstab' will be always processed before 'fstab.local'.
348 <collection name="apps">
349 <collection name="init">
352 The initial-mtab which will be used for the vserver.
356 <scalar name="style">
358 Contains the init-style.
361 <enumeration value="sysv"/>
362 <enumeration value="plain"/>
363 <enumeration value="minit"/>
364 <enumeration value="gento"/>
368 <scalar name="runlevel">
369 <description>The start runlevel.</description>
372 <scalar name="runlevel.start">
373 <description>The start runlevel.</description>
376 <scalar name="runlevel.stop">
377 <description>The stop runlevel.</description>
380 <scalar name="killseq">
382 Contains the 'signal [wait signal]*' sequence which is used to stop the
387 <list name="cmd.start">
389 The command which is used to start the vserver. Each option must be on a
394 <list name="cmd.start-sync">
396 The command which is used to wait on the vserver after it has been
397 started. Each option must be on a separate line. This file will be ignored when the
398 'sync' does not exist and the '--sync' option was not used.
402 <list name="cmd.stop">
404 The command which is used to stop the vserver. Each option must be on a
409 <list name="cmd.stop-sync">
411 The command which is used to wait on the vserver after it has been
412 stopped. Each option must be on a separate line. This file will be ignored when the
413 'sync' does not exist and the '--sync' option was not used.
417 <list name="cmd.prepare">
419 The command which is used to setup the init-system (e.g. to set the runlevel
420 in the utmp-file). Each option must be on a separate line.
424 <boolean name="sync">
426 If this file is not present, all 'cmd.*-sync files will be ignored.
432 A symlink to the TTY device where input/output will be redirected from/to
433 at startup via initscript.
439 This file is used to mark group of vservers which shall be started/stopped
440 together by the initscript. Content is a simple string like 'default'.
444 <list name="depends">
446 This file is used to configure vservers which must be running before the
447 current vserver can be started. At shutdown, the current vserver will be stopped before
448 its dependencies. Content of this file are vserver ids (one name per line).
453 <collection name="vshelper">
454 <scalar name="sync-timeout">
456 The timeout in seconds which is used when synchronising vserver startup/shutdown
457 with the vshelper. When no set, 30 seconds will be assumed.
459 <default>30</default>
462 <scalar name="action">
464 The action which is going to be executed when a vshelper event occurs. The
465 default value is 'restart', but there can be defined own methods by placing scripts into
466 the 'vshelper-methods' directories. These scripts are fed with the same arguments as the
469 <default>restart</default>
472 <program name="event" type="symbolic">
474 When existing. these scripts will be executed *instead* of the default
475 handler defined in 'action'. Their name must match the event which caused the execution
476 of 'vshelper'; e.g. 'restart' or 'poweroff'. See the vs_reboot() function in the kernel
480 <parameter name="xid">
481 <description>The xid of the context calling the vshelper</description>
483 <parameter name="event">
484 <description>The reboot-event</description>
489 <boolean name="disabled">
491 When existing, the vshelper functionality will be disabled for this
496 <boolean name="warning-disabled">
498 When existing, sanity checks for the vshelper functionality will be
503 <link name="logfile">
505 The file where output will be logged to when 'vshelper' is invoked from the
506 kernel. This should point somewhere e.g. into /var/log.
511 <collection name="vshelper-methods">
512 <program name="handler" type="symbolic">
519 <collection name="vunify">
521 This directory contains configuration data required for vserver
525 <list name="exclude">
527 Static list of excluded files. This list supports an rsync syntax: when a
528 file is prefixed by '+', it is a candidate for unification; when there is no prefix or a
529 '-' it will be excluded. Shell-wildcards are allowed for the filenames.
533 <link name="refserver.X" type="symbolic">
535 These are symlinks to the configuration directory
536 (e.g. CONFDIR/vservers/<id>) of a refserver. There may be multiple such symlinks
537 but they must be prefixed by 'refserver.' and will be processed in alphanumerical
544 <collection name="scripts">
546 A directory for scripts. By default, when one of these scripts will be executed,
547 the execution of defaultscripts (within .../.defaults/scripts) will be skipped. To execute
548 them nevertheless, the $DONT_SKIP_DEFAULTS environment variable must be set by one of the
549 in-shellcontext scripts (the non-executable ones).
552 <program name="prepre-start">
554 The scriptlet which will be executed before the network-interfaces are enabled
555 and the directories are mounted."
558 <parameter name="vserver-dir">
559 <description>The configuration directory of the current vserver.</description>
561 <parameter name="vserver-name">
562 <description>The name of the current vserver.</description>
564 <parameter name="action">
565 <description>The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).</description>
569 <collection name="prepre-start.d">
571 Repository of prepre-start like scripts
573 <program name="script" type="symbolic">
574 <description>See prepre-start.</description>
576 <parameter name="vserver-dir">
577 <description>The configuration directory of the current vserver.</description>
579 <parameter name="vserver-name">
580 <description>The name of the current vserver.</description>
582 <parameter name="action">
583 <description>The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).</description>
589 <program name="pre-start">
591 The scriptlet which will be executed after network-interfaces were enabled and
592 the directories mounted, but before the vserver itself has been started.
595 <parameter name="vserver-dir">
596 <description>The configuration directory of the current vserver.</description>
598 <parameter name="vserver-name">
599 <description>The name of the current vserver.</description>
601 <parameter name="action">
602 <description>The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).</description>
606 <collection name="pre-start.d">
608 Repository of pre-start like scripts
610 <program name="script" type="symbolic">
611 <description>See pre-start.</description>
613 <parameter name="vserver-dir">
614 <description>The configuration directory of the current vserver.</description>
616 <parameter name="vserver-name">
617 <description>The name of the current vserver.</description>
619 <parameter name="action">
620 <description>The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).</description>
627 <program name="post-start">
629 The scriptlet which will be executed after the vserver has been started.
632 <parameter name="vserver-dir">
633 <description>The configuration directory of the current vserver.</description>
635 <parameter name="vserver-name">
636 <description>The name of the current vserver.</description>
638 <parameter name="action">
639 <description>The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).</description>
643 <collection name="post-start.d">
645 Repository of post-start like scripts
647 <program name="script" type="symbolic">
648 <description>See post-start.</description>
650 <parameter name="vserver-dir">
651 <description>The configuration directory of the current vserver.</description>
653 <parameter name="vserver-name">
654 <description>The name of the current vserver.</description>
656 <parameter name="action">
657 <description>The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).</description>
664 <program name="pre-stop">
666 The scriptlet which will be executed before the vserver will be stopped.
669 <parameter name="vserver-dir">
670 <description>The configuration directory of the current vserver.</description>
672 <parameter name="vserver-name">
673 <description>The name of the current vserver.</description>
675 <parameter name="action">
676 <description>The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).</description>
680 <collection name="pre-stop.d">
682 Repository of pre-stop like scripts
684 <program name="script" type="symbolic">
685 <description>See pre-stop.</description>
687 <parameter name="vserver-dir">
688 <description>The configuration directory of the current vserver.</description>
690 <parameter name="vserver-name">
691 <description>The name of the current vserver.</description>
693 <parameter name="action">
694 <description>The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).</description>
700 <program name="post-stop">
702 The scriptlet which will be executed after the vserver has been stopped, but
703 before the directories will be umounted and the the interfaces
707 <parameter name="vserver-dir">
708 <description>The configuration directory of the current vserver.</description>
710 <parameter name="vserver-name">
711 <description>The name of the current vserver.</description>
713 <parameter name="action">
714 <description>The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).</description>
718 <collection name="post-stop.d">
720 Repository of post-stop like scripts
722 <program name="script" type="symbolic">
723 <description>See post-stop.</description>
725 <parameter name="vserver-dir">
726 <description>The configuration directory of the current vserver.</description>
728 <parameter name="vserver-name">
729 <description>The name of the current vserver.</description>
731 <parameter name="action">
732 <description>The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).</description>
738 <program name="postpost-stop">
740 The scriptlet which will be executed after the vserver has been stopped
744 <parameter name="vserver-dir">
745 <description>The configuration directory of the current vserver.</description>
747 <parameter name="vserver-name">
748 <description>The name of the current vserver.</description>
750 <parameter name="action">
751 <description>The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).</description>
755 <collection name="postpost-stop.d">
757 Repository of postpost-stop like scripts
759 <program name="script" type="symbolic">
760 <description>See postpost-stop.</description>
762 <parameter name="vserver-dir">
763 <description>The configuration directory of the current vserver.</description>
765 <parameter name="vserver-name">
766 <description>The name of the current vserver.</description>
768 <parameter name="action">
769 <description>The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).</description>
776 <collection name="interfaces">
777 <scalar name="bcast">
778 <description>The default broadcast address.</description>
781 <description>The default network device.</description>
783 <scalar name="prefix">
784 <description>The default network prefix.</description>
787 <description>The default network mask.</description>
789 <scalar name="scope">
790 <description>The default scope of the network interfaces.</description>
793 <collection name="iface" type="symbolic">
795 'iface' is an arbitrary name for the interface; the value itself is not important
796 but may be interesting regarding interface-creation and usage with 'chbind'. Both happens in
797 alphabetical order and numbers like '00' are good names for these directories.
800 <boolean name="disabled">
801 <description>When this file exists, this interface will be ignored.</description>
805 <description>The ip which will be assigned to this interface.</description>
807 <scalar name="bcast">
808 <description>The broadcast address.</description>
811 <description>The network device.</description>
813 <scalar name="prefix">
814 <description>The network prefix.</description>
817 <description>The network mask.</description>
819 <scalar name="scope">
820 <description>The scope of the network interface.</description>
824 When this file exists, the interface will be named with the text in this file.
827 <boolean name="nodev">
829 When this file exists, the interface will be assumed to exist already.
835 <collection name="ulimits">
837 A directory with ulimits. Possible resources are cpu, data, fsize, locks,
838 memlock, nofile, nproc, rss and/or stack. This configuration will be honored
841 <scalar name="resource" type="symbolic">
843 A file which contains the hard- and soft-limit of the given resource in the
844 first line. The special keyword 'inf' is recognized.
847 <scalar name="resource.hard" type="symbolic">
849 A file which contains the hard- of the given resource in the first line. The
850 special keyword 'inf' is recognized.
853 <scalar name="resource.soft" type="symbolic">
855 A file which contains the soft- of the given resource in the first line. The
856 special keyword 'inf' is recognized.
861 <collection name="rlimits">
863 A directory with resource limits. Possible resources are cpu, data, fsize, locks,
864 memlock, nofile, nproc, rss and/or stack. This configuration will be honored
867 <scalar name="resource" type="symbolic">
869 A file which contains the hard- and soft-limit of the given resource in the
870 first line. The special keyword 'inf' is recognized.
873 <scalar name="resource.hard" type="symbolic">
875 A file which contains the hard- of the given resource in the first line. The
876 special keyword 'inf' is recognized.
879 <scalar name="resource.soft" type="symbolic">
881 A file which contains the soft- of the given resource in the first line. The
882 special keyword 'inf' is recognized.
885 <scalar name="resource.min" type="symbolic">
887 A file which contains the guaranted minimum of the given resource in the first line. The
888 special keyword 'inf' is recognized.
893 <collection name="uts">
894 <scalar name="context">
896 The context-name of the vserver. This file is listed for completeness only;
897 the 'context' name is used and set internally by the util-vserver tools and can *not* be
901 <scalar name="sysname">
902 <description>The sysname of the vserver</description>
904 <scalar name="nodename">
905 <description>The node-/hostname of the vserver</description>
907 <scalar name="release">
908 <description>The OS-release of the vserver</description>
910 <scalar name="version">
911 <description>The OS-version of the vserver</description>
913 <scalar name="machine">
914 <description>The machine-type of the vserver</description>
916 <scalar name="domainname">
917 <description>The NIS domainname of the vserver</description>