X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=doc%2Fconfiguration.xml;h=7cfe4ca1d23fc48c1d112d48423eaf7a58fbcfd5;hb=95e2774070e989fe9cf9f48dae5fa054e55e2a3e;hp=04b5ecf97556bc69f2f539a9df0403d0041d848e;hpb=2822ba293eb308225c50d346930c47bf98d9927b;p=util-vserver.git diff --git a/doc/configuration.xml b/doc/configuration.xml index 04b5ecf..7cfe4ca 100644 --- a/doc/configuration.xml +++ b/doc/configuration.xml @@ -1,6 +1,6 @@ - + @@ -18,6 +18,13 @@ A link to the default vserver rootdirectory. + + /var/cache/vservers + +A link to the directory which will hold cached information about +vservers. + + @@ -30,6 +37,20 @@ the 'barrier' attribute. Else, common chroot(2) exploits are possible. + + +Disable namespace cleanup globally. It can be overridden for a single vserver +by setting the namespace-cleanup flag +there. + + + + + +List of paths to skip during namespace cleanup. + + + Path of the vserver run reverse directory. This directory contains @@ -41,12 +62,40 @@ NOTE: this link exists in 0.30.202+ only; in previous versions it was a vserver specific setting. + + + +Contains the pathname of the shell which will be used by the "vserver +... enter" command. Can be overridden by the +per-guest shell. + + + + + +The default fstab file to put in newly built guests. + + + + + +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 context.next. + + + + + +The context id to use for the next guest created by "vserver ... build". + + /vservers/.pkg - + The default apt.conf which is going to be used. It is overridden by distribution specific configuration file. @@ -68,6 +117,33 @@ from this uri and install it at a temporary place. + + + 'x' is an arbitrary name, replace it with e.g. device names + + When this file exists, the device can be opened + + + When this file exists, the device can be created (if the guest has CAP_MKNOD) + + + +When this file exists, target will +have to exist as well and opening the device will in fact open the target device + + + + This file will let you specify unimplemented flags manually + + + Contains the name of a device node + + + Contains the device node of the target node to open instead of the device when remap is set + + + + @@ -80,7 +156,7 @@ is invoked from the kernel. This should point somewhere e.g. into -See vshelper/action. +See vshelper/action. @@ -110,7 +186,7 @@ skipped. -A list of files which will be made visibly by vprocunhide. Wildcards are +A list of files which will be made visible by vprocunhide. Wildcards are allowed and anything ending in '/' will be processed recursively. When this file exists, it overrides the defaults in SYSDEFAULTDIR/vprocunhide-files. The entries there must be absolute filenames inclusive the leading '/proc'. @@ -125,6 +201,13 @@ A symlink to the TTY device where input/output will be redirected from/to at startup via initscript. + + + +The environment to set when starting guests. Contains one VAR=VAL +pair per line. + + @@ -168,6 +251,59 @@ operation will fail. Most tools assume 'on' as the default value. + + + + +When this file exists, vlogin isn't used on vserver <guest> enter. + + + + + + + +A list of default options to supply to vserver ... build, one option per line. + + + + + + + + +When this file exists, the steps which setup and destroy a VLAN +interface will be executed. + + + + + + This directory contains some files which will be copied to the guests during build. + + The default /etc/hosts file. + + + The default /etc/nsswitch.conf file. + + + The default /etc/krb5.conf file. + + + The default /etc/krb.conf file. + + + The default /etc/krb.realms file. + + + The default /etc/ldap.conf file. + + + The default /etc/localtime file. + + + The default /etc/resolv.conf file. + @@ -208,9 +344,9 @@ Script which will be executed before packages will be installed. The configuration directory of the vserver which is going to be set up. - + -The pathname of the vserver binary. +The pathname of the util-vserver-vars file. @@ -227,7 +363,7 @@ The configuration directory of the vserver which is going to be set up. -The pathname of the vserver binary. +The pathname of the util-vserver-vars file. @@ -276,6 +412,11 @@ this distribution. + + +Symlink to the default template for this distribution. + + @@ -283,10 +424,18 @@ this distribution. The configuration directory for the vserver vserver-name. + + + ../.defaults/cachebase/VSERVERNAME + +Path of the storage area for cached information about this vserver. + + + ../.defaults/vdirbase/VSERVERNAME -Path of the vserver root directory +Path of the vserver root directory. @@ -299,16 +448,22 @@ the vserver is stopped, this can be a dangling symlink. -[experimental; name is subject of possible change] Contains the system capabilities. See -lib/bcaps-v13.c +Contains the system capabilities. See +lib/bcaps-v13.c for possible values. -[experimental; name is subject of possible change] Contains the -context capabilities. See lib/ccaps-v13.c +Contains the context capabilities. See lib/ccaps-v13.c +for possible values. + + + + +Contains the network capabilities. See lib/ncaps-net.c for possible values. @@ -329,9 +484,24 @@ the 'barrier' attribute. Else, common chroot(2) exploits are possible. + + +Overrides the global nonamespace-cleanup flag and enables +namespace cleanup for the current vserver. + + + + + +List of paths to skip during namespace cleanup. This overrides the global +namespace-cleanup-skip +file. + + + -[experimental; name is subject of possible change] Contains the +[deprecated; use sched instead] Contains the scheduler parameters, one per line. The Hard CPU limit uses a mechanism called a Token Bucket. the @@ -342,6 +512,9 @@ 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. + +See the Linux +VServer Wiki for more information about this file. @@ -394,7 +567,7 @@ Contains per line a capability. This file is used for the 2.4 kernel only; for 2.6 use bcapabilities. - + Contains the pathname of the shell which will be used by the "vserver ... enter" command. @@ -411,9 +584,10 @@ values. Contains per line a flag. See lib/cflags-v13.c +url="http://svn.linux-vserver.org/svn/util-vserver/trunk/lib/cflags-v13.c">lib/cflags-v13.c for possible values. + + + + +Contains a network flag per line. See lib/nflags-net.c +for possible values. + -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. + + +Contains the network context id which shall be used for the vserver. Valid range is 2 through 49151. + + + + +Contains the filesystem tag which shall be used for the vserver. Valid range is 2 through 49151. + + The fstab file for the vserver. Entries in this file will be mounted @@ -469,7 +661,7 @@ the 'fstab' file should be used. 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 chbind <options> mount .... See fstab also. @@ -491,7 +683,6 @@ Contains the init-style. - @@ -581,6 +772,13 @@ will be stopped before its dependencies. Content of this file are vserver ids (one name per line). + + + +The environment to set when starting the guest. Contains one VAR=VAL +pair per line. + + @@ -588,12 +786,12 @@ vserver ids (one name per line). 30 The timeout in seconds which is used when synchronising vserver -startup/shutdown with the vshelper. When no set, 30 seconds will be +startup/shutdown with the vshelper. When not set, 30 seconds will be assumed. - + restart The action which is going to be executed when a vshelper event @@ -650,7 +848,7 @@ skipped. -See vshelper/action. +See vshelper/action. @@ -729,16 +927,16 @@ environment variable must be set by one of the in-shellcontext scripts (the non-executable ones). - + -The scriptlet which will be executed before the network-interfaces are -enabled and the directories are mounted. Before executing the script, -the configuration directory will be made the working directory. +The scriptlet which will be executed before the root filesystem is mounted and +the configuration has been loaded. Before executing the script, the +configuration directory will be made the working directory. - + -The configuration directory of the current vserver. +The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). @@ -746,24 +944,60 @@ The configuration directory of the current vserver. The name of the current vserver. + + + + +Repository of initialize like scripts. Before executing the script, +the configuration directory will be made the working directory. + + + See initialize. + + + +The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). + + + + +The name of the current vserver. + + + + + + + + +The scriptlet which will be executed before the network-interfaces are +enabled and the directories are mounted. Before executing the script, +the configuration directory will be made the working directory. + + The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). + + +The name of the current vserver. + + Repository of prepre-start like scripts. Before executing the script, the configuration directory will be made the working directory. - + See prepre-start. - + -The configuration directory of the current vserver. +The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). @@ -771,11 +1005,6 @@ The configuration directory of the current vserver. The name of the current vserver. - - -The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). - - @@ -788,9 +1017,9 @@ been started. Before executing the script, the vserver root directory will be made the working directory. - + -The configuration directory of the current vserver. +The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). @@ -798,32 +1027,24 @@ The configuration directory of the current vserver. The name of the current vserver. - - -The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). - - Repository of pre-start like scripts. Before executing these scripts, the vserver root directory will be made the working directory. - + See pre-start. - + -The configuration directory of the current vserver. +The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). - The name of the current vserver. - - -The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). +The name of the current vserver. @@ -838,17 +1059,16 @@ started. Before executing the script, the vserver root directory will be made the working directory. - - The configuration directory of the current vserver. - - - The name of the current vserver. - The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). + + +The name of the current vserver. + + @@ -859,17 +1079,16 @@ the vserver root directory will be made the working directory. See post-start. - - The configuration directory of the current vserver. - - - The name of the current vserver. - The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). + + +The name of the current vserver. + + @@ -882,38 +1101,36 @@ stopped. Before executing the script, the vserver root directory will be made the working directory. - - The configuration directory of the current vserver. - - - The name of the current vserver. - The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). + + +The name of the current vserver. + + Repository of pre-stop like scripts. Before executing the script, the vserver root directory will be made the working directory. - + See pre-stop. - - The configuration directory of the current vserver. - - - The name of the current vserver. - The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). + + +The name of the current vserver. + + @@ -926,17 +1143,16 @@ interfaces disabled. Before executing the script, the vserver root directory will be made the working directory. - - The configuration directory of the current vserver. - - - The name of the current vserver. - The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). + + +The name of the current vserver. + + @@ -947,17 +1163,16 @@ vserver root directory will be made the working directory. See post-stop. - - The configuration directory of the current vserver. - - - The name of the current vserver. - The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). + + +The name of the current vserver. + + @@ -969,17 +1184,16 @@ completely. Before executing the script, the vserver root directory will be made the working directory. - - The configuration directory of the current vserver. - - - The name of the current vserver. - The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). + + +The name of the current vserver. + + @@ -990,17 +1204,16 @@ the vserver root directory will be made the working directory. See postpost-stop. - - The configuration directory of the current vserver. - - - The name of the current vserver. - The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). + + +The name of the current vserver. + + @@ -1008,10 +1221,13 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). - The default broadcast address. + The guest's broadcast address. + + + The guest's loopback address. - The default network device. + The default network device. See iface/dev for more information. The default network prefix-length. @@ -1022,6 +1238,20 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). The default scope of the network interfaces. + + +When this file exists, the steps which setup and destroy a VLAN +interface will be executed for all interfaces of this vserver. + + + + +When this file exists, the steps which setup and destroy a VLAN +interface will be skipped. This overrides the global +vlandev setting for +this vserver. + + @@ -1036,13 +1266,10 @@ numbers like '00' are good names for these directories. - The ip which will be assigned to this interface. - - - The broadcast address. + The IP address which will be assigned to this interface. - - The network device. + + The network device. When this is specified, the IP address will be assigned and removed when starting and stopping the guest. The network prefix-length. @@ -1068,30 +1295,43 @@ already. This can be used to assign primary interfaces which are created by the host or another vserver. + + +When this file exists, the steps which setup and destroy a VLAN +interface will be skipped. This will override the global +vlandev and the per-guest +vlandev. + + + + +When this file exists, the steps which setup and destroy a VLAN +interface will be executed. + + A directory with ulimits. Possible resources are cpu, data, fsize, -locks, memlock, nofile, nproc, rss and/or stack. This configuration -will be honored for kernel 2.4 only. - +locks, memlock, nofile, nproc, rss and/or stack. + A file which contains the hard- and soft-limit of the given resource in the first line. The special keyword 'inf' is recognized. - + -A file which contains the hard- of the given resource in the first +A file which contains the hard-limit of the given resource in the first line. The special keyword 'inf' is recognized. - + -A file which contains the soft- of the given resource in the first +A file which contains the soft-limit of the given resource in the first line. The special keyword 'inf' is recognized. @@ -1100,30 +1340,31 @@ line. The special keyword 'inf' is recognized. A directory with resource limits. Possible resources are cpu, fsize, -data, stack, core, rss, nproc, nofile, memlock, as and locks. This +data, stack, core, rss, nproc, nofile, memlock, as, locks, msgqueue, +nsock, openfd, anon, shmem, semary, nsems and dentry. This configuration will be honored for kernel 2.6 only. - + A file which contains the hard- and soft-limit of the given resource in the first line. The special keyword 'inf' is recognized. - + -A file which contains the hard- of the given resource in the first +A file which contains the hard-limit of the given resource in the first line. The special keyword 'inf' is recognized. - + -A file which contains the soft- of the given resource in the first +A file which contains the soft-limit of the given resource in the first line. The special keyword 'inf' is recognized. -A file which contains the guaranted minimum of the given resource in +A file which contains the guaranteed minimum of the given resource in the first line. The special keyword 'inf' is recognized. @@ -1156,5 +1397,121 @@ tools and can *not* be modified. The NIS domainname of the vserver + + + + + The directory to which the limit should be applied + + + The amount of inodes this vserver should be limited to + + + The amount of space this vserver should be limited to (measured in blocks of 1024 bytes) + + + How much space (percentage-wise) should be reserved for the root user + + + + + + + 'x' is an arbitrary name, replace it with e.g. integers + + The sysctl setting + + + The value + + + + + + + The name of the cpuset for this vserver + + + The list of CPUs in this cpuset + + + The list of Memory Nodes in this cpuset + + + Is the CPU assignment exclusive? + + + Is the memory node assignment exclusive? + + + When this file exists, the cpuset will be assumed to exist already + + + + + + The initial amount of tokens to put in the bucket + + + The minimum amount of tokens required to unhold the context + + + The bucket's size + + + Amount of tokens to add each interval + + + The interval between refills of the bucket + + + Bias added to priorities calculated within the guest (result is clamped to -20/+19) + + + Amount of tokens to add each interval2 when advancing idle time + + + The interval between refills of the bucket when advancing idle time + + + When this file exists, advancing idle time is activated + + + This directory contains per-CPU and/or per-bucket specific settings. Remember to set the cpu-id file. All CPUs inherit the global settings. + + The initial amount of tokens to put in the bucket + + + The minimum amount of tokens required to unhold the context + + + The bucket's size + + + Amount of tokens to add each interval + + + The interval between refills of the bucket + + + Bias added to priorities calculated within the guest (result is clamped to -20/+19) + + + Amount of tokens to add each interval2 when advancing idle time + + + The interval between refills of the bucket when advancing idle time + + + When this file exists, advancing idle time is activated + + + The CPU to apply these settings to + + + The bucket to apply these settings to + + +