X-Git-Url: http://git.linux-vserver.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=util-vserver%2Fdoc%2Fconfiguration.xml;h=948afa4b0778a35f77bf740d16550ae8220c1d90;hb=ad8bbbc806a25d166b211b211af6465fc424353e;hp=af70f8956d8ef30d7ae899c9b94add61a7018f6f;hpb=0c2e244062d7572fdca516c3028c6ee1f57a83b1;p=util-vserver.git diff --git a/util-vserver/doc/configuration.xml b/util-vserver/doc/configuration.xml index af70f89..948afa4 100644 --- a/util-vserver/doc/configuration.xml +++ b/util-vserver/doc/configuration.xml @@ -1,522 +1,877 @@ - - - - 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 base configuration directory. - - - - - Default mtab-file - - - - - - /vservers - - - - - - - /vservers/.pkg - - - - The default apt.conf which is going to be used. It is overridden by - distribution specific configuration file. - - - - - - The Debian mirror which is used for 'debootstrap'. - - - - When the 'debootstrap' package is not installed; fetch it from this uri and - install it at a temporary place. - - - - - - A list of files which will be made visibly 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'. - - - - - - A symlink to the TTY device where input/output will be redirected from/to - at startup via initscript. - - - - - - Static list of excluded files. - - - - - - - - - - - - - The default apt.conf which is going to be used. It overrides the apt.conf - from CONFDIR/.defaults/apps/pkgmgmt. - - - - - - - - Contains files with packages. - - File which contains the name of packages. On top of file the special - keywords '--reinstall' and '--can-fail' are possible. - - - - - Directory with GPG pubkeys which are used to sign the packages of this - distribution. - - - - Default content of the /etc/apt/ directory. - - - - Default content of the /etc/rpm directory. - - - - Directory which overrides /usr/lib/rpm. - - - - Directory with all executables and libraries which are required for this - distribution. - - - - - - The configuration directory for the vserver vserver-name. - - - [experimental; name is subject of possible change] Contains the system capabilities. - - - - [experimental; name is subject of possible change] Contains the context capabilities. - - - - [experimental; name is subject of possible change] Contains the scheduler - parameters: fill-rate, interval, tokens, tokens-min, tokens-max and cpu-mask. One parameter - per line. - - - - - Contains the hostname of the vserver. Same as uts/nodename. - - - - Contains the name of the vserver. When not given, the basename of the directory - will be assumed as this name. - - - - The domainname of the vserver. Same as uts/domainname. - - - - The nice-level on which the vserver will be started. - - - - Contains per line a capability. - - - - Contains the pathname of the shell which will be used by the "vserver ... enter" - command. - - - - Contains per line a flag. - - - - 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. - - - - 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 initial-mtab which will be used for the vserver. - - - - Contains the init-style; possible values are 'sysv', 'plain', 'minit' and - 'gentoo'. - - - - The start runlevel. - - - - The start runlevel. - - - - The stop runlevel. - - - - Contains the 'signal [wait signal]*' sequence which is used to stop the - vserver. - - - - The command which is used to start the vserver. Each option must be on 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. - - - - The command which is used to stop the vserver. Each option must be on 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. - - - - The command which is used to setup the init-system (e.g. to set the runlevel - in the utmp-file). Each option must be on a separate line. - - - - Without this file, the 'cmd.*-sync' files will be ignored. - - - - A symlink to the TTY device where input/output will be redirected from/to - at startup via initscript. - - - - This file is used to mark group of vservers which shall be started/stopped - together by the initscript. Content is a simple string like 'default'. - - - - This file is used to configure vservers which must be running before the - current vserver can be started. At shutdown, the current vserver will be stopped before - its dependencies. Content of this file are vserver ids (one name per line). - - - - - This directory contains configuration data required for vserver - 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. - - - - These are symlinks to the configuration directory - (e.g. CONFDIR/vservers/<idgt;) of a refserver. There may be multiple such symlinks - but they must be prefixed by 'refserver.' and will be processed in alphanumerical - order. - - - - - - - - &init-dir-text; &init-prepre-start; - - - - - - - - &init-dir-text; &init-pre-start; - - - - - - - - &init-dir-text; &init-post-start; - - - - - - - - &init-dir-text; &init-pre-stop; - - - - - - - &init-dir-text; &init-post-stop; - - - - - - - &init-dir-text; &init-postpost-stop; - - - - - - - - - The deafult broadcast address. - - - The default network-device. - - - The default network-prefix. - - - The default network-mask. - - - The default scope of the network interfaces. - - - - '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. - - - When this file exists, this interface will be ignored. - - - - The ip which will be assigned to this interface. - - - The broadcast address. - - - The network-device. - - - The network-prefix. - - - The network-mask. - - - The scope of the network interface. - - - When this file exists, the interface will be named with the text in this file. - - - 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. - - - - - - A directory with ulimits. Possible resources are cpu, data, fsize, 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 line. The - special keyword 'inf' is recognized. - - - - A file which contains the soft- of the given resource in the first line. The - special keyword 'inf' is recognized. - - - - - see ulimits - - - - - The context-name of the vserver - - - The sysname of the vserver - - - The node-/hostname of the vserver - - - The OS-release of the vserver - - - The OS-version of the vserver - - - The machine-type of the vserver - - - The NIS domainname of the vserver - - - - - - - - + + + + + + + + Default mtab file + + + + + /vservers + + + + + + + The file where output will be logged to when 'vshelper' is invoked from the + kernel. This should point somewhere e.g. into /var/log. + + + + + + + /vservers/.pkg + + + + The default apt.conf which is going to be used. It is overridden by + distribution specific configuration file. + + + + + + + + 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. + + + + + + + + A list of files which will be made visibly 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'. + + + + + + + + A symlink to the TTY device where input/output will be redirected from/to + at startup via initscript. + + + + + + + + Static list of excluded files. + + + + + + + + + + + + + + The default apt.conf which is going to be used. It overrides the apt.conf + from CONFDIR/.defaults/apps/pkgmgmt. + + + + + 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. + + + + + + + Script which will be executed after packages are installed. + + + + + The configuration directory of the vserver which is going to be set up. + + + + + The pathname of the vserver binary. + + + + + + + + Contains files with packages. + + + + File which contains the name of packages. On top of file the special + keywords '--reinstall' and '--can-fail' are possible. + + + + + + + Directory with GPG pubkeys which are used to sign the packages of this + distribution. + + + + + + Default content of the /etc/apt/ directory. + + + + + + Default content of the /etc/rpm directory. + + + + + + Directory which overrides /usr/lib/rpm. + + + + + Directory with all executables and libraries which are required for this + distribution. + + + + + + + + + + The configuration directory for the vserver vserver-name. + + + + + [experimental; name is subject of possible change] Contains the system capabilities. + + + + + [experimental; name is subject of possible change] Contains the context capabilities. + + + + + [experimental; name is subject of possible change] Contains the scheduler parameters, + one per line. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains the hostname of the vserver. Same as uts/nodename. + + + + + Contains the name of the vserver. When not given, the basename of the directory + will be assumed as this name. + + + + + The domainname of the vserver. Same as uts/domainname. + + + + + 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'. + + + + + Contains the pathname of the shell which will be used by the "vserver ... enter" + command. + + + + + Contains per line a flag. + + + + + The new process will believe it is process number 1. Useful to run a real + /sbin/init in a vserver. + + + + + The new process is trapped and can't use chcontext anymore. + + + + + The new process and its children will share a common + + + + + Limit the number of process in the vserver according to + ulimit setting. Normally, ulimit is a per user thing. + With this flag, it becomes a per vserver thing. + + + + + No one can join this security context once created. + + + + + Apply the current ulimit to the whole context + + + + + + + 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. + + + + + 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 initial-mtab which will be used for the vserver. + + + + + + Contains the init-style. + + + + + + + + + + + The start runlevel. + + + + The start runlevel. + + + + The stop runlevel. + + + + + Contains the 'signal [wait signal]*' sequence which is used to stop the + vserver. + + + + + + The command which is used to start the vserver. Each option must be on 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. + + + + + + The command which is used to stop the vserver. Each option must be on 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. + + + + + + The command which is used to setup the init-system (e.g. to set the 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. + + + + + + A symlink to the TTY device where input/output will be redirected from/to + at startup via initscript. + + + + + + This file is used to mark group of vservers which shall be started/stopped + together by the initscript. Content is a simple string like 'default'. + + + + + + This file is used to configure vservers which must be running before the + current vserver can be started. At shutdown, the current vserver will be stopped before + its dependencies. Content of this file are vserver ids (one name per line). + + + + + + + + The timeout in seconds which is used when synchronising vserver startup/shutdown + with the vshelper. When no set, 30 seconds will be assumed. + + 30 + + + + + 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 the vs_reboot() function in the kernel + for more details. + + + + The xid of the context calling the vshelper + + + The reboot-event + + + + + + + When existing, the vshelper functionality will be disabled for this + vserver. + + + + + + When existing, sanity checks for the vshelper functionality will be + skipped. + + + + + + + + + See vshelper/action. + + + + + + + This directory contains configuration data required for vserver + 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. + + + + + + These are symlinks to the configuration directory + (e.g. CONFDIR/vservers/<id>) of a refserver. There may be multiple such symlinks + but they must be prefixed by 'refserver.' and will be processed in alphanumerical + order. + + + + + + + + A directory for scripts. By default, when one of these scripts will be executed, + the execution of defaultscripts (within .../.defaults/scripts) will be skipped. To execute + them nevertheless, the $DONT_SKIP_DEFAULTS 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." + + + + 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 prepre-start like scripts + + + See prepre-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 scriptlet which will be executed after network-interfaces were enabled and + the directories mounted, but before the vserver itself has been started. + + + + 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 + + + See pre-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 scriptlet which will be executed after the vserver has been started. + + + + 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 post-start like scripts + + + 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 scriptlet which will be executed before the vserver will be stopped. + + + + 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-stop like scripts + + + 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 scriptlet which will be executed after the vserver has been stopped, but + before the directories will be umounted and the the interfaces + disabled. + + + + 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 post-stop like scripts + + + 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 scriptlet which will be executed after the vserver has been stopped + completely. + + + + 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 postpost-stop like scripts + + + 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 default broadcast address. + + + The default network device. + + + The default network prefix. + + + The default network mask. + + + The default scope of the network interfaces. + + + + + '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. + + + + When this file exists, this interface will be ignored. + + + + The ip which will be assigned to this interface. + + + The broadcast address. + + + The network device. + + + The network prefix. + + + The network mask. + + + The scope of the network interface. + + + + When this file exists, the interface will be named with the text in this file. + + + + + 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. + + + + + + + + A directory with ulimits. Possible resources are cpu, data, fsize, 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 line. The + special keyword 'inf' is recognized. + + + + + A file which contains the soft- of the given resource in the first line. The + special keyword 'inf' is recognized. + + + + + + + A directory with ulimits. Possible resources are cpu, data, fsize, 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 line. The + special keyword 'inf' is recognized. + + + + + A file which contains the soft- of the given resource in the first line. The + special keyword 'inf' is recognized. + + + + + + + + The context-name of the vserver. This file is listed for completeness only; + the 'context' name is used and set internally by the util-vserver tools and can *not* be + modified. + + + + The sysname of the vserver + + + The node-/hostname of the vserver + + + The OS-release of the vserver + + + The OS-version of the vserver + + + The machine-type of the vserver + + + The NIS domainname of the vserver + + + +