183d51953b0d46c248ae6d92a753e12abb8f8d7a
[util-vserver.git] / util-vserver / doc / configuration.xml
1 <?xml version="1.0"?>
2 <!DOCTYPE cfgdirdoc SYSTEM "cfgdirdoc.dtd" [
3 <!ENTITY init-scriptlet-params
4           "<params>
5             <param id='vserver-dir'>
6               <description>The configuration directory of the current vserver</description>
7             </param>
8             <param id='vserver-name'>
9               <description>The name of the current vserver</description>
10             </param>
11             <param id='action'>
12               <description>The fixed value of the current action (e.g. 'prepre-start', 'post-stop', ...).</description>
13             </param>
14           </params>">
15 <!ENTITY init-script-text     "The scriptlet">
16 <!ENTITY init-dir-text        "A directory with scriptlets">
17 <!ENTITY init-dir-script-text "A scriptlet">
18
19 <!ENTITY init-prepre-start "which will be executed before the network-interfaces are enabled
20                             and the directories are mounted.">
21 <!ENTITY init-pre-start  "which will be executed after network-interfaces were enabled and
22                           the directories mounted, but before the vserver itself has been
23                           started.">
24 <!ENTITY init-post-start "which will be executed after the vserver has been started.">
25 <!ENTITY init-pre-stop   "which will be executed before the vserver will be stopped.">
26 <!ENTITY init-post-stop  "which will be executed after the vserver has been stopped, but
27                           before the directories will be umounted and the the interfaces
28                           disabled.">
29 <!ENTITY init-postpost-stop "which will be executed after the vserver has been stopped
30                              completely.">
31 ]>
32
33
34 <cfgdirdoc>
35   <topleveldir path="@CONFDIR@">
36     <description>The base configuration directory.</description>
37
38     <dir name=".defaults" type="fixed" optional="yes">
39       <dir name="init" type="fixed">
40         <file name="mtab">
41           <description>Default mtab-file</description>
42         </file>
43       </dir>
44
45       <symlink name="vdirbase">
46         <description></description>
47         <default>/vservers</default>
48       </symlink>
49
50       <dir name="apps" type="fixed">
51         <dir name="pkgmgmt" type="fixed">
52           <symlink name="base">
53             <description></description>
54             <default>/vservers/.pkg</default>
55           </symlink>
56         </dir>
57
58         <dir name="debootstrap" type="fixed">
59           <file name="mirror">
60             <description>The Debian mirror which is used for 'debootstrap'.</description>
61           </file>
62
63           <file name="uri">
64             <description>When the 'debootstrap' package is not installed; fetch it from this uri and
65             install it at a temporary place.</description>
66           </file>
67         </dir>
68       </dir>
69     </dir>
70
71     <dir name=".distributions" type="fixed" optional="yes">
72       <dir name="dist" type="symbolic">
73         <file name="dev">
74           <description></description>
75         </file>
76
77         <script name="initpre">
78           <description>Script which will be executed before packages will be installed.</description>
79           <params>
80             <param id="confdir">
81               <description>The configuration directory of the vserver which is going to be set
82               up.</description>
83             </param>
84
85             <param id="vserver">
86               <description>The pathname of the vserver binary.</description>
87             </param>
88           </params>
89         </script>
90
91         <script name="initpost">
92           <description>Script which will be executed after packages are installed.</description>
93           <params>
94             <param id="confdir">
95               <description>The configuration directory of the vserver which is going to be set
96               up.</description>
97             </param>
98
99             <param id="vserver">
100               <description>The pathname of the vserver binary.</description>
101             </param>
102           </params>
103         </script>
104
105         <dir name="pkgs" type="fixed">
106           <description>Contains files with packages.</description>
107           <file name="list" type="symbolic">
108             <description>File which contains the name of packages. On top of file the special
109             keywords '--reinstall' and '--can-fail' are possible.</description>
110           </file>
111         </dir>
112
113         <dir name="pubkeys" type="fixed">
114           <description>Directory with GPG pubkeys which are used to sign the packages of this
115           distribution.</description>
116         </dir>
117
118         <dir name="apt" type="fixed">
119           <description>Default content of the /etc/apt/ directory.</description>
120         </dir>
121
122         <dir name="rpm" type="fixed">
123           <description>Default content of the /etc/rpm directory.</description>
124         </dir>
125
126         <symlink name="rpmlib">
127           <description>Directory which overrides /usr/lib/rpm.</description>
128         </symlink>
129         
130         <symlink name="execdir">
131           <description>Directory with all executables and libraries which are required for this
132           distribution.</description>
133         </symlink>
134       </dir>
135     </dir> <!-- .distributions -->
136
137     <dir name="vserver-name" type="symbolic">
138       <description>The configuration directory for the vserver vserver-name.</description>
139
140       <file name="hostname">
141         <description>Contains the hostname of the vserver.</description>
142       </file>
143
144       <file name="name">
145         <description>Contains the name of the vserver. When not given, the basename of the directory
146         will be assumed as this name.</description>
147       </file>
148
149       <file name="domainname">
150         <description>The domainname of the vserver.</description>
151       </file>
152
153       <file name="nice">
154         <description>The nice-level on which the vserver will be started.</description>
155       </file>
156
157       <file name="capabilities">
158         <description>Contains per line a capability.</description>
159       </file>
160
161       <file name="shell">
162         <description>Contains the pathname of the shell which will be used by the "vserver ... enter"
163         command.</description>
164       </file>
165
166       <file name="flags">
167         <description>Contains per line a flag.</description>
168       </file>
169
170       <file name="context">
171         <description>Contains the context which shall be used for the vserver.</description>
172       </file>
173
174       <file name="fstab">
175         <description>The fstab file for the vserver.</description>
176       </file>
177       
178       <dir name="apps" type="fixed">
179         <dir name="init" type="fixed">
180           <file name="mtab">
181             <description>The initial-mtab which will be used for the vserver.</description>
182           </file>
183
184           <file name="style">
185             <description>Contains the init-style; possible values are 'sysv', 'plain' and
186             'minit'.</description>
187           </file>
188
189           <file name="runlevel">
190             <description>The start runlevel.</description>
191           </file>
192
193           <file name="runlevel.start">
194             <description>The start runlevel.</description>
195           </file>
196
197           <file name="runlevel.stop">
198             <description>The stop runlevel.</description>
199           </file>
200
201           <file name="killseq">
202             <description>Contains the 'signal [wait signal]*' sequence which is used to stop the
203             vserver.</description>
204           </file>
205
206           <file name="cmd.start">
207             <description>The command which is used to start the vserver. Each option must be on a
208             separate line.</description>
209           </file>
210
211           <file name="cmd.start-sync">
212             <description>The command which is used to wait on the vserver after it has been
213             started. Each option must be on a separate line. This file will be ignored when the
214             'sync' does not exist and the '--sync' option was not used.</description>
215           </file>
216           
217           <file name="cmd.stop">
218             <description>The command which is used to stop the vserver. Each option must be on a
219             separate line.</description>
220           </file>
221
222           <file name="cmd.stop-sync">
223             <description>The command which is used to wait on the vserver after it has been
224             stopped. Each option must be on a separate line. This file will be ignored when the
225             'sync' does not exist and the '--sync' option was not used.</description>
226           </file>
227
228           <file name="cmd.prepare">
229             <description>The command which is used to setup the init-system (e.g. to set the runlevel
230             in the utmp-file). Each option must be on a separate line.</description>
231           </file>
232
233           <file name="sync">
234             <description>Without this file, the 'cmd.*-sync' files will be ignored.</description>
235           </file>
236         </dir>
237       </dir>
238
239       <dir name="scripts" type="fixed">
240         <script name="prepre-start">
241           <description>&init-script-text; &init-prepre-start;</description>
242           &init-scriptlet-params;
243         </script>
244         <dir name="prepre-start.d" type="fixed">
245           <description>&init-dir-text; &init-prepre-start;</description>
246
247           <script name="script">
248             <description>&init-dir-script-text; &init-prepre-start;</description>
249             &init-scriptlet-params;
250           </script>
251         </dir>
252
253         <script name="pre-start">
254           <description>&init-script-text; &init-pre-start;</description>
255           &init-scriptlet-params;
256         </script>
257
258         <dir name="pre-start.d">
259           <description>&init-dir-text; &init-pre-start;</description>
260           
261           <script name="script">
262             <description>&init-dir-script-text; &init-pre-start;</description>
263             &init-scriptlet-params;
264           </script>
265           
266         </dir>
267
268         <script name="post-start">
269           <description>&init-script-text; &init-post-start;</description>
270           &init-scriptlet-params;
271         </script>
272
273         <dir name="post-start.d">
274           <description>&init-dir-text; &init-post-start;</description>
275           
276           <script name="script">
277             <description>&init-dir-script-text; &init-post-start;</description>
278             &init-scriptlet-params;
279           </script>
280         </dir>
281
282         <script name="pre-stop">
283           <description>&init-script-text; &init-pre-stop;</description>
284           &init-scriptlet-params;
285         </script>
286
287         <dir name="pre-stop.d" type="fixed">
288           <description>&init-dir-text; &init-pre-stop;</description>
289           <script name="script">
290             <description>&init-dir-script-text; &init-pre-stop;</description>
291             &init-scriptlet-params;
292           </script>
293         </dir>
294
295         <script name="post-stop">
296           <description>&init-script-text; &init-post-stop;</description>
297           &init-scriptlet-params;
298         </script>
299
300         <dir name="post-stop.d" type="fixed">
301           <description>&init-dir-text; &init-post-stop;</description>
302           <script name="script">
303             <description>&init-dir-script-text; &init-post-stop;</description>
304             &init-scriptlet-params;
305           </script>
306         </dir>
307
308         <script name="postpost-stop">
309           <description>&init-script-text; &init-postpost-stop;</description>
310           &init-scriptlet-params;
311         </script>
312
313         <dir name="postpost-stop.d" type="fixed">
314           <description>&init-dir-text; &init-postpost-stop;</description>
315           <script name="script">
316             <description>&init-dir-script-text; &init-postpost-stop;</description>
317             &init-scriptlet-params;
318           </script>
319         </dir>
320       </dir>
321
322
323       
324       <dir name="interfaces" type="fixed">
325         <file name="bcast">
326           <description>The deafult broadcast address.</description>
327         </file>
328         <file name="dev">
329           <description>The default network-device.</description>
330         </file>
331         <file name="prefix">
332           <description>The default network-prefix.</description>
333         </file>
334         <file name="mask">
335           <description>The default network-mask.</description>
336         </file>
337         <file name="scope">
338           <description>The default scope of the network interfaces.</description>
339         </file>
340
341         <dir name="iface" type="symbolic">
342           <file name="disabled">
343             <description>When this file exists, this interface will be ignored.</description>
344           </file>
345           
346           <file name="ip">
347             <description>The ip which will be assigned to this interface.</description>
348           </file>
349           <file name="bcast">
350             <description>The broadcast address.</description>
351           </file>
352           <file name="dev">
353             <description>The network-device.</description>
354           </file>
355           <file name="prefix">
356             <description>The network-prefix.</description>
357           </file>
358           <file name="mask">
359             <description>The network-mask.</description>
360           </file>
361           <file name="scope">
362             <description>The scope of the network interfaces.</description>
363           </file>
364           <file name="name">
365             <description>When this file exists, the interface will be named.</description>
366           </file>
367         </dir>
368       </dir>
369
370       <dir name="ulimits" type="fixed">
371         <description>A directory with ulimits.</description>
372
373         <file name="resource" type="symbolic">
374           <description>A file which contains the hard- and soft-limit of the given resource in the
375           first line. The special keyword 'inf' is recognized.</description>
376         </file>
377
378         <file name="resource.hard" type="symbolic">
379           <description>A file which contains the hard- of the given resource in the first line. The
380           special keyword 'inf' is recognized.</description>
381         </file>
382
383         <file name="resource.soft" type="symbolic">
384           <description>A file which contains the soft- of the given resource in the first line. The
385           special keyword 'inf' is recognized.</description>
386         </file>
387       </dir>
388     </dir>
389   </topleveldir>
390 </cfgdirdoc>
391
392
393 <!--
394 !! Local Variables:
395 !! fill-column: 100
396 !! End:
397 -->