documented vdir, run, run.rev (provided by Olivier Poitrey)
authorEnrico Scholz <enrico.scholz@informatik.tu-chemnitz.de>
Thu, 8 Jul 2004 11:44:19 +0000 (11:44 +0000)
committerEnrico Scholz <enrico.scholz@informatik.tu-chemnitz.de>
Thu, 8 Jul 2004 11:44:19 +0000 (11:44 +0000)
added some links about [bc]capabilities and flags
added more scheduler doc (provided by Olivier Poitrey)
added some comments about 2.4 vs. 2.6 at rlimits/ulimits
added doc about rlimit's 'min' setting

git-svn-id: http://svn.linux-vserver.org/svn/util-vserver/trunk@1645 94cd875c-1c1d-0410-91d2-eb244daf1a30

util-vserver/doc/configuration.xml

index 9138ca2..48af8e0 100644 (file)
   </link>
   
   <collection name="apps">
-    <collection name="vunify">
-                  <link name="logfile">
-                   <description>
-                    The file where output will be logged to when 'vshelper' is invoked from the
-                    kernel. This should point somewhere e.g. into /var/log.
-                   </description>
-                 </link>
-
-    </collection>
    <collection name="pkgmgmt">
     <link name="base">
      <default>/vservers/.pkg</default>
    The configuration directory for the vserver vserver-name.
   </description>
   
+  <link name="vdir">
+   <description>
+    Path of the vserver root directory
+   </description>
+  </link>
+
+  <link name="run">
+   <description>
+    Path of the vserver run directory
+   </description>
+  </link>
+
+  <link name="run.rev">
+   <description>
+    Path of the vserver run reverse directory
+   </description>
+  </link>
+  
   <list name="bcapabilities">
    <description>
-    [experimental; name is subject of possible change] Contains the system capabilities.
+    [experimental; name is subject of possible change] Contains the system capabilities. See
+    <ulink url="http://savannah.nongnu.org/cgi-bin/viewcvs/util-vserver/util-vserver/lib/bcaps-v13.c?rev=HEAD">lib/bcaps-v13.c</ulink>
+    for possible values.
    </description>
   </list>
   <list name="ccapabilities">
    <description>
-    [experimental; name is subject of possible change] Contains the context capabilities.
+    [experimental; name is subject of possible change] Contains the context capabilities. See
+    <ulink url="http://savannah.nongnu.org/cgi-bin/viewcvs/util-vserver/util-vserver/lib/ccaps-v13.c?rev=HEAD">lib/ccaps-v13.c</ulink>
+    for possible values.
    </description>
   </list>
   <hash name="schedule">
    <description>
     [experimental; name is subject of possible change] Contains the scheduler parameters, 
     one per line.
+    
+    The Hard CPU limit uses a mechanism called a Token Bucket.
+    the concept is simple: you have a bucket of a certain size
+    which is filled with a specified amount R of tokens each
+    interval T until the maximum is reached (excess tokens
+    are spilled). At each timer tick, a running process consumes
+    one token from the bucket, unless the bucket is empty. If the
+    bucket is empty the process is put in the hold queue. When the
+    bucket has been refilled to at least M tokens, all on hold 
+    processes are rescheduled.
    </description>
    <keys>
     <key name="fill-rate">
      <description>
+      Amount of tokens append to the bucket each interval.
      </description>
     </key>
     <key name="interval">
      <description>
+      The intervall between refills of amount 'fill_rate'. This value is express in ticks.
      </description>
     </key>
     <key name="tokens">
      <description>
+      Initial bucket contents.
      </description>
     </key>
      <key name="tokens-min">
      <description>
+      The minimum amount of tokens required to unhold processes
      </description>
     </key>
     <key name="tokens-max">
      <description>
+      The bucket size.
      </description>
     </key>
     <key name="cpu-mask">
      <description>
+      Unused at the moment.
      </description>
     </key>
    </keys>
   </scalar>
   <list name="flags">
    <description>
-    Contains per line a flag.
+    Contains per line a flag. See
+    <ulink url="http://savannah.nongnu.org/cgi-bin/viewcvs/util-vserver/util-vserver/lib/cflags-v13.c?rev=HEAD">lib/cflags-v13.c</ulink>
+    for possible values.
    </description>
    <elements>
     <element name="fakeinit">
                    </description>
                  </boolean>
                                                                                                                                          
+    <link name="logfile">
+      <description>
+       The file where output will be logged to when 'vshelper' is invoked from the
+       kernel. This should point somewhere e.g. into /var/log.
+      </description>
+    </link>
    </collection>
    
    <collection name="vshelper-methods">
                  </scalar>
                  <boolean name="nodev">
                   <description>
-                   When this file exists, the interface will be assumed to exist already. A
-                   former name for this flag was 'only_ip' which is deprecated now.
+                   When this file exists, the interface will be assumed to exist already.
                   </description>
                  </boolean>
    </collection>
   <collection name="ulimits">
                        <description>
                         A directory with ulimits. Possible resources are cpu, data, fsize, locks,
-                        memlock, nofile, nproc, rss and/or stack.
+                        memlock, nofile, nproc, rss and/or stack. This configuration will be honored
+                         for kernel 2.4 only.
                        </description>                                                                                                                 
                        <scalar name="resource" type="symbolic">
                          <description>
  
   <collection name="rlimits">
    <description>
-                        A directory with ulimits. Possible resources are cpu, data, fsize, locks,
-                        memlock, nofile, nproc, rss and/or stack.
+                        A directory with resource limits. Possible resources are cpu, data, fsize, locks,
+                        memlock, nofile, nproc, rss and/or stack. This configuration will be honored
+                         for kernel 2.6 only.
                        </description>                                                                                                                 
                        <scalar name="resource" type="symbolic">
                          <description>
                           special keyword 'inf' is recognized.
                          </description>
                        </scalar>
+                       <scalar name="resource.min" type="symbolic">
+                         <description>
+                          A file which contains the guaranted minimum of the given resource in the first line. The
+                          special keyword 'inf' is recognized.
+                         </description>
+                       </scalar>
   </collection>
   
   <collection name="uts">