From baece282266318a9bb527cefc85ebf7b6dd7f10e Mon Sep 17 00:00:00 2001 From: Serge Hallyn Date: Tue, 13 Aug 2013 13:45:56 -0500 Subject: [PATCH] lxc.conf.sgml.in: note the arguments and environment variables passed to hooks Signed-off-by: Serge Hallyn --- doc/lxc.conf.sgml.in | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/doc/lxc.conf.sgml.in b/doc/lxc.conf.sgml.in index 6500e50ba..02667fcf1 100644 --- a/doc/lxc.conf.sgml.in +++ b/doc/lxc.conf.sgml.in @@ -861,6 +861,27 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Container hooks are programs or scripts which can be executed at various times in a container's lifetime. + + When a container hook is executed, information is passed both + as command line arguments and through environment variables. + The arguments are: + + Container name. + Section (always 'lxc'). + The hook type (i.e. 'clone' or 'pre-mount'). + Additional arguments In the + case of the clone hook, any extra arguments passed to + lxc-clone will appear as further arguments to the hook. + + The following environment variables are set: + + LXC_NAME: is the container's name. + LXC_ROOTFS_MOUNT: the path to the mounted root filesystem. + LXC_CONFIG_FILE: the path to the container configuration file. + LXC_SRC_NAME: in the case of the clone hook, this is the original container's name. + LXC_ROOTFS_PATH: this is the lxc.rootfs enty for the container. Note this is likely not where the mounted rootfs is to be found, use LXC_ROOTFS_MOUNT for that. + + Standard output from the hooks is logged at debug level. Standard error is not logged, but can be captured by the