util-vserver 0.30.214
[util-vserver.git] / doc / configuration.html
index 5fced83..793cd14 100644 (file)
             <div class="description">
 A link to the directory which will hold cached information about
 vservers.
+      </div>
+          </li>
+          <li>
+            <span class="boolean" title="/etc/vservers/.defaults/context.dynamic">context.dynamic</span>
+            <br />
+            <div class="description">
+If this file exists, kernel-side dynamic contexts will be used by the "vserver
+... build" command. Otherwise a context will be generated, based on the
+contents of <a class="optionref" href="#context.next">context.next</a>.
+      </div>
+          </li>
+          <li id="context.next">
+            <span class="file" title="/etc/vservers/.defaults/context.next">context.next</span>
+            <br />
+            <div class="description">
+The context id to use for the next guest created by "vserver ... build".
+      </div>
+          </li>
+          <li>
+            <span class="data" title="/etc/vservers/.defaults/fstab">fstab</span>
+            <br />
+            <div class="description">
+The default fstab file to put in newly built guests.
       </div>
           </li>
           <li id="global-namespace-cleanup-skip">
@@ -64,6 +87,15 @@ to VSERVER mapping; Under kernel 2.6 it is unused.
 
 NOTE: this link exists in 0.30.202+ only; in previous versions it was
 a vserver specific setting.
+      </div>
+          </li>
+          <li>
+            <span class="file" title="/etc/vservers/.defaults/shell">shell</span>
+            <br />
+            <div class="description">
+Contains the pathname of the shell which will be used by the "vserver
+... enter" command. Can be overridden by the
+<a class="optionref" href="#shell">per-guest shell</a>.
       </div>
           </li>
           <li>
@@ -75,6 +107,19 @@ a vserver specific setting.
             <span class="directory">/etc/vservers/<span class="">.defaults</span>/<span class="">apps</span></span>
             <br />
             <ul>
+              <li>
+                <span class="directory">/etc/vservers/<span class="">.defaults</span>/<span class="">apps</span>/<span class="">build</span></span>
+                <br />
+                <ul>
+                  <li>
+                    <span class="list" title="/etc/vservers/.defaults/apps/build/options">options</span>
+                    <br />
+                    <div class="description">
+A list of default options to supply to vserver ... build, one option per line.
+          </div>
+                  </li>
+                </ul>
+              </li>
               <li>
                 <span class="directory">/etc/vservers/<span class="">.defaults</span>/<span class="">apps</span>/<span class="">debootstrap</span></span>
                 <br />
@@ -135,6 +180,52 @@ distribution specific configuration file.
                   </li>
                 </ul>
               </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="">.defaults</span>/<span class="">apps</span>/<span class="">vdevmap</span></span>
+                <br />
+                <ul>
+                  <li>
+                    <span class="directory">/etc/vservers/<span class="">.defaults</span>/<span class="">apps</span>/<span class="">vdevmap</span>/<span class="sybmolic">x</span></span>
+                    <br />
+                    <div class="description">'x' is an arbitrary name, replace it with e.g. device names</div>
+                    <ul>
+                      <li>
+                        <span class="boolean" title="/etc/vservers/.defaults/apps/vdevmap/x/create">create</span>
+                        <br />
+                        <div class="description">When this file exists, the device can be created (if the guest has <a class="optionref" href="#bcapabilities">CAP_MKNOD</a>)</div>
+                      </li>
+                      <li>
+                        <span class="file" title="/etc/vservers/.defaults/apps/vdevmap/x/device">device</span>
+                        <br />
+                        <div class="description">Contains the name of a device node</div>
+                      </li>
+                      <li>
+                        <span class="file" title="/etc/vservers/.defaults/apps/vdevmap/x/flags">flags</span>
+                        <br />
+                        <div class="description">This file will let you specify unimplemented flags manually</div>
+                      </li>
+                      <li>
+                        <span class="boolean" title="/etc/vservers/.defaults/apps/vdevmap/x/open">open</span>
+                        <br />
+                        <div class="description">When this file exists, the device can be opened</div>
+                      </li>
+                      <li id="vdevmap-remap">
+                        <span class="boolean" title="/etc/vservers/.defaults/apps/vdevmap/x/remap">remap</span>
+                        <br />
+                        <div class="description">
+When this file exists, <a class="optionref" href="#vdevmap-target">target</a> will
+have to exist as well and opening the device will in fact open the target device
+            </div>
+                      </li>
+                      <li id="vdevmap-target">
+                        <span class="file" title="/etc/vservers/.defaults/apps/vdevmap/x/target">target</span>
+                        <br />
+                        <div class="description">Contains the device node of the target node to open instead of the device when <a class="optionref" href="#vdevmap-remap">remap</a> is set</div>
+                      </li>
+                    </ul>
+                  </li>
+                </ul>
+              </li>
               <li>
                 <span class="directory">/etc/vservers/<span class="">.defaults</span>/<span class="">apps</span>/<span class="">vlogin</span></span>
                 <br />
