]>
Commit | Line | Data |
---|---|---|
f757855e | 1 | <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> |
8f7a3c14 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
12b42c76 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
8f7a3c14 LP |
4 | |
5 | <!-- | |
6 | This file is part of systemd. | |
7 | ||
8 | Copyright 2010 Lennart Poettering | |
9 | ||
10 | systemd is free software; you can redistribute it and/or modify it | |
5430f7f2 LP |
11 | under the terms of the GNU Lesser General Public License as published by |
12 | the Free Software Foundation; either version 2.1 of the License, or | |
8f7a3c14 LP |
13 | (at your option) any later version. |
14 | ||
15 | systemd is distributed in the hope that it will be useful, but | |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
5430f7f2 | 18 | Lesser General Public License for more details. |
8f7a3c14 | 19 | |
5430f7f2 | 20 | You should have received a copy of the GNU Lesser General Public License |
8f7a3c14 LP |
21 | along with systemd; If not, see <http://www.gnu.org/licenses/>. |
22 | --> | |
23 | ||
dfdebb1b | 24 | <refentry id="systemd-nspawn" |
798d3a52 ZJS |
25 | xmlns:xi="http://www.w3.org/2001/XInclude"> |
26 | ||
27 | <refentryinfo> | |
28 | <title>systemd-nspawn</title> | |
29 | <productname>systemd</productname> | |
30 | ||
31 | <authorgroup> | |
32 | <author> | |
33 | <contrib>Developer</contrib> | |
34 | <firstname>Lennart</firstname> | |
35 | <surname>Poettering</surname> | |
36 | <email>lennart@poettering.net</email> | |
37 | </author> | |
38 | </authorgroup> | |
39 | </refentryinfo> | |
40 | ||
41 | <refmeta> | |
42 | <refentrytitle>systemd-nspawn</refentrytitle> | |
43 | <manvolnum>1</manvolnum> | |
44 | </refmeta> | |
45 | ||
46 | <refnamediv> | |
47 | <refname>systemd-nspawn</refname> | |
48 | <refpurpose>Spawn a namespace container for debugging, testing and building</refpurpose> | |
49 | </refnamediv> | |
50 | ||
51 | <refsynopsisdiv> | |
52 | <cmdsynopsis> | |
53 | <command>systemd-nspawn</command> | |
54 | <arg choice="opt" rep="repeat">OPTIONS</arg> | |
55 | <arg choice="opt"><replaceable>COMMAND</replaceable> | |
56 | <arg choice="opt" rep="repeat">ARGS</arg> | |
57 | </arg> | |
58 | </cmdsynopsis> | |
59 | <cmdsynopsis> | |
60 | <command>systemd-nspawn</command> | |
4447e799 | 61 | <arg choice="plain">--boot</arg> |
798d3a52 ZJS |
62 | <arg choice="opt" rep="repeat">OPTIONS</arg> |
63 | <arg choice="opt" rep="repeat">ARGS</arg> | |
64 | </cmdsynopsis> | |
65 | </refsynopsisdiv> | |
66 | ||
67 | <refsect1> | |
68 | <title>Description</title> | |
69 | ||
70 | <para><command>systemd-nspawn</command> may be used to run a | |
71 | command or OS in a light-weight namespace container. In many ways | |
72 | it is similar to | |
73 | <citerefentry project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
74 | but more powerful since it fully virtualizes the file system | |
75 | hierarchy, as well as the process tree, the various IPC subsystems | |
76 | and the host and domain name.</para> | |
77 | ||
78 | <para><command>systemd-nspawn</command> limits access to various | |
79 | kernel interfaces in the container to read-only, such as | |
80 | <filename>/sys</filename>, <filename>/proc/sys</filename> or | |
81 | <filename>/sys/fs/selinux</filename>. Network interfaces and the | |
82 | system clock may not be changed from within the container. Device | |
83 | nodes may not be created. The host system cannot be rebooted and | |
84 | kernel modules may not be loaded from within the container.</para> | |
85 | ||
86 | <para>Note that even though these security precautions are taken | |
7de7ee62 | 87 | <command>systemd-nspawn</command> is not suitable for fully secure |
798d3a52 ZJS |
88 | container setups. Many of the security features may be |
89 | circumvented and are hence primarily useful to avoid accidental | |
7de7ee62 | 90 | changes to the host system from the container.</para> |
798d3a52 ZJS |
91 | |
92 | <para>In contrast to | |
93 | <citerefentry project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>1</manvolnum></citerefentry> <command>systemd-nspawn</command> | |
94 | may be used to boot full Linux-based operating systems in a | |
95 | container.</para> | |
96 | ||
97 | <para>Use a tool like | |
98 | <citerefentry project='mankier'><refentrytitle>dnf</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
798d3a52 ZJS |
99 | <citerefentry project='die-net'><refentrytitle>debootstrap</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
100 | or | |
101 | <citerefentry project='archlinux'><refentrytitle>pacman</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
102 | to set up an OS directory tree suitable as file system hierarchy | |
103 | for <command>systemd-nspawn</command> containers.</para> | |
104 | ||
105 | <para>Note that <command>systemd-nspawn</command> will mount file | |
106 | systems private to the container to <filename>/dev</filename>, | |
107 | <filename>/run</filename> and similar. These will not be visible | |
108 | outside of the container, and their contents will be lost when the | |
109 | container exits.</para> | |
110 | ||
111 | <para>Note that running two <command>systemd-nspawn</command> | |
112 | containers from the same directory tree will not make processes in | |
113 | them see each other. The PID namespace separation of the two | |
114 | containers is complete and the containers will share very few | |
115 | runtime objects except for the underlying file system. Use | |
116 | <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s | |
117 | <command>login</command> command to request an additional login | |
118 | prompt in a running container.</para> | |
119 | ||
120 | <para><command>systemd-nspawn</command> implements the | |
121 | <ulink | |
122 | url="http://www.freedesktop.org/wiki/Software/systemd/ContainerInterface">Container | |
123 | Interface</ulink> specification.</para> | |
124 | ||
125 | <para>As a safety check <command>systemd-nspawn</command> will | |
126 | verify the existence of <filename>/usr/lib/os-release</filename> | |
127 | or <filename>/etc/os-release</filename> in the container tree | |
128 | before starting the container (see | |
129 | <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>). | |
130 | It might be necessary to add this file to the container tree | |
131 | manually if the OS of the container is too old to contain this | |
132 | file out-of-the-box.</para> | |
133 | </refsect1> | |
134 | ||
135 | <refsect1> | |
136 | <title>Options</title> | |
137 | ||
138 | <para>If option <option>-b</option> is specified, the arguments | |
139 | are used as arguments for the init binary. Otherwise, | |
140 | <replaceable>COMMAND</replaceable> specifies the program to launch | |
141 | in the container, and the remaining arguments are used as | |
142 | arguments for this program. If <option>-b</option> is not used and | |
ff9b60f3 | 143 | no arguments are specified, a shell is launched in the |
798d3a52 ZJS |
144 | container.</para> |
145 | ||
146 | <para>The following options are understood:</para> | |
147 | ||
148 | <variablelist> | |
149 | <varlistentry> | |
150 | <term><option>-D</option></term> | |
151 | <term><option>--directory=</option></term> | |
152 | ||
153 | <listitem><para>Directory to use as file system root for the | |
154 | container.</para> | |
155 | ||
156 | <para>If neither <option>--directory=</option>, nor | |
157 | <option>--image=</option> is specified the directory is | |
32b64cce RM |
158 | determined by searching for a directory named the same as the |
159 | machine name specified with <option>--machine=</option>. See | |
160 | <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
161 | section "Files and Directories" for the precise search path.</para> | |
162 | ||
163 | <para>If neither <option>--directory=</option>, | |
164 | <option>--image=</option>, nor <option>--machine=</option> | |
165 | are specified, the current directory will | |
166 | be used. May not be specified together with | |
798d3a52 ZJS |
167 | <option>--image=</option>.</para></listitem> |
168 | </varlistentry> | |
169 | ||
170 | <varlistentry> | |
171 | <term><option>--template=</option></term> | |
172 | ||
173 | <listitem><para>Directory or <literal>btrfs</literal> | |
174 | subvolume to use as template for the container's root | |
175 | directory. If this is specified and the container's root | |
176 | directory (as configured by <option>--directory=</option>) | |
177 | does not yet exist it is created as <literal>btrfs</literal> | |
178 | subvolume and populated from this template tree. Ideally, the | |
179 | specified template path refers to the root of a | |
180 | <literal>btrfs</literal> subvolume, in which case a simple | |
181 | copy-on-write snapshot is taken, and populating the root | |
182 | directory is instant. If the specified template path does not | |
183 | refer to the root of a <literal>btrfs</literal> subvolume (or | |
184 | not even to a <literal>btrfs</literal> file system at all), | |
185 | the tree is copied, which can be substantially more | |
186 | time-consuming. Note that if this option is used the | |
187 | container's root directory (in contrast to the template | |
188 | directory!) must be located on a <literal>btrfs</literal> file | |
189 | system, so that the <literal>btrfs</literal> subvolume may be | |
190 | created. May not be specified together with | |
191 | <option>--image=</option> or | |
3fe22bb4 LP |
192 | <option>--ephemeral</option>.</para> |
193 | ||
194 | <para>Note that this switch leaves host name, machine ID and | |
195 | all other settings that could identify the instance | |
196 | unmodified.</para></listitem> | |
798d3a52 ZJS |
197 | </varlistentry> |
198 | ||
199 | <varlistentry> | |
200 | <term><option>-x</option></term> | |
201 | <term><option>--ephemeral</option></term> | |
202 | ||
203 | <listitem><para>If specified, the container is run with a | |
204 | temporary <literal>btrfs</literal> snapshot of its root | |
205 | directory (as configured with <option>--directory=</option>), | |
206 | that is removed immediately when the container terminates. | |
207 | This option is only supported if the root file system is | |
208 | <literal>btrfs</literal>. May not be specified together with | |
209 | <option>--image=</option> or | |
3fe22bb4 LP |
210 | <option>--template=</option>.</para> |
211 | <para>Note that this switch leaves host name, machine ID and | |
212 | all other settings that could identify the instance | |
213 | unmodified.</para></listitem> | |
798d3a52 ZJS |
214 | </varlistentry> |
215 | ||
216 | <varlistentry> | |
217 | <term><option>-i</option></term> | |
218 | <term><option>--image=</option></term> | |
219 | ||
220 | <listitem><para>Disk image to mount the root directory for the | |
221 | container from. Takes a path to a regular file or to a block | |
222 | device node. The file or block device must contain | |
223 | either:</para> | |
224 | ||
225 | <itemizedlist> | |
226 | <listitem><para>An MBR partition table with a single | |
227 | partition of type 0x83 that is marked | |
228 | bootable.</para></listitem> | |
229 | ||
230 | <listitem><para>A GUID partition table (GPT) with a single | |
231 | partition of type | |
232 | 0fc63daf-8483-4772-8e79-3d69d8477de4.</para></listitem> | |
233 | ||
234 | <listitem><para>A GUID partition table (GPT) with a marked | |
235 | root partition which is mounted as the root directory of the | |
236 | container. Optionally, GPT images may contain a home and/or | |
237 | a server data partition which are mounted to the appropriate | |
238 | places in the container. All these partitions must be | |
239 | identified by the partition types defined by the <ulink | |
240 | url="http://www.freedesktop.org/wiki/Specifications/DiscoverablePartitionsSpec/">Discoverable | |
241 | Partitions Specification</ulink>.</para></listitem> | |
242 | </itemizedlist> | |
243 | ||
244 | <para>Any other partitions, such as foreign partitions, swap | |
245 | partitions or EFI system partitions are not mounted. May not | |
246 | be specified together with <option>--directory=</option>, | |
247 | <option>--template=</option> or | |
248 | <option>--ephemeral</option>.</para></listitem> | |
249 | </varlistentry> | |
250 | ||
7732f92b LP |
251 | <varlistentry> |
252 | <term><option>-a</option></term> | |
253 | <term><option>--as-pid2</option></term> | |
254 | ||
255 | <listitem><para>Invoke the shell or specified program as process ID (PID) 2 instead of PID 1 (init). By | |
256 | default, if neither this option nor <option>--boot</option> is used, the selected binary is run as process with | |
257 | PID 1, a mode only suitable for programs that are aware of the special semantics that the process with PID 1 | |
258 | has on UNIX. For example, it needs to reap all processes reparented to it, and should implement | |
259 | <command>sysvinit</command> compatible signal handling (specifically: it needs to reboot on SIGINT, reexecute | |
260 | on SIGTERM, reload configuration on SIGHUP, and so on). With <option>--as-pid2</option> a minimal stub init | |
261 | process is run as PID 1 and the selected binary is executed as PID 2 (and hence does not need to implement any | |
262 | special semantics). The stub init process will reap processes as necessary and react appropriately to | |
263 | signals. It is recommended to use this mode to invoke arbitrary commands in containers, unless they have been | |
264 | modified to run correctly as PID 1. Or in other words: this switch should be used for pretty much all commands, | |
265 | except when the command refers to an init or shell implementation, as these are generally capable of running | |
4447e799 | 266 | correctly as PID 1. This option may not be combined with <option>--boot</option> or |
7732f92b LP |
267 | <option>--share-system</option>.</para> |
268 | </listitem> | |
269 | </varlistentry> | |
270 | ||
798d3a52 ZJS |
271 | <varlistentry> |
272 | <term><option>-b</option></term> | |
273 | <term><option>--boot</option></term> | |
274 | ||
7732f92b LP |
275 | <listitem><para>Automatically search for an init binary and invoke it as PID 1, instead of a shell or a user |
276 | supplied program. If this option is used, arguments specified on the command line are used as arguments for the | |
277 | init binary. This option may not be combined with <option>--as-pid2</option> or | |
278 | <option>--share-system</option>.</para> | |
279 | ||
280 | <para>The following table explains the different modes of invocation and relationship to | |
281 | <option>--as-pid2</option> (see above):</para> | |
282 | ||
283 | <table> | |
284 | <title>Invocation Mode</title> | |
285 | <tgroup cols='2' align='left' colsep='1' rowsep='1'> | |
286 | <colspec colname="switch" /> | |
287 | <colspec colname="explanation" /> | |
288 | <thead> | |
289 | <row> | |
290 | <entry>Switch</entry> | |
291 | <entry>Explanation</entry> | |
292 | </row> | |
293 | </thead> | |
294 | <tbody> | |
295 | <row> | |
296 | <entry>Neither <option>--as-pid2</option> nor <option>--boot</option> specified</entry> | |
4447e799 | 297 | <entry>The passed parameters are interpreted as the command line, which is executed as PID 1 in the container.</entry> |
7732f92b LP |
298 | </row> |
299 | ||
300 | <row> | |
301 | <entry><option>--as-pid2</option> specified</entry> | |
4447e799 | 302 | <entry>The passed parameters are interpreted as the command line, which is executed as PID 2 in the container. A stub init process is run as PID 1.</entry> |
7732f92b LP |
303 | </row> |
304 | ||
305 | <row> | |
306 | <entry><option>--boot</option> specified</entry> | |
307 | <entry>An init binary as automatically searched and run as PID 1 in the container. The passed parameters are used as invocation parameters for this process.</entry> | |
308 | </row> | |
309 | ||
310 | </tbody> | |
311 | </tgroup> | |
312 | </table> | |
313 | </listitem> | |
798d3a52 ZJS |
314 | </varlistentry> |
315 | ||
5f932eb9 LP |
316 | <varlistentry> |
317 | <term><option>--chdir=</option></term> | |
318 | ||
319 | <listitem><para>Change to the specified working directory before invoking the process in the container. Expects | |
320 | an absolute path in the container's file system namespace.</para></listitem> | |
321 | </varlistentry> | |
322 | ||
798d3a52 ZJS |
323 | <varlistentry> |
324 | <term><option>-u</option></term> | |
325 | <term><option>--user=</option></term> | |
326 | ||
327 | <listitem><para>After transitioning into the container, change | |
328 | to the specified user-defined in the container's user | |
329 | database. Like all other systemd-nspawn features, this is not | |
330 | a security feature and provides protection against accidental | |
331 | destructive operations only.</para></listitem> | |
332 | </varlistentry> | |
333 | ||
334 | <varlistentry> | |
335 | <term><option>-M</option></term> | |
336 | <term><option>--machine=</option></term> | |
337 | ||
338 | <listitem><para>Sets the machine name for this container. This | |
339 | name may be used to identify this container during its runtime | |
340 | (for example in tools like | |
341 | <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
342 | and similar), and is used to initialize the container's | |
343 | hostname (which the container can choose to override, | |
344 | however). If not specified, the last component of the root | |
345 | directory path of the container is used, possibly suffixed | |
346 | with a random identifier in case <option>--ephemeral</option> | |
347 | mode is selected. If the root directory selected is the host's | |
348 | root directory the host's hostname is used as default | |
349 | instead.</para></listitem> | |
350 | </varlistentry> | |
351 | ||
352 | <varlistentry> | |
353 | <term><option>--uuid=</option></term> | |
354 | ||
355 | <listitem><para>Set the specified UUID for the container. The | |
356 | init system will initialize | |
357 | <filename>/etc/machine-id</filename> from this if this file is | |
e01ff70a MS |
358 | not set yet. Note that this option takes effect only if |
359 | <filename>/etc/machine-id</filename> in the container is | |
360 | unpopulated.</para></listitem> | |
798d3a52 ZJS |
361 | </varlistentry> |
362 | ||
363 | <varlistentry> | |
364 | <term><option>--slice=</option></term> | |
365 | ||
366 | <listitem><para>Make the container part of the specified | |
367 | slice, instead of the default | |
f36933fe LP |
368 | <filename>machine.slice</filename>. This is only applies if |
369 | the machine is run in its own scope unit, i.e. if | |
370 | <option>--keep-unit</option> is not used.</para> | |
371 | </listitem> | |
372 | </varlistentry> | |
373 | ||
374 | <varlistentry> | |
375 | <term><option>--property=</option></term> | |
376 | ||
377 | <listitem><para>Set a unit property on the scope unit to | |
378 | register for the machine. This only applies if the machine is | |
379 | run in its own scope unit, i.e. if | |
380 | <option>--keep-unit</option> is not used. Takes unit property | |
381 | assignments in the same format as <command>systemctl | |
382 | set-property</command>. This is useful to set memory limits | |
383 | and similar for machines.</para> | |
798d3a52 ZJS |
384 | </listitem> |
385 | </varlistentry> | |
386 | ||
03cfe0d5 LP |
387 | <varlistentry> |
388 | <term><option>--private-users=</option></term> | |
389 | ||
b938cb90 | 390 | <listitem><para>Enables user namespacing. If enabled, the |
03cfe0d5 LP |
391 | container will run with its own private set of Unix user and |
392 | group ids (UIDs and GIDs). Takes none, one or two | |
393 | colon-separated parameters: the first parameter specifies the | |
394 | first host UID to assign to the container, the second | |
395 | parameter specifies the number of host UIDs to assign to the | |
396 | container. If the second parameter is omitted, 65536 UIDs are | |
7c918141 | 397 | assigned. If the first parameter is also omitted (and hence |
03cfe0d5 LP |
398 | no parameter passed at all), the first UID assigned to the |
399 | container is read from the owner of the root directory of the | |
b938cb90 | 400 | container's directory tree. By default, no user namespacing is |
03cfe0d5 LP |
401 | applied.</para> |
402 | ||
403 | <para>Note that user namespacing currently requires OS trees | |
404 | that are prepared for the UID shift that is being applied: | |
405 | UIDs and GIDs used for file ownership or in file ACL entries | |
406 | must be shifted to the container UID base that is | |
407 | used during container runtime.</para> | |
408 | ||
a8eaaee7 | 409 | <para>It is recommended to assign at least 65536 UIDs to each |
03cfe0d5 | 410 | container, so that the usable UID range in the container |
b938cb90 | 411 | covers 16 bit. For best security, do not assign overlapping UID |
03cfe0d5 | 412 | ranges to multiple containers. It is hence a good idea to use |
b938cb90 JE |
413 | the upper 16 bit of the host 32-bit UIDs as container |
414 | identifier, while the lower 16 bit encode the container UID | |
03cfe0d5 LP |
415 | used.</para> |
416 | ||
b938cb90 | 417 | <para>When user namespaces are used, the GID range assigned to |
03cfe0d5 LP |
418 | each container is always chosen identical to the UID |
419 | range.</para></listitem> | |
420 | </varlistentry> | |
421 | ||
422 | ||
798d3a52 ZJS |
423 | <varlistentry> |
424 | <term><option>--private-network</option></term> | |
425 | ||
426 | <listitem><para>Disconnect networking of the container from | |
427 | the host. This makes all network interfaces unavailable in the | |
428 | container, with the exception of the loopback device and those | |
429 | specified with <option>--network-interface=</option> and | |
430 | configured with <option>--network-veth</option>. If this | |
431 | option is specified, the CAP_NET_ADMIN capability will be | |
432 | added to the set of capabilities the container retains. The | |
433 | latter may be disabled by using | |
434 | <option>--drop-capability=</option>.</para></listitem> | |
435 | </varlistentry> | |
436 | ||
437 | <varlistentry> | |
438 | <term><option>--network-interface=</option></term> | |
439 | ||
440 | <listitem><para>Assign the specified network interface to the | |
441 | container. This will remove the specified interface from the | |
442 | calling namespace and place it in the container. When the | |
443 | container terminates, it is moved back to the host namespace. | |
444 | Note that <option>--network-interface=</option> implies | |
445 | <option>--private-network</option>. This option may be used | |
446 | more than once to add multiple network interfaces to the | |
447 | container.</para></listitem> | |
448 | </varlistentry> | |
449 | ||
450 | <varlistentry> | |
451 | <term><option>--network-macvlan=</option></term> | |
452 | ||
453 | <listitem><para>Create a <literal>macvlan</literal> interface | |
454 | of the specified Ethernet network interface and add it to the | |
455 | container. A <literal>macvlan</literal> interface is a virtual | |
456 | interface that adds a second MAC address to an existing | |
457 | physical Ethernet link. The interface in the container will be | |
458 | named after the interface on the host, prefixed with | |
459 | <literal>mv-</literal>. Note that | |
460 | <option>--network-macvlan=</option> implies | |
461 | <option>--private-network</option>. This option may be used | |
462 | more than once to add multiple network interfaces to the | |
463 | container.</para></listitem> | |
464 | </varlistentry> | |
465 | ||
466 | <varlistentry> | |
467 | <term><option>--network-ipvlan=</option></term> | |
468 | ||
469 | <listitem><para>Create an <literal>ipvlan</literal> interface | |
470 | of the specified Ethernet network interface and add it to the | |
471 | container. An <literal>ipvlan</literal> interface is a virtual | |
472 | interface, similar to a <literal>macvlan</literal> interface, | |
473 | which uses the same MAC address as the underlying interface. | |
474 | The interface in the container will be named after the | |
475 | interface on the host, prefixed with <literal>iv-</literal>. | |
476 | Note that <option>--network-ipvlan=</option> implies | |
477 | <option>--private-network</option>. This option may be used | |
478 | more than once to add multiple network interfaces to the | |
479 | container.</para></listitem> | |
480 | </varlistentry> | |
481 | ||
482 | <varlistentry> | |
483 | <term><option>-n</option></term> | |
484 | <term><option>--network-veth</option></term> | |
485 | ||
486 | <listitem><para>Create a virtual Ethernet link | |
487 | (<literal>veth</literal>) between host and container. The host | |
488 | side of the Ethernet link will be available as a network | |
489 | interface named after the container's name (as specified with | |
490 | <option>--machine=</option>), prefixed with | |
491 | <literal>ve-</literal>. The container side of the Ethernet | |
492 | link will be named <literal>host0</literal>. Note that | |
493 | <option>--network-veth</option> implies | |
494 | <option>--private-network</option>.</para></listitem> | |
495 | </varlistentry> | |
496 | ||
f6d6bad1 LP |
497 | <varlistentry> |
498 | <term><option>--network-veth-extra=</option></term> | |
499 | ||
500 | <listitem><para>Adds an additional virtual Ethernet link | |
501 | between host and container. Takes a colon-separated pair of | |
502 | host interface name and container interface name. The latter | |
503 | may be omitted in which case the container and host sides will | |
504 | be assigned the same name. This switch is independent of | |
ccddd104 | 505 | <option>--network-veth</option>, and — in contrast — may be |
f6d6bad1 LP |
506 | used multiple times, and allows configuration of the network |
507 | interface names. Note that <option>--network-bridge=</option> | |
508 | has no effect on interfaces created with | |
509 | <option>--network-veth-extra=</option>.</para></listitem> | |
510 | </varlistentry> | |
511 | ||
798d3a52 ZJS |
512 | <varlistentry> |
513 | <term><option>--network-bridge=</option></term> | |
514 | ||
515 | <listitem><para>Adds the host side of the Ethernet link | |
516 | created with <option>--network-veth</option> to the specified | |
517 | bridge. Note that <option>--network-bridge=</option> implies | |
518 | <option>--network-veth</option>. If this option is used, the | |
519 | host side of the Ethernet link will use the | |
520 | <literal>vb-</literal> prefix instead of | |
521 | <literal>ve-</literal>.</para></listitem> | |
522 | </varlistentry> | |
523 | ||
524 | <varlistentry> | |
525 | <term><option>-p</option></term> | |
526 | <term><option>--port=</option></term> | |
527 | ||
528 | <listitem><para>If private networking is enabled, maps an IP | |
529 | port on the host onto an IP port on the container. Takes a | |
530 | protocol specifier (either <literal>tcp</literal> or | |
531 | <literal>udp</literal>), separated by a colon from a host port | |
532 | number in the range 1 to 65535, separated by a colon from a | |
533 | container port number in the range from 1 to 65535. The | |
534 | protocol specifier and its separating colon may be omitted, in | |
535 | which case <literal>tcp</literal> is assumed. The container | |
7c918141 | 536 | port number and its colon may be omitted, in which case the |
798d3a52 | 537 | same port as the host port is implied. This option is only |
a8eaaee7 | 538 | supported if private networking is used, such as with |
798d3a52 ZJS |
539 | <option>--network-veth</option> or |
540 | <option>--network-bridge=</option>.</para></listitem> | |
541 | </varlistentry> | |
542 | ||
543 | <varlistentry> | |
544 | <term><option>-Z</option></term> | |
545 | <term><option>--selinux-context=</option></term> | |
546 | ||
547 | <listitem><para>Sets the SELinux security context to be used | |
548 | to label processes in the container.</para> | |
549 | </listitem> | |
550 | </varlistentry> | |
551 | ||
552 | <varlistentry> | |
553 | <term><option>-L</option></term> | |
554 | <term><option>--selinux-apifs-context=</option></term> | |
555 | ||
556 | <listitem><para>Sets the SELinux security context to be used | |
557 | to label files in the virtual API file systems in the | |
558 | container.</para> | |
559 | </listitem> | |
560 | </varlistentry> | |
561 | ||
562 | <varlistentry> | |
563 | <term><option>--capability=</option></term> | |
564 | ||
565 | <listitem><para>List one or more additional capabilities to | |
566 | grant the container. Takes a comma-separated list of | |
567 | capability names, see | |
568 | <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> | |
569 | for more information. Note that the following capabilities | |
570 | will be granted in any way: CAP_CHOWN, CAP_DAC_OVERRIDE, | |
571 | CAP_DAC_READ_SEARCH, CAP_FOWNER, CAP_FSETID, CAP_IPC_OWNER, | |
572 | CAP_KILL, CAP_LEASE, CAP_LINUX_IMMUTABLE, | |
573 | CAP_NET_BIND_SERVICE, CAP_NET_BROADCAST, CAP_NET_RAW, | |
574 | CAP_SETGID, CAP_SETFCAP, CAP_SETPCAP, CAP_SETUID, | |
575 | CAP_SYS_ADMIN, CAP_SYS_CHROOT, CAP_SYS_NICE, CAP_SYS_PTRACE, | |
576 | CAP_SYS_TTY_CONFIG, CAP_SYS_RESOURCE, CAP_SYS_BOOT, | |
577 | CAP_AUDIT_WRITE, CAP_AUDIT_CONTROL. Also CAP_NET_ADMIN is | |
578 | retained if <option>--private-network</option> is specified. | |
579 | If the special value <literal>all</literal> is passed, all | |
580 | capabilities are retained.</para></listitem> | |
581 | </varlistentry> | |
582 | ||
583 | <varlistentry> | |
584 | <term><option>--drop-capability=</option></term> | |
585 | ||
586 | <listitem><para>Specify one or more additional capabilities to | |
587 | drop for the container. This allows running the container with | |
588 | fewer capabilities than the default (see | |
589 | above).</para></listitem> | |
590 | </varlistentry> | |
591 | ||
c6c8f6e2 LP |
592 | <varlistentry> |
593 | <term><option>--kill-signal=</option></term> | |
594 | ||
595 | <listitem><para>Specify the process signal to send to the | |
596 | container's PID 1 when nspawn itself receives SIGTERM, in | |
597 | order to trigger an orderly shutdown of the | |
598 | container. Defaults to SIGRTMIN+3 if <option>--boot</option> | |
599 | is used (on systemd-compatible init systems SIGRTMIN+3 | |
b3969f73 PA |
600 | triggers an orderly shutdown). For a list of valid signals, see |
601 | <citerefentry project='man-pages'><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para></listitem> | |
c6c8f6e2 LP |
602 | </varlistentry> |
603 | ||
798d3a52 ZJS |
604 | <varlistentry> |
605 | <term><option>--link-journal=</option></term> | |
606 | ||
607 | <listitem><para>Control whether the container's journal shall | |
608 | be made visible to the host system. If enabled, allows viewing | |
609 | the container's journal files from the host (but not vice | |
610 | versa). Takes one of <literal>no</literal>, | |
611 | <literal>host</literal>, <literal>try-host</literal>, | |
612 | <literal>guest</literal>, <literal>try-guest</literal>, | |
613 | <literal>auto</literal>. If <literal>no</literal>, the journal | |
614 | is not linked. If <literal>host</literal>, the journal files | |
615 | are stored on the host file system (beneath | |
616 | <filename>/var/log/journal/<replaceable>machine-id</replaceable></filename>) | |
617 | and the subdirectory is bind-mounted into the container at the | |
618 | same location. If <literal>guest</literal>, the journal files | |
619 | are stored on the guest file system (beneath | |
620 | <filename>/var/log/journal/<replaceable>machine-id</replaceable></filename>) | |
621 | and the subdirectory is symlinked into the host at the same | |
622 | location. <literal>try-host</literal> and | |
623 | <literal>try-guest</literal> do the same but do not fail if | |
624 | the host does not have persistent journalling enabled. If | |
625 | <literal>auto</literal> (the default), and the right | |
626 | subdirectory of <filename>/var/log/journal</filename> exists, | |
627 | it will be bind mounted into the container. If the | |
628 | subdirectory does not exist, no linking is performed. | |
629 | Effectively, booting a container once with | |
630 | <literal>guest</literal> or <literal>host</literal> will link | |
631 | the journal persistently if further on the default of | |
632 | <literal>auto</literal> is used.</para></listitem> | |
633 | </varlistentry> | |
634 | ||
635 | <varlistentry> | |
636 | <term><option>-j</option></term> | |
637 | ||
638 | <listitem><para>Equivalent to | |
639 | <option>--link-journal=try-guest</option>.</para></listitem> | |
640 | </varlistentry> | |
641 | ||
642 | <varlistentry> | |
643 | <term><option>--read-only</option></term> | |
644 | ||
645 | <listitem><para>Mount the root file system read-only for the | |
646 | container.</para></listitem> | |
647 | </varlistentry> | |
648 | ||
649 | <varlistentry> | |
650 | <term><option>--bind=</option></term> | |
651 | <term><option>--bind-ro=</option></term> | |
652 | ||
653 | <listitem><para>Bind mount a file or directory from the host | |
b938cb90 | 654 | into the container. Takes one of: a path argument — in which |
798d3a52 | 655 | case the specified path will be mounted from the host to the |
b938cb90 JE |
656 | same path in the container —, or a colon-separated pair of |
657 | paths — in which case the first specified path is the source | |
798d3a52 | 658 | in the host, and the second path is the destination in the |
b938cb90 JE |
659 | container —, or a colon-separated triple of source path, |
660 | destination path and mount options. Mount options are | |
661 | comma-separated and currently, only "rbind" and "norbind" | |
662 | are allowed. Defaults to "rbind". Backslash escapes are interpreted, so | |
8ef24e7a RM |
663 | <literal>\:</literal> may be used to embed colons in either path. |
664 | This option may be specified multiple times for | |
64b282ef LP |
665 | creating multiple independent bind mount points. The |
666 | <option>--bind-ro=</option> option creates read-only bind | |
667 | mounts.</para></listitem> | |
798d3a52 ZJS |
668 | </varlistentry> |
669 | ||
670 | <varlistentry> | |
671 | <term><option>--tmpfs=</option></term> | |
672 | ||
673 | <listitem><para>Mount a tmpfs file system into the container. | |
674 | Takes a single absolute path argument that specifies where to | |
675 | mount the tmpfs instance to (in which case the directory | |
676 | access mode will be chosen as 0755, owned by root/root), or | |
677 | optionally a colon-separated pair of path and mount option | |
b938cb90 | 678 | string that is used for mounting (in which case the kernel |
798d3a52 ZJS |
679 | default for access mode and owner will be chosen, unless |
680 | otherwise specified). This option is particularly useful for | |
681 | mounting directories such as <filename>/var</filename> as | |
682 | tmpfs, to allow state-less systems, in particular when | |
ffcd3e89 | 683 | combined with <option>--read-only</option>. |
b938cb90 | 684 | Backslash escapes are interpreted in the path, so |
ffcd3e89 RM |
685 | <literal>\:</literal> may be used to embed colons in the path. |
686 | </para></listitem> | |
798d3a52 ZJS |
687 | </varlistentry> |
688 | ||
5a8af538 LP |
689 | <varlistentry> |
690 | <term><option>--overlay=</option></term> | |
691 | <term><option>--overlay-ro=</option></term> | |
692 | ||
693 | <listitem><para>Combine multiple directory trees into one | |
694 | overlay file system and mount it into the container. Takes a | |
695 | list of colon-separated paths to the directory trees to | |
696 | combine and the destination mount point.</para> | |
697 | ||
2eadf91c RM |
698 | <para>Backslash escapes are interpreted in the paths, so |
699 | <literal>\:</literal> may be used to embed colons in the paths. | |
700 | </para> | |
701 | ||
5a8af538 LP |
702 | <para>If three or more paths are specified, then the last |
703 | specified path is the destination mount point in the | |
704 | container, all paths specified before refer to directory trees | |
705 | on the host and are combined in the specified order into one | |
706 | overlay file system. The left-most path is hence the lowest | |
707 | directory tree, the second-to-last path the highest directory | |
708 | tree in the stacking order. If <option>--overlay-ro=</option> | |
b938cb90 | 709 | is used instead of <option>--overlay=</option>, a read-only |
5a8af538 | 710 | overlay file system is created. If a writable overlay file |
b938cb90 | 711 | system is created, all changes made to it are written to the |
5a8af538 LP |
712 | highest directory tree in the stacking order, i.e. the |
713 | second-to-last specified.</para> | |
714 | ||
715 | <para>If only two paths are specified, then the second | |
716 | specified path is used both as the top-level directory tree in | |
717 | the stacking order as seen from the host, as well as the mount | |
718 | point for the overlay file system in the container. At least | |
719 | two paths have to be specified.</para> | |
720 | ||
721 | <para>For details about overlay file systems, see <ulink | |
722 | url="https://www.kernel.org/doc/Documentation/filesystems/overlayfs.txt">overlayfs.txt</ulink>. Note | |
723 | that the semantics of overlay file systems are substantially | |
724 | different from normal file systems, in particular regarding | |
725 | reported device and inode information. Device and inode | |
726 | information may change for a file while it is being written | |
727 | to, and processes might see out-of-date versions of files at | |
728 | times. Note that this switch automatically derives the | |
729 | <literal>workdir=</literal> mount option for the overlay file | |
730 | system from the top-level directory tree, making it a sibling | |
731 | of it. It is hence essential that the top-level directory tree | |
732 | is not a mount point itself (since the working directory must | |
733 | be on the same file system as the top-most directory | |
734 | tree). Also note that the <literal>lowerdir=</literal> mount | |
735 | option receives the paths to stack in the opposite order of | |
736 | this switch.</para></listitem> | |
737 | </varlistentry> | |
738 | ||
798d3a52 | 739 | <varlistentry> |
a5f1cb3b ZJS |
740 | <term><option>-E <replaceable>NAME</replaceable>=<replaceable>VALUE</replaceable></option></term> |
741 | <term><option>--setenv=<replaceable>NAME</replaceable>=<replaceable>VALUE</replaceable></option></term> | |
798d3a52 ZJS |
742 | |
743 | <listitem><para>Specifies an environment variable assignment | |
744 | to pass to the init process in the container, in the format | |
745 | <literal>NAME=VALUE</literal>. This may be used to override | |
746 | the default variables or to set additional variables. This | |
747 | parameter may be used more than once.</para></listitem> | |
748 | </varlistentry> | |
749 | ||
750 | <varlistentry> | |
751 | <term><option>--share-system</option></term> | |
752 | ||
753 | <listitem><para>Allows the container to share certain system | |
754 | facilities with the host. More specifically, this turns off | |
755 | PID namespacing, UTS namespacing and IPC namespacing, and thus | |
756 | allows the guest to see and interact more easily with | |
757 | processes outside of the container. Note that using this | |
758 | option makes it impossible to start up a full Operating System | |
759 | in the container, as an init system cannot operate in this | |
760 | mode. It is only useful to run specific programs or | |
761 | applications this way, without involving an init system in the | |
762 | container. This option implies <option>--register=no</option>. | |
763 | This option may not be combined with | |
764 | <option>--boot</option>.</para></listitem> | |
765 | </varlistentry> | |
766 | ||
767 | <varlistentry> | |
768 | <term><option>--register=</option></term> | |
769 | ||
770 | <listitem><para>Controls whether the container is registered | |
771 | with | |
772 | <citerefentry><refentrytitle>systemd-machined</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
a8eaaee7 | 773 | Takes a boolean argument, which defaults to <literal>yes</literal>. |
798d3a52 ZJS |
774 | This option should be enabled when the container runs a full |
775 | Operating System (more specifically: an init system), and is | |
776 | useful to ensure that the container is accessible via | |
777 | <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
778 | and shown by tools such as | |
779 | <citerefentry project='man-pages'><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry>. | |
780 | If the container does not run an init system, it is | |
781 | recommended to set this option to <literal>no</literal>. Note | |
782 | that <option>--share-system</option> implies | |
783 | <option>--register=no</option>. </para></listitem> | |
784 | </varlistentry> | |
785 | ||
786 | <varlistentry> | |
787 | <term><option>--keep-unit</option></term> | |
788 | ||
789 | <listitem><para>Instead of creating a transient scope unit to | |
790 | run the container in, simply register the service or scope | |
791 | unit <command>systemd-nspawn</command> has been invoked in | |
792 | with | |
793 | <citerefentry><refentrytitle>systemd-machined</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
794 | This has no effect if <option>--register=no</option> is used. | |
795 | This switch should be used if | |
796 | <command>systemd-nspawn</command> is invoked from within a | |
797 | service unit, and the service unit's sole purpose is to run a | |
798 | single <command>systemd-nspawn</command> container. This | |
799 | option is not available if run from a user | |
800 | session.</para></listitem> | |
801 | </varlistentry> | |
802 | ||
803 | <varlistentry> | |
804 | <term><option>--personality=</option></term> | |
805 | ||
806 | <listitem><para>Control the architecture ("personality") | |
807 | reported by | |
3ba3a79d | 808 | <citerefentry project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry> |
798d3a52 ZJS |
809 | in the container. Currently, only <literal>x86</literal> and |
810 | <literal>x86-64</literal> are supported. This is useful when | |
811 | running a 32-bit container on a 64-bit host. If this setting | |
812 | is not used, the personality reported in the container is the | |
813 | same as the one reported on the host.</para></listitem> | |
814 | </varlistentry> | |
815 | ||
816 | <varlistentry> | |
817 | <term><option>-q</option></term> | |
818 | <term><option>--quiet</option></term> | |
819 | ||
820 | <listitem><para>Turns off any status output by the tool | |
821 | itself. When this switch is used, the only output from nspawn | |
822 | will be the console output of the container OS | |
823 | itself.</para></listitem> | |
824 | </varlistentry> | |
825 | ||
826 | <varlistentry> | |
f757855e LP |
827 | <term><option>--volatile</option></term> |
828 | <term><option>--volatile=</option><replaceable>MODE</replaceable></term> | |
798d3a52 ZJS |
829 | |
830 | <listitem><para>Boots the container in volatile mode. When no | |
831 | mode parameter is passed or when mode is specified as | |
b938cb90 | 832 | <option>yes</option>, full volatile mode is enabled. This |
a8eaaee7 | 833 | means the root directory is mounted as a mostly unpopulated |
798d3a52 | 834 | <literal>tmpfs</literal> instance, and |
cd72d204 JE |
835 | <filename>/usr</filename> from the OS tree is mounted into it |
836 | in read-only mode (the system thus starts up with read-only OS | |
798d3a52 ZJS |
837 | resources, but pristine state and configuration, any changes |
838 | to the either are lost on shutdown). When the mode parameter | |
b938cb90 | 839 | is specified as <option>state</option>, the OS tree is |
798d3a52 | 840 | mounted read-only, but <filename>/var</filename> is mounted as |
a8eaaee7 | 841 | a <literal>tmpfs</literal> instance into it (the system thus |
798d3a52 | 842 | starts up with read-only OS resources and configuration, but |
a8eaaee7 | 843 | pristine state, and any changes to the latter are lost on |
798d3a52 | 844 | shutdown). When the mode parameter is specified as |
b938cb90 | 845 | <option>no</option> (the default), the whole OS tree is made |
798d3a52 ZJS |
846 | available writable.</para> |
847 | ||
f757855e LP |
848 | <para>Note that setting this to <option>yes</option> or |
849 | <option>state</option> will only work correctly with | |
798d3a52 ZJS |
850 | operating systems in the container that can boot up with only |
851 | <filename>/usr</filename> mounted, and are able to populate | |
852 | <filename>/var</filename> automatically, as | |
853 | needed.</para></listitem> | |
854 | </varlistentry> | |
855 | ||
f757855e LP |
856 | <varlistentry> |
857 | <term><option>--settings=</option><replaceable>MODE</replaceable></term> | |
858 | ||
859 | <listitem><para>Controls whether | |
860 | <command>systemd-nspawn</command> shall search for and use | |
861 | additional per-container settings from | |
862 | <filename>.nspawn</filename> files. Takes a boolean or the | |
863 | special values <option>override</option> or | |
864 | <option>trusted</option>.</para> | |
865 | ||
b938cb90 | 866 | <para>If enabled (the default), a settings file named after the |
f757855e LP |
867 | machine (as specified with the <option>--machine=</option> |
868 | setting, or derived from the directory or image file name) | |
869 | with the suffix <filename>.nspawn</filename> is searched in | |
870 | <filename>/etc/systemd/nspawn/</filename> and | |
871 | <filename>/run/systemd/nspawn/</filename>. If it is found | |
872 | there, its settings are read and used. If it is not found | |
b938cb90 | 873 | there, it is subsequently searched in the same directory as the |
f757855e | 874 | image file or in the immediate parent of the root directory of |
b938cb90 | 875 | the container. In this case, if the file is found, its settings |
f757855e | 876 | will be also read and used, but potentially unsafe settings |
b938cb90 | 877 | are ignored. Note that in both these cases, settings on the |
4f76ef04 | 878 | command line take precedence over the corresponding settings |
f757855e LP |
879 | from loaded <filename>.nspawn</filename> files, if both are |
880 | specified. Unsafe settings are considered all settings that | |
881 | elevate the container's privileges or grant access to | |
882 | additional resources such as files or directories of the | |
883 | host. For details about the format and contents of | |
b938cb90 | 884 | <filename>.nspawn</filename> files, consult |
f757855e LP |
885 | <citerefentry><refentrytitle>systemd.nspawn</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> |
886 | ||
b938cb90 JE |
887 | <para>If this option is set to <option>override</option>, the |
888 | file is searched, read and used the same way, however, the order of | |
f757855e LP |
889 | precedence is reversed: settings read from the |
890 | <filename>.nspawn</filename> file will take precedence over | |
891 | the corresponding command line options, if both are | |
892 | specified.</para> | |
893 | ||
b938cb90 | 894 | <para>If this option is set to <option>trusted</option>, the |
f757855e | 895 | file is searched, read and used the same way, but regardless |
a8eaaee7 | 896 | of being found in <filename>/etc/systemd/nspawn/</filename>, |
f757855e LP |
897 | <filename>/run/systemd/nspawn/</filename> or next to the image |
898 | file or container root directory, all settings will take | |
b938cb90 | 899 | effect, however, command line arguments still take precedence |
f757855e LP |
900 | over corresponding settings.</para> |
901 | ||
b938cb90 | 902 | <para>If disabled, no <filename>.nspawn</filename> file is read |
f757855e LP |
903 | and no settings except the ones on the command line are in |
904 | effect.</para></listitem> | |
905 | </varlistentry> | |
906 | ||
798d3a52 ZJS |
907 | <xi:include href="standard-options.xml" xpointer="help" /> |
908 | <xi:include href="standard-options.xml" xpointer="version" /> | |
909 | </variablelist> | |
910 | ||
911 | </refsect1> | |
912 | ||
913 | <refsect1> | |
914 | <title>Examples</title> | |
915 | ||
916 | <example> | |
917 | <title>Download a Fedora image and start a shell in it</title> | |
918 | ||
919 | <programlisting># machinectl pull-raw --verify=no http://ftp.halifax.rwth-aachen.de/fedora/linux/releases/21/Cloud/Images/x86_64/Fedora-Cloud-Base-20141203-21.x86_64.raw.xz | |
e0ea94c1 LP |
920 | # systemd-nspawn -M Fedora-Cloud-Base-20141203-21</programlisting> |
921 | ||
798d3a52 ZJS |
922 | <para>This downloads an image using |
923 | <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
924 | and opens a shell in it.</para> | |
925 | </example> | |
e0ea94c1 | 926 | |
798d3a52 ZJS |
927 | <example> |
928 | <title>Build and boot a minimal Fedora distribution in a container</title> | |
8f7a3c14 | 929 | |
09c76ef6 | 930 | <programlisting># dnf -y --releasever=23 --installroot=/srv/mycontainer --disablerepo='*' --enablerepo=fedora --enablerepo=updates install systemd passwd dnf fedora-release vim-minimal |
2b3987a8 | 931 | # systemd-nspawn -bD /srv/mycontainer</programlisting> |
8f7a3c14 | 932 | |
798d3a52 ZJS |
933 | <para>This installs a minimal Fedora distribution into the |
934 | directory <filename noindex='true'>/srv/mycontainer/</filename> | |
935 | and then boots an OS in a namespace container in it.</para> | |
936 | </example> | |
8f7a3c14 | 937 | |
798d3a52 ZJS |
938 | <example> |
939 | <title>Spawn a shell in a container of a minimal Debian unstable distribution</title> | |
8f7a3c14 | 940 | |
798d3a52 | 941 | <programlisting># debootstrap --arch=amd64 unstable ~/debian-tree/ |
25f5971b | 942 | # systemd-nspawn -D ~/debian-tree/</programlisting> |
8f7a3c14 | 943 | |
798d3a52 ZJS |
944 | <para>This installs a minimal Debian unstable distribution into |
945 | the directory <filename>~/debian-tree/</filename> and then | |
946 | spawns a shell in a namespace container in it.</para> | |
947 | </example> | |
8f7a3c14 | 948 | |
798d3a52 ZJS |
949 | <example> |
950 | <title>Boot a minimal Arch Linux distribution in a container</title> | |
68562936 | 951 | |
798d3a52 | 952 | <programlisting># pacstrap -c -d ~/arch-tree/ base |
68562936 WG |
953 | # systemd-nspawn -bD ~/arch-tree/</programlisting> |
954 | ||
ff9b60f3 | 955 | <para>This installs a minimal Arch Linux distribution into the |
798d3a52 ZJS |
956 | directory <filename>~/arch-tree/</filename> and then boots an OS |
957 | in a namespace container in it.</para> | |
958 | </example> | |
68562936 | 959 | |
798d3a52 ZJS |
960 | <example> |
961 | <title>Boot into an ephemeral <literal>btrfs</literal> snapshot of the host system</title> | |
f9f4dd51 | 962 | |
798d3a52 | 963 | <programlisting># systemd-nspawn -D / -xb</programlisting> |
f9f4dd51 | 964 | |
798d3a52 ZJS |
965 | <para>This runs a copy of the host system in a |
966 | <literal>btrfs</literal> snapshot which is removed immediately | |
967 | when the container exits. All file system changes made during | |
968 | runtime will be lost on shutdown, hence.</para> | |
969 | </example> | |
f9f4dd51 | 970 | |
798d3a52 ZJS |
971 | <example> |
972 | <title>Run a container with SELinux sandbox security contexts</title> | |
a8828ed9 | 973 | |
798d3a52 | 974 | <programlisting># chcon system_u:object_r:svirt_sandbox_file_t:s0:c0,c1 -R /srv/container |
a8828ed9 | 975 | # systemd-nspawn -L system_u:object_r:svirt_sandbox_file_t:s0:c0,c1 -Z system_u:system_r:svirt_lxc_net_t:s0:c0,c1 -D /srv/container /bin/sh</programlisting> |
798d3a52 ZJS |
976 | </example> |
977 | </refsect1> | |
978 | ||
979 | <refsect1> | |
980 | <title>Exit status</title> | |
981 | ||
982 | <para>The exit code of the program executed in the container is | |
983 | returned.</para> | |
984 | </refsect1> | |
985 | ||
986 | <refsect1> | |
987 | <title>See Also</title> | |
988 | <para> | |
989 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
f757855e | 990 | <citerefentry><refentrytitle>systemd.nspawn</refentrytitle><manvolnum>5</manvolnum></citerefentry>, |
798d3a52 ZJS |
991 | <citerefentry project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
992 | <citerefentry project='mankier'><refentrytitle>dnf</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
798d3a52 ZJS |
993 | <citerefentry project='die-net'><refentrytitle>debootstrap</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
994 | <citerefentry project='archlinux'><refentrytitle>pacman</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
995 | <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
996 | <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
3ba3a79d | 997 | <citerefentry project='man-pages'><refentrytitle>btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry> |
798d3a52 ZJS |
998 | </para> |
999 | </refsect1> | |
8f7a3c14 LP |
1000 | |
1001 | </refentry> |