lxc.conf.sgml.in: note the arguments and environment variables passed to hooks

Signed-off-by: Serge Hallyn <serge.hallyn@ubuntu.com>
This commit is contained in:
Serge Hallyn 2013-08-13 13:45:56 -05:00
parent 8bb17b7791
commit baece28226

View File

@ -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 Container hooks are programs or scripts which can be executed
at various times in a container's lifetime. at various times in a container's lifetime.
</para> </para>
<para>
When a container hook is executed, information is passed both
as command line arguments and through environment variables.
The arguments are:
<itemizedlist>
<listitem> Container name. </listitem>
<listitem> Section (always 'lxc'). </listitem>
<listitem> The hook type (i.e. 'clone' or 'pre-mount'). </listitem>
<listitem> Additional arguments In the
case of the clone hook, any extra arguments passed to
lxc-clone will appear as further arguments to the hook. </listitem>
</itemizedlist>
The following environment variables are set:
<itemizedlist>
<listitem> LXC_NAME: is the container's name. </listitem>
<listitem> LXC_ROOTFS_MOUNT: the path to the mounted root filesystem. </listitem>
<listitem> LXC_CONFIG_FILE: the path to the container configuration file. </listitem>
<listitem> LXC_SRC_NAME: in the case of the clone hook, this is the original container's name. </listitem>
<listitem> 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. </listitem>
</itemizedlist>
</para>
<para> <para>
Standard output from the hooks is logged at debug level. Standard output from the hooks is logged at debug level.
Standard error is not logged, but can be captured by the Standard error is not logged, but can be captured by the