X-Git-Url: http://git.linux-vserver.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=util-vserver%2Fdoc%2Fconfiguration.xml;h=6e51a7319cce052cf532450aaaa72b539d227a85;hb=fd7d854e6c352ac403d403ce7664e712b41c6fb4;hp=23b9041cf58eda378efd187eabb51bf231cfcc7c;hpb=ac9ef87cc367cbbbf8f27bd27f16f627545d4548;p=util-vserver.git diff --git a/util-vserver/doc/configuration.xml b/util-vserver/doc/configuration.xml index 23b9041..6e51a73 100644 --- a/util-vserver/doc/configuration.xml +++ b/util-vserver/doc/configuration.xml @@ -1,5 +1,5 @@ - + /vservers A link to the default vserver rootdirectory. - + + + + +Disable namespace usage globally. It can be overridden for a single vserver +by setting the namespace flag +there. + +In this mode the /vservers directory must have +the 'barrier' attribute. Else, common chroot(2) exploits are possible. + + + Path of the vserver run reverse directory. This directory contains @@ -45,13 +57,13 @@ distribution specific configuration file. -The Debian mirror to use with the 'debootstrap' program +The Debian mirror to use with the debootstrap program -When the 'debootstrap' package is not installed; fetch it from this -uri and install it at a temporary place. +When the debootstrap package is not installed; fetch it +from this uri and install it at a temporary place. @@ -59,8 +71,9 @@ uri and install it at a temporary place. -The file where output will be logged to when 'vshelper' is invoked -from the kernel. This should point somewhere e.g. into /var/log. +The file where output will be logged to when vshelper +is invoked from the kernel. This should point somewhere e.g. into +/var/log. @@ -78,6 +91,12 @@ When existing, the vshelper functionality will be disabled for all vservers. + + + +When existing, the vshelper execution will be traced. + + @@ -112,6 +131,42 @@ at startup via initscript. Static list of excluded files. + + + +A directory which will be used as the storage place for the +vhashify command. + + + +Points to a directory within the filesystems which are used for the +vservers. There must be not more than one of such a directory per +filesystem. + + + + + SHA1 + The used hash method. + + + + + +When existing, information from packagemanagement will not be used to +create dynamic exclude-lists. + + + + + +When existing, information from packagemanagement will be used to +create dynamic exclude-lists. This option requires that (a known) +packagemanagement is configured for the vserver; else the requested +operation will fail. Most tools assume 'on' as the default value. + + + @@ -123,13 +178,14 @@ at startup via initscript. -The default, yum-related content of the /etc directory. +The default, yum-related content of the /etc +directory. The master yum configuration file. It supports the @YUMETCDIR@, @YUMCACHEDIR@ and @YUMLOGDIR@ placeholder which will be replaced at -'vserver ... build' time. +vserver ... build time. @@ -179,7 +235,7 @@ The pathname of the vserver binary. -Contains files with packages. +Contains files with packagenames. @@ -198,19 +254,19 @@ distribution. -Default content of the /etc/apt/ directory. +Default content of the /etc/apt/ directory. -Default content of the /etc/rpm directory. +Default content of the /etc/rpm directory. -Directory which overrides /usr/lib/rpm. +Directory which overrides /usr/lib/rpm. @@ -241,7 +297,7 @@ 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 @@ -256,6 +312,23 @@ url="http://savannah.nongnu.org/cgi-bin/viewcvs/util-vserver/util-vserver/lib/cc for possible values. + + + +Overrides the global nonamespace flag and enables +namespace usage for the current vserver. + + + + + +Disables namespace usage for the current vserver. + +In this mode the /vservers directory must have +the 'barrier' attribute. Else, common chroot(2) exploits are possible. + + + [experimental; name is subject of possible change] Contains the @@ -271,15 +344,15 @@ hold queue. When the bucket has been refilled to at least M tokens, all on hold processes are rescheduled. - + Amount of tokens append to the bucket each interval. -The intervall between refills of amount 'fill_rate'. This value is -express in ticks. +The intervall between refills of amount fill_rate. This +value is express in ticks. @@ -318,7 +391,7 @@ The nice-level on which the vserver will be started. Contains per line a capability. This file is used for the 2.4 kernel -only; for 2.6 use 'bcapabilities'. +only; for 2.6 use bcapabilities. @@ -327,6 +400,14 @@ Contains the pathname of the shell which will be used by the "vserver ... enter" command. + + +Used to set the personality of the vserver. First line in the file +is the personality-type followed by flags (one item per line). See +/usr/include/linux/personality.h for possible +values. + + Contains per line a flag. See - + The fstab file for the vserver. Entries in this file will be mounted -within the network context of the vserver; this means that mount will -be called as 'chbind <options> mount ...'. Use the 'fstab.local' -file when you do not want this behavior, but in most cases the 'fstab' -file should be used. +within the network context of the host. Use the +fstab.remote file when you want that the +mounting happens in the network context of the vserver. In most cases +the 'fstab' file should be used. - + -The fstab file for the vserver. In opposite to the normal 'fstab' -file, the mounting happens in the local network context. Currently -there is no way to mix entries of both files; 'fstab' will be always -processed before 'fstab.local'. +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 +called as chbind <options> mount .... See +fstab also. @@ -444,8 +525,8 @@ a separate line. The command which is used to wait on the vserver after it has been started. Each option must be on a separate line. This file will be -ignored when the 'sync' does not exist and the '--sync' option was not -used. +ignored when the sync flag does not exist and the +'--sync' option was not used. @@ -460,8 +541,8 @@ a separate line. The command which is used to wait on the vserver after it has been stopped. Each option must be on a separate line. This file will be -ignored when the 'sync' does not exist and the '--sync' option was not -used. +ignored when the sync flag does not exist and the +'--sync' option was not used. @@ -472,7 +553,7 @@ runlevel in the utmp-file). Each option must be on a separate line. - + If this file is not present, all 'cmd.*-sync files will be ignored. @@ -504,29 +585,30 @@ 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 assumed. - 30 + restart -The action which is going to be executed when a vshelper event occurs. The -default value is 'restart', but there can be defined own methods by placing -scripts into the 'vshelper-methods' directories. These scripts are fed with -the same arguments as the 'vshelper' script. +The action which is going to be executed when a vshelper event +occurs. The default value is 'restart', but there can be defined own +methods by placing scripts into the +vshelper-methods directories. These scripts are +fed with the same arguments as the vshelper script. - restart -When existing. these scripts will be executed *instead* of the default -handler defined in 'action'. Their name must match the event which -caused the execution of 'vshelper'; e.g. 'restart' or 'poweroff'. See +When existing, these scripts will be executed *instead* of the default +handler defined in 'action'. Their name must match the event which caused +the execution of vshelper; e.g. 'restart' or 'poweroff'. See the vs_reboot() function in the kernel for more details. @@ -549,6 +631,12 @@ When existing, the vshelper functionality will be disabled for this vserver. + + + +When existing, the vshelper execution will be traced for this vserver. + + @@ -559,7 +647,7 @@ skipped. - + See vshelper/action. @@ -575,10 +663,13 @@ unification. -Static list of excluded files. This list supports an rsync syntax: -when a file is prefixed by '+', it is a candidate for unification; -when there is no prefix or a '-' it will be excluded. Shell-wildcards -are allowed for the filenames. +

