4887920815a2fefac5a427eabd4e53713f71ce75
[util-vserver.git] / doc / configuration.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE database SYSTEM "configuration.dtd" []>
3 <!-- $Id$ -->
4
5 <database xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6           xsi:noNamespaceSchemaLocation="file:configuration.xsd">
7
8   <!-- Global configuration -->
9   <collection name=".defaults" use="optional">
10     <collection name="init" type="fixed">
11       <data name="mtab">
12         <description>Default mtab file</description>
13       </data>
14     </collection>
15
16     <link name="vdirbase">
17       <default>/vservers</default>
18       <description>A link to the default vserver rootdirectory.</description>
19     </link>
20
21     <link name="cachebase">
22       <default>/var/cache/vservers</default>
23       <description>
24 A link to the directory which will hold cached information about
25 vservers.
26       </description>
27     </link>
28
29     <boolean id="global-nonamespace" name="nonamespace">
30       <description>
31 Disable namespace usage globally. It can be overridden for a single vserver
32 by setting the <optionref ref="global-namespace">namespace</optionref> flag
33 there.
34
35 In this mode the <directory>/vservers</directory> directory must have
36 the 'barrier' attribute. Else, common chroot(2) exploits are possible.
37       </description>
38     </boolean>
39
40     <boolean id="global-nonamespace-cleanup" name="nonamespace-cleanup">
41       <description>
42 Disable namespace cleanup globally. It can be overridden for a single vserver
43 by setting the <optionref ref="namespace-cleanup">namespace-cleanup</optionref> flag
44 there.
45       </description>
46     </boolean>
47
48     <list id="global-namespace-cleanup-skip" name="namespace-cleanup-skip">
49       <description>
50 List of paths to skip during namespace cleanup.
51       </description>
52     </list>
53
54     <link name="run.rev">
55       <description>
56 Path of the vserver run reverse directory. This directory contains
57 symlinks named with XID numbers which point back to the configuration
58 directory of vservers. Under kernel 2.4 this is required for the XID
59 to VSERVER mapping; Under kernel 2.6 it is unused.
60
61 NOTE: this link exists in 0.30.202+ only; in previous versions it was
62 a vserver specific setting.
63       </description>
64     </link>
65     
66     <collection name="apps">
67       <collection name="pkgmgmt">
68         <link name="base">
69           <default>/vservers/.pkg</default>
70         </link>
71         <data name="apt.conf">
72           <description>The default apt.conf which is going to be used. It is overridden by
73 distribution specific configuration file.
74           </description>
75         </data>
76       </collection>
77       
78       <collection name="debootstrap">
79         <scalar name="mirror">
80           <description>
81 The Debian mirror to use with the <tool>debootstrap</tool> program
82           </description>
83         </scalar>
84         <scalar name="uri">
85           <description>
86 When the <tool>debootstrap</tool> package is not installed; fetch it
87 from this uri and install it at a temporary place.
88           </description>
89         </scalar>
90       </collection>
91
92       <collection name="vshelper">
93         <link name="logfile">
94           <description>
95 The file where output will be logged to when <tool>vshelper</tool>
96 is invoked from the kernel. This should point somewhere e.g. into
97 <directory>/var/log</directory>.
98           </description>
99         </link>
100
101         <collection name="vshelper-methods">
102           <program name="handler" type="symbolic">
103             <description>
104 See vshelper/action.
105             </description>
106           </program>
107         </collection>
108
109         <boolean name="disabled">
110           <description>
111 When existing, the vshelper functionality will be disabled for all
112 vservers.
113           </description>
114         </boolean>
115
116         <boolean name="debug">
117           <description>
118 When existing, the vshelper execution will be traced.
119           </description>
120         </boolean>
121         
122         <boolean name="warning-disabled">
123           <description>
124 When existing, sanity checks for the vshelper functionality will be
125 skipped.
126           </description>
127         </boolean>
128
129       </collection>
130       
131       <collection name="vprocunhide">
132         <list name="files">
133           <description>
134 A list of files which will be made visible by vprocunhide. Wildcards are
135 allowed and anything ending in '/' will be processed recursively. When this file exists,
136 it overrides the defaults in SYSDEFAULTDIR/vprocunhide-files. The entries there must be
137 absolute filenames inclusive the leading '/proc'.
138           </description>
139         </list>
140       </collection>
141       
142       <collection name="init">
143         <link name="tty">
144           <description>
145 A symlink to the TTY device where input/output will be redirected from/to
146 at startup via initscript.
147           </description>
148         </link>
149
150         <hash id="global-environment" name="environment" since="0.30.211">
151           <description>
152 The environment to set when starting guests. Contains one VAR=VAL
153 pair per line.
154           </description>
155         </hash>
156       </collection>
157       
158       <collection name="vunify">
159         <list name="exclude">
160           <description>Static list of excluded files.</description>
161         </list>
162
163         <collection name="hash" since="0.30.205">
164           <description>
165 A directory which will be used as the storage place for the
166 <tool>vhashify</tool> command.
167           </description>
168           <link name="id" type="symbolic">
169             <description>
170 Points to a directory within the filesystems which are used for the
171 vservers. There must be not more than one of such a directory per
172 filesystem.
173             </description>
174           </link>
175
176           <scalar name="method" since="0.30.299">
177             <default>SHA1</default>
178             <description>The used hash method.</description>
179           </scalar>
180         </collection>
181
182         <boolean name="pkgmgmt-ignore" default="off" since="0.30.205">
183           <description>
184 When existing, information from packagemanagement will not be used to
185 create dynamic exclude-lists.
186           </description>
187         </boolean>
188
189         <boolean name="pgkmgmt-force" default="off" since="0.30.205">
190           <description>
191 When existing, information from packagemanagement will be used to
192 create dynamic exclude-lists. This option requires that (a known)
193 packagemanagement is configured for the vserver; else the requested
194 operation will fail. Most tools assume 'on' as the default value.
195           </description>
196         </boolean>
197
198       </collection>
199
200       <collection name="vlogin">
201         <boolean id="vlogin-disable" name="disable" since="0.30.212">
202           <description>
203 When this file exists, vlogin isn't used on vserver &lt;guest&gt; enter.
204           </description>
205         </boolean>
206       </collection>
207     </collection>
208
209     <collection name="interfaces" use="optional">
210       <boolean id="global-vlandev" name="vlandev" since="0.30.211">
211         <description>
212 When this file exists, the steps which setup and destroy a VLAN
213 interface will be executed.
214         </description>
215       </boolean>
216     </collection>
217   </collection>
218     
219   <collection name=".distributions" use="optional">
220     <collection name="dist" type="symbolic">
221       <scalar name="dev">
222         <description></description>
223       </scalar>
224       <collection name="yum">
225         <description>
226 The default, yum-related content of the <directory>/etc</directory>
227 directory.
228         </description>
229         <scalar name="yum.conf">
230           <description>
231 The master yum configuration file. It supports the @YUMETCDIR@,
232 @YUMCACHEDIR@ and @YUMLOGDIR@ placeholder which will be replaced at
233 <command>vserver ... build</command> time.
234           </description>
235         </scalar>
236       </collection>
237       <collection name="yum.repos.d">
238         <description>A directory with yum repositories.</description>
239       </collection>
240       <data name="apt.conf">
241         <description>
242 The default apt.conf which is going to be used. It overrides the
243 apt.conf from CONFDIR/.defaults/apps/pkgmgmt.
244         </description>
245       </data>
246       <program name="initpre">
247         <description>
248 Script which will be executed before packages will be installed.
249           </description>
250         <parameterList>
251           <parameter name="confdir">
252             <description>
253 The configuration directory of the vserver which is going to be set up.
254             </description>
255           </parameter>
256           <parameter name="util-vserver-vars">
257             <description>
258 The pathname of the util-vserver-vars file.
259             </description>
260           </parameter>
261         </parameterList>
262       </program>
263       <program name="initpost">
264         <description>
265 Script which will be executed after packages are installed.
266           </description>
267         <parameterList>
268           <parameter name="confdir">
269             <description>
270 The configuration directory of the vserver which is going to be set up.
271             </description>
272           </parameter>
273           <parameter name="vserver">
274             <description>
275 The pathname of the util-vserver-vars file.
276             </description>
277           </parameter>
278         </parameterList>
279       </program>
280       
281       <collection name="pkgs">
282         <description>
283 Contains files with packagenames.
284         </description>
285         <list name="list">
286           <description>
287 File which contains the name of packages. On top of file the special
288 keywords '--reinstall' and '--can-fail' are possible.
289           </description>
290         </list>
291       </collection>
292       
293       <collection name="pubkeys">
294         <description>
295 Directory with GPG pubkeys which are used to sign the packages of this
296 distribution.
297         </description>
298       </collection>
299       
300       <collection name="apt">
301         <description>
302 Default content of the <directory>/etc/apt/</directory> directory.
303         </description>
304       </collection>
305       
306       <collection name="rpm">
307         <description>
308 Default content of the <directory>/etc/rpm</directory> directory.
309         </description>
310       </collection>
311       
312       <link name="rpmlib">
313         <description>
314 Directory which overrides <directory>/usr/lib/rpm</directory>.
315         </description>
316       </link>
317       <link name="execdir">
318         <description>
319 Directory with all executables and libraries which are required for
320 this distribution.
321         </description>
322       </link>
323     </collection>
324   </collection>
325   
326   <!-- Vserver configuration -->
327   <collection name="vserver-name" type="symbolic">
328     <description>
329 The configuration directory for the vserver vserver-name.
330     </description>
331
332     <link name="cache">
333       <default>../.defaults/cachebase/VSERVERNAME</default>
334       <description>
335 Path of the storage area for cached information about this vserver.
336       </description>
337     </link>
338     
339     <link name="vdir">
340       <default>../.defaults/vdirbase/VSERVERNAME</default>
341       <description>
342 Path of the vserver root directory.
343       </description>
344     </link>
345
346     <link name="run">
347       <description>
348 Points to a file which will contain the XID of the running vserver. When
349 the vserver is stopped, this can be a dangling symlink.
350       </description>
351     </link>
352
353     <list id="bcapabilities" name="bcapabilities">
354       <description>
355 Contains the system capabilities. See
356 <ulink url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/bcaps-v13.c">lib/bcaps-v13.c</ulink>
357 for possible values.
358       </description>
359     </list>
360     <list name="ccapabilities">
361       <description>
362 Contains the context capabilities. See <ulink
363 url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/ccaps-v13.c">lib/ccaps-v13.c</ulink>
364 for possible values.
365       </description>
366     </list>
367
368     <boolean id="global-namespace" name="namespace">
369       <description>
370 Overrides the global <optionref ref="global-nonamespace">nonamespace</optionref> flag and enables
371 namespace usage for the current vserver.
372       </description>
373     </boolean>
374
375     <boolean name="nonamespace">
376       <description>
377 Disables namespace usage for the current vserver.
378
379 In this mode the <directory>/vservers</directory> directory must have
380 the 'barrier' attribute. Else, common chroot(2) exploits are possible.
381       </description>
382     </boolean>
383
384     <boolean id="namespace-cleanup" name="namespace-cleanup">
385       <description>
386 Overrides the global <optionref ref="global-nonamespace-cleanup">nonamespace-cleanup</optionref> flag and enables
387 namespace cleanup for the current vserver.
388       </description>
389     </boolean>
390
391     <list name="namespace-cleanup-skip">
392       <description>
393 List of paths to skip during namespace cleanup. This overrides the global
394 <optionref ref="global-namespace-cleanup-skip">namespace-cleanup-skip</optionref>
395 file.
396       </description>
397     </list>
398
399     <hash name="schedule">
400       <description>
401 [deprecated; use <optionref ref="sched">sched</optionref> instead] Contains the
402 scheduler parameters, one per line.
403
404 The Hard CPU limit uses a mechanism called a Token Bucket.  the
405 concept is simple: you have a bucket of a certain size which is
406 filled with a specified amount R of tokens each interval T until the
407 maximum is reached (excess tokens are spilled). At each timer tick,
408 a running process consumes one token from the bucket, unless the
409 bucket is empty. If the bucket is empty the process is put in the
410 hold queue. When the bucket has been refilled to at least M tokens,
411 all on hold processes are rescheduled.
412
413 See the <ulink url="http://linux-vserver.org/Scheduler+Parameters">Linux
414 VServer Wiki</ulink> for more information about this file.
415       </description>
416       <keys>
417         <key id="fill_rate" name="fill-rate">
418           <description>
419 Amount of tokens append to the bucket each interval.
420             </description>
421         </key>
422         <key name="interval">
423           <description>
424 The intervall between refills of amount <optionref>fill_rate</optionref>. This
425 value is express in ticks.
426           </description>
427         </key>
428         <key name="tokens">
429           <description>
430 Initial bucket contents.
431           </description>
432         </key>
433         <key name="tokens-min">
434           <description>
435 The minimum amount of tokens required to unhold processes
436           </description>
437         </key>
438         <key name="tokens-max">
439           <description>
440 The bucket size.
441           </description>
442         </key>
443         <key name="priority-bias">
444           <description>
445 ???
446           </description>
447         </key>
448       </keys>
449     </hash>
450     <scalar name="name">
451       <description>
452 Contains the name of the vserver. When not given, the basename of the directory
453 will be assumed as this name.
454       </description>
455     </scalar>
456     <scalar name="nice">
457       <description>
458 The nice-level on which the vserver will be started.
459       </description>
460     </scalar>
461     <list name="capabilities">
462       <description>
463 Contains per line a capability. This file is used for the 2.4 kernel
464 only; for 2.6 use <optionref>bcapabilities</optionref>.
465       </description>
466     </list>
467     <scalar name="shell">
468       <description>
469 Contains the pathname of the shell which will be used by the "vserver
470 ... enter" command.
471       </description>
472     </scalar>
473     <list name="personality">
474       <description>
475 Used to set the personality of the vserver. First line in the file
476 is the personality-type followed by flags (one item per line). See
477 <filename>/usr/include/linux/personality.h</filename> for possible
478 values.
479       </description>
480     </list>
481     <list name="flags">
482       <description>
483 Contains per line a flag. See <ulink
484 url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/cflags-v13.c">lib/cflags-v13.c</ulink>
485 for possible values.
486       </description>
487       <!--
488       <elements>
489         <element name="fakeinit">
490           <description>
491 The new process will believe it is process number 1. Useful to run a
492 real /sbin/init in a vserver. Warning: this flag should not be used
493 unless you know what you are doing. Often, it is better to use the
494 'plain' initstyle.
495           </description>
496         </element>
497         <element name="lock">
498           <description>
499 The new process is trapped and can't use chcontext anymore.
500           </description>
501         </element>
502         <element name="sched">
503           <description>
504 The new process and its children will share a common
505           </description>
506         </element>
507         <element name="nproc">
508           <description>
509 Limit the number of process in the vserver according to
510 ulimit setting. Normally, ulimit is a per user thing.
511 With this flag, it becomes a per vserver thing.
512           </description>
513         </element>
514         <element name="private">
515           <description>
516 No one can join this security context once created.
517           </description>
518         </element>
519         <element name="ulimit">
520           <description>
521 Apply the current ulimit to the whole context
522           </description>
523         </element>
524       </elements>
525       -->
526     </list>
527     <scalar name="context">
528       <description>
529 Contains the context which shall be used for the vserver.
530         </description>
531     </scalar>
532     <data id="fstab" name="fstab">
533       <description>
534 The fstab file for the vserver. Entries in this file will be mounted
535 within the network context of the host. Use the
536 <optionref>fstab.remote</optionref> file when you want that the
537 mounting happens in the network context of the vserver. In most cases
538 the 'fstab' file should be used.
539       </description>
540     </data>
541     <data id="fstab.remote" name="fstab.remote">
542       <description>
543 The fstab file for the vserver. Entries in this file will be mounted
544 within the network context of the host; this means that mount will be
545 called as <command>chbind &lt;options&gt; mount ...</command>. See
546 <optionref>fstab</optionref> also.
547       </description>
548     </data>
549     
550     <collection name="apps">
551       <collection name="init">
552         <data name="mtab">
553           <description>
554 The initial-mtab which will be used for the vserver.
555           </description>
556         </data>
557         
558         <scalar name="style">
559           <description>
560 Contains the init-style.
561           </description>
562           <restriction>
563             <enumeration value="sysv"/>
564             <enumeration value="plain"/>
565             <enumeration value="minit"/>
566           </restriction>
567         </scalar>
568         
569         <scalar name="runlevel">
570           <description>The start runlevel.</description>
571         </scalar>
572         
573         <scalar name="runlevel.start">
574           <description>The start runlevel.</description>
575         </scalar>
576         
577         <scalar name="runlevel.stop">
578           <description>The stop runlevel.</description>
579         </scalar>
580         
581         <scalar name="killseq">
582           <description>
583 Contains the 'signal [wait signal]*' sequence which is used to stop
584 the vserver.
585           </description>
586         </scalar>
587         
588         <list name="cmd.start">
589           <description>
590 The command which is used to start the vserver. Each option must be on
591 a separate line.
592           </description>
593         </list>
594         
595         <list name="cmd.start-sync">
596           <description>
597 The command which is used to wait on the vserver after it has been
598 started. Each option must be on a separate line. This file will be
599 ignored when the <optionref>sync</optionref> flag does not exist and the
600 '--sync' option was not used.
601           </description>
602         </list>
603         
604         <list name="cmd.stop">
605           <description>
606 The command which is used to stop the vserver. Each option must be on
607 a separate line.
608           </description>
609         </list>
610         
611         <list name="cmd.stop-sync">
612           <description>
613 The command which is used to wait on the vserver after it has been
614 stopped. Each option must be on a separate line. This file will be
615 ignored when the <optionref>sync</optionref> flag does not exist and the
616 '--sync' option was not used.
617           </description>
618         </list>
619         
620         <list name="cmd.prepare">
621           <description>
622 The command which is used to setup the init-system (e.g. to set the
623 runlevel in the utmp-file). Each option must be on a separate line.
624           </description>
625         </list>
626         
627         <boolean id="sync" name="sync">
628           <description>
629 If this file is not present, all 'cmd.*-sync files will be ignored.
630             </description>
631         </boolean>
632         
633         <link name="tty">
634           <description>
635 A symlink to the TTY device where input/output will be redirected
636 from/to at startup via initscript.
637           </description>
638         </link>
639         
640         <scalar name="mark">
641           <description>
642 This file is used to mark group of vservers which shall be started/stopped
643 together by the initscript. Content is a simple string like 'default'.
644           </description>
645         </scalar>
646         
647         <list name="depends">
648           <description>
649 This file is used to configure vservers which must be running before
650 the current vserver can be started. At shutdown, the current vserver
651 will be stopped before its dependencies. Content of this file are
652 vserver ids (one name per line).
653           </description>
654         </list>
655
656         <hash name="environment" since="0.30.211">
657           <description>
658 The environment to set when starting the guest. Contains one VAR=VAL
659 pair per line.
660           </description>
661         </hash>
662       </collection>
663       
664       <collection name="vshelper">
665         <scalar name="sync-timeout">
666           <default>30</default>
667           <description>
668 The timeout in seconds which is used when synchronising vserver
669 startup/shutdown with the vshelper. When not set, 30 seconds will be
670 assumed.
671           </description>
672         </scalar>
673         
674         <scalar name="action">
675           <default>restart</default>
676           <description>
677 The action which is going to be executed when a vshelper event
678 occurs. The default value is 'restart', but there can be defined own
679 methods by placing scripts into the
680 <optionref>vshelper-methods</optionref> directories. These scripts are
681 fed with the same arguments as the <tool>vshelper</tool> script.
682           </description>
683         </scalar>
684         
685         <program name="event" type="symbolic">
686           <description>
687 When existing, these scripts will be executed *instead* of the default
688 handler defined in 'action'. Their name must match the event which caused
689 the execution of <tool>vshelper</tool>; e.g. 'restart' or 'poweroff'. See
690 the vs_reboot() function in the kernel for more details.
691           </description>
692           <parameterList>
693             <parameter name="xid">
694               <description>
695 The xid of the context calling the vshelper
696               </description>
697             </parameter>
698             <parameter name="event">
699               <description>
700 The reboot-event.
701               </description>
702             </parameter>
703           </parameterList>
704         </program>
705         
706         <boolean name="disabled">
707           <description>
708 When existing, the vshelper functionality will be disabled for this
709 vserver.
710           </description>
711         </boolean>
712
713         <boolean name="debug">
714           <description>
715 When existing, the vshelper execution will be traced for this vserver.
716           </description>
717         </boolean>
718         
719         <boolean name="warning-disabled">
720           <description>
721 When existing, sanity checks for the vshelper functionality will be
722 skipped.
723           </description>
724         </boolean>
725         
726       </collection>
727       
728       <collection id="vshelper-methods" name="vshelper-methods">
729         <program name="handler" type="symbolic">
730           <description>
731 See vshelper/action.
732           </description>
733         </program>
734       </collection>
735       
736       <collection name="vunify">
737         <description>
738 This directory contains configuration data required for vserver
739 unification.
740         </description>
741         
742         <list name="exclude">
743           <description>
744 <p>Static list of files which are excluded for unification. This list
745 supports an rsync-like syntax: when a file is prefixed by '+', it is a
746 candidate for unification; when there is no prefix or a '-' or a '~' it
747 will be excluded. Shell-wildcards are allowed for the filenames.</p>
748 <p>When used with <tool>vcopy</tool>, the '~' prefix prevents copying
749 of the file entirely (e.g. for keyfiles). With this tool, the file will
750 be copied instead of hardlinked when the '-' prefix is used.</p>
751           </description>
752         </list>
753         
754         <link name="refserver.X" type="symbolic">
755           <description>
756 These are symlinks to the configuration directory
757 (e.g. CONFDIR/vservers/&lt;id&gt;) of a refserver. There may be
758 multiple such symlinks but they must be prefixed by 'refserver.' and
759 will be processed in alphanumerical order.
760           </description>
761         </link>
762
763         <collection name="hash" since="0.30.205">
764           <description>
765 A directory which will be used as the storage place for the
766 <tool>vhashify</tool> command.
767           </description>
768           <link name="id" type="symbolic">
769             <description>
770 Points to a directory within the filesystems which are used for the
771 vservers. There must be not more than one of such a directory per
772 filesystem.
773             </description>
774           </link>
775
776           <scalar name="method"  since="0.30.299">
777             <default>SHA1</default>
778             <description>The used hash method.</description>
779           </scalar>
780         </collection>
781
782         <boolean name="pkgmgmt-ignore" default="off" since="0.30.205">
783           <description>
784 When existing, information from packagemanagement will not be used to
785 create dynamic exclude-lists.
786           </description>
787         </boolean>
788
789         <boolean name="pgkmgmt-force" default="off" since="0.30.205">
790           <description>
791 When existing, information from packagemanagement will be used to
792 create dynamic exclude-lists. This option requires that (a known)
793 packagemanagement is configured for the vserver; else the requested
794 operation will fail. Most tools assume 'on' as the default value.
795           </description>
796         </boolean>
797         
798       </collection>
799     </collection>
800     
801     <collection name="scripts">
802       <description>
803 A directory for scripts. By default, when one of these scripts will be
804 executed, the execution of defaultscripts (within .../.defaults/scripts)
805 will be skipped. To execute them nevertheless, the $DONT_SKIP_DEFAULTS
806 environment variable must be set by one of the in-shellcontext scripts
807 (the non-executable ones).
808       </description>
809       
810       <program name="initialize" since="0.30.211">
811         <description>
812 The scriptlet which will be executed before the root filesystem is mounted and
813 the configuration has been loaded. Before executing the script, the
814 configuration directory will be made the working directory.
815         </description>
816         <parameterList>
817           <parameter name="action">
818             <description>
819 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
820             </description>
821           </parameter>
822           <parameter name="vserver-name">
823             <description>
824 The name of the current vserver.
825             </description>
826           </parameter>
827         </parameterList>
828       </program>
829       <collection name="initialize.d" since="0.30.211">
830         <description>
831 Repository of initialize like scripts.  Before executing the script,
832 the configuration directory will be made the working directory.
833         </description>
834         <program name="script" type="symbolic">
835           <description>See initialize.</description>
836           <parameterList>
837             <parameter name="action">
838               <description>
839 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
840               </description>
841             </parameter>
842             <parameter name="vserver-name">
843               <description>
844 The name of the current vserver.
845               </description>
846             </parameter>
847           </parameterList>
848         </program>
849       </collection>
850       
851       <program name="prepre-start">
852         <description>
853 The scriptlet which will be executed before the network-interfaces are
854 enabled and the directories are mounted. Before executing the script,
855 the configuration directory will be made the working directory.
856         </description>
857         <parameterList>
858           <parameter name="action">
859             <description>
860 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
861             </description>
862           </parameter>
863           <parameter name="vserver-name">
864             <description>
865 The name of the current vserver.
866             </description>
867           </parameter>
868         </parameterList>
869       </program>
870       <collection name="prepre-start.d">
871         <description>
872 Repository of prepre-start like scripts.  Before executing the script,
873 the configuration directory will be made the working directory.
874         </description>
875         <program name="script" type="symbolic">
876           <description>See prepre-start.</description>
877           <parameterList>
878             <parameter name="action">
879               <description>
880 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
881               </description>
882             </parameter>
883             <parameter name="vserver-name">
884               <description>
885 The name of the current vserver.
886               </description>
887             </parameter>
888           </parameterList>
889         </program>
890       </collection>
891       
892       <program name="pre-start">
893         <description>
894 The scriptlet which will be executed after network-interfaces were
895 enabled and the directories mounted, but before the vserver itself has
896 been started.  Before executing the script, the vserver root directory
897 will be made the working directory.
898         </description>
899         <parameterList>
900           <parameter name="action">
901             <description>
902 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
903             </description>
904           </parameter>
905           <parameter name="vserver-name">
906             <description>
907 The name of the current vserver.
908             </description>
909           </parameter>
910         </parameterList>
911       </program>
912       <collection name="pre-start.d">
913         <description>
914 Repository of pre-start like scripts. Before executing these scripts,
915 the vserver root directory will be made the working directory.
916         </description>
917         <program name="script" type="symbolic">
918           <description>See pre-start.</description>
919           <parameterList>
920             <parameter name="action">
921               <description>
922 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
923               </description>
924             </parameter>
925             <parameter name="vserver-name">
926               <description>
927 The name of the current vserver.
928               </description>
929             </parameter>
930           </parameterList>
931         </program>
932       </collection>
933       
934
935       <program name="post-start">
936         <description>
937 The scriptlet which will be executed after the vserver has been
938 started. Before executing the script, the vserver root directory
939 will be made the working directory.
940         </description>
941         <parameterList>
942           <parameter name="action">
943             <description>
944 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
945             </description>
946           </parameter>
947           <parameter name="vserver-name">
948             <description>
949 The name of the current vserver.
950             </description>
951           </parameter>
952         </parameterList>
953       </program>
954       <collection name="post-start.d">
955         <description>
956 Repository of post-start like scripts. Before executing these scripts,
957 the vserver root directory will be made the working directory.
958         </description>
959         <program name="script" type="symbolic">
960           <description>See post-start.</description>
961           <parameterList>
962             <parameter name="action">
963               <description>
964 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
965               </description>
966             </parameter>
967             <parameter name="vserver-name">
968               <description>
969 The name of the current vserver.
970               </description>
971             </parameter>
972           </parameterList>
973         </program>
974       </collection>
975
976
977       <program name="pre-stop">
978         <description>
979 The scriptlet which will be executed before the vserver will be
980 stopped. Before executing the script, the vserver root directory
981 will be made the working directory.
982         </description>
983         <parameterList>
984           <parameter name="action">
985             <description>
986 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
987             </description>
988           </parameter>
989           <parameter name="vserver-name">
990             <description>
991 The name of the current vserver.
992             </description>
993           </parameter>
994         </parameterList>
995       </program>
996       <collection name="pre-stop.d">
997         <description>
998 Repository of pre-stop like scripts. Before executing the script, the
999 vserver root directory will be made the working directory.
1000         </description>
1001         <program name="script" type="symbolic">
1002           <description>See pre-stop.</description>
1003           <parameterList>
1004             <parameter name="action">
1005               <description>
1006 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1007               </description>
1008             </parameter>
1009             <parameter name="vserver-name">
1010               <description>
1011 The name of the current vserver.
1012               </description>
1013             </parameter>
1014           </parameterList>
1015         </program>
1016       </collection>
1017
1018       <program name="post-stop">
1019         <description>
1020 The scriptlet which will be executed after the vserver has been
1021 stopped, but before the directories will be umounted and the the
1022 interfaces disabled. Before executing the script, the vserver root
1023 directory will be made the working directory.
1024         </description>
1025         <parameterList>
1026           <parameter name="action">
1027             <description>
1028 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1029             </description>
1030           </parameter>
1031           <parameter name="vserver-name">
1032             <description>
1033 The name of the current vserver.
1034             </description>
1035           </parameter>
1036         </parameterList>
1037       </program>
1038       <collection name="post-stop.d">
1039         <description>
1040 Repository of post-stop like scripts. Before executing the script, the
1041 vserver root directory will be made the working directory.
1042         </description>
1043         <program name="script" type="symbolic">
1044           <description>See post-stop.</description>
1045           <parameterList>
1046             <parameter name="action">
1047               <description>
1048 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1049               </description>
1050             </parameter>
1051             <parameter name="vserver-name">
1052               <description>
1053 The name of the current vserver.
1054               </description>
1055             </parameter>
1056           </parameterList>
1057         </program>
1058       </collection>
1059       
1060       <program name="postpost-stop">
1061         <description>
1062 The scriptlet which will be executed after the vserver has been stopped
1063 completely. Before executing the script, the vserver root directory
1064 will be made the working directory.
1065         </description>
1066         <parameterList>
1067           <parameter name="action">
1068             <description>
1069 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1070             </description>
1071           </parameter>
1072           <parameter name="vserver-name">
1073             <description>
1074 The name of the current vserver.
1075             </description>
1076           </parameter>
1077         </parameterList>
1078       </program>
1079       <collection name="postpost-stop.d">
1080         <description>
1081 Repository of postpost-stop like scripts. Before executing the script,
1082 the vserver root directory will be made the working directory.
1083         </description>
1084         <program name="script" type="symbolic">
1085           <description>See postpost-stop.</description>
1086           <parameterList>
1087             <parameter name="action">
1088               <description>
1089 The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
1090               </description>
1091             </parameter>
1092             <parameter name="vserver-name">
1093               <description>
1094 The name of the current vserver.
1095               </description>
1096             </parameter>
1097           </parameterList>
1098         </program>
1099       </collection>
1100     </collection>
1101     
1102     <collection name="interfaces">
1103       <scalar name="bcast">
1104         <description>The default broadcast address.</description>
1105       </scalar>
1106       <scalar name="dev">
1107         <description>The default network device.</description>
1108       </scalar>
1109       <scalar name="prefix">
1110         <description>The default network prefix-length.</description>
1111       </scalar>
1112       <scalar name="mask">
1113         <description>The default network mask.</description>
1114       </scalar>
1115       <scalar name="scope">
1116         <description>The default scope of the network interfaces.</description>
1117       </scalar>
1118       <boolean id="local-vlandev" name="vlandev" since="0.30.211">
1119         <description>
1120 When this file exists, the steps which setup and destroy a VLAN
1121 interface will be executed for all interfaces of this vserver.
1122         </description>
1123       </boolean>
1124       <boolean id="local-novlandev" name="novlandev">
1125         <description>
1126 When this file exists, the steps which setup and destroy a VLAN
1127 interface will be skipped. This overrides the global
1128 <optionref ref="global-vlandev">vlandev</optionref> setting for
1129 this vserver.
1130         </description>
1131       </boolean>
1132       
1133       <collection name="iface" type="symbolic">
1134         <description>
1135 'iface' is an arbitrary name for the interface; the value itself is
1136 not important but may be interesting regarding interface-creation and
1137 usage with <tool>chbind</tool>. Both happens in alphabetical order and
1138 numbers like '00' are good names for these directories.
1139         </description>
1140         
1141         <boolean name="disabled">
1142           <description>When this file exists, this interface will be ignored.</description>
1143         </boolean>
1144         
1145         <scalar name="ip">
1146           <description>The ip which will be assigned to this interface.</description>
1147         </scalar>
1148         <scalar name="bcast">
1149           <description>The broadcast address.</description>
1150         </scalar>
1151         <scalar name="dev">
1152           <description>The network device.</description>
1153         </scalar>
1154         <scalar name="prefix">
1155           <description>The network prefix-length.</description>
1156         </scalar>
1157         <scalar name="mask">
1158           <description>The network mask.</description>
1159         </scalar>
1160         <scalar name="scope">
1161           <description>The scope of the network interface.</description>
1162         </scalar>
1163         <scalar name="name">
1164           <description>
1165 When this file exists, the interface will be named with the text in
1166 this file. Without such an entry, the IP will not be shown by
1167 <tool>ifconfig</tool> but by <command>ip addr ls</command> only.  Such
1168 a labeled interface is known as an "alias" also (e.g. 'eth0:foo').
1169           </description>
1170         </scalar>
1171         <boolean name="nodev">
1172           <description>
1173 When this file exists, the interface will be assumed to exist
1174 already. This can be used to assign primary interfaces which are
1175 created by the host or another vserver.
1176           </description>
1177         </boolean>
1178         <boolean name="novlandev">
1179           <description>
1180 When this file exists, the steps which setup and destroy a VLAN
1181 interface will be skipped. This will override the global
1182 <optionref ref="global-vlandev">vlandev</optionref> and the per-guest
1183 <optionref ref="local-vlandev">vlandev</optionref>.
1184           </description>
1185         </boolean>
1186         <boolean name="vlandev" since="0.30.211">
1187           <description>
1188 When this file exists, the steps which setup and destroy a VLAN
1189 interface will be executed.
1190           </description>
1191         </boolean>
1192       </collection>
1193     </collection>
1194     
1195     <collection name="ulimits">
1196       <description>
1197 A directory with ulimits. Possible resources are cpu, data, fsize,
1198 locks, memlock, nofile, nproc, rss and/or stack.
1199       </description>
1200       <scalar name="resource" type="symbolic">
1201         <description>
1202 A file which contains the hard- and soft-limit of the given resource
1203 in the first line. The special keyword 'inf' is recognized.
1204         </description>
1205       </scalar>
1206       <scalar name="resource.hard" type="symbolic">
1207         <description>
1208 A file which contains the hard- of the given resource in the first
1209 line. The special keyword 'inf' is recognized.
1210         </description>
1211       </scalar>
1212       <scalar name="resource.soft" type="symbolic">
1213         <description>
1214 A file which contains the soft- of the given resource in the first
1215 line. The special keyword 'inf' is recognized.
1216         </description>
1217       </scalar>
1218     </collection>
1219     
1220     <collection name="rlimits">
1221       <description>
1222 A directory with resource limits. Possible resources are cpu, fsize,
1223 data, stack, core, rss, nproc, nofile, memlock, as, locks, msgqueue,
1224 nsock, openfd, anon, shmem, semary, nsems and dentry. This
1225 configuration will be honored for kernel 2.6 only.
1226       </description>
1227       <scalar name="resource" type="symbolic">
1228         <description>
1229 A file which contains the hard- and soft-limit of the given resource
1230 in the first line. The special keyword 'inf' is recognized.
1231         </description>
1232       </scalar>
1233       <scalar name="resource.hard" type="symbolic">
1234         <description>
1235 A file which contains the hard- of the given resource in the first
1236 line. The special keyword 'inf' is recognized.
1237         </description>
1238       </scalar>
1239       <scalar name="resource.soft" type="symbolic">
1240         <description>
1241 A file which contains the soft- of the given resource in the first
1242 line. The special keyword 'inf' is recognized.
1243         </description>
1244       </scalar>
1245       <scalar name="resource.min" type="symbolic">
1246         <description>
1247 A file which contains the guaranted minimum of the given resource in
1248 the first line. The special keyword 'inf' is recognized.
1249         </description>
1250       </scalar>
1251     </collection>
1252     
1253     <collection name="uts">
1254       <scalar name="context">
1255         <description>
1256 The context-name of the vserver. This file is listed for completeness
1257 only; the 'context' name is used and set internally by the util-vserver
1258 tools and can *not* be modified.
1259         </description>
1260       </scalar>
1261       <scalar name="sysname">
1262         <description>The sysname of the vserver</description>
1263       </scalar>
1264       <scalar name="nodename">
1265         <description>The node-/hostname of the vserver</description>
1266       </scalar>
1267       <scalar name="release">
1268         <description>The OS-release of the vserver</description>
1269       </scalar>
1270       <scalar name="version">
1271         <description>The OS-version of the vserver</description>
1272       </scalar>
1273       <scalar name="machine">
1274         <description>The machine-type of the vserver</description>
1275       </scalar>
1276       <scalar name="domainname">
1277         <description>The NIS domainname of the vserver</description>
1278       </scalar>
1279     </collection>
1280
1281     <collection name="dlimits" since="0.30.210">
1282       <collection name="dlimit" type="symbolic">
1283         <scalar name="directory">
1284           <description>The directory to which the limit should be applied</description>
1285         </scalar>
1286         <scalar name="inodes_total">
1287           <description>The amount of inodes this vserver should be limited to</description>
1288         </scalar>
1289         <scalar name="space_total">
1290           <description>The amount of space this vserver should be limited to (measured in blocks of 1024 bytes)</description>
1291         </scalar>
1292         <scalar name="reserved">
1293           <description>How much space (percentage-wise) should be reserved for the root user</description>
1294         </scalar>
1295       </collection>
1296     </collection>
1297
1298     <collection name="cpuset" since="0.30.211">
1299       <scalar name="name">
1300         <description>The name of the cpuset for this vserver</description>
1301       </scalar>
1302       <scalar name="cpus">
1303         <description>The list of CPUs in this cpuset</description>
1304       </scalar>
1305       <scalar name="mems">
1306         <description>The list of Memory Nodes in this cpuset</description>
1307       </scalar>
1308       <scalar name="cpu_exclusive">
1309         <description>Is the CPU assignment exclusive?</description>
1310       </scalar>
1311       <scalar name="mems_exclusive">
1312         <description>Is the memory node assignment exclusive?</description>
1313       </scalar>
1314       <scalar name="nocreate">
1315         <description>When this file exists, the cpuset will be assumed to exist already</description>
1316       </scalar>
1317     </collection>
1318
1319     <collection id="sched" name="sched" since="0.30.212">
1320       <scalar id="global-tokens" name="tokens">
1321         <description>The initial amount of tokens to put in the bucket</description>
1322       </scalar>
1323       <scalar id="global-tokens-min" name="tokens-min">
1324         <description>The minimum amount of tokens required to unhold the context</description>
1325       </scalar>
1326       <scalar id="global-tokens-max" name="tokens-max">
1327         <description>The bucket's size</description>
1328       </scalar>
1329       <scalar id="global-fill-rate" name="fill-rate">
1330         <description>Amount of tokens to add each <optionref ref="global-interval">interval</optionref></description>
1331       </scalar>
1332       <scalar id="global-interval" name="interval">
1333         <description>The interval between refills of the bucket</description>
1334       </scalar>
1335       <scalar id="global-priority-bias" name="priority-bias">
1336         <description>Bias added to priorities calculated within the guest (result is clamped to -20/+19)</description>
1337       </scalar>
1338       <scalar id="global-fill-rate2" name="fill-rate2">
1339         <description>Amount of tokens to add each <optionref ref="global-interval2">interval2</optionref> when advancing idle time</description>
1340       </scalar>
1341       <scalar id="global-interval2" name="interval2">
1342         <description>The interval between refills of the bucket when advancing idle time</description>
1343       </scalar>
1344       <boolean id="global-idle-time" name="idle-time">
1345         <description>When this file exists, advancing idle time is activated</description>
1346       </boolean>
1347       <collection name="cpu-id" type="symbolic">
1348         <description>This directory contains per-CPU and/or per-bucket specific settings. Remember to set the <optionref ref="cpu-id">cpu-id</optionref> file. All CPUs inherit the global settings.</description>
1349         <scalar name="tokens">
1350           <description>The initial amount of tokens to put in the bucket</description>
1351         </scalar>
1352         <scalar name="tokens-min">
1353           <description>The minimum amount of tokens required to unhold the context</description>
1354         </scalar>
1355         <scalar name="tokens-max">
1356           <description>The bucket's size</description>
1357         </scalar>
1358         <scalar name="fill-rate">
1359           <description>Amount of tokens to add each <optionref ref="local-interval">interval</optionref></description>
1360         </scalar>
1361         <scalar id="local-interval" name="interval">
1362           <description>The interval between refills of the bucket</description>
1363         </scalar>
1364         <scalar name="priority-bias">
1365           <description>Bias added to priorities calculated within the guest (result is clamped to -20/+19)</description>
1366         </scalar>
1367         <scalar name="fill-rate2">
1368           <description>Amount of tokens to add each <optionref ref="local-interval2">interval2</optionref> when advancing idle time</description>
1369         </scalar>
1370         <scalar id="local-interval2" name="interval2">
1371           <description>The interval between refills of the bucket when advancing idle time</description>
1372         </scalar>
1373         <boolean name="idle-time">
1374           <description>When this file exists, advancing idle time is activated</description>
1375         </boolean>
1376         <scalar id="cpu-id" name="cpu-id">
1377           <description>The CPU to apply these settings to</description>
1378         </scalar>
1379         <scalar name="bucket-id">
1380           <description>The bucket to apply these settings to</description>
1381         </scalar>
1382       </collection>
1383     </collection>
1384   </collection>
1385   </database>