doc/lxc.system.conf.sgml.in

   1 <!--
   2
   3 lxc: linux Container library
   4
   5 (C) Copyright Canonical Ltd. 2014
   6
   7 Authors:
   8 Stéphane Graber <stgraber@ubuntu.com>
   9
  10 This library is free software; you can redistribute it and/or
  11 modify it under the terms of the GNU Lesser General Public
  12 License as published by the Free Software Foundation; either
  13 version 2.1 of the License, or (at your option) any later version.
  14
  15 This library is distributed in the hope that it will be useful,
  16 but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18 Lesser General Public License for more details.
  19
  20 You should have received a copy of the GNU Lesser General Public
  21 License along with this library; if not, write to the Free Software
  22 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  23
  24 -->
  25
  26 <!DOCTYPE refentry PUBLIC @docdtd@ [
  27
  28 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
  29 ]>
  30
  31 <refentry>
  32
  33   <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
  34
  35   <refmeta>
  36     <refentrytitle>lxc.system.conf</refentrytitle>
  37     <manvolnum>5</manvolnum>
  38   </refmeta>
  39
  40   <refnamediv>
  41     <refname>lxc.system.conf</refname>
  42
  43     <refpurpose>
  44       LXC system configuration file
  45     </refpurpose>
  46   </refnamediv>
  47
  48   <refsect1>
  49     <title>Description</title>
  50
  51     <para>
  52       The system configuration is located at
  53       <filename>@LXC_GLOBAL_CONF@</filename> or
  54       <filename>~/.config/lxc/lxc.conf</filename> for unprivileged
  55       containers.
  56     </para>
  57
  58     <para>
  59       This configuration file is used to set values such as default
  60       lookup paths and storage backend settings for LXC.
  61     </para>
  62
  63     <refsect2>
  64       <title>Configuration paths</title>
  65
  66       <variablelist>
  67         <varlistentry>
  68           <term>
  69             <option>lxc.lxcpath</option>
  70           </term>
  71           <listitem>
  72             <para>
  73               The location in which all containers are stored.
  74             </para>
  75           </listitem>
  76         </varlistentry>
  77         <varlistentry>
  78           <term>
  79             <option>lxc.default_config</option>
  80           </term>
  81           <listitem>
  82             <para>
  83               The path to the default container configuration.
  84             </para>
  85           </listitem>
  86         </varlistentry>
  87       </variablelist>
  88     </refsect2>
  89
  90     <refsect2>
  91       <title>Control Groups</title>
  92
  93       <variablelist>
  94         <varlistentry>
  95           <term>
  96             <option>lxc.cgroup.use</option>
  97           </term>
  98           <listitem>
  99             <para>
 100               Comma separated list of cgroup controllers to setup.
 101               If none is specified, all available controllers will be used.
 102             </para>
 103           </listitem>
 104         </varlistentry>
 105         <varlistentry>
 106           <term>
 107             <option>lxc.cgroup.pattern</option>
 108           </term>
 109           <listitem>
 110             <para>
 111               Format string used to generate the cgroup path (e.g. lxc/%n).
 112             </para>
 113           </listitem>
 114         </varlistentry>
 115       </variablelist>
 116     </refsect2>
 117
 118     <refsect2>
 119       <title>LVM</title>
 120
 121       <variablelist>
 122         <varlistentry>
 123           <term>
 124             <option>lxc.bdev.lvm.vg</option>
 125           </term>
 126           <listitem>
 127             <para>
 128               Default LVM volume group name.
 129             </para>
 130           </listitem>
 131         </varlistentry>
 132         <varlistentry>
 133           <term>
 134             <option>lxc.bdev.lvm.thin_pool</option>
 135           </term>
 136           <listitem>
 137             <para>
 138               Default LVM thin pool name.
 139             </para>
 140           </listitem>
 141         </varlistentry>
 142       </variablelist>
 143     </refsect2>
 144
 145     <refsect2>
 146       <title>ZFS</title>
 147
 148       <variablelist>
 149         <varlistentry>
 150           <term>
 151             <option>lxc.bdev.zfs.root</option>
 152           </term>
 153           <listitem>
 154             <para>
 155               Default ZFS root name.
 156             </para>
 157           </listitem>
 158         </varlistentry>
 159       </variablelist>
 160     </refsect2>
 161   </refsect1>
 162
 163   <refsect1>
 164     <simpara>
 165       <citerefentry>
 166         <refentrytitle><command>lxc</command></refentrytitle>
 167         <manvolnum>1</manvolnum>
 168       </citerefentry>,
 169       <citerefentry>
 170         <refentrytitle><command>lxc.container.conf</command></refentrytitle>
 171         <manvolnum>5</manvolnum>
 172       </citerefentry>,
 173       <citerefentry>
 174         <refentrytitle><command>lxc.system.conf</command></refentrytitle>
 175         <manvolnum>5</manvolnum>
 176       </citerefentry>,
 177       <citerefentry>
 178         <refentrytitle><command>lxc-usernet</command></refentrytitle>
 179         <manvolnum>5</manvolnum>
 180       </citerefentry>
 181     </simpara>
 182   </refsect1>
 183
 184   &seealso;
 185
 186   <refsect1>
 187     <title>Author</title>
 188     <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
 189   </refsect1>
 190 </refentry>
 191
 192 <!-- Keep this comment at the end of the file
 193 Local variables:
 194 mode: sgml
 195 sgml-omittag:t
 196 sgml-shorttag:t
 197 sgml-minimize-attributes:nil
 198 sgml-always-quote-attributes:t
 199 sgml-indent-step:2
 200 sgml-indent-data:t
 201 sgml-parent-document:nil
 202 sgml-default-dtd-file:nil
 203 sgml-exposed-tags:nil
 204 sgml-local-catalogs:nil
 205 sgml-local-ecat-files:nil
 206 End:
 207 -->