X-Git-Url: http://git.linux-vserver.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=util-vserver%2Fdoc%2Fconfiguration.xml;h=8866b7a4d0058369cff13b1c063a9911d3293203;hb=faa778968d1a7dfeaebc9fe4b847e691dc62fd15;hp=86d92416cdbcd336f0a94ded788fe6265dce02b4;hpb=6840e9b8b7bfafae69c91a262fafca7eeae2bb59;p=util-vserver.git diff --git a/util-vserver/doc/configuration.xml b/util-vserver/doc/configuration.xml index 86d9241..8866b7a 100644 --- a/util-vserver/doc/configuration.xml +++ b/util-vserver/doc/configuration.xml @@ -1,5 +1,5 @@ - + A link to the default vserver rootdirectory. + + /var/cache/vservers + +A link to the directory which will hold cached information about +vservers. + + - + -Disable namespace usage globally. It can be overridden for a single -vserver by setting the 'namespace' flag there. +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. +In this mode the /vservers directory must have +the 'barrier' attribute. Else, common chroot(2) exploits are possible. @@ -56,13 +64,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. @@ -70,8 +78,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. @@ -129,6 +138,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. + + + @@ -140,13 +185,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. @@ -196,7 +242,7 @@ The pathname of the vserver binary. -Contains files with packages. +Contains files with packagenames. @@ -215,19 +261,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. @@ -244,8 +290,16 @@ 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 @@ -258,7 +312,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 @@ -274,10 +328,10 @@ for possible values. - + -Overrides the global 'nonamespace' flag and enables namespace usage -for the current vserver. +Overrides the global nonamespace flag and enables +namespace usage for the current vserver. @@ -285,8 +339,8 @@ 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. +In this mode the /vservers directory must have +the 'barrier' attribute. Else, common chroot(2) exploits are possible. @@ -303,17 +357,20 @@ 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. - + 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. @@ -352,7 +409,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. @@ -361,12 +418,21 @@ 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 lib/cflags-v13.c for possible values. + Contains the context which shall be used for the vserver. - + 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. @@ -478,8 +545,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. @@ -494,8 +561,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. @@ -506,7 +573,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. @@ -538,29 +605,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. @@ -599,7 +667,7 @@ skipped. - + See vshelper/action. @@ -615,10 +683,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.

@@ -630,6 +701,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. + + +
@@ -645,7 +752,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. @@ -667,7 +775,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. @@ -695,7 +804,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. @@ -717,7 +827,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. @@ -742,7 +853,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. @@ -759,7 +872,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. @@ -781,7 +897,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. @@ -799,7 +917,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. @@ -823,7 +942,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. @@ -840,7 +960,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. @@ -862,7 +985,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. @@ -879,7 +1003,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. @@ -920,8 +1047,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. @@ -948,10 +1075,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'). @@ -961,6 +1088,13 @@ 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 flag should be set when a VLAN +interface is used by multiple vservers or by the host. + + @@ -1049,5 +1183,22 @@ 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 + + +