@@ -208,7 +299,7 @@ skipped.
                         <span class="script" title="/etc/vservers/.defaults/apps/vshelper/vshelper-methods/$handler">handler</span>
                         <br />
                         <div class="description">
-See vshelper/action.
+See <a class="optionref" href="#vshelper-action">vshelper/action</a>.
             </div>
                       </li>
                     </ul>
@@ -270,6 +361,53 @@ filesystem.
               </li>
             </ul>
           </li>
+          <li>
+            <span class="directory">/etc/vservers/<span class="">.defaults</span>/<span class="">files</span></span>
+            <br />
+            <div class="description">This directory contains some files which will be copied to the guests during build.</div>
+            <ul>
+              <li>
+                <span class="data" title="/etc/vservers/.defaults/files/hosts">hosts</span>
+                <br />
+                <div class="description">The default /etc/hosts file.</div>
+              </li>
+              <li>
+                <span class="data" title="/etc/vservers/.defaults/files/krb.conf">krb.conf</span>
+                <br />
+                <div class="description">The default /etc/krb.conf file.</div>
+              </li>
+              <li>
+                <span class="data" title="/etc/vservers/.defaults/files/krb.realms">krb.realms</span>
+                <br />
+                <div class="description">The default /etc/krb.realms file.</div>
+              </li>
+              <li>
+                <span class="data" title="/etc/vservers/.defaults/files/krb5.conf">krb5.conf</span>
+                <br />
+                <div class="description">The default /etc/krb5.conf file.</div>
+              </li>
+              <li>
+                <span class="data" title="/etc/vservers/.defaults/files/ldap.conf">ldap.conf</span>
+                <br />
+                <div class="description">The default /etc/ldap.conf file.</div>
+              </li>
+              <li>
+                <span class="data" title="/etc/vservers/.defaults/files/localtime">localtime</span>
+                <br />
+                <div class="description">The default /etc/localtime file.</div>
+              </li>
+              <li>
+                <span class="data" title="/etc/vservers/.defaults/files/nsswitch.conf">nsswitch.conf</span>
+                <br />
+                <div class="description">The default /etc/nsswitch.conf file.</div>
+              </li>
+              <li>
+                <span class="data" title="/etc/vservers/.defaults/files/resolv.conf">resolv.conf</span>
+                <br />
+                <div class="description">The default /etc/resolv.conf file.</div>
+              </li>
+            </ul>
+          </li>
           <li>
             <span class="directory">/etc/vservers/<span class="">.defaults</span>/<span class="fixed">init</span></span>
             <br />
@@ -301,6 +439,13 @@ interface will be executed.
         <span class="directory">/etc/vservers/<span class="">.distributions</span></span>
         <br />
         <ul>
+          <li>
+            <span class="symlink" title="/etc/vservers/.distributions/template">template</span>
+            <br />
+            <div class="description">
+Symlink to the default template for this distribution.
+      </div>
+          </li>
           <li>
             <span class="directory">/etc/vservers/<span class="">.distributions</span>/<span class="symbolic">dist</span></span>
             <br />
@@ -457,7 +602,7 @@ for possible values.
             <span class="file" title="/etc/vservers/$vserver-name/context">context</span>
             <br />
             <div class="description">
-Contains the context which shall be used for the vserver.
+Contains the context id which shall be used for the vserver. Valid range is 2 through 49151.
         </div>
           </li>
           <li>
@@ -484,7 +629,7 @@ the 'fstab' file should be used.
             <br />
             <div class="description">
 The fstab file for the vserver. Entries in this file will be mounted
-within the network context of the host; this means that mount will be
+within the network context of the guest; this means that mount will be
 called as <code class="command">chbind &lt;options&gt; mount ...</code>. See
 <a class="optionref" href="#fstab">fstab</a> also.
       </div>
@@ -528,6 +673,13 @@ file.
             <div class="description">
 Contains the network capabilities. See <a href="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/ncaps-net.c">lib/ncaps-net.c</a>
 for possible values.
+      </div>
+          </li>
+          <li>
+            <span class="file" title="/etc/vservers/$vserver-name/ncontext">ncontext</span>
+            <br />
+            <div class="description">
+Contains the network context id which shall be used for the vserver. Valid range is 2 through 49151.
       </div>
           </li>
           <li>
