Debian Codegraph @

doc/lxc.system.conf.sgml.in

raw
1 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
2
3 <!DOCTYPE refentry PUBLIC @docdtd@ [
4
5 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
6 ]>
7
8 <refentry>
9
10 <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
11
12 <refmeta>
13 <refentrytitle>lxc.system.conf</refentrytitle>
14 <manvolnum>5</manvolnum>
15 </refmeta>
16
17 <refnamediv>
18 <refname>lxc.system.conf</refname>
19
20 <refpurpose>
21 LXC system configuration file
22 </refpurpose>
23 </refnamediv>
24
25 <refsect1>
26 <title>Description</title>
27
28 <para>
29 The system configuration is located at
30 <filename>@LXC_GLOBAL_CONF@</filename> or
31 <filename>~/.config/lxc/lxc.conf</filename> for unprivileged
32 containers.
33 </para>
34
35 <para>
36 This configuration file is used to set values such as default
37 lookup paths and storage backend settings for LXC.
38 </para>
39
40 <refsect2>
41 <title>Configuration paths</title>
42
43 <variablelist>
44 <varlistentry>
45 <term>
46 <option>lxc.lxcpath</option>
47 </term>
48 <listitem>
49 <para>
50 The location in which all containers are stored.
51 </para>
52 </listitem>
53 </varlistentry>
54 <varlistentry>
55 <term>
56 <option>lxc.default_config</option>
57 </term>
58 <listitem>
59 <para>
60 The path to the default container configuration.
61 </para>
62 </listitem>
63 </varlistentry>
64 </variablelist>
65 </refsect2>
66
67 <refsect2>
68 <title>Control Groups</title>
69
70 <variablelist>
71 <varlistentry>
72 <term>
73 <option>lxc.cgroup.use</option>
74 </term>
75 <listitem>
76 <para>
77 Comma separated list of cgroup controllers to setup.
78 If none is specified, all available controllers will be used.
79 </para>
80 </listitem>
81 </varlistentry>
82 <varlistentry>
83 <term>
84 <option>lxc.cgroup.pattern</option>
85 </term>
86 <listitem>
87 <para>
88 Format string used to generate the cgroup path (e.g. lxc/%n).
89 </para>
90 </listitem>
91 </varlistentry>
92 </variablelist>
93 </refsect2>
94
95 <refsect2>
96 <title>LVM</title>
97
98 <variablelist>
99 <varlistentry>
100 <term>
101 <option>lxc.bdev.lvm.vg</option>
102 </term>
103 <listitem>
104 <para>
105 Default LVM volume group name.
106 </para>
107 </listitem>
108 </varlistentry>
109 <varlistentry>
110 <term>
111 <option>lxc.bdev.lvm.thin_pool</option>
112 </term>
113 <listitem>
114 <para>
115 Default LVM thin pool name.
116 </para>
117 </listitem>
118 </varlistentry>
119 </variablelist>
120 </refsect2>
121
122 <refsect2>
123 <title>ZFS</title>
124
125 <variablelist>
126 <varlistentry>
127 <term>
128 <option>lxc.bdev.zfs.root</option>
129 </term>
130 <listitem>
131 <para>
132 Default ZFS root name.
133 </para>
134 </listitem>
135 </varlistentry>
136 </variablelist>
137 </refsect2>
138 </refsect1>
139
140 <refsect1>
141 <simpara>
142 <citerefentry>
143 <refentrytitle><command>lxc</command></refentrytitle>
144 <manvolnum>1</manvolnum>
145 </citerefentry>,
146 <citerefentry>
147 <refentrytitle><command>lxc.container.conf</command></refentrytitle>
148 <manvolnum>5</manvolnum>
149 </citerefentry>,
150 <citerefentry>
151 <refentrytitle><command>lxc.system.conf</command></refentrytitle>
152 <manvolnum>5</manvolnum>
153 </citerefentry>,
154 <citerefentry>
155 <refentrytitle><command>lxc-usernet</command></refentrytitle>
156 <manvolnum>5</manvolnum>
157 </citerefentry>
158 </simpara>
159 </refsect1>
160
161 &seealso;
162 </refentry>
163
164 <!-- Keep this comment at the end of the file
165 Local variables:
166 mode: sgml
167 sgml-omittag:t
168 sgml-shorttag:t
169 sgml-minimize-attributes:nil
170 sgml-always-quote-attributes:t
171 sgml-indent-step:2
172 sgml-indent-data:t
173 sgml-parent-document:nil
174 sgml-default-dtd-file:nil
175 sgml-exposed-tags:nil
176 sgml-local-catalogs:nil
177 sgml-local-ecat-files:nil
178 End:
179 -->