Static list of files which are excluded for unification. This list +supports an rsync-like syntax: when a file is prefixed by '+', it is a +candidate for unification; when there is no prefix or a '-' or a '~' it +will be excluded. Shell-wildcards are allowed for the filenames.

+

When used with vcopy, the '~' prefix prevents copying +of the file entirely (e.g. for keyfiles). With this tool, the file will +be copied instead of hardlinked when the '-' prefix is used.

@@ -590,6 +681,42 @@ multiple such symlinks but they must be prefixed by 'refserver.' and will be processed in alphanumerical order.
+ + + +A directory which will be used as the storage place for the +vhashify command. + + + +Points to a directory within the filesystems which are used for the +vservers. There must be not more than one of such a directory per +filesystem. + + + + + SHA1 + The used hash method. + + + + + +When existing, information from packagemanagement will not be used to +create dynamic exclude-lists. + + + + + +When existing, information from packagemanagement will be used to +create dynamic exclude-lists. This option requires that (a known) +packagemanagement is configured for the vserver; else the requested +operation will fail. Most tools assume 'on' as the default value. + + +
@@ -605,7 +732,8 @@ environment variable must be set by one of the in-shellcontext scripts The scriptlet which will be executed before the network-interfaces are -enabled and the directories are mounted." +enabled and the directories are mounted. Before executing the script, +the configuration directory will be made the working directory. @@ -627,7 +755,8 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). -Repository of prepre-start like scripts +Repository of prepre-start like scripts. Before executing the script, +the configuration directory will be made the working directory. See prepre-start. @@ -655,7 +784,8 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). The scriptlet which will be executed after network-interfaces were enabled and the directories mounted, but before the vserver itself has -been started. +been started. Before executing the script, the vserver root directory +will be made the working directory. @@ -677,7 +807,8 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). -Repository of pre-start like scripts +Repository of pre-start like scripts. Before executing these scripts, +the vserver root directory will be made the working directory. See pre-start. @@ -702,7 +833,9 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). -The scriptlet which will be executed after the vserver has been started. +The scriptlet which will be executed after the vserver has been +started. Before executing the script, the vserver root directory +will be made the working directory. @@ -719,7 +852,10 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). - Repository of post-start like scripts + +Repository of post-start like scripts. Before executing these scripts, +the vserver root directory will be made the working directory. + See post-start. @@ -741,7 +877,9 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). -The scriptlet which will be executed before the vserver will be stopped. +The scriptlet which will be executed before the vserver will be +stopped. Before executing the script, the vserver root directory +will be made the working directory. @@ -759,7 +897,8 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). -Repository of pre-stop like scripts +Repository of pre-stop like scripts. Before executing the script, the +vserver root directory will be made the working directory. See pre-stop. @@ -783,7 +922,8 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). The scriptlet which will be executed after the vserver has been stopped, but before the directories will be umounted and the the -interfaces disabled. +interfaces disabled. Before executing the script, the vserver root +directory will be made the working directory. @@ -800,7 +940,10 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). - Repository of post-stop like scripts + +Repository of post-stop like scripts. Before executing the script, the +vserver root directory will be made the working directory. + See post-stop. @@ -822,7 +965,8 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). The scriptlet which will be executed after the vserver has been stopped -completely. +completely. Before executing the script, the vserver root directory +will be made the working directory. @@ -839,7 +983,10 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). - Repository of postpost-stop like scripts + +Repository of postpost-stop like scripts. Before executing the script, +the vserver root directory will be made the working directory. + See postpost-stop. @@ -880,8 +1027,8 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...). 'iface' is an arbitrary name for the interface; the value itself is not important but may be interesting regarding interface-creation and -usage with 'chbind'. Both happens in alphabetical order and numbers -like '00' are good names for these directories. +usage with chbind. Both happens in alphabetical order and +numbers like '00' are good names for these directories. @@ -908,10 +1055,10 @@ like '00' are good names for these directories. -When this file exists, the interface will be named with the text in this -file. Without such an entry, the IP will not be shown by 'ifconfig' but -by 'ip addr ls' only. Such a labeled interface is known as an "alias" -also (e.g. 'eth0:foo'). +When this file exists, the interface will be named with the text in +this file. Without such an entry, the IP will not be shown by +ifconfig but by ip addr ls only. Such +a labeled interface is known as an "alias" also (e.g. 'eth0:foo').