]> git.proxmox.com Git - mirror_lxc.git/blame - doc/lxc.container.conf.sgml.in
conf: order includes
[mirror_lxc.git] / doc / lxc.container.conf.sgml.in
CommitLineData
55fc19a1
SG
1<!--
2
3lxc: linux Container library
4
5(C) Copyright IBM Corp. 2007, 2008
6
7Authors:
8Daniel Lezcano <daniel.lezcano at free.fr>
9
10This library is free software; you can redistribute it and/or
11modify it under the terms of the GNU Lesser General Public
12License as published by the Free Software Foundation; either
13version 2.1 of the License, or (at your option) any later version.
14
15This library is distributed in the hope that it will be useful,
16but WITHOUT ANY WARRANTY; without even the implied warranty of
17MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18Lesser General Public License for more details.
19
20You should have received a copy of the GNU Lesser General Public
21License along with this library; if not, write to the Free Software
22Foundation, 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.container.conf</refentrytitle>
37 <manvolnum>5</manvolnum>
38 </refmeta>
39
40 <refnamediv>
41 <refname>lxc.container.conf</refname>
42
43 <refpurpose>
44 LXC container configuration file
45 </refpurpose>
46 </refnamediv>
47
48 <refsect1>
49 <title>Description</title>
50
51 <para>
b9986e43
CB
52 LXC is the well-known and heavily tested low-level Linux container
53 runtime. It is in active development since 2008 and has proven itself in
54 critical production environments world-wide. Some of its core contributors
55 are the same people that helped to implement various well-known
56 containerization features inside the Linux kernel.
55fc19a1
SG
57 </para>
58
59 <para>
b9986e43
CB
60 LXC's main focus is system containers. That is, containers which offer an
61 environment as close as possible as the one you'd get from a VM but
62 without the overhead that comes with running a separate kernel and
63 simulating all the hardware.
55fc19a1
SG
64 </para>
65
66 <para>
b9986e43
CB
67 This is achieved through a combination of kernel security features such as
68 namespaces, mandatory access control and control groups.
69 </para>
70
71 <para>
72 LXC has supports unprivileged containers. Unprivileged containers are
73 containers that are run without any privilege. This requires support for
74 user namespaces in the kernel that the container is run on. LXC was the
75 first runtime to support unprivileged containers after user namespaces
76 were merged into the mainline kernel.
77 </para>
78
79 <para>
80 In essence, user namespaces isolate given sets of UIDs and GIDs. This is
81 achieved by establishing a mapping between a range of UIDs and GIDs on the
82 host to a different (unprivileged) range of UIDs and GIDs in the
83 container. The kernel will translate this mapping in such a way that
84 inside the container all UIDs and GIDs appear as you would expect from the
85 host whereas on the host these UIDs and GIDs are in fact unprivileged. For
86 example, a process running as UID and GID 0 inside the container might
87 appear as UID and GID 100000 on the host. The implementation and working
88 details can be gathered from the corresponding user namespace man page.
bdcbb6b3 89 UID and GID mappings can be defined with the <option>lxc.idmap</option>
b9986e43
CB
90 key.
91 </para>
92
93 <para>
94 Linux containers are defined with a simple configuration file. Each
95 option in the configuration file has the form <command>key =
96 value</command> fitting in one line. The "#" character means the line is a
97 comment. List options, like capabilities and cgroups options, can be used
98 with no value to clear any previously defined values of that option.
99 </para>
100
101 <para>
102 LXC namespaces configuration keys by using single dots. This means complex
7fa3f2e9 103 configuration keys such as <option>lxc.net.0</option> expose various
104 subkeys such as <option>lxc.net.0.type</option>,
2e44ae28 105 <option>lxc.net.0.link</option>, <option>lxc.net.0.ipv6.address</option>, and
b9986e43 106 others for even more fine-grained configuration.
55fc19a1
SG
107 </para>
108
109 <refsect2>
110 <title>Configuration</title>
111 <para>
b9986e43
CB
112 In order to ease administration of multiple related containers, it is
113 possible to have a container configuration file cause another file to be
114 loaded. For instance, network configuration can be defined in one common
115 file which is included by multiple containers. Then, if the containers
116 are moved to another host, only one file may need to be updated.
55fc19a1
SG
117 </para>
118
119 <variablelist>
c464fd7e
SG
120 <varlistentry>
121 <term>
122 <option>lxc.include</option>
123 </term>
124 <listitem>
125 <para>
126 Specify the file to be included. The included file must be
127 in the same valid lxc configuration file format.
128 </para>
129 </listitem>
130 </varlistentry>
55fc19a1
SG
131 </variablelist>
132 </refsect2>
133
134 <refsect2>
135 <title>Architecture</title>
136 <para>
b9986e43
CB
137 Allows one to set the architecture for the container. For example, set a
138 32bits architecture for a container running 32bits binaries on a 64bits
139 host. This fixes the container scripts which rely on the architecture to
140 do some work like downloading the packages.
55fc19a1
SG
141 </para>
142
143 <variablelist>
c464fd7e
SG
144 <varlistentry>
145 <term>
146 <option>lxc.arch</option>
147 </term>
148 <listitem>
149 <para>
150 Specify the architecture for the container.
151 </para>
152 <para>
b9986e43 153 Some valid options are
c464fd7e
SG
154 <option>x86</option>,
155 <option>i686</option>,
156 <option>x86_64</option>,
157 <option>amd64</option>
158 </para>
159 </listitem>
160 </varlistentry>
55fc19a1
SG
161 </variablelist>
162
163 </refsect2>
164
165 <refsect2>
166 <title>Hostname</title>
167 <para>
b9986e43
CB
168 The utsname section defines the hostname to be set for the container.
169 That means the container can set its own hostname without changing the
170 one from the system. That makes the hostname private for the container.
55fc19a1
SG
171 </para>
172 <variablelist>
c464fd7e
SG
173 <varlistentry>
174 <term>
b67771bc 175 <option>lxc.uts.name</option>
c464fd7e
SG
176 </term>
177 <listitem>
178 <para>
179 specify the hostname for the container
180 </para>
181 </listitem>
182 </varlistentry>
55fc19a1
SG
183 </variablelist>
184 </refsect2>
185
186 <refsect2>
187 <title>Halt signal</title>
188 <para>
b9986e43
CB
189 Allows one to specify signal name or number sent to the container's
190 init process to cleanly shutdown the container. Different init systems
191 could use different signals to perform clean shutdown sequence. This
192 option allows the signal to be specified in kill(1) fashion, e.g.
193 SIGPWR, SIGRTMIN+14, SIGRTMAX-10 or plain number. The default signal is
194 SIGPWR.
55fc19a1
SG
195 </para>
196 <variablelist>
936762f3
BP
197 <varlistentry>
198 <term>
55c84efc 199 <option>lxc.signal.halt</option>
936762f3
BP
200 </term>
201 <listitem>
202 <para>
203 specify the signal used to halt the container
204 </para>
205 </listitem>
206 </varlistentry>
207 </variablelist>
208 </refsect2>
209
210 <refsect2>
211 <title>Reboot signal</title>
212 <para>
b9986e43
CB
213 Allows one to specify signal name or number to reboot the container.
214 This option allows signal to be specified in kill(1) fashion, e.g.
215 SIGTERM, SIGRTMIN+14, SIGRTMAX-10 or plain number. The default signal
216 is SIGINT.
936762f3
BP
217 </para>
218 <variablelist>
219 <varlistentry>
220 <term>
55c84efc 221 <option>lxc.signal.reboot</option>
936762f3
BP
222 </term>
223 <listitem>
224 <para>
225 specify the signal used to reboot the container
226 </para>
227 </listitem>
228 </varlistentry>
55fc19a1
SG
229 </variablelist>
230 </refsect2>
231
232 <refsect2>
233 <title>Stop signal</title>
234 <para>
b9986e43
CB
235 Allows one to specify signal name or number to forcibly shutdown the
236 container. This option allows signal to be specified in kill(1) fashion,
237 e.g. SIGKILL, SIGRTMIN+14, SIGRTMAX-10 or plain number. The default
238 signal is SIGKILL.
936762f3
BP
239 </para>
240 <variablelist>
241 <varlistentry>
242 <term>
55c84efc 243 <option>lxc.signal.stop</option>
936762f3
BP
244 </term>
245 <listitem>
246 <para>
247 specify the signal used to stop the container
248 </para>
249 </listitem>
250 </varlistentry>
55fc19a1
SG
251 </variablelist>
252 </refsect2>
253
67c660d0
SG
254 <refsect2>
255 <title>Init command</title>
256 <para>
257 Sets the command to use as the init system for the containers.
67c660d0 258 </para>
5cda27c1
SH
259 <variablelist>
260 <varlistentry>
261 <term>
262 <option>lxc.execute.cmd</option>
263 </term>
264 <listitem>
265 <para>
266 Absolute path from container rootfs to the binary to run by default. This
fcd95ae9 267 mostly makes sense for <command>lxc-execute</command>.
5cda27c1
SH
268 </para>
269 </listitem>
270 </varlistentry>
271 </variablelist>
67c660d0 272 <variablelist>
936762f3
BP
273 <varlistentry>
274 <term>
9dcf7b4d 275 <option>lxc.init.cmd</option>
936762f3
BP
276 </term>
277 <listitem>
278 <para>
fcd95ae9
KY
279 Absolute path from container rootfs to the binary to use as init. This
280 mostly makes sense for <command>lxc-start</command>. Default is <command>/sbin/init</command>.
936762f3
BP
281 </para>
282 </listitem>
283 </varlistentry>
67c660d0
SG
284 </variablelist>
285 </refsect2>
286
3c491553
L
287 <refsect2>
288 <title>Init working directory</title>
289 <para>
290 Sets the absolute path inside the container as the working directory for the containers.
291 LXC will switch to this directory before executing init.
292 </para>
293 <variablelist>
294 <varlistentry>
295 <term>
296 <option>lxc.init.cwd</option>
297 </term>
298 <listitem>
299 <para>
300 Absolute path inside the container to use as the working directory.
301 </para>
302 </listitem>
303 </varlistentry>
304 </variablelist>
305 </refsect2>
306
dbca9237
PT
307 <refsect2>
308 <title>Init ID</title>
309 <para>
b9986e43 310 Sets the UID/GID to use for the init system, and subsequent commands.
14a7b0f9 311 Note that using a non-root UID when booting a system container will
b9986e43 312 likely not work due to missing privileges. Setting the UID/GID is mostly
14a7b0f9 313 useful when running application containers.
dbca9237
PT
314
315 Defaults to: UID(0), GID(0)
316 </para>
317 <variablelist>
318 <varlistentry>
319 <term>
9dcf7b4d 320 <option>lxc.init.uid</option>
dbca9237
PT
321 </term>
322 <listitem>
323 <para>
b9986e43 324 UID to use for init.
dbca9237
PT
325 </para>
326 </listitem>
327 </varlistentry>
328 <varlistentry>
329 <term>
9dcf7b4d 330 <option>lxc.init.gid</option>
dbca9237
PT
331 </term>
332 <listitem>
333 <para>
b9986e43 334 GID to use for init.
dbca9237
PT
335 </para>
336 </listitem>
337 </varlistentry>
338 </variablelist>
339 </refsect2>
340
61d7a733
YT
341 <refsect2>
342 <title>Proc</title>
343 <para>
344 Configure proc filesystem for the container.
345 </para>
346 <variablelist>
347 <varlistentry>
348 <term>
349 <option>lxc.proc.[proc file name]</option>
350 </term>
351 <listitem>
352 <para>
353 Specify the proc file name to be set. The file name available
354 are those listed under /proc/PID/.
355 Example:
356 </para>
357 <programlisting>
358 lxc.proc.oom_score_adj = 10
359 </programlisting>
360 </listitem>
361 </varlistentry>
362 </variablelist>
363 </refsect2>
364
4e6eb26b
CB
365 <refsect2>
366 <title>Ephemeral</title>
367 <para>
368 Allows one to specify whether a container will be destroyed on shutdown.
369 </para>
370 <variablelist>
371 <varlistentry>
372 <term>
373 <option>lxc.ephemeral</option>
374 </term>
375 <listitem>
376 <para>
377 The only allowed values are 0 and 1. Set this to 1 to destroy a
378 container on shutdown.
379 </para>
380 </listitem>
381 </varlistentry>
382 </variablelist>
383 </refsect2>
384
55fc19a1
SG
385 <refsect2>
386 <title>Network</title>
387 <para>
c464fd7e
SG
388 The network section defines how the network is virtualized in
389 the container. The network virtualization acts at layer
390 two. In order to use the network virtualization, parameters
391 must be specified to define the network interfaces of the
392 container. Several virtual interfaces can be assigned and used
393 in a container even if the system has only one physical
394 network interface.
55fc19a1
SG
395 </para>
396 <variablelist>
020104c3
MH
397 <varlistentry>
398 <term>
7fa3f2e9 399 <option>lxc.net</option>
020104c3
MH
400 </term>
401 <listitem>
402 <para>
403 may be used without a value to clear all previous network options.
404 </para>
405 </listitem>
406 </varlistentry>
c464fd7e
SG
407 <varlistentry>
408 <term>
7fa3f2e9 409 <option>lxc.net.[i].type</option>
c464fd7e
SG
410 </term>
411 <listitem>
412 <para>
413 specify what kind of network virtualization to be used
b9986e43
CB
414 for the container.
415 Multiple networks can be specified by using an additional index
416 <option>i</option>
7fa3f2e9 417 after all <option>lxc.net.*</option> keys. For example,
418 <option>lxc.net.0.type = veth</option> and
419 <option>lxc.net.1.type = veth</option> specify two different
b9986e43
CB
420 networks of the same type. All keys sharing the same index
421 <option>i</option> will be treated as belonging to the same
7fa3f2e9 422 network. For example, <option>lxc.net.0.link = br0</option>
423 will belong to <option>lxc.net.0.type</option>.
b9986e43 424 Currently, the different virtualization types can be:
c464fd7e
SG
425 </para>
426
427 <para>
428 <option>none:</option> will cause the container to share
429 the host's network namespace. This means the host
430 network devices are usable in the container. It also
431 means that if both the container and host have upstart as
432 init, 'halt' in a container (for instance) will shut down the
433 host.
434 </para>
435
436 <para>
437 <option>empty:</option> will create only the loopback
438 interface.
439 </para>
440
441 <para>
38005c54
MA
442 <option>veth:</option> a virtual ethernet pair
443 device is created with one side assigned to the container
444 and the other side attached to a bridge specified by
7fa3f2e9 445 the <option>lxc.net.[i].link</option> option.
38005c54
MA
446 If the bridge is not specified, then the veth pair device
447 will be created but not attached to any bridge.
448 Otherwise, the bridge has to be created on the system
449 before starting the container.
450 <command>lxc</command> won't handle any
451 configuration outside of the container.
452 By default, <command>lxc</command> chooses a name for the
c464fd7e 453 network device belonging to the outside of the
38005c54
MA
454 container, but if you wish to handle
455 this name yourselves, you can tell <command>lxc</command>
c464fd7e 456 to set a specific name with
7fa3f2e9 457 the <option>lxc.net.[i].veth.pair</option> option (except for
c464fd7e
SG
458 unprivileged containers where this option is ignored for security
459 reasons).
460 </para>
461
462 <para>
463 <option>vlan:</option> a vlan interface is linked with
464 the interface specified by
7fa3f2e9 465 the <option>lxc.net.[i].link</option> and assigned to
c464fd7e 466 the container. The vlan identifier is specified with the
7fa3f2e9 467 option <option>lxc.net.[i].vlan.id</option>.
c464fd7e
SG
468 </para>
469
470 <para>
471 <option>macvlan:</option> a macvlan interface is linked
472 with the interface specified by
7fa3f2e9 473 the <option>lxc.net.[i].link</option> and assigned to
c464fd7e 474 the container.
7fa3f2e9 475 <option>lxc.net.[i].macvlan.mode</option> specifies the
c464fd7e
SG
476 mode the macvlan will use to communicate between
477 different macvlan on the same upper device. The accepted
c15ea607
EL
478 modes are <option>private</option>, <option>vepa</option>,
479 <option>bridge</option> and <option>passthru</option>.
480 In <option>private</option> mode, the device never
481 communicates with any other device on the same upper_dev (default).
482 In <option>vepa</option> mode, the new Virtual Ethernet Port
c464fd7e
SG
483 Aggregator (VEPA) mode, it assumes that the adjacent
484 bridge returns all frames where both source and
485 destination are local to the macvlan port, i.e. the
486 bridge is set up as a reflective relay. Broadcast
487 frames coming in from the upper_dev get flooded to all
488 macvlan interfaces in VEPA mode, local frames are not
c15ea607 489 delivered locally. In <option>bridge</option> mode, it
c464fd7e
SG
490 provides the behavior of a simple bridge between
491 different macvlan interfaces on the same port. Frames
492 from one interface to another one get delivered directly
493 and are not sent out externally. Broadcast frames get
494 flooded to all other bridge ports and to the external
495 interface, but when they come back from a reflective
496 relay, we don't deliver them again. Since we know all
497 the MAC addresses, the macvlan bridge mode does not
c15ea607
EL
498 require learning or STP like the bridge module does. In
499 <option>passthru</option> mode, all frames received by
500 the physical interface are forwarded to the macvlan
501 interface. Only one macvlan interface in <option>passthru</option>
502 mode is possible for one physical interface.
c464fd7e
SG
503 </para>
504
505 <para>
506 <option>phys:</option> an already existing interface
7fa3f2e9 507 specified by the <option>lxc.net.[i].link</option> is
c464fd7e
SG
508 assigned to the container.
509 </para>
510 </listitem>
511 </varlistentry>
512
513 <varlistentry>
514 <term>
7fa3f2e9 515 <option>lxc.net.[i].flags</option>
c464fd7e
SG
516 </term>
517 <listitem>
518 <para>
b9986e43 519 Specify an action to do for the network.
c464fd7e
SG
520 </para>
521
522 <para><option>up:</option> activates the interface.
523 </para>
524 </listitem>
525 </varlistentry>
526
527 <varlistentry>
528 <term>
7fa3f2e9 529 <option>lxc.net.[i].link</option>
c464fd7e
SG
530 </term>
531 <listitem>
532 <para>
b9986e43
CB
533 Specify the interface to be used for real network traffic.
534 </para>
c464fd7e
SG
535 </listitem>
536 </varlistentry>
537
538 <varlistentry>
539 <term>
7fa3f2e9 540 <option>lxc.net.[i].mtu</option>
c464fd7e
SG
541 </term>
542 <listitem>
543 <para>
b9986e43 544 Specify the maximum transfer unit for this interface.
c464fd7e
SG
545 </para>
546 </listitem>
547 </varlistentry>
548
549 <varlistentry>
550 <term>
7fa3f2e9 551 <option>lxc.net.[i].name</option>
c464fd7e
SG
552 </term>
553 <listitem>
554 <para>
b9986e43
CB
555 The interface name is dynamically allocated, but if another name
556 is needed because the configuration files being used by the
557 container use a generic name, eg. eth0, this option will rename
558 the interface in the container.
c464fd7e
SG
559 </para>
560 </listitem>
561 </varlistentry>
562
563 <varlistentry>
564 <term>
7fa3f2e9 565 <option>lxc.net.[i].hwaddr</option>
c464fd7e
SG
566 </term>
567 <listitem>
568 <para>
b9986e43
CB
569 The interface mac address is dynamically allocated by default to
570 the virtual interface, but in some cases, this is needed to
571 resolve a mac address conflict or to always have the same
572 link-local ipv6 address. Any "x" in address will be replaced by
573 random value, this allows setting hwaddr templates.
c464fd7e
SG
574 </para>
575 </listitem>
576 </varlistentry>
577
578 <varlistentry>
579 <term>
9ff60df2 580 <option>lxc.net.[i].ipv4.address</option>
c464fd7e
SG
581 </term>
582 <listitem>
583 <para>
b9986e43
CB
584 Specify the ipv4 address to assign to the virtualized interface.
585 Several lines specify several ipv4 addresses. The address is in
586 format x.y.z.t/m, eg. 192.168.1.123/24.
c464fd7e
SG
587 </para>
588 </listitem>
589 </varlistentry>
590
591 <varlistentry>
592 <term>
7fa3f2e9 593 <option>lxc.net.[i].ipv4.gateway</option>
c464fd7e
SG
594 </term>
595 <listitem>
596 <para>
b9986e43
CB
597 Specify the ipv4 address to use as the gateway inside the
598 container. The address is in format x.y.z.t, eg. 192.168.1.123.
c464fd7e
SG
599
600 Can also have the special value <option>auto</option>,
601 which means to take the primary address from the bridge
602 interface (as specified by the
7fa3f2e9 603 <option>lxc.net.[i].link</option> option) and use that as
c464fd7e
SG
604 the gateway. <option>auto</option> is only available when
605 using the <option>veth</option> and
606 <option>macvlan</option> network types.
607 </para>
608 </listitem>
609 </varlistentry>
610
c464fd7e
SG
611 <varlistentry>
612 <term>
2e44ae28 613 <option>lxc.net.[i].ipv6.address</option>
c464fd7e
SG
614 </term>
615 <listitem>
616 <para>
b9986e43
CB
617 Specify the ipv6 address to assign to the virtualized
618 interface. Several lines specify several ipv6 addresses. The
619 address is in format x::y/m, eg.
620 2003:db8:1:0:214:1234:fe0b:3596/64
c464fd7e
SG
621 </para>
622 </listitem>
623 </varlistentry>
624
625 <varlistentry>
626 <term>
7fa3f2e9 627 <option>lxc.net.[i].ipv6.gateway</option>
c464fd7e
SG
628 </term>
629 <listitem>
630 <para>
b9986e43
CB
631 Specify the ipv6 address to use as the gateway inside the
632 container. The address is in format x::y, eg. 2003:db8:1:0::1
c464fd7e
SG
633
634 Can also have the special value <option>auto</option>,
635 which means to take the primary address from the bridge
636 interface (as specified by the
7fa3f2e9 637 <option>lxc.net.[i].link</option> option) and use that as
c464fd7e
SG
638 the gateway. <option>auto</option> is only available when
639 using the <option>veth</option> and
640 <option>macvlan</option> network types.
641 </para>
642 </listitem>
643 </varlistentry>
644
645 <varlistentry>
646 <term>
7fa3f2e9 647 <option>lxc.net.[i].script.up</option>
c464fd7e
SG
648 </term>
649 <listitem>
650 <para>
b9986e43 651 Add a configuration option to specify a script to be
c464fd7e 652 executed after creating and configuring the network used
14a7b0f9
CB
653 from the host side.
654 </para>
655
656 <para>
657 In addition to the information available to all hooks. The
658 following information is provided to the script:
659 <itemizedlist>
660 <listitem>
661 <para>
662 LXC_HOOK_TYPE: the hook type. This is either 'up' or 'down'.
663 </para>
664 </listitem>
665
666 <listitem>
667 <para>
668 LXC_HOOK_SECTION: the section type 'net'.
669 </para>
670 </listitem>
671
672 <listitem>
673 <para>
674 LXC_NET_TYPE: the network type. This is one of the valid
675 network types listed here (e.g. 'macvlan', 'veth').
676 </para>
677 </listitem>
678
679 <listitem>
680 <para>
681 LXC_NET_PARENT: the parent device on the host. This is only
682 set for network types 'mavclan', 'veth', 'phys'.
683 </para>
684 </listitem>
685
686 <listitem>
687 <para>
688 LXC_NET_PEER: the name of the peer device on the host. This is
689 only set for 'veth' network types. Note that this information
690 is only available when <option>lxc.hook.version</option> is set
691 to 1.
692 </para>
693 </listitem>
694 </itemizedlist>
695
696 Whether this information is provided in the form of environment
697 variables or as arguments to the script depends on the value of
698 <option>lxc.hook.version</option>. If set to 1 then information is
699 provided in the form of environment variables. If set to 0
700 information is provided as arguments to the script.
c464fd7e 701 </para>
14a7b0f9 702
c464fd7e
SG
703 <para>
704 Standard output from the script is logged at debug level.
705 Standard error is not logged, but can be captured by the
706 hook redirecting its standard error to standard output.
707 </para>
708 </listitem>
709 </varlistentry>
710
711 <varlistentry>
712 <term>
7fa3f2e9 713 <option>lxc.net.[i].script.down</option>
c464fd7e
SG
714 </term>
715 <listitem>
716 <para>
b9986e43 717 Add a configuration option to specify a script to be
c464fd7e 718 executed before destroying the network used from the
14a7b0f9
CB
719 host side.
720 </para>
721
722 <para>
723 In addition to the information available to all hooks. The
724 following information is provided to the script:
725 <itemizedlist>
726 <listitem>
727 <para>
728 LXC_HOOK_TYPE: the hook type. This is either 'up' or 'down'.
729 </para>
730 </listitem>
731
732 <listitem>
733 <para>
734 LXC_HOOK_SECTION: the section type 'net'.
735 </para>
736 </listitem>
737
738 <listitem>
739 <para>
740 LXC_NET_TYPE: the network type. This is one of the valid
741 network types listed here (e.g. 'macvlan', 'veth').
742 </para>
743 </listitem>
744
745 <listitem>
746 <para>
747 LXC_NET_PARENT: the parent device on the host. This is only
748 set for network types 'mavclan', 'veth', 'phys'.
749 </para>
750 </listitem>
751
752 <listitem>
753 <para>
754 LXC_NET_PEER: the name of the peer device on the host. This is
755 only set for 'veth' network types. Note that this information
756 is only available when <option>lxc.hook.version</option> is set
757 to 1.
758 </para>
759 </listitem>
760 </itemizedlist>
761
762 Whether this information is provided in the form of environment
763 variables or as arguments to the script depends on the value of
764 <option>lxc.hook.version</option>. If set to 1 then information is
765 provided in the form of environment variables. If set to 0
766 information is provided as arguments to the script.
c464fd7e 767 </para>
14a7b0f9 768
c464fd7e
SG
769 <para>
770 Standard output from the script is logged at debug level.
771 Standard error is not logged, but can be captured by the
772 hook redirecting its standard error to standard output.
773 </para>
774 </listitem>
775 </varlistentry>
55fc19a1
SG
776 </variablelist>
777 </refsect2>
778
779 <refsect2>
780 <title>New pseudo tty instance (devpts)</title>
781 <para>
c464fd7e
SG
782 For stricter isolation the container can have its own private
783 instance of the pseudo tty.
55fc19a1
SG
784 </para>
785 <variablelist>
c464fd7e
SG
786 <varlistentry>
787 <term>
232763d6 788 <option>lxc.pty.max</option>
c464fd7e
SG
789 </term>
790 <listitem>
791 <para>
792 If set, the container will have a new pseudo tty
793 instance, making this private to it. The value specifies
55fc19a1
SG
794 the maximum number of pseudo ttys allowed for a pts
795 instance (this limitation is not implemented yet).
c464fd7e
SG
796 </para>
797 </listitem>
798 </varlistentry>
55fc19a1
SG
799 </variablelist>
800 </refsect2>
801
802 <refsect2>
803 <title>Container system console</title>
804 <para>
c464fd7e
SG
805 If the container is configured with a root filesystem and the
806 inittab file is setup to use the console, you may want to specify
807 where the output of this console goes.
55fc19a1
SG
808 </para>
809 <variablelist>
28f3b1cd
CB
810
811 <varlistentry>
812 <term>
813 <option>lxc.console.buffer.size</option>
814 </term>
815 <listitem>
816 <para>
817 Setting this option instructs liblxc to allocate an in-memory
818 ringbuffer. The container's console output will be written to the
819 ringbuffer. Note that ringbuffer must be at least as big as a
820 standard page size. When passed a value smaller than a single page
821 size liblxc will allocate a ringbuffer of a single page size. A page
822 size is usually 4kB.
823
824 The keyword 'auto' will cause liblxc to allocate a ringbuffer of
825 128kB.
826
827 When manually specifying a size for the ringbuffer the value should
828 be a power of 2 when converted to bytes. Valid size prefixes are
829 'kB', 'MB', 'GB'. (Note that all conversions are based on multiples
830 of 1024. That means 'kb' == 'KiB', 'MB' == 'MiB', 'GB' == 'GiB'.)
831 </para>
832 </listitem>
833 </varlistentry>
834
861813e5
CB
835 <varlistentry>
836 <term>
837 <option>lxc.console.size</option>
838 </term>
839 <listitem>
840 <para>
841 Setting this option instructs liblxc to place a limit on the size of
842 the console log file specified in
843 <option>lxc.console.logfile</option>. Note that size of the log file
844 must be at least as big as a standard page size. When passed a value
845 smaller than a single page size liblxc will set the size of log file
846 to a single page size. A page size is usually 4kB.
847
848 The keyword 'auto' will cause liblxc to place a limit of 128kB on
849 the log file.
850
851 When manually specifying a size for the log file the value should
852 be a power of 2 when converted to bytes. Valid size prefixes are
853 'kB', 'MB', 'GB'. (Note that all conversions are based on multiples
854 of 1024. That means 'kb' == 'KiB', 'MB' == 'MiB', 'GB' == 'GiB'.)
855
856 If users want to mirror the console ringbuffer on disk they should set
857 <option>lxc.console.size</option> equal to
858 <option>lxc.console.buffer.size</option>.
859 </para>
860 </listitem>
861 </varlistentry>
862
c464fd7e
SG
863 <varlistentry>
864 <term>
865 <option>lxc.console.logfile</option>
866 </term>
867 <listitem>
868 <para>
d91adfa6
CB
869 Specify a path to a file where the console output will be written.
870 Note that in contrast to the on-disk ringbuffer logfile this file
871 will keep growing potentially filling up the users disks if not
872 rotated and deleted. This problem can also be avoided by using the
873 in-memory ringbuffer options
874 <option>lxc.console.buffer.size</option> and
875 <option>lxc.console.buffer.logfile</option>.
c464fd7e
SG
876 </para>
877 </listitem>
878 </varlistentry>
d91adfa6
CB
879
880 <varlistentry>
881 <term>
882 <option>lxc.console.rotate</option>
883 </term>
884 <listitem>
885 <para>
886 Whether to rotate the console logfile specified in
887 <option>lxc.console.logfile</option>. Users can send an API
888 request to rotate the logfile. Note that the old logfile will have
889 the same name as the original with the suffix ".1" appended.
890
891 Users wishing to prevent the console log file from filling the
892 disk should rotate the logfile and delete it if unneeded. This
893 problem can also be avoided by using the in-memory ringbuffer
894 options <option>lxc.console.buffer.size</option> and
895 <option>lxc.console.buffer.logfile</option>.
896 </para>
897 </listitem>
898 </varlistentry>
899
c464fd7e
SG
900 <varlistentry>
901 <term>
3aed4934 902 <option>lxc.console.path</option>
c464fd7e
SG
903 </term>
904 <listitem>
905 <para>
906 Specify a path to a device to which the console will be
6e3bb289
CB
907 attached. The keyword 'none' will simply disable the
908 console. Note, when specifying 'none' and creating a device node
909 for the console in the container at /dev/console or bind-mounting
910 the hosts's /dev/console into the container at /dev/console the
911 container will have direct access to the hosts's /dev/console.
912 This is dangerous when the container has write access to the
913 device and should thus be used with caution.
c464fd7e
SG
914 </para>
915 </listitem>
916 </varlistentry>
55fc19a1
SG
917 </variablelist>
918 </refsect2>
919
920 <refsect2>
921 <title>Console through the ttys</title>
922 <para>
c464fd7e
SG
923 This option is useful if the container is configured with a root
924 filesystem and the inittab file is setup to launch a getty on the
925 ttys. The option specifies the number of ttys to be available for
926 the container. The number of gettys in the inittab file of the
927 container should not be greater than the number of ttys specified
928 in this option, otherwise the excess getty sessions will die and
929 respawn indefinitely giving annoying messages on the console or in
930 <filename>/var/log/messages</filename>.
55fc19a1
SG
931 </para>
932 <variablelist>
c464fd7e
SG
933 <varlistentry>
934 <term>
fe1c5887 935 <option>lxc.tty.max</option>
c464fd7e
SG
936 </term>
937 <listitem>
938 <para>
939 Specify the number of tty to make available to the
940 container.
941 </para>
942 </listitem>
943 </varlistentry>
55fc19a1
SG
944 </variablelist>
945 </refsect2>
946
947 <refsect2>
948 <title>Console devices location</title>
949 <para>
950 LXC consoles are provided through Unix98 PTYs created on the
c464fd7e
SG
951 host and bind-mounted over the expected devices in the container.
952 By default, they are bind-mounted over <filename>/dev/console</filename>
953 and <filename>/dev/ttyN</filename>. This can prevent package upgrades
954 in the guest. Therefore you can specify a directory location (under
955 <filename>/dev</filename> under which LXC will create the files and
956 bind-mount over them. These will then be symbolically linked to
957 <filename>/dev/console</filename> and <filename>/dev/ttyN</filename>.
958 A package upgrade can then succeed as it is able to remove and replace
959 the symbolic links.
55fc19a1
SG
960 </para>
961 <variablelist>
c464fd7e
SG
962 <varlistentry>
963 <term>
fe1c5887 964 <option>lxc.tty.dir</option>
c464fd7e
SG
965 </term>
966 <listitem>
967 <para>
968 Specify a directory under <filename>/dev</filename>
6e3bb289
CB
969 under which to create the container console devices. Note that LXC
970 will move any bind-mounts or device nodes for /dev/console into
971 this directory.
c464fd7e
SG
972 </para>
973 </listitem>
974 </varlistentry>
55fc19a1
SG
975 </variablelist>
976 </refsect2>
977
978 <refsect2>
979 <title>/dev directory</title>
980 <para>
c464fd7e
SG
981 By default, lxc creates a few symbolic links (fd,stdin,stdout,stderr)
982 in the container's <filename>/dev</filename> directory but does not
983 automatically create device node entries. This allows the container's
984 <filename>/dev</filename> to be set up as needed in the container
985 rootfs. If lxc.autodev is set to 1, then after mounting the container's
986 rootfs LXC will mount a fresh tmpfs under <filename>/dev</filename>
c35d2909 987 (limited to 500k) and fill in a minimal set of initial devices.
55fc19a1
SG
988 This is generally required when starting a container containing
989 a "systemd" based "init" but may be optional at other times. Additional
990 devices in the containers /dev directory may be created through the
991 use of the <option>lxc.hook.autodev</option> hook.
992 </para>
993 <variablelist>
c464fd7e
SG
994 <varlistentry>
995 <term>
996 <option>lxc.autodev</option>
997 </term>
998 <listitem>
999 <para>
124fa0a8 1000 Set this to 0 to stop LXC from mounting and populating a minimal
c464fd7e
SG
1001 <filename>/dev</filename> when starting the container.
1002 </para>
1003 </listitem>
1004 </varlistentry>
55fc19a1 1005 </variablelist>
55fc19a1
SG
1006 </refsect2>
1007
1008 <refsect2>
1009 <title>Mount points</title>
1010 <para>
c464fd7e
SG
1011 The mount points section specifies the different places to be
1012 mounted. These mount points will be private to the container
1013 and won't be visible by the processes running outside of the
1014 container. This is useful to mount /etc, /var or /home for
1015 examples.
55fc19a1 1016 </para>
592fd47a
SH
1017 <para>
1018 NOTE - LXC will generally ensure that mount targets and relative
1019 bind-mount sources are properly confined under the container
1020 root, to avoid attacks involving over-mounting host directories
1021 and files. (Symbolic links in absolute mount sources are ignored)
1022 However, if the container configuration first mounts a directory which
1023 is under the control of the container user, such as /home/joe, into
1024 the container at some <filename>path</filename>, and then mounts
1025 under <filename>path</filename>, then a TOCTTOU attack would be
1026 possible where the container user modifies a symbolic link under
1027 his home directory at just the right time.
1028 </para>
55fc19a1 1029 <variablelist>
c464fd7e
SG
1030 <varlistentry>
1031 <term>
47148e96 1032 <option>lxc.mount.fstab</option>
c464fd7e
SG
1033 </term>
1034 <listitem>
1035 <para>
1036 specify a file location in
1037 the <filename>fstab</filename> format, containing the
1038 mount information. The mount target location can and in
1039 most cases should be a relative path, which will become
1040 relative to the mounted container root. For instance,
1041 </para>
b9986e43
CB
1042 <programlisting>
1043 proc proc proc nodev,noexec,nosuid 0 0
1044 </programlisting>
c464fd7e
SG
1045 <para>
1046 Will mount a proc filesystem under the container's /proc,
1047 regardless of where the root filesystem comes from. This
1048 is resilient to block device backed filesystems as well as
1049 container cloning.
1050 </para>
1051 <para>
1052 Note that when mounting a filesystem from an
1053 image file or block device the third field (fs_vfstype)
1054 cannot be auto as with
55fc19a1 1055 <citerefentry>
c464fd7e 1056 <refentrytitle>mount</refentrytitle>
55fc19a1
SG
1057 <manvolnum>8</manvolnum>
1058 </citerefentry>
1059 but must be explicitly specified.
c464fd7e
SG
1060 </para>
1061 </listitem>
1062 </varlistentry>
1063
1064 <varlistentry>
1065 <term>
1066 <option>lxc.mount.entry</option>
1067 </term>
1068 <listitem>
1069 <para>
d840039e 1070 Specify a mount point corresponding to a line in the
c464fd7e 1071 fstab format.
f5b67b36 1072
d840039e
YT
1073 Moreover lxc supports mount propagation, such as rslave or
1074 rprivate, and adds three additional mount options.
f5b67b36
NC
1075 <option>optional</option> don't fail if mount does not work.
1076 <option>create=dir</option> or <option>create=file</option>
1077 to create dir (or file) when the point will be mounted.
181437fd
YT
1078 <option>relative</option> source path is taken to be relative to
1079 the mounted container root. For instance,
1080 </para>
1081<screen>
1082dev/null proc/kcore none bind,relative 0 0
1083</screen>
1084 <para>
1085 Will expand dev/null to ${<option>LXC_ROOTFS_MOUNT</option>}/dev/null,
1086 and mount it to proc/kcore inside the container.
1087 </para>
c464fd7e
SG
1088 </listitem>
1089 </varlistentry>
1090
1091 <varlistentry>
1092 <term>
1093 <option>lxc.mount.auto</option>
1094 </term>
1095 <listitem>
1096 <para>
1097 specify which standard kernel file systems should be
1098 automatically mounted. This may dramatically simplify
1099 the configuration. The file systems are:
1100 </para>
1101 <itemizedlist>
1102 <listitem>
1103 <para>
1104 <option>proc:mixed</option> (or <option>proc</option>):
1105 mount <filename>/proc</filename> as read-write, but
1106 remount <filename>/proc/sys</filename> and
1107 <filename>/proc/sysrq-trigger</filename> read-only
1108 for security / container isolation purposes.
1109 </para>
1110 </listitem>
1111 <listitem>
1112 <para>
1113 <option>proc:rw</option>: mount
1114 <filename>/proc</filename> as read-write
1115 </para>
1116 </listitem>
1117 <listitem>
1118 <para>
f24a52d5
SG
1119 <option>sys:mixed</option> (or <option>sys</option>):
1120 mount <filename>/sys</filename> as read-only but with
1121 /sys/devices/virtual/net writable.
1122 </para>
1123 </listitem>
1124 <listitem>
1125 <para>
1126 <option>sys:ro</option>:
c464fd7e
SG
1127 mount <filename>/sys</filename> as read-only
1128 for security / container isolation purposes.
1129 </para>
1130 </listitem>
1131 <listitem>
1132 <para>
1133 <option>sys:rw</option>: mount
1134 <filename>/sys</filename> as read-write
1135 </para>
1136 </listitem>
3f69fb12 1137
c464fd7e
SG
1138 <listitem>
1139 <para>
1140 <option>cgroup:mixed</option>:
3f69fb12
SY
1141 Mount a tmpfs to <filename>/sys/fs/cgroup</filename>,
1142 create directories for all hierarchies to which the container
1143 is added, create subdirectories in those hierarchies with the
1144 name of the cgroup, and bind-mount the container's own cgroup
1145 into that directory. The container will be able to write to
1146 its own cgroup directory, but not the parents, since they will
1147 be remounted read-only.
c464fd7e
SG
1148 </para>
1149 </listitem>
3f69fb12 1150
c464fd7e
SG
1151 <listitem>
1152 <para>
3f69fb12
SY
1153 <option>cgroup:mixed:force</option>:
1154 The <option>force</option> option will cause LXC to perform
1155 the cgroup mounts for the container under all circumstances.
1156 Otherwise it is similar to <option>cgroup:mixed</option>.
1157 This is mainly useful when the cgroup namespaces are enabled
1158 where LXC will normally leave mounting cgroups to the init
1159 binary of the container since it is perfectly safe to do so.
c464fd7e
SG
1160 </para>
1161 </listitem>
3f69fb12
SY
1162
1163 <listitem>
1164 <para>
1165 <option>cgroup:ro</option>:
1166 similar to <option>cgroup:mixed</option>, but everything will
1167 be mounted read-only.
1168 </para>
1169 </listitem>
1170
1171 <listitem>
1172 <para>
1173 <option>cgroup:ro:force</option>:
1174 The <option>force</option> option will cause LXC to perform
1175 the cgroup mounts for the container under all circumstances.
1176 Otherwise it is similar to <option>cgroup:ro</option>.
1177 This is mainly useful when the cgroup namespaces are enabled
1178 where LXC will normally leave mounting cgroups to the init
1179 binary of the container since it is perfectly safe to do so.
1180 </para>
1181 </listitem>
1182
c464fd7e
SG
1183 <listitem>
1184 <para>
1185 <option>cgroup:rw</option>: similar to
3f69fb12
SY
1186 <option>cgroup:mixed</option>, but everything will be mounted
1187 read-write. Note that the paths leading up to the container's
1188 own cgroup will be writable, but will not be a cgroup
1189 filesystem but just part of the tmpfs of
1190 <filename>/sys/fs/cgroup</filename>
1191 </para>
1192 </listitem>
1193
1194 <listitem>
1195 <para>
1196 <option>cgroup:rw:force</option>:
1197 The <option>force</option> option will cause LXC to perform
1198 the cgroup mounts for the container under all circumstances.
1199 Otherwise it is similar to <option>cgroup:rw</option>.
1200 This is mainly useful when the cgroup namespaces are enabled
1201 where LXC will normally leave mounting cgroups to the init
1202 binary of the container since it is perfectly safe to do so.
c464fd7e
SG
1203 </para>
1204 </listitem>
3f69fb12 1205
c464fd7e
SG
1206 <listitem>
1207 <para>
1208 <option>cgroup</option> (without specifier):
1209 defaults to <option>cgroup:rw</option> if the
1210 container retains the CAP_SYS_ADMIN capability,
1211 <option>cgroup:mixed</option> otherwise.
1212 </para>
1213 </listitem>
e7806b2e 1214
c464fd7e
SG
1215 <listitem>
1216 <para>
1217 <option>cgroup-full:mixed</option>:
1218 mount a tmpfs to <filename>/sys/fs/cgroup</filename>,
1219 create directories for all hierarchies to which
1220 the container is added, bind-mount the hierarchies
1221 from the host to the container and make everything
1222 read-only except the container's own cgroup. Note
1223 that compared to <option>cgroup</option>, where
1224 all paths leading up to the container's own cgroup
1225 are just simple directories in the underlying
1226 tmpfs, here
1227 <filename>/sys/fs/cgroup/$hierarchy</filename>
1228 will contain the host's full cgroup hierarchy,
1229 albeit read-only outside the container's own cgroup.
1230 This may leak quite a bit of information into the
1231 container.
1232 </para>
1233 </listitem>
e7806b2e
CB
1234
1235 <listitem>
1236 <para>
1237 <option>cgroup-full:mixed:force</option>:
1238 The <option>force</option> option will cause LXC to perform
1239 the cgroup mounts for the container under all circumstances.
1240 Otherwise it is similar to <option>cgroup-full:mixed</option>.
1241 This is mainly useful when the cgroup namespaces are enabled
1242 where LXC will normally leave mounting cgroups to the init
1243 binary of the container since it is perfectly safe to do so.
1244 </para>
1245 </listitem>
1246
c464fd7e
SG
1247 <listitem>
1248 <para>
1249 <option>cgroup-full:ro</option>: similar to
1250 <option>cgroup-full:mixed</option>, but everything
1251 will be mounted read-only.
1252 </para>
1253 </listitem>
e7806b2e
CB
1254
1255 <listitem>
1256 <para>
1257 <option>cgroup-full:ro:force</option>:
1258 The <option>force</option> option will cause LXC to perform
1259 the cgroup mounts for the container under all circumstances.
1260 Otherwise it is similar to <option>cgroup-full:ro</option>.
1261 This is mainly useful when the cgroup namespaces are enabled
1262 where LXC will normally leave mounting cgroups to the init
1263 binary of the container since it is perfectly safe to do so.
1264 </para>
1265 </listitem>
1266
c464fd7e
SG
1267 <listitem>
1268 <para>
1269 <option>cgroup-full:rw</option>: similar to
1270 <option>cgroup-full:mixed</option>, but everything
1271 will be mounted read-write. Note that in this case,
1272 the container may escape its own cgroup. (Note also
1273 that if the container has CAP_SYS_ADMIN support
1274 and can mount the cgroup filesystem itself, it may
1275 do so anyway.)
1276 </para>
1277 </listitem>
e7806b2e
CB
1278
1279 <listitem>
1280 <para>
1281 <option>cgroup-full:rw:force</option>:
1282 The <option>force</option> option will cause LXC to perform
1283 the cgroup mounts for the container under all circumstances.
1284 Otherwise it is similar to <option>cgroup-full:rw</option>.
1285 This is mainly useful when the cgroup namespaces are enabled
1286 where LXC will normally leave mounting cgroups to the init
1287 binary of the container since it is perfectly safe to do so.
1288 </para>
1289 </listitem>
1290
c464fd7e
SG
1291 <listitem>
1292 <para>
1293 <option>cgroup-full</option> (without specifier):
1294 defaults to <option>cgroup-full:rw</option> if the
1295 container retains the CAP_SYS_ADMIN capability,
1296 <option>cgroup-full:mixed</option> otherwise.
1297 </para>
1298 </listitem>
e7806b2e 1299
c464fd7e 1300 </itemizedlist>
4608594e
SH
1301 <para>
1302 If cgroup namespaces are enabled, then any <option>cgroup</option>
1303 auto-mounting request will be ignored, since the container can
1304 mount the filesystems itself, and automounting can confuse the
1305 container init.
1306 </para>
c464fd7e
SG
1307 <para>
1308 Note that if automatic mounting of the cgroup filesystem
1309 is enabled, the tmpfs under
1310 <filename>/sys/fs/cgroup</filename> will always be
1311 mounted read-write (but for the <option>:mixed</option>
1312 and <option>:ro</option> cases, the individual
1313 hierarchies,
1314 <filename>/sys/fs/cgroup/$hierarchy</filename>, will be
1315 read-only). This is in order to work around a quirk in
1316 Ubuntu's
b46f0553 1317 <citerefentry>
c464fd7e 1318 <refentrytitle>mountall</refentrytitle>
b46f0553
CS
1319 <manvolnum>8</manvolnum>
1320 </citerefentry>
c464fd7e
SG
1321 command that will cause containers to wait for user
1322 input at boot if
1323 <filename>/sys/fs/cgroup</filename> is mounted read-only
1324 and the container can't remount it read-write due to a
1325 lack of CAP_SYS_ADMIN.
1326 </para>
1327 <para>
1328 Examples:
1329 </para>
1330 <programlisting>
1331 lxc.mount.auto = proc sys cgroup
1332 lxc.mount.auto = proc:rw sys:rw cgroup-full:rw
1333 </programlisting>
1334 </listitem>
1335 </varlistentry>
55fc19a1
SG
1336
1337 </variablelist>
1338 </refsect2>
1339
1340 <refsect2>
1341 <title>Root file system</title>
1342 <para>
c464fd7e
SG
1343 The root file system of the container can be different than that
1344 of the host system.
55fc19a1
SG
1345 </para>
1346 <variablelist>
c464fd7e
SG
1347 <varlistentry>
1348 <term>
7a96a068 1349 <option>lxc.rootfs.path</option>
c464fd7e
SG
1350 </term>
1351 <listitem>
1352 <para>
1353 specify the root file system for the container. It can
1354 be an image file, a directory or a block device. If not
1355 specified, the container shares its root file system
1356 with the host.
1357 </para>
1358 <para>
f1c26f2c
SH
1359 For directory or simple block-device backed containers,
1360 a pathname can be used. If the rootfs is backed by a nbd
1361 device, then <filename>nbd:file:1</filename> specifies that
1362 <filename>file</filename> should be attached to a nbd device,
1363 and partition 1 should be mounted as the rootfs.
1364 <filename>nbd:file</filename> specifies that the nbd device
1365 itself should be mounted. <filename>overlayfs:/lower:/upper</filename>
1366 specifies that the rootfs should be an overlay with <filename>/upper</filename>
1367 being mounted read-write over a read-only mount of <filename>/lower</filename>.
1368 <filename>aufs:/lower:/upper</filename> does the same using aufs in place
280d2379
CB
1369 of overlayfs. For both <filename>overlayfs</filename> and
1370 <filename>aufs</filename> multiple <filename>/lower</filename>
1371 directories can be specified. <filename>loop:/file</filename> tells lxc to attach
f1c26f2c 1372 <filename>/file</filename> to a loop device and mount the loop device.
c464fd7e
SG
1373 </para>
1374 </listitem>
1375 </varlistentry>
1376
1377 <varlistentry>
1378 <term>
1379 <option>lxc.rootfs.mount</option>
1380 </term>
1381 <listitem>
1382 <para>
7a96a068 1383 where to recursively bind <option>lxc.rootfs.path</option>
c464fd7e
SG
1384 before pivoting. This is to ensure success of the
1385 <citerefentry>
1386 <refentrytitle><command>pivot_root</command></refentrytitle>
1387 <manvolnum>8</manvolnum>
1388 </citerefentry>
1389 syscall. Any directory suffices, the default should
1390 generally work.
1391 </para>
1392 </listitem>
1393 </varlistentry>
1394
1395 <varlistentry>
1396 <term>
1397 <option>lxc.rootfs.options</option>
1398 </term>
1399 <listitem>
1400 <para>
1401 extra mount options to use when mounting the rootfs.
1402 </para>
1403 </listitem>
1404 </varlistentry>
a17b1e65 1405
55fc19a1
SG
1406 </variablelist>
1407 </refsect2>
1408
1409 <refsect2>
1410 <title>Control group</title>
1411 <para>
c464fd7e
SG
1412 The control group section contains the configuration for the
1413 different subsystem. <command>lxc</command> does not check the
1414 correctness of the subsystem name. This has the disadvantage
1415 of not detecting configuration errors until the container is
1416 started, but has the advantage of permitting any future
1417 subsystem.
55fc19a1
SG
1418 </para>
1419 <variablelist>
c464fd7e
SG
1420 <varlistentry>
1421 <term>
54860ed0 1422 <option>lxc.cgroup.[controller name]</option>
c464fd7e
SG
1423 </term>
1424 <listitem>
1425 <para>
54860ed0
CB
1426 Specify the control group value to be set on a legacy cgroup
1427 hierarchy. The controller name is the literal name of the control
1428 group. The permitted names and the syntax of their values is not
1429 dictated by LXC, instead it depends on the features of the Linux
1430 kernel running at the time the container is started, eg.
1431 <option>lxc.cgroup.cpuset.cpus</option>
1432 </para>
1433 </listitem>
1434 </varlistentry>
1435 <varlistentry>
1436 <term>
1437 <option>lxc.cgroup2.[controller name]</option>
1438 </term>
1439 <listitem>
1440 <para>
1441 Specify the control group value to be set on the unified cgroup
1442 shierarchy. The controller name is the literal name of the control
1443 group. The permitted names and the syntax of their values is not
1444 dictated by LXC, instead it depends on the features of the Linux
1445 kernel running at the time the container is started, eg.
1446 <option>lxc.cgroup2.memory.high</option>
c464fd7e
SG
1447 </para>
1448 </listitem>
1449 </varlistentry>
bdcbb6b3
CB
1450 <varlistentry>
1451 <term>
1452 <option>lxc.cgroup.dir</option>
1453 </term>
1454 <listitem>
1455 <para>
1456 specify a directory or path in which the container's cgroup will
1457 be created. For example, setting
1458 <option>lxc.cgroup.dir = my-cgroup/first</option> for a container
1459 named "c1" will create the container's cgroup as a sub-cgroup of
1460 "my-cgroup". For example, if the user's current cgroup "my-user"
78be8d75 1461 is located in the root cgroup of the cpuset controller in a
bdcbb6b3
CB
1462 cgroup v1 hierarchy this would create the cgroup
1463 "/sys/fs/cgroup/cpuset/my-user/my-cgroup/first/c1" for the
1464 container. Any missing cgroups will be created by LXC. This
1465 presupposes that the user has write access to its current cgroup.
1466 </para>
1467 </listitem>
1468 </varlistentry>
55fc19a1
SG
1469 </variablelist>
1470 </refsect2>
1471
1472 <refsect2>
1473 <title>Capabilities</title>
1474 <para>
c464fd7e
SG
1475 The capabilities can be dropped in the container if this one
1476 is run as root.
55fc19a1
SG
1477 </para>
1478 <variablelist>
c464fd7e
SG
1479 <varlistentry>
1480 <term>
1481 <option>lxc.cap.drop</option>
1482 </term>
1483 <listitem>
1484 <para>
1485 Specify the capability to be dropped in the container. A
1486 single line defining several capabilities with a space
1487 separation is allowed. The format is the lower case of
1488 the capability definition without the "CAP_" prefix,
1489 eg. CAP_SYS_MODULE should be specified as
1490 sys_module. See
1491 <citerefentry>
1492 <refentrytitle><command>capabilities</command></refentrytitle>
1493 <manvolnum>7</manvolnum>
7eff30fd
MH
1494 </citerefentry>.
1495 If used with no value, lxc will clear any drop capabilities
1496 specified up to this point.
c464fd7e
SG
1497 </para>
1498 </listitem>
1499 </varlistentry>
1500 <varlistentry>
1501 <term>
1502 <option>lxc.cap.keep</option>
1503 </term>
1504 <listitem>
1505 <para>
1506 Specify the capability to be kept in the container. All other
1507 capabilities will be dropped. When a special value of "none" is
1508 encountered, lxc will clear any keep capabilities specified up
1509 to this point. A value of "none" alone can be used to drop all
1510 capabilities.
1511 </para>
1512 </listitem>
1513 </varlistentry>
55fc19a1
SG
1514 </variablelist>
1515 </refsect2>
1516
f3c9f122 1517 <refsect2>
46186acd 1518 <title>Namespaces</title>
f3c9f122 1519 <para>
46186acd
CB
1520 A namespace can be cloned (<option>lxc.namespace.clone</option>),
1521 kept (<option>lxc.namespace.keep</option>) or shared
1522 (<option>lxc.namespace.share.[namespace identifier]</option>).
f3c9f122
CB
1523 </para>
1524 <variablelist>
46186acd
CB
1525 <varlistentry>
1526 <term>
1527 <option>lxc.namespace.clone</option>
1528 </term>
1529 <listitem>
1530 <para>
1531 Specify namespaces which the container is supposed to be created
1532 with. The namespaces to create are specified as a space separated
1533 list. Each namespace must correspond to one of the standard
1534 namespace identifiers as seen in the
1535 <filename>/proc/PID/ns</filename> directory.
1536 When <option>lxc.namespace.clone</option> is not explicitly set all
1537 namespaces supported by the kernel and the current configuration
1538 will be used.
1539 </para>
1540
1541 <para>
1542 To create a new mount, net and ipc namespace set
1543 <option>lxc.namespace.clone=mount net ipc</option>.
1544 </para>
1545 </listitem>
1546 </varlistentry>
1547
1548 <varlistentry>
1549 <term>
1550 <option>lxc.namespace.keep</option>
1551 </term>
1552 <listitem>
1553 <para>
1554 Specify namespaces which the container is supposed to inherit from
1555 the process that created it. The namespaces to keep are specified as
1556 a space separated list. Each namespace must correspond to one of the
1557 standard namespace identifiers as seen in the
1558 <filename>/proc/PID/ns</filename> directory.
1559 The <option>lxc.namespace.keep</option> is a
1560 blacklist option, i.e. it is useful when enforcing that containers
1561 must keep a specific set of namespaces.
1562 </para>
1563
1564 <para>
1565 To keep the network, user and ipc namespace set
1566 <option>lxc.namespace.keep=user net ipc</option>.
1567 </para>
1568
1569 <para>
1570 Note that sharing pid namespaces will likely not work with most init
1571 systems.
1572 </para>
1573
1574 <para>
1575 Note that if the container requests a new user namespace and the
1576 container wants to inherit the network namespace it needs to inherit
1577 the user namespace as well.
1578 </para>
1579 </listitem>
1580 </varlistentry>
1581
f3c9f122
CB
1582 <varlistentry>
1583 <term>
b074bbf1 1584 <option>lxc.namespace.share.[namespace identifier]</option>
f3c9f122
CB
1585 </term>
1586 <listitem>
1587 <para>
1588 Specify a namespace to inherit from another container or process.
1589 The <option>[namespace identifier]</option> suffix needs to be
1590 replaced with one of the namespaces that appear in the
1591 <filename>/proc/PID/ns</filename> directory.
1592 </para>
1593
1594 <para>
1595 To inherit the namespace from another process set the
b074bbf1
CB
1596 <option>lxc.namespace.share.[namespace identifier]</option> to the PID of
1597 the process, e.g. <option>lxc.namespace.share.net=42</option>.
f3c9f122
CB
1598 </para>
1599
1600 <para>
1601 To inherit the namespace from another container set the
b074bbf1
CB
1602 <option>lxc.namespace.share.[namespace identifier]</option> to the name of
1603 the container, e.g. <option>lxc.namespace.share.pid=c3</option>.
f3c9f122
CB
1604 </para>
1605
1606 <para>
1607 To inherit the namespace from another container located in a
1608 different path than the standard liblxc path set the
b074bbf1 1609 <option>lxc.namespace.share.[namespace identifier]</option> to the full
f3c9f122 1610 path to the container, e.g.
b074bbf1 1611 <option>lxc.namespace.share.user=/opt/c3</option>.
f3c9f122
CB
1612 </para>
1613
1614 <para>
1615 In order to inherit namespaces the caller needs to have sufficient
1616 privilege over the process or container.
1617 </para>
1618
1619 <para>
1620 Note that sharing pid namespaces between system containers will
1621 likely not work with most init systems.
1622 </para>
1623
1624 <para>
1625 Note that if two processes are in different user namespaces and one
1626 process wants to inherit the other's network namespace it usually
1627 needs to inherit the user namespace as well.
1628 </para>
1629 </listitem>
1630 </varlistentry>
1631 </variablelist>
1632 </refsect2>
1633
93f9e90d
WB
1634 <refsect2>
1635 <title>Resource limits</title>
1636 <para>
1637 The soft and hard resource limits for the container can be changed.
1638 Unprivileged containers can only lower them. Resources which are not
1639 explicitly specified will be inherited.
1640 </para>
1641 <variablelist>
1642 <varlistentry>
1643 <term>
240d4b74 1644 <option>lxc.prlimit.[limit name]</option>
93f9e90d
WB
1645 </term>
1646 <listitem>
1647 <para>
1648 Specify the resource limit to be set. A limit is specified as two
1649 colon separated values which are either numeric or the word
1650 'unlimited'. A single value can be used as a shortcut to set both
1651 soft and hard limit to the same value. The permitted names the
1652 "RLIMIT_" resource names in lowercase without the "RLIMIT_"
1653 prefix, eg. RLIMIT_NOFILE should be specified as "nofile". See
1654 <citerefentry>
1655 <refentrytitle><command>setrlimit</command></refentrytitle>
1656 <manvolnum>2</manvolnum>
1657 </citerefentry>.
1658 If used with no value, lxc will clear the resource limit
1659 specified up to this point. A resource with no explicitly
1660 configured limitation will be inherited from the process starting
1661 up the container.
1662 </para>
1663 </listitem>
1664 </varlistentry>
1665 </variablelist>
1666 </refsect2>
1667
7edd0540
L
1668 <refsect2>
1669 <title>Sysctl</title>
1670 <para>
1671 Configure kernel parameters for the container.
1672 </para>
1673 <variablelist>
1674 <varlistentry>
1675 <term>
1676 <option>lxc.sysctl.[kernel parameters name]</option>
1677 </term>
1678 <listitem>
1679 <para>
1680 Specify the kernel parameters to be set. The parameters available
1681 are those listed under /proc/sys/.
e409b214 1682 Note that not all sysctls are namespaced. Changing Non-namespaced
7edd0540
L
1683 sysctls will cause the system-wide setting to be modified.
1684 <citerefentry>
1685 <refentrytitle><command>sysctl</command></refentrytitle>
1686 <manvolnum>8</manvolnum>
1687 </citerefentry>.
1688 If used with no value, lxc will clear the parameters specified up
1689 to this point.
1690 </para>
1691 </listitem>
1692 </varlistentry>
1693 </variablelist>
1694 </refsect2>
1695
55fc19a1
SG
1696 <refsect2>
1697 <title>Apparmor profile</title>
1698 <para>
c464fd7e
SG
1699 If lxc was compiled and installed with apparmor support, and the host
1700 system has apparmor enabled, then the apparmor profile under which the
1701 container should be run can be specified in the container
7a126ae1
SH
1702 configuration. The default is <command>lxc-container-default-cgns</command>
1703 if the host kernel is cgroup namespace aware, or
1704 <command>lxc-container-default</command> othewise.
55fc19a1
SG
1705 </para>
1706 <variablelist>
c464fd7e
SG
1707 <varlistentry>
1708 <term>
a1d5fdfd 1709 <option>lxc.apparmor.profile</option>
c464fd7e
SG
1710 </term>
1711 <listitem>
1712 <para>
1713 Specify the apparmor profile under which the container should
1714 be run. To specify that the container should be unconfined,
1715 use
1716 </para>
a1d5fdfd 1717 <programlisting>lxc.apparmor.profile = unconfined</programlisting>
7a126ae1
SH
1718 <para>
1719 If the apparmor profile should remain unchanged (i.e. if you
1720 are nesting containers and are already confined), then use
1721 </para>
a1d5fdfd 1722 <programlisting>lxc.apparmor.profile = unchanged</programlisting>
c464fd7e
SG
1723 </listitem>
1724 </varlistentry>
1725 <varlistentry>
1726 <term>
69e38e00 1727 <option>lxc.apparmor.allow_incomplete</option>
c464fd7e
SG
1728 </term>
1729 <listitem>
1730 <para>
1731 Apparmor profiles are pathname based. Therefore many file
1732 restrictions require mount restrictions to be effective against
1733 a determined attacker. However, these mount restrictions are not
1734 yet implemented in the upstream kernel. Without the mount
1735 restrictions, the apparmor profiles still protect against accidental
1736 damager.
1737 </para>
1738 <para>
1739 If this flag is 0 (default), then the container will not be
1740 started if the kernel lacks the apparmor mount features, so that a
1741 regression after a kernel upgrade will be detected. To start the
1742 container under partial apparmor protection, set this flag to 1.
1743 </para>
1744 </listitem>
1745 </varlistentry>
55fc19a1
SG
1746 </variablelist>
1747 </refsect2>
1748
1749 <refsect2>
1750 <title>SELinux context</title>
1751 <para>
c464fd7e
SG
1752 If lxc was compiled and installed with SELinux support, and the host
1753 system has SELinux enabled, then the SELinux context under which the
1754 container should be run can be specified in the container
1755 configuration. The default is <command>unconfined_t</command>,
1756 which means that lxc will not attempt to change contexts.
1757 See @DATADIR@/lxc/selinux/lxc.te for an example policy and more
1758 information.
55fc19a1
SG
1759 </para>
1760 <variablelist>
c464fd7e
SG
1761 <varlistentry>
1762 <term>
b84702ab 1763 <option>lxc.selinux.context</option>
c464fd7e
SG
1764 </term>
1765 <listitem>
1766 <para>
1767 Specify the SELinux context under which the container should
1768 be run or <command>unconfined_t</command>. For example
1769 </para>
b84702ab 1770 <programlisting>lxc.selinux.context = system_u:system_r:lxc_t:s0:c22</programlisting>
c464fd7e
SG
1771 </listitem>
1772 </varlistentry>
55fc19a1
SG
1773 </variablelist>
1774 </refsect2>
1775
1776 <refsect2>
1777 <title>Seccomp configuration</title>
1778 <para>
1779 A container can be started with a reduced set of available
c464fd7e
SG
1780 system calls by loading a seccomp profile at startup. The
1781 seccomp configuration file must begin with a version number
1782 on the first line, a policy type on the second line, followed
1783 by the configuration.
55fc19a1 1784 </para>
a7c27357
SH
1785 <para>
1786 Versions 1 and 2 are currently supported. In version 1, the
c464fd7e
SG
1787 policy is a simple whitelist. The second line therefore must
1788 read "whitelist", with the rest of the file containing one (numeric)
1789 sycall number per line. Each syscall number is whitelisted,
1790 while every unlisted number is blacklisted for use in the container
a7c27357
SH
1791 </para>
1792
1793 <para>
1794 In version 2, the policy may be blacklist or whitelist,
1795 supports per-rule and per-policy default actions, and supports
1796 per-architecture system call resolution from textual names.
1797 </para>
1798 <para>
1799 An example blacklist policy, in which all system calls are
1800 allowed except for mknod, which will simply do nothing and
1801 return 0 (success), looks like:
1802 </para>
b9986e43
CB
1803
1804 <programlisting>
1805 2
1806 blacklist
1807 mknod errno 0
1808 </programlisting>
1809
55fc19a1 1810 <variablelist>
c464fd7e
SG
1811 <varlistentry>
1812 <term>
0b427da0 1813 <option>lxc.seccomp.profile</option>
c464fd7e
SG
1814 </term>
1815 <listitem>
1816 <para>
1817 Specify a file containing the seccomp configuration to
1818 load before the container starts.
1819 </para>
1820 </listitem>
1821 </varlistentry>
55fc19a1
SG
1822 </variablelist>
1823 </refsect2>
1824
222ddc91
CB
1825 <refsect2>
1826 <title>PR_SET_NO_NEW_PRIVS</title>
1827 <para>
1828 With PR_SET_NO_NEW_PRIVS active execve() promises not to grant
1829 privileges to do anything that could not have been done without
1830 the execve() call (for example, rendering the set-user-ID and
1831 set-group-ID mode bits, and file capabilities non-functional).
1832 Once set, this bit cannot be unset. The setting of this bit is
1833 inherited by children created by fork() and clone(), and preserved
1834 across execve().
1835 Note that PR_SET_NO_NEW_PRIVS is applied after the container has
1836 changed into its intended AppArmor profile or SElinux context.
1837 </para>
1838 <variablelist>
1839 <varlistentry>
1840 <term>
1841 <option>lxc.no_new_privs</option>
1842 </term>
1843 <listitem>
1844 <para>
1845 Specify whether the PR_SET_NO_NEW_PRIVS flag should be set for the
1846 container. Set to 1 to activate.
1847 </para>
1848 </listitem>
1849 </varlistentry>
1850 </variablelist>
1851 </refsect2>
1852
55fc19a1
SG
1853 <refsect2>
1854 <title>UID mappings</title>
1855 <para>
1856 A container can be started in a private user namespace with
c464fd7e
SG
1857 user and group id mappings. For instance, you can map userid
1858 0 in the container to userid 200000 on the host. The root
1859 user in the container will be privileged in the container,
1860 but unprivileged on the host. Normally a system container
1861 will want a range of ids, so you would map, for instance,
1862 user and group ids 0 through 20,000 in the container to the
1863 ids 200,000 through 220,000.
55fc19a1
SG
1864 </para>
1865 <variablelist>
c464fd7e
SG
1866 <varlistentry>
1867 <term>
bdcbb6b3 1868 <option>lxc.idmap</option>
c464fd7e
SG
1869 </term>
1870 <listitem>
1871 <para>
1872 Four values must be provided. First a character, either
1873 'u', or 'g', to specify whether user or group ids are
1874 being mapped. Next is the first userid as seen in the
1875 user namespace of the container. Next is the userid as
1876 seen on the host. Finally, a range indicating the number
1877 of consecutive ids to map.
1878 </para>
1879 </listitem>
1880 </varlistentry>
55fc19a1
SG
1881 </variablelist>
1882 </refsect2>
1883
1884 <refsect2>
1885 <title>Container hooks</title>
1886 <para>
1887 Container hooks are programs or scripts which can be executed
c464fd7e 1888 at various times in a container's lifetime.
55fc19a1
SG
1889 </para>
1890 <para>
44ae0fb6
CB
1891 When a container hook is executed, additional information is passed
1892 along. The <option>lxc.hook.version</option> argument can be used to
1893 determine if the following arguments are passed as command line
1894 arguments or through environment variables. The arguments are:
c464fd7e
SG
1895 <itemizedlist>
1896 <listitem><para> Container name. </para></listitem>
1897 <listitem><para> Section (always 'lxc'). </para></listitem>
1898 <listitem><para> The hook type (i.e. 'clone' or 'pre-mount'). </para></listitem>
0a2b5ab1 1899 <listitem><para> Additional arguments. In the
a9145d62
CB
1900 case of the clone hook, any extra arguments passed will appear as
1901 further arguments to the hook. In the case of the stop hook, paths to
1902 filedescriptors for each of the container's namespaces along with
1903 their types are passed. </para></listitem>
c464fd7e
SG
1904 </itemizedlist>
1905 The following environment variables are set:
1906 <itemizedlist>
44ae0fb6
CB
1907 <listitem><para> LXC_CGNS_AWARE: indicator whether the container is
1908 cgroup namespace aware. </para></listitem>
1909 <listitem><para> LXC_CONFIG_FILE: the path to the container
1910 configuration file. </para></listitem>
1911 <listitem><para> LXC_HOOK_TYPE: the hook type (e.g. 'clone', 'mount',
1912 'pre-mount'). Note that the existence of this environment variable is
1913 conditional on the value of <option>lxc.hook.version</option>. If it
1914 is set to 1 then LXC_HOOK_TYPE will be set.
1915 </para></listitem>
1916 <listitem><para> LXC_HOOK_SECTION: the section type (e.g. 'lxc',
1917 'net'). Note that the existence of this environment variable is
1918 conditional on the value of <option>lxc.hook.version</option>. If it
1919 is set to 1 then LXC_HOOK_SECTION will be set.
1920 </para></listitem>
a2c09be0
CB
1921 <listitem><para> LXC_HOOK_VERSION: the version of the hooks. This
1922 value is identical to the value of the container's
1923 <option>lxc.hook.version</option> config item. If it is set to 0 then
1924 old-style hooks are used. If it is set to 1 then new-style hooks are
1925 used. </para></listitem>
44ae0fb6 1926 <listitem><para> LXC_LOG_LEVEL: the container's log level. </para></listitem>
c464fd7e 1927 <listitem><para> LXC_NAME: is the container's name. </para></listitem>
18b3b9c1
CB
1928 <listitem><para> LXC_[NAMESPACE IDENTIFIER]_NS: path under
1929 /proc/PID/fd/ to a file descriptor referring to the container's
1930 namespace. For each preserved namespace type there will be a separate
1931 environment variable. These environment variables will only be set if
1932 <option>lxc.hook.version</option> is set to 1. </para></listitem>
c464fd7e 1933 <listitem><para> LXC_ROOTFS_MOUNT: the path to the mounted root filesystem. </para></listitem>
44ae0fb6
CB
1934 <listitem><para> LXC_ROOTFS_PATH: this is the lxc.rootfs.path entry
1935 for the container. Note this is likely not where the mounted rootfs is
1936 to be found, use LXC_ROOTFS_MOUNT for that. </para></listitem>
1937 <listitem><para> LXC_SRC_NAME: in the case of the clone hook, this is
1938 the original container's name. </para></listitem>
c464fd7e 1939 </itemizedlist>
55fc19a1
SG
1940 </para>
1941 <para>
1942 Standard output from the hooks is logged at debug level.
1943 Standard error is not logged, but can be captured by the
1944 hook redirecting its standard error to standard output.
1945 </para>
1946 <variablelist>
44ae0fb6
CB
1947 <varlistentry>
1948 <term>
1949 <option>lxc.hook.version</option>
1950 </term>
1951 <listitem>
1952 <para>
1953 To pass the arguments in new style via environment variables set to
1954 1 otherwise set to 0 to pass them as arguments.
1955 This setting affects all hooks arguments that were traditionally
1956 passed as arguments to the script. Specifically, it affects the
1957 container name, section (e.g. 'lxc', 'net') and hook type (e.g.
1958 'clone', 'mount', 'pre-mount') arguments. If new-style hooks are
1959 used then the arguments will be available as environment variables.
1960 The container name will be set in LXC_NAME. (This is set
1961 independently of the value used for this config item.) The section
1962 will be set in LXC_HOOK_SECTION and the hook type will be set in
1963 LXC_HOOK_TYPE.
18b3b9c1
CB
1964 It also affects how the paths to file descriptors referring to the
1965 container's namespaces are passed. If set to 1 then for each
1966 namespace a separate environment variable LXC_[NAMESPACE
1967 IDENTIFIER]_NS will be set. If set to 0 then the paths will be
1968 passed as arguments to the stop hook.
44ae0fb6
CB
1969 </para>
1970 </listitem>
1971 </varlistentry>
1972 </variablelist>
1973 <variablelist>
c464fd7e
SG
1974 <varlistentry>
1975 <term>
1976 <option>lxc.hook.pre-start</option>
1977 </term>
1978 <listitem>
1979 <para>
1980 A hook to be run in the host's namespace before the
1981 container ttys, consoles, or mounts are up.
1982 </para>
1983 </listitem>
1984 </varlistentry>
55fc19a1
SG
1985 </variablelist>
1986 <variablelist>
c464fd7e
SG
1987 <varlistentry>
1988 <term>
1989 <option>lxc.hook.pre-mount</option>
1990 </term>
1991 <listitem>
1992 <para>
1993 A hook to be run in the container's fs namespace but before
1994 the rootfs has been set up. This allows for manipulation
1995 of the rootfs, i.e. to mount an encrypted filesystem. Mounts
1996 done in this hook will not be reflected on the host (apart from
1997 mounts propagation), so they will be automatically cleaned up
1998 when the container shuts down.
1999 </para>
2000 </listitem>
2001 </varlistentry>
55fc19a1
SG
2002 </variablelist>
2003 <variablelist>
c464fd7e
SG
2004 <varlistentry>
2005 <term>
2006 <option>lxc.hook.mount</option>
2007 </term>
2008 <listitem>
2009 <para>
2010 A hook to be run in the container's namespace after
2011 mounting has been done, but before the pivot_root.
2012 </para>
2013 </listitem>
2014 </varlistentry>
55fc19a1
SG
2015 </variablelist>
2016 <variablelist>
c464fd7e
SG
2017 <varlistentry>
2018 <term>
2019 <option>lxc.hook.autodev</option>
2020 </term>
2021 <listitem>
2022 <para>
2023 A hook to be run in the container's namespace after
2024 mounting has been done and after any mount hooks have
2025 run, but before the pivot_root, if
2026 <option>lxc.autodev</option> == 1.
2027 The purpose of this hook is to assist in populating the
2028 /dev directory of the container when using the autodev
2029 option for systemd based containers. The container's /dev
2030 directory is relative to the
2031 ${<option>LXC_ROOTFS_MOUNT</option>} environment
2032 variable available when the hook is run.
2033 </para>
2034 </listitem>
2035 </varlistentry>
55fc19a1 2036 </variablelist>
08dd2805
SH
2037 <variablelist>
2038 <varlistentry>
2039 <term>
2040 <option>lxc.hook.start-host</option>
2041 </term>
2042 <listitem>
2043 <para>
2044 A hook to be run in the host's namespace after the
2045 container has been setup, and immediately before starting
2046 the container init.
2047 </para>
2048 </listitem>
2049 </varlistentry>
2050 </variablelist>
55fc19a1 2051 <variablelist>
c464fd7e
SG
2052 <varlistentry>
2053 <term>
2054 <option>lxc.hook.start</option>
2055 </term>
2056 <listitem>
2057 <para>
2058 A hook to be run in the container's namespace immediately
2059 before executing the container's init. This requires the
2060 program to be available in the container.
2061 </para>
2062 </listitem>
2063 </varlistentry>
55fc19a1 2064 </variablelist>
0a2b5ab1
WB
2065 <variablelist>
2066 <varlistentry>
2067 <term>
2068 <option>lxc.hook.stop</option>
2069 </term>
2070 <listitem>
2071 <para>
2072 A hook to be run in the host's namespace with references
2073 to the container's namespaces after the container has been shut
2074 down. For each namespace an extra argument is passed to the hook
2075 containing the namespace's type and a filename that can be used to
2076 obtain a file descriptor to the corresponding namespace, separated
2077 by a colon. The type is the name as it would appear in the
2078 <filename>/proc/PID/ns</filename> directory.
2079 For instance for the mount namespace the argument usually looks
2080 like <filename>mnt:/proc/PID/fd/12</filename>.
2081 </para>
2082 </listitem>
2083 </varlistentry>
2084 </variablelist>
55fc19a1 2085 <variablelist>
c464fd7e
SG
2086 <varlistentry>
2087 <term>
2088 <option>lxc.hook.post-stop</option>
2089 </term>
2090 <listitem>
2091 <para>
2092 A hook to be run in the host's namespace after the
2093 container has been shut down.
2094 </para>
2095 </listitem>
2096 </varlistentry>
55fc19a1
SG
2097 </variablelist>
2098 <variablelist>
c464fd7e
SG
2099 <varlistentry>
2100 <term>
2101 <option>lxc.hook.clone</option>
2102 </term>
2103 <listitem>
2104 <para>
2105 A hook to be run when the container is cloned to a new one.
2106 See <citerefentry><refentrytitle><command>lxc-clone</command></refentrytitle>
2107 <manvolnum>1</manvolnum></citerefentry> for more information.
2108 </para>
2109 </listitem>
2110 </varlistentry>
55fc19a1 2111 </variablelist>
37cf711b
SY
2112 <variablelist>
2113 <varlistentry>
2114 <term>
2115 <option>lxc.hook.destroy</option>
2116 </term>
2117 <listitem>
2118 <para>
2119 A hook to be run when the container is destroyed.
2120 </para>
2121 </listitem>
2122 </varlistentry>
2123 </variablelist>
55fc19a1
SG
2124 </refsect2>
2125
2126 <refsect2>
2127 <title>Container hooks Environment Variables</title>
2128 <para>
2129 A number of environment variables are made available to the startup
2130 hooks to provide configuration information and assist in the
2131 functioning of the hooks. Not all variables are valid in all
2132 contexts. In particular, all paths are relative to the host system
2133 and, as such, not valid during the <option>lxc.hook.start</option> hook.
2134 </para>
2135 <variablelist>
c464fd7e
SG
2136 <varlistentry>
2137 <term>
2138 <option>LXC_NAME</option>
2139 </term>
2140 <listitem>
2141 <para>
2142 The LXC name of the container. Useful for logging messages
2143 in common log environments. [<option>-n</option>]
2144 </para>
2145 </listitem>
2146 </varlistentry>
55fc19a1
SG
2147 </variablelist>
2148 <variablelist>
c464fd7e
SG
2149 <varlistentry>
2150 <term>
2151 <option>LXC_CONFIG_FILE</option>
2152 </term>
2153 <listitem>
2154 <para>
2155 Host relative path to the container configuration file. This
2156 gives the container to reference the original, top level,
2157 configuration file for the container in order to locate any
2158 additional configuration information not otherwise made
2159 available. [<option>-f</option>]
2160 </para>
2161 </listitem>
2162 </varlistentry>
55fc19a1
SG
2163 </variablelist>
2164 <variablelist>
c464fd7e
SG
2165 <varlistentry>
2166 <term>
2167 <option>LXC_CONSOLE</option>
2168 </term>
2169 <listitem>
2170 <para>
2171 The path to the console output of the container if not NULL.
3aed4934 2172 [<option>-c</option>] [<option>lxc.console.path</option>]
c464fd7e
SG
2173 </para>
2174 </listitem>
2175 </varlistentry>
55fc19a1
SG
2176 </variablelist>
2177 <variablelist>
c464fd7e
SG
2178 <varlistentry>
2179 <term>
2180 <option>LXC_CONSOLE_LOGPATH</option>
2181 </term>
2182 <listitem>
2183 <para>
2184 The path to the console log output of the container if not NULL.
2185 [<option>-L</option>]
2186 </para>
2187 </listitem>
2188 </varlistentry>
55fc19a1
SG
2189 </variablelist>
2190 <variablelist>
c464fd7e
SG
2191 <varlistentry>
2192 <term>
2193 <option>LXC_ROOTFS_MOUNT</option>
2194 </term>
2195 <listitem>
2196 <para>
2197 The mount location to which the container is initially bound.
2198 This will be the host relative path to the container rootfs
2199 for the container instance being started and is where changes
2200 should be made for that instance.
2201 [<option>lxc.rootfs.mount</option>]
2202 </para>
2203 </listitem>
2204 </varlistentry>
55fc19a1
SG
2205 </variablelist>
2206 <variablelist>
c464fd7e
SG
2207 <varlistentry>
2208 <term>
2209 <option>LXC_ROOTFS_PATH</option>
2210 </term>
2211 <listitem>
2212 <para>
2213 The host relative path to the container root which has been
2214 mounted to the rootfs.mount location.
7a96a068 2215 [<option>lxc.rootfs.path</option>]
c464fd7e
SG
2216 </para>
2217 </listitem>
2218 </varlistentry>
55fc19a1 2219 </variablelist>
07945418
KY
2220 <variablelist>
2221 <varlistentry>
2222 <term>
2223 <option>LXC_SRC_NAME</option>
2224 </term>
2225 <listitem>
2226 <para>
2227 Only for the clone hook. Is set to the original container name.
2228 </para>
2229 </listitem>
2230 </varlistentry>
2231 </variablelist>
c154af98
SG
2232 <variablelist>
2233 <varlistentry>
2234 <term>
2235 <option>LXC_TARGET</option>
2236 </term>
2237 <listitem>
2238 <para>
2239 Only for the stop hook. Is set to "stop" for a container
2240 shutdown or "reboot" for a container reboot.
2241 </para>
2242 </listitem>
2243 </varlistentry>
c4cafa08
SH
2244 </variablelist>
2245 <variablelist>
2246 <varlistentry>
2247 <term>
2248 <option>LXC_CGNS_AWARE</option>
2249 </term>
2250 <listitem>
2251 <para>
2252 If unset, then this version of lxc is not aware of cgroup
2253 namespaces. If set, it will be set to 1, and lxc is aware
2254 of cgroup namespaces. Note this does not guarantee that
2255 cgroup namespaces are enabled in the kernel. This is used
2256 by the lxcfs mount hook.
2257 </para>
2258 </listitem>
2259 </varlistentry>
c154af98 2260 </variablelist>
55fc19a1
SG
2261 </refsect2>
2262 <refsect2>
2263 <title>Logging</title>
2264 <para>
2265 Logging can be configured on a per-container basis. By default,
2266 depending upon how the lxc package was compiled, container startup
2267 is logged only at the ERROR level, and logged to a file named after
2268 the container (with '.log' appended) either under the container path,
2269 or under @LOGPATH@.
2270 </para>
2271 <para>
2272 Both the default log level and the log file can be specified in the
2273 container configuration file, overriding the default behavior. Note
2274 that the configuration file entries can in turn be overridden by the
2275 command line options to <command>lxc-start</command>.
2276 </para>
2277 <variablelist>
c464fd7e
SG
2278 <varlistentry>
2279 <term>
46cc906d 2280 <option>lxc.log.level</option>
c464fd7e
SG
2281 </term>
2282 <listitem>
2283 <para>
2284 The level at which to log. The log level is an integer in
2285 the range of 0..8 inclusive, where a lower number means more
2286 verbose debugging. In particular 0 = trace, 1 = debug, 2 =
2287 info, 3 = notice, 4 = warn, 5 = error, 6 = critical, 7 =
2288 alert, and 8 = fatal. If unspecified, the level defaults
2289 to 5 (error), so that only errors and above are logged.
2290 </para>
2291 <para>
2292 Note that when a script (such as either a hook script or a
2293 network interface up or down script) is called, the script's
2294 standard output is logged at level 1, debug.
2295 </para>
2296 </listitem>
2297 </varlistentry>
2298 <varlistentry>
2299 <term>
5757588f 2300 <option>lxc.log.file</option>
c464fd7e
SG
2301 </term>
2302 <listitem>
2303 <para>
2304 The file to which logging info should be written.
2305 </para>
2306 </listitem>
2307 </varlistentry>
204dfdf2
BD
2308 <varlistentry>
2309 <term>
46cc906d 2310 <option>lxc.log.syslog</option>
204dfdf2
BD
2311 </term>
2312 <listitem>
2313 <para>
2314 Send logging info to syslog. It respects the log level defined in
46cc906d 2315 <command>lxc.log.level</command>. The argument should be the syslog
204dfdf2 2316 facility to use, valid ones are: daemon, local0, local1, local2,
917420dd 2317 local3, local4, local5, local5, local6, local7.
204dfdf2
BD
2318 </para>
2319 </listitem>
2320 </varlistentry>
55fc19a1
SG
2321 </variablelist>
2322 </refsect2>
2323
2324 <refsect2>
2325 <title>Autostart</title>
2326 <para>
2327 The autostart options support marking which containers should be
2328 auto-started and in what order. These options may be used by LXC tools
2329 directly or by external tooling provided by the distributions.
2330 </para>
2331
2332 <variablelist>
2333 <varlistentry>
2334 <term>
2335 <option>lxc.start.auto</option>
2336 </term>
2337 <listitem>
2338 <para>
2339 Whether the container should be auto-started.
2340 Valid values are 0 (off) and 1 (on).
2341 </para>
2342 </listitem>
2343 </varlistentry>
2344 <varlistentry>
2345 <term>
2346 <option>lxc.start.delay</option>
2347 </term>
2348 <listitem>
2349 <para>
2350 How long to wait (in seconds) after the container is
2351 started before starting the next one.
2352 </para>
2353 </listitem>
2354 </varlistentry>
2355 <varlistentry>
2356 <term>
2357 <option>lxc.start.order</option>
2358 </term>
2359 <listitem>
2360 <para>
2361 An integer used to sort the containers when auto-starting
2362 a series of containers at once.
2363 </para>
2364 </listitem>
2365 </varlistentry>
a8dfe4e0
WB
2366 <varlistentry>
2367 <term>
2368 <option>lxc.monitor.unshare</option>
2369 </term>
2370 <listitem>
2371 <para>
2372 If not zero the mount namespace will be unshared from the host
2373 before initializing the container (before running any pre-start
6039eaa2
WB
2374 hooks). This requires the CAP_SYS_ADMIN capability at startup.
2375 Default is 0.
a8dfe4e0
WB
2376 </para>
2377 </listitem>
2378 </varlistentry>
55fc19a1
SG
2379 <varlistentry>
2380 <term>
2381 <option>lxc.group</option>
2382 </term>
2383 <listitem>
2384 <para>
2385 A multi-value key (can be used multiple times) to put the
2386 container in a container group. Those groups can then be
2387 used (amongst other things) to start a series of related
2388 containers.
2389 </para>
2390 </listitem>
2391 </varlistentry>
2392 </variablelist>
2393 </refsect2>
015f0dd7
MW
2394
2395 <refsect2>
2396 <title>Autostart and System Boot</title>
2397 <para>
2398 Each container can be part of any number of groups or no group at all.
2399 Two groups are special. One is the NULL group, i.e. the container does
2400 not belong to any group. The other group is the "onboot" group.
2401 </para>
2402
2403 <para>
2404 When the system boots with the LXC service enabled, it will first
2405 attempt to boot any containers with lxc.start.auto == 1 that is a member
2406 of the "onboot" group. The startup will be in order of lxc.start.order.
2407 If an lxc.start.delay has been specified, that delay will be honored
2408 before attempting to start the next container to give the current
2409 container time to begin initialization and reduce overloading the host
2410 system. After starting the members of the "onboot" group, the LXC system
2411 will proceed to boot containers with lxc.start.auto == 1 which are not
2412 members of any group (the NULL group) and proceed as with the onboot
2413 group.
2414 </para>
2415
2416 </refsect2>
7c661726
MP
2417
2418 <refsect2>
2419 <title>Container Environment</title>
2420 <para>
c464fd7e
SG
2421 If you want to pass environment variables into the container (that
2422 is, environment variables which will be available to init and all of
2423 its descendents), you can use <command>lxc.environment</command>
2424 parameters to do so. Be careful that you do not pass in anything
2425 sensitive; any process in the container which doesn't have its
2426 environment scrubbed will have these variables available to it, and
2427 environment variables are always available via
2428 <command>/proc/PID/environ</command>.
7c661726
MP
2429 </para>
2430
2431 <para>
2432 This configuration parameter can be specified multiple times; once
2433 for each environment variable you wish to configure.
2434 </para>
2435
2436 <variablelist>
c464fd7e
SG
2437 <varlistentry>
2438 <term>
2439 <option>lxc.environment</option>
2440 </term>
2441 <listitem>
2442 <para>
2443 Specify an environment variable to pass into the container.
2444 Example:
2445 </para>
2446 <programlisting>
2447 lxc.environment = APP_ENV=production
2448 lxc.environment = SYSLOG_SERVER=192.0.2.42
2449 </programlisting>
2450 </listitem>
2451 </varlistentry>
7c661726
MP
2452 </variablelist>
2453 </refsect2>
2454
55fc19a1
SG
2455 </refsect1>
2456
2457 <refsect1>
2458 <title>Examples</title>
2459 <para>
c464fd7e
SG
2460 In addition to the few examples given below, you will find
2461 some other examples of configuration file in @DOCDIR@/examples
55fc19a1
SG
2462 </para>
2463 <refsect2>
2464 <title>Network</title>
2465 <para>This configuration sets up a container to use a veth pair
c464fd7e
SG
2466 device with one side plugged to a bridge br0 (which has been
2467 configured before on the system by the administrator). The
2468 virtual network device visible in the container is renamed to
2469 eth0.</para>
55fc19a1 2470 <programlisting>
b67771bc 2471 lxc.uts.name = myhostname
7fa3f2e9 2472 lxc.net.0.type = veth
2473 lxc.net.0.flags = up
2474 lxc.net.0.link = br0
2475 lxc.net.0.name = eth0
2476 lxc.net.0.hwaddr = 4a:49:43:49:79:bf
9ff60df2 2477 lxc.net.0.ipv4.address = 10.2.3.5/24 10.2.3.255
2e44ae28 2478 lxc.net.0.ipv6.address = 2003:db8:1:0:214:1234:fe0b:3597
55fc19a1
SG
2479 </programlisting>
2480 </refsect2>
2481
2482 <refsect2>
2483 <title>UID/GID mapping</title>
2484 <para>This configuration will map both user and group ids in the
2485 range 0-9999 in the container to the ids 100000-109999 on the host.
2486 </para>
2487 <programlisting>
bdcbb6b3
CB
2488 lxc.idmap = u 0 100000 10000
2489 lxc.idmap = g 0 100000 10000
55fc19a1
SG
2490 </programlisting>
2491 </refsect2>
2492
2493 <refsect2>
2494 <title>Control group</title>
2495 <para>This configuration will setup several control groups for
2496 the application, cpuset.cpus restricts usage of the defined cpu,
2497 cpus.share prioritize the control group, devices.allow makes
2498 usable the specified devices.</para>
2499 <programlisting>
c464fd7e
SG
2500 lxc.cgroup.cpuset.cpus = 0,1
2501 lxc.cgroup.cpu.shares = 1234
2502 lxc.cgroup.devices.deny = a
2503 lxc.cgroup.devices.allow = c 1:3 rw
2504 lxc.cgroup.devices.allow = b 8:0 rw
55fc19a1
SG
2505 </programlisting>
2506 </refsect2>
2507
2508 <refsect2>
2509 <title>Complex configuration</title>
2510 <para>This example show a complex configuration making a complex
2511 network stack, using the control groups, setting a new hostname,
2512 mounting some locations and a changing root file system.</para>
2513 <programlisting>
b67771bc 2514 lxc.uts.name = complex
7fa3f2e9 2515 lxc.net.0.type = veth
2516 lxc.net.0.flags = up
2517 lxc.net.0.link = br0
2518 lxc.net.0.hwaddr = 4a:49:43:49:79:bf
9ff60df2 2519 lxc.net.0.ipv4.address = 10.2.3.5/24 10.2.3.255
2e44ae28
CB
2520 lxc.net.0.ipv6.address = 2003:db8:1:0:214:1234:fe0b:3597
2521 lxc.net.0.ipv6.address = 2003:db8:1:0:214:5432:feab:3588
7fa3f2e9 2522 lxc.net.1.type = macvlan
2523 lxc.net.1.flags = up
2524 lxc.net.1.link = eth0
2525 lxc.net.1.hwaddr = 4a:49:43:49:79:bd
9ff60df2
CB
2526 lxc.net.1.ipv4.address = 10.2.3.4/24
2527 lxc.net.1.ipv4.address = 192.168.10.125/24
2e44ae28 2528 lxc.net.1.ipv6.address = 2003:db8:1:0:214:1234:fe0b:3596
7fa3f2e9 2529 lxc.net.2.type = phys
2530 lxc.net.2.flags = up
2531 lxc.net.2.link = dummy0
2532 lxc.net.2.hwaddr = 4a:49:43:49:79:ff
9ff60df2 2533 lxc.net.2.ipv4.address = 10.2.3.6/24
2e44ae28 2534 lxc.net.2.ipv6.address = 2003:db8:1:0:214:1234:fe0b:3297
c464fd7e
SG
2535 lxc.cgroup.cpuset.cpus = 0,1
2536 lxc.cgroup.cpu.shares = 1234
2537 lxc.cgroup.devices.deny = a
2538 lxc.cgroup.devices.allow = c 1:3 rw
2539 lxc.cgroup.devices.allow = b 8:0 rw
47148e96 2540 lxc.mount.fstab = /etc/fstab.complex
c464fd7e 2541 lxc.mount.entry = /lib /root/myrootfs/lib none ro,bind 0 0
7a96a068 2542 lxc.rootfs.path = dir:/mnt/rootfs.complex
c464fd7e
SG
2543 lxc.cap.drop = sys_module mknod setuid net_raw
2544 lxc.cap.drop = mac_override
55fc19a1
SG
2545 </programlisting>
2546 </refsect2>
2547
2548 </refsect1>
2549
2550 <refsect1>
2551 <title>See Also</title>
2552 <simpara>
2553 <citerefentry>
c464fd7e
SG
2554 <refentrytitle><command>chroot</command></refentrytitle>
2555 <manvolnum>1</manvolnum>
55fc19a1
SG
2556 </citerefentry>,
2557
2558 <citerefentry>
c464fd7e
SG
2559 <refentrytitle><command>pivot_root</command></refentrytitle>
2560 <manvolnum>8</manvolnum>
55fc19a1
SG
2561 </citerefentry>,
2562
2563 <citerefentry>
c464fd7e
SG
2564 <refentrytitle><filename>fstab</filename></refentrytitle>
2565 <manvolnum>5</manvolnum>
55fc19a1
SG
2566 </citerefentry>,
2567
2568 <citerefentry>
c464fd7e
SG
2569 <refentrytitle><filename>capabilities</filename></refentrytitle>
2570 <manvolnum>7</manvolnum>
55fc19a1
SG
2571 </citerefentry>
2572 </simpara>
2573 </refsect1>
2574
2575 &seealso;
2576
2577 <refsect1>
2578 <title>Author</title>
2579 <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
2580 </refsect1>
2581
2582</refentry>
2583
2584<!-- Keep this comment at the end of the file
2585Local variables:
2586mode: sgml
2587sgml-omittag:t
2588sgml-shorttag:t
2589sgml-minimize-attributes:nil
2590sgml-always-quote-attributes:t
2591sgml-indent-step:2
2592sgml-indent-data:t
2593sgml-parent-document:nil
2594sgml-default-dtd-file:nil
2595sgml-exposed-tags:nil
2596sgml-local-catalogs:nil
2597sgml-local-ecat-files:nil
2598End:
2599-->