Skip to content

L
lxc
Commit 55fc19a1 by Stéphane Graber
Options

doc: Try to clear some confusion about lxc.conf

Signed-off-by: 's avatarStéphane Graber <stgraber@ubuntu.com> Acked-by: 's avatarSerge E. Hallyn <serge.hallyn@ubuntu.com>
parent ffa0e610
Showing with 232 additions and 1 deletion
configure.ac
......@@ -608,6 +608,8 @@ AC_CONFIG_FILES([
doc/lxc-wait.sgml
doc/lxc.conf.sgml
doc/lxc.container.conf.sgml
doc/lxc.system.conf.sgml
doc/lxc-usernet.sgml
doc/lxc.sgml
doc/common_options.sgml
......
doc/Makefile.am
......@@ -10,7 +10,8 @@ SUBDIRS += api
endif
EXTRA_DIST = \
lxc.conf \
lxc.container.conf \
lxc.system.conf \
FAQ.txt
if ENABLE_DOCBOOK
......@@ -37,6 +38,8 @@ man_MANS = \
lxc-wait.1 \
\
lxc.conf.5 \
lxc.container.conf.5 \
lxc.system.conf.5 \
lxc-usernet.5 \
\
lxc.7
......
doc/lxc.system.conf 0 → 100644
# LVM: volume group to use for new containers
lxc.bdev.lvm.vg = lxc
# LVM: thin pool to use for new containers
lxc.bdev.lvm.thin_pool = lxc
# ZFS: Root path
lxc.bdev.zfs.root = lxc
# Path to the containers
lxc.lxcpath = /var/lib/lxc/
# Path to the default configuration file
lxc.default_config = /etc/lxc/default.conf
# Pattern to use for the cgroup path
lxc.cgroup.pattern = lxc/%n
# List of cgroups to use
lxc.cgroup.use =
doc/lxc.system.conf.sgml.in 0 → 100644
<!--
lxc: linux Container library
(C) Copyright Canonical Ltd. 2014
Authors:
Stéphane Graber <stgraber@ubuntu.com>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
-->
<!DOCTYPE refentry PUBLIC @docdtd@ [
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]>
<refentry>
<docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
<refmeta>
<refentrytitle>lxc.system.conf</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>lxc.system.conf</refname>
<refpurpose>
LXC system configuration file
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
The system configuration is located at
<filename>@LXC_GLOBAL_CONF@</filename> or
<filename>~/.config/lxc/lxc.conf</filename> for unprivileged
containers.
</para>
<para>
This configuration file is used to set values such as default
lookup paths and storage backend settings for LXC.
</para>
<refsect2>
<title>Configuration paths</title>
<variablelist>
<varlistentry>
<term>
<option>lxc.lxcpath</option>
</term>
<listitem>
<para>
The location in which all containers are stored.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>lxc.default_config</option>
</term>
<listitem>
<para>
The path to the default container configuration.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Control Groups</title>
<variablelist>
<varlistentry>
<term>
<option>lxc.cgroup.user</option>
</term>
<listitem>
<para>
Comma separated list of cgroup controllers to setup.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>lxc.cgroup.pattern</option>
</term>
<listitem>
<para>
Format string used to generate the cgroup path (e.g. lxc/%n).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>LVM</title>
<variablelist>
<varlistentry>
<term>
<option>lxc.bdev.lvm.vg</option>
</term>
<listitem>
<para>
Default LVM volume group name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>lxc.bdev.lvm.thin_pool</option>
</term>
<listitem>
<para>
Default LVM thin pool name.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>ZFS</title>
<variablelist>
<varlistentry>
<term>
<option>lxc.bdev.zfs.root</option>
</term>
<listitem>
<para>
Default ZFS root name.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>
<simpara>
<citerefentry>
<refentrytitle><command>lxc</command></refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle><command>lxc.container.conf</command></refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle><command>lxc.system.conf</command></refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle><command>lxc-usernet</command></refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>
</simpara>
</refsect1>
&seealso;
<refsect1>
<title>Author</title>
<para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment