1 <?xml version="1.0" encoding="UTF-8"?>
2 <!-- <!DOCTYPE database SYSTEM "configuration.dtd" []> -->
5 <database xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:noNamespaceSchemaLocation="file:configuration.xsd">
8 <!-- Global configuration -->
9 <collection name=".defaults" use="optional">
10 <collection name="init" type="fixed">
12 <description>Default mtab file</description>
16 <link name="vdirbase">
17 <default>/vservers</default>
18 <description>A link to the default vserver rootdirectory.</description>
22 <boolean name="nonamespace">
24 Disable namespace usage globally. It can be overridden for a single
25 vserver by setting the 'namespace' flag there.
27 In this mode the /vservers directory must have the 'barrier'
28 attribute. Else, common chroot(2) exploits are possible.
34 Path of the vserver run reverse directory. This directory contains
35 symlinks named with XID numbers which point back to the configuration
36 directory of vservers. Under kernel 2.4 this is required for the XID
37 to VSERVER mapping; Under kernel 2.6 it is unused.
39 NOTE: this link exists in 0.30.202+ only; in previous versions it was
40 a vserver specific setting.
44 <collection name="apps">
45 <collection name="pkgmgmt">
47 <default>/vservers/.pkg</default>
49 <data name="apt.conf">
50 <description>The default apt.conf which is going to be used. It is overridden by
51 distribution specific configuration file.
56 <collection name="debootstrap">
57 <scalar name="mirror">
59 The Debian mirror to use with the 'debootstrap' program
64 When the 'debootstrap' package is not installed; fetch it from this
65 uri and install it at a temporary place.
70 <collection name="vshelper">
73 The file where output will be logged to when 'vshelper' is invoked
74 from the kernel. This should point somewhere e.g. into /var/log.
78 <collection name="vshelper-methods">
79 <program name="handler" type="symbolic">
86 <boolean name="disabled">
88 When existing, the vshelper functionality will be disabled for all
93 <boolean name="debug">
95 When existing, the vshelper execution will be traced.
99 <boolean name="warning-disabled">
101 When existing, sanity checks for the vshelper functionality will be
108 <collection name="vprocunhide">
111 A list of files which will be made visibly by vprocunhide. Wildcards are
112 allowed and anything ending in '/' will be processed recursively. When this file exists,
113 it overrides the defaults in SYSDEFAULTDIR/vprocunhide-files. The entries there must be
114 absolute filenames inclusive the leading '/proc'.
119 <collection name="init">
122 A symlink to the TTY device where input/output will be redirected from/to
123 at startup via initscript.
128 <collection name="vunify">
129 <list name="exclude">
130 <description>Static list of excluded files.</description>
136 <collection name=".distributions" use="optional">
137 <collection name="dist" type="symbolic">
139 <description></description>
141 <collection name="yum">
143 The default, yum-related content of the /etc directory.
145 <scalar name="yum.conf">
147 The master yum configuration file. It supports the @YUMETCDIR@,
148 @YUMCACHEDIR@ and @YUMLOGDIR@ placeholder which will be replaced at
149 'vserver ... build' time.
153 <collection name="yum.repos.d">
154 <description>A directory with yum repositories.</description>
156 <data name="apt.conf">
158 The default apt.conf which is going to be used. It overrides the
159 apt.conf from CONFDIR/.defaults/apps/pkgmgmt.
162 <program name="initpre">
164 Script which will be executed before packages will be installed.
167 <parameter name="confdir">
169 The configuration directory of the vserver which is going to be set up.
172 <parameter name="vserver">
174 The pathname of the vserver binary.
179 <program name="initpost">
181 Script which will be executed after packages are installed.
184 <parameter name="confdir">
186 The configuration directory of the vserver which is going to be set up.
189 <parameter name="vserver">
191 The pathname of the vserver binary.
197 <collection name="pkgs">
199 Contains files with packages.
203 File which contains the name of packages. On top of file the special
204 keywords '--reinstall' and '--can-fail' are possible.
209 <collection name="pubkeys">
211 Directory with GPG pubkeys which are used to sign the packages of this
216 <collection name="apt">
218 Default content of the /etc/apt/ directory.
222 <collection name="rpm">
224 Default content of the /etc/rpm directory.
230 Directory which overrides /usr/lib/rpm.
233 <link name="execdir">
235 Directory with all executables and libraries which are required for
242 <!-- Vserver configuration -->
243 <collection name="vserver-name" type="symbolic">
245 The configuration directory for the vserver vserver-name.
250 Path of the vserver root directory
256 Points to a file which will contain the XID of the running vserver. When
257 the vserver is stopped, this can be a dangling symlink.
261 <list name="bcapabilities">
263 [experimental; name is subject of possible change] Contains the system capabilities. See
264 <ulink url="http://savannah.nongnu.org/cgi-bin/viewcvs/util-vserver/util-vserver/lib/bcaps-v13.c?rev=HEAD">lib/bcaps-v13.c</ulink>
268 <list name="ccapabilities">
270 [experimental; name is subject of possible change] Contains the
271 context capabilities. See <ulink
272 url="http://savannah.nongnu.org/cgi-bin/viewcvs/util-vserver/util-vserver/lib/ccaps-v13.c?rev=HEAD">lib/ccaps-v13.c</ulink>
277 <boolean name="namespace">
279 Overrides the global 'nonamespace' flag and enables namespace usage
280 for the current vserver.
284 <boolean name="nonamespace">
286 Disables namespace usage for the current vserver.
288 In this mode the /vservers directory must have the 'barrier'
289 attribute. Else, common chroot(2) exploits are possible.
293 <hash name="schedule">
295 [experimental; name is subject of possible change] Contains the
296 scheduler parameters, one per line.
298 The Hard CPU limit uses a mechanism called a Token Bucket. the
299 concept is simple: you have a bucket of a certain size which is
300 filled with a specified amount R of tokens each interval T until the
301 maximum is reached (excess tokens are spilled). At each timer tick,
302 a running process consumes one token from the bucket, unless the
303 bucket is empty. If the bucket is empty the process is put in the
304 hold queue. When the bucket has been refilled to at least M tokens,
305 all on hold processes are rescheduled.
308 <key name="fill-rate">
310 Amount of tokens append to the bucket each interval.
313 <key name="interval">
315 The intervall between refills of amount 'fill_rate'. This value is
321 Initial bucket contents.
324 <key name="tokens-min">
326 The minimum amount of tokens required to unhold processes
329 <key name="tokens-max">
334 <key name="priority-bias">
343 Contains the name of the vserver. When not given, the basename of the directory
344 will be assumed as this name.
349 The nice-level on which the vserver will be started.
352 <list name="capabilities">
354 Contains per line a capability. This file is used for the 2.4 kernel
355 only; for 2.6 use 'bcapabilities'.
358 <scalar name="shell">
360 Contains the pathname of the shell which will be used by the "vserver
366 Contains per line a flag. See <ulink
367 url="http://savannah.nongnu.org/cgi-bin/viewcvs/util-vserver/util-vserver/lib/cflags-v13.c?rev=HEAD">lib/cflags-v13.c</ulink>
371 <element name="fakeinit">
373 The new process will believe it is process number 1. Useful to run a
374 real /sbin/init in a vserver. Warning: this flag should not be used
375 unless you know what you are doing. Often, it is better to use the
379 <element name="lock">
381 The new process is trapped and can't use chcontext anymore.
384 <element name="sched">
386 The new process and its children will share a common
389 <element name="nproc">
391 Limit the number of process in the vserver according to
392 ulimit setting. Normally, ulimit is a per user thing.
393 With this flag, it becomes a per vserver thing.
396 <element name="private">
398 No one can join this security context once created.
401 <element name="ulimit">
403 Apply the current ulimit to the whole context
408 <scalar name="context">
410 Contains the context which shall be used for the vserver.
415 The fstab file for the vserver. Entries in this file will be mounted
416 within the network context of the vserver; this means that mount will
417 be called as 'chbind <options> mount ...'. Use the 'fstab.local'
418 file when you do not want this behavior, but in most cases the 'fstab'
422 <data name="fstab.local">
424 The fstab file for the vserver. In opposite to the normal 'fstab'
425 file, the mounting happens in the local network context. Currently
426 there is no way to mix entries of both files; 'fstab' will be always
427 processed before 'fstab.local'.
431 <collection name="apps">
432 <collection name="init">
435 The initial-mtab which will be used for the vserver.
439 <scalar name="style">
441 Contains the init-style.
444 <enumeration value="sysv"/>
445 <enumeration value="plain"/>
446 <enumeration value="minit"/>
447 <enumeration value="gento"/>
451 <scalar name="runlevel">
452 <description>The start runlevel.</description>
455 <scalar name="runlevel.start">
456 <description>The start runlevel.</description>
459 <scalar name="runlevel.stop">
460 <description>The stop runlevel.</description>
463 <scalar name="killseq">
465 Contains the 'signal [wait signal]*' sequence which is used to stop
470 <list name="cmd.start">
472 The command which is used to start the vserver. Each option must be on
477 <list name="cmd.start-sync">
479 The command which is used to wait on the vserver after it has been
480 started. Each option must be on a separate line. This file will be
481 ignored when the 'sync' does not exist and the '--sync' option was not
486 <list name="cmd.stop">
488 The command which is used to stop the vserver. Each option must be on
493 <list name="cmd.stop-sync">
495 The command which is used to wait on the vserver after it has been
496 stopped. Each option must be on a separate line. This file will be
497 ignored when the 'sync' does not exist and the '--sync' option was not
502 <list name="cmd.prepare">
504 The command which is used to setup the init-system (e.g. to set the
505 runlevel in the utmp-file). Each option must be on a separate line.
509 <boolean name="sync">
511 If this file is not present, all 'cmd.*-sync files will be ignored.
517 A symlink to the TTY device where input/output will be redirected
518 from/to at startup via initscript.
524 This file is used to mark group of vservers which shall be started/stopped
525 together by the initscript. Content is a simple string like 'default'.
529 <list name="depends">
531 This file is used to configure vservers which must be running before
532 the current vserver can be started. At shutdown, the current vserver
533 will be stopped before its dependencies. Content of this file are
534 vserver ids (one name per line).
539 <collection name="vshelper">
540 <scalar name="sync-timeout">
542 The timeout in seconds which is used when synchronising vserver
543 startup/shutdown with the vshelper. When no set, 30 seconds will be
546 <default>30</default>
549 <scalar name="action">
551 The action which is going to be executed when a vshelper event occurs. The
552 default value is 'restart', but there can be defined own methods by placing
553 scripts into the 'vshelper-methods' directories. These scripts are fed with
554 the same arguments as the 'vshelper' script.
556 <default>restart</default>
559 <program name="event" type="symbolic">
561 When existing. these scripts will be executed *instead* of the default
562 handler defined in 'action'. Their name must match the event which
563 caused the execution of 'vshelper'; e.g. 'restart' or 'poweroff'. See
564 the vs_reboot() function in the kernel for more details.
567 <parameter name="xid">
569 The xid of the context calling the vshelper
572 <parameter name="event">
580 <boolean name="disabled">
582 When existing, the vshelper functionality will be disabled for this
587 <boolean name="debug">
589 When existing, the vshelper execution will be traced for this vserver.
593 <boolean name="warning-disabled">
595 When existing, sanity checks for the vshelper functionality will be
602 <collection name="vshelper-methods">
603 <program name="handler" type="symbolic">
610 <collection name="vunify">
612 This directory contains configuration data required for vserver
616 <list name="exclude">
618 Static list of excluded files. This list supports an rsync syntax:
619 when a file is prefixed by '+', it is a candidate for unification;
620 when there is no prefix or a '-' it will be excluded. Shell-wildcards
621 are allowed for the filenames.
625 <link name="refserver.X" type="symbolic">
627 These are symlinks to the configuration directory
628 (e.g. CONFDIR/vservers/<id>) of a refserver. There may be
629 multiple such symlinks but they must be prefixed by 'refserver.' and
630 will be processed in alphanumerical order.
636 <collection name="scripts">
638 A directory for scripts. By default, when one of these scripts will be
639 executed, the execution of defaultscripts (within .../.defaults/scripts)
640 will be skipped. To execute them nevertheless, the $DONT_SKIP_DEFAULTS
641 environment variable must be set by one of the in-shellcontext scripts
642 (the non-executable ones).
645 <program name="prepre-start">
647 The scriptlet which will be executed before the network-interfaces are
648 enabled and the directories are mounted."
651 <parameter name="vserver-dir">
653 The configuration directory of the current vserver.
656 <parameter name="vserver-name">
658 The name of the current vserver.
661 <parameter name="action">
663 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
668 <collection name="prepre-start.d">
670 Repository of prepre-start like scripts
672 <program name="script" type="symbolic">
673 <description>See prepre-start.</description>
675 <parameter name="vserver-dir">
677 The configuration directory of the current vserver.
680 <parameter name="vserver-name">
682 The name of the current vserver.
685 <parameter name="action">
687 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
694 <program name="pre-start">
696 The scriptlet which will be executed after network-interfaces were
697 enabled and the directories mounted, but before the vserver itself has
701 <parameter name="vserver-dir">
703 The configuration directory of the current vserver.
706 <parameter name="vserver-name">
708 The name of the current vserver.
711 <parameter name="action">
713 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
718 <collection name="pre-start.d">
720 Repository of pre-start like scripts
722 <program name="script" type="symbolic">
723 <description>See pre-start.</description>
725 <parameter name="vserver-dir">
727 The configuration directory of the current vserver.
730 <parameter name="vserver-name">
731 <description>The name of the current vserver.</description>
733 <parameter name="action">
735 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
743 <program name="post-start">
745 The scriptlet which will be executed after the vserver has been started.
748 <parameter name="vserver-dir">
749 <description>The configuration directory of the current vserver.</description>
751 <parameter name="vserver-name">
752 <description>The name of the current vserver.</description>
754 <parameter name="action">
756 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
761 <collection name="post-start.d">
762 <description>Repository of post-start like scripts</description>
763 <program name="script" type="symbolic">
764 <description>See post-start.</description>
766 <parameter name="vserver-dir">
767 <description>The configuration directory of the current vserver.</description>
769 <parameter name="vserver-name">
770 <description>The name of the current vserver.</description>
772 <parameter name="action">
774 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
782 <program name="pre-stop">
784 The scriptlet which will be executed before the vserver will be stopped.
787 <parameter name="vserver-dir">
788 <description>The configuration directory of the current vserver.</description>
790 <parameter name="vserver-name">
791 <description>The name of the current vserver.</description>
793 <parameter name="action">
795 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
800 <collection name="pre-stop.d">
802 Repository of pre-stop like scripts
804 <program name="script" type="symbolic">
805 <description>See pre-stop.</description>
807 <parameter name="vserver-dir">
808 <description>The configuration directory of the current vserver.</description>
810 <parameter name="vserver-name">
811 <description>The name of the current vserver.</description>
813 <parameter name="action">
815 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
822 <program name="post-stop">
824 The scriptlet which will be executed after the vserver has been
825 stopped, but before the directories will be umounted and the the
829 <parameter name="vserver-dir">
830 <description>The configuration directory of the current vserver.</description>
832 <parameter name="vserver-name">
833 <description>The name of the current vserver.</description>
835 <parameter name="action">
837 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
842 <collection name="post-stop.d">
843 <description>Repository of post-stop like scripts</description>
844 <program name="script" type="symbolic">
845 <description>See post-stop.</description>
847 <parameter name="vserver-dir">
848 <description>The configuration directory of the current vserver.</description>
850 <parameter name="vserver-name">
851 <description>The name of the current vserver.</description>
853 <parameter name="action">
855 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
862 <program name="postpost-stop">
864 The scriptlet which will be executed after the vserver has been stopped
868 <parameter name="vserver-dir">
869 <description>The configuration directory of the current vserver.</description>
871 <parameter name="vserver-name">
872 <description>The name of the current vserver.</description>
874 <parameter name="action">
876 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
881 <collection name="postpost-stop.d">
882 <description>Repository of postpost-stop like scripts</description>
883 <program name="script" type="symbolic">
884 <description>See postpost-stop.</description>
886 <parameter name="vserver-dir">
887 <description>The configuration directory of the current vserver.</description>
889 <parameter name="vserver-name">
890 <description>The name of the current vserver.</description>
892 <parameter name="action">
894 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
902 <collection name="interfaces">
903 <scalar name="bcast">
904 <description>The default broadcast address.</description>
907 <description>The default network device.</description>
909 <scalar name="prefix">
910 <description>The default network prefix-length.</description>
913 <description>The default network mask.</description>
915 <scalar name="scope">
916 <description>The default scope of the network interfaces.</description>
919 <collection name="iface" type="symbolic">
921 'iface' is an arbitrary name for the interface; the value itself is
922 not important but may be interesting regarding interface-creation and
923 usage with 'chbind'. Both happens in alphabetical order and numbers
924 like '00' are good names for these directories.
927 <boolean name="disabled">
928 <description>When this file exists, this interface will be ignored.</description>
932 <description>The ip which will be assigned to this interface.</description>
934 <scalar name="bcast">
935 <description>The broadcast address.</description>
938 <description>The network device.</description>
940 <scalar name="prefix">
941 <description>The network prefix-length.</description>
944 <description>The network mask.</description>
946 <scalar name="scope">
947 <description>The scope of the network interface.</description>
951 When this file exists, the interface will be named with the text in this
952 file. Without such an entry, the IP will not be shown by 'ifconfig' but
953 by 'ip addr ls' only. Such a labeled interface is known as an "alias"
954 also (e.g. 'eth0:foo').
957 <boolean name="nodev">
959 When this file exists, the interface will be assumed to exist
960 already. This can be used to assign primary interfaces which are
961 created by the host or another vserver.
967 <collection name="ulimits">
969 A directory with ulimits. Possible resources are cpu, data, fsize,
970 locks, memlock, nofile, nproc, rss and/or stack. This configuration
971 will be honored for kernel 2.4 only.
973 <scalar name="resource" type="symbolic">
975 A file which contains the hard- and soft-limit of the given resource
976 in the first line. The special keyword 'inf' is recognized.
979 <scalar name="resource.hard" type="symbolic">
981 A file which contains the hard- of the given resource in the first
982 line. The special keyword 'inf' is recognized.
985 <scalar name="resource.soft" type="symbolic">
987 A file which contains the soft- of the given resource in the first
988 line. The special keyword 'inf' is recognized.
993 <collection name="rlimits">
995 A directory with resource limits. Possible resources are cpu, fsize,
996 data, stack, core, rss, nproc, nofile, memlock, as and locks. This
997 configuration will be honored for kernel 2.6 only.
999 <scalar name="resource" type="symbolic">
1001 A file which contains the hard- and soft-limit of the given resource
1002 in the first line. The special keyword 'inf' is recognized.
1005 <scalar name="resource.hard" type="symbolic">
1007 A file which contains the hard- of the given resource in the first
1008 line. The special keyword 'inf' is recognized.
1011 <scalar name="resource.soft" type="symbolic">
1013 A file which contains the soft- of the given resource in the first
1014 line. The special keyword 'inf' is recognized.
1017 <scalar name="resource.min" type="symbolic">
1019 A file which contains the guaranted minimum of the given resource in
1020 the first line. The special keyword 'inf' is recognized.
1025 <collection name="uts">
1026 <scalar name="context">
1028 The context-name of the vserver. This file is listed for completeness
1029 only; the 'context' name is used and set internally by the util-vserver
1030 tools and can *not* be modified.
1033 <scalar name="sysname">
1034 <description>The sysname of the vserver</description>
1036 <scalar name="nodename">
1037 <description>The node-/hostname of the vserver</description>
1039 <scalar name="release">
1040 <description>The OS-release of the vserver</description>
1042 <scalar name="version">
1043 <description>The OS-version of the vserver</description>
1045 <scalar name="machine">
1046 <description>The machine-type of the vserver</description>
1048 <scalar name="domainname">
1049 <description>The NIS domainname of the vserver</description>