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