@@ -593,12 +745,19 @@ See the <a href="http://linux-vserver.org/Scheduler+Parameters">Linux
 VServer Wiki</a> for more information about this file.
       </div>
           </li>
-          <li>
+          <li id="shell">
             <span class="file" title="/etc/vservers/$vserver-name/shell">shell</span>
             <br />
             <div class="description">
 Contains the pathname of the shell which will be used by the "vserver
 ... enter" command.
+      </div>
+          </li>
+          <li>
+            <span class="file" title="/etc/vservers/$vserver-name/tag">tag</span>
+            <br />
+            <div class="description">
+Contains the filesystem tag which shall be used for the vserver. Valid range is 2 through 49151.
       </div>
           </li>
           <li>
@@ -744,7 +903,7 @@ from/to at startup via initscript.
                 <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">apps</span>/<span class="">vshelper</span></span>
                 <br />
                 <ul>
-                  <li>
+                  <li id="vshelper-action">
                     <span class="file" title="/etc/vservers/$vserver-name/apps/vshelper/action">action</span>
                     <br />
                     <div class="description">
@@ -807,7 +966,7 @@ skipped.
                     <span class="script" title="/etc/vservers/$vserver-name/apps/vshelper-methods/$handler">handler</span>
                     <br />
                     <div class="description">
-See vshelper/action.
+See <a class="optionref" href="#vshelper-action">vshelper/action</a>.
           </div>
                   </li>
                 </ul>
@@ -964,12 +1123,17 @@ filesystem.
               <li>
                 <span class="file" title="/etc/vservers/$vserver-name/interfaces/bcast">bcast</span>
                 <br />
-                <div class="description">The default broadcast address.</div>
+                <div class="description">The guest's broadcast address.</div>
               </li>
               <li>
                 <span class="file" title="/etc/vservers/$vserver-name/interfaces/dev">dev</span>
                 <br />
-                <div class="description">The default network device.</div>
+                <div class="description">The default network device. See <a class="optionref" href="#per-if-dev">iface/dev</a> for more information.</div>
+              </li>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/interfaces/lback">lback</span>
+                <br />
+                <div class="description">The guest's loopback address.</div>
               </li>
               <li>
                 <span class="file" title="/etc/vservers/$vserver-name/interfaces/mask">mask</span>
@@ -1014,15 +1178,10 @@ usage with <code class="tool">chbind</code>. Both happens in alphabetical order
 numbers like '00' are good names for these directories.
         </div>
                 <ul>
-                  <li>
-                    <span class="file" title="/etc/vservers/$vserver-name/interfaces/$iface/bcast">bcast</span>
-                    <br />
-                    <div class="description">The broadcast address.</div>
-                  </li>
-                  <li>
+                  <li id="per-if-dev">
                     <span class="file" title="/etc/vservers/$vserver-name/interfaces/$iface/dev">dev</span>
                     <br />
-                    <div class="description">The network device.</div>
+                    <div class="description">The network device. When this is specified, the IP address will be assigned and removed when starting and stopping the guest.</div>
                   </li>
                   <li>
                     <span class="boolean" title="/etc/vservers/$vserver-name/interfaces/$iface/disabled">disabled</span>
@@ -1032,7 +1191,7 @@ numbers like '00' are good names for these directories.
                   <li>
                     <span class="file" title="/etc/vservers/$vserver-name/interfaces/$iface/ip">ip</span>
                     <br />
-                    <div class="description">The ip which will be assigned to this interface.</div>
+                    <div class="description">The IP address which will be assigned to this interface.</div>
                   </li>
                   <li>
                     <span class="file" title="/etc/vservers/$vserver-name/interfaces/$iface/mask">mask</span>
@@ -1430,6 +1589,29 @@ the configuration directory will be made the working directory.
               </li>
             </ul>
           </li>
+          <li>
+            <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">sysctl</span></span>
+            <br />
+            <ul>
+              <li>
+                <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">sysctl</span>/<span class="symbolic">x</span></span>
+                <br />
+                <div class="description">'x' is an arbitrary name, replace it with e.g. integers</div>
+                <ul>
+                  <li>
+                    <span class="file" title="/etc/vservers/$vserver-name/sysctl/$x/setting">setting</span>
+                    <br />
+                    <div class="description">The sysctl setting</div>
+                  </li>
+                  <li>
+                    <span class="file" title="/etc/vservers/$vserver-name/sysctl/$x/value">value</span>
+                    <br />
+                    <div class="description">The value</div>
+                  </li>
+                </ul>
+              </li>
+            </ul>
+          </li>
           <li>
             <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">ulimits</span></span>
             <br />