]>
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" |
7a8aa0ec ZJS |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ |
4 | <!ENTITY fedora_latest_version "28"> | |
5 | <!ENTITY fedora_cloud_release "1.1"> | |
6 | ]> | |
8f7a3c14 LP |
7 | |
8 | <!-- | |
572eb058 | 9 | SPDX-License-Identifier: LGPL-2.1+ |
8f7a3c14 LP |
10 | --> |
11 | ||
dfdebb1b | 12 | <refentry id="systemd-nspawn" |
798d3a52 ZJS |
13 | xmlns:xi="http://www.w3.org/2001/XInclude"> |
14 | ||
15 | <refentryinfo> | |
16 | <title>systemd-nspawn</title> | |
17 | <productname>systemd</productname> | |
18 | ||
19 | <authorgroup> | |
20 | <author> | |
21 | <contrib>Developer</contrib> | |
22 | <firstname>Lennart</firstname> | |
23 | <surname>Poettering</surname> | |
24 | <email>lennart@poettering.net</email> | |
25 | </author> | |
26 | </authorgroup> | |
27 | </refentryinfo> | |
28 | ||
29 | <refmeta> | |
30 | <refentrytitle>systemd-nspawn</refentrytitle> | |
31 | <manvolnum>1</manvolnum> | |
32 | </refmeta> | |
33 | ||
34 | <refnamediv> | |
35 | <refname>systemd-nspawn</refname> | |
36 | <refpurpose>Spawn a namespace container for debugging, testing and building</refpurpose> | |
37 | </refnamediv> | |
38 | ||
39 | <refsynopsisdiv> | |
40 | <cmdsynopsis> | |
41 | <command>systemd-nspawn</command> | |
42 | <arg choice="opt" rep="repeat">OPTIONS</arg> | |
43 | <arg choice="opt"><replaceable>COMMAND</replaceable> | |
44 | <arg choice="opt" rep="repeat">ARGS</arg> | |
45 | </arg> | |
46 | </cmdsynopsis> | |
47 | <cmdsynopsis> | |
48 | <command>systemd-nspawn</command> | |
4447e799 | 49 | <arg choice="plain">--boot</arg> |
798d3a52 ZJS |
50 | <arg choice="opt" rep="repeat">OPTIONS</arg> |
51 | <arg choice="opt" rep="repeat">ARGS</arg> | |
52 | </cmdsynopsis> | |
53 | </refsynopsisdiv> | |
54 | ||
55 | <refsect1> | |
56 | <title>Description</title> | |
57 | ||
b09c0bba LP |
58 | <para><command>systemd-nspawn</command> may be used to run a command or OS in a light-weight namespace |
59 | container. In many ways it is similar to <citerefentry | |
60 | project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>1</manvolnum></citerefentry>, but more powerful | |
61 | since it fully virtualizes the file system hierarchy, as well as the process tree, the various IPC subsystems and | |
62 | the host and domain name.</para> | |
63 | ||
5164c3b4 | 64 | <para><command>systemd-nspawn</command> may be invoked on any directory tree containing an operating system tree, |
b09c0bba | 65 | using the <option>--directory=</option> command line option. By using the <option>--machine=</option> option an OS |
5164c3b4 | 66 | tree is automatically searched for in a couple of locations, most importantly in |
b09c0bba LP |
67 | <filename>/var/lib/machines</filename>, the suggested directory to place container images installed on the |
68 | system.</para> | |
69 | ||
70 | <para>In contrast to <citerefentry | |
71 | project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>1</manvolnum></citerefentry> <command>systemd-nspawn</command> | |
72 | may be used to boot full Linux-based operating systems in a container.</para> | |
73 | ||
74 | <para><command>systemd-nspawn</command> limits access to various kernel interfaces in the container to read-only, | |
75 | such as <filename>/sys</filename>, <filename>/proc/sys</filename> or <filename>/sys/fs/selinux</filename>. The | |
76 | host's network interfaces and the system clock may not be changed from within the container. Device nodes may not | |
77 | be created. The host system cannot be rebooted and kernel modules may not be loaded from within the | |
798d3a52 ZJS |
78 | container.</para> |
79 | ||
b09c0bba LP |
80 | <para>Use a tool like <citerefentry |
81 | project='mankier'><refentrytitle>dnf</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry | |
82 | project='die-net'><refentrytitle>debootstrap</refentrytitle><manvolnum>8</manvolnum></citerefentry>, or | |
83 | <citerefentry project='archlinux'><refentrytitle>pacman</refentrytitle><manvolnum>8</manvolnum></citerefentry> to | |
84 | set up an OS directory tree suitable as file system hierarchy for <command>systemd-nspawn</command> containers. See | |
85 | the Examples section below for details on suitable invocation of these commands.</para> | |
86 | ||
87 | <para>As a safety check <command>systemd-nspawn</command> will verify the existence of | |
88 | <filename>/usr/lib/os-release</filename> or <filename>/etc/os-release</filename> in the container tree before | |
89 | starting the container (see | |
90 | <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>). It might be | |
91 | necessary to add this file to the container tree manually if the OS of the container is too old to contain this | |
798d3a52 | 92 | file out-of-the-box.</para> |
b09c0bba LP |
93 | |
94 | <para><command>systemd-nspawn</command> may be invoked directly from the interactive command line or run as system | |
95 | service in the background. In this mode each container instance runs as its own service instance; a default | |
96 | template unit file <filename>systemd-nspawn@.service</filename> is provided to make this easy, taking the container | |
97 | name as instance identifier. Note that different default options apply when <command>systemd-nspawn</command> is | |
6dd6a9c4 | 98 | invoked by the template unit file than interactively on the command line. Most importantly the template unit file |
b09c0bba | 99 | makes use of the <option>--boot</option> which is not the default in case <command>systemd-nspawn</command> is |
6dd6a9c4 | 100 | invoked from the interactive command line. Further differences with the defaults are documented along with the |
b09c0bba LP |
101 | various supported options below.</para> |
102 | ||
103 | <para>The <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> tool may | |
104 | be used to execute a number of operations on containers. In particular it provides easy-to-use commands to run | |
105 | containers as system services using the <filename>systemd-nspawn@.service</filename> template unit | |
106 | file.</para> | |
107 | ||
108 | <para>Along with each container a settings file with the <filename>.nspawn</filename> suffix may exist, containing | |
109 | additional settings to apply when running the container. See | |
110 | <citerefentry><refentrytitle>systemd.nspawn</refentrytitle><manvolnum>5</manvolnum></citerefentry> for | |
111 | details. Settings files override the default options used by the <filename>systemd-nspawn@.service</filename> | |
112 | template unit file, making it usually unnecessary to alter this template file directly.</para> | |
113 | ||
114 | <para>Note that <command>systemd-nspawn</command> will mount file systems private to the container to | |
115 | <filename>/dev</filename>, <filename>/run</filename> and similar. These will not be visible outside of the | |
116 | container, and their contents will be lost when the container exits.</para> | |
117 | ||
118 | <para>Note that running two <command>systemd-nspawn</command> containers from the same directory tree will not make | |
119 | processes in them see each other. The PID namespace separation of the two containers is complete and the containers | |
120 | will share very few runtime objects except for the underlying file system. Use | |
121 | <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s | |
122 | <command>login</command> or <command>shell</command> commands to request an additional login session in a running | |
123 | container.</para> | |
124 | ||
125 | <para><command>systemd-nspawn</command> implements the <ulink | |
28a0ad81 | 126 | url="https://www.freedesktop.org/wiki/Software/systemd/ContainerInterface">Container Interface</ulink> |
b09c0bba LP |
127 | specification.</para> |
128 | ||
129 | <para>While running, containers invoked with <command>systemd-nspawn</command> are registered with the | |
130 | <citerefentry><refentrytitle>systemd-machined</refentrytitle><manvolnum>8</manvolnum></citerefentry> service that | |
131 | keeps track of running containers, and provides programming interfaces to interact with them.</para> | |
798d3a52 ZJS |
132 | </refsect1> |
133 | ||
134 | <refsect1> | |
135 | <title>Options</title> | |
136 | ||
137 | <para>If option <option>-b</option> is specified, the arguments | |
3f2d1365 | 138 | are used as arguments for the init program. Otherwise, |
798d3a52 ZJS |
139 | <replaceable>COMMAND</replaceable> specifies the program to launch |
140 | in the container, and the remaining arguments are used as | |
b09c0bba | 141 | arguments for this program. If <option>--boot</option> is not used and |
ff9b60f3 | 142 | no arguments are specified, a shell is launched in the |
798d3a52 ZJS |
143 | container.</para> |
144 | ||
145 | <para>The following options are understood:</para> | |
146 | ||
147 | <variablelist> | |
148 | <varlistentry> | |
149 | <term><option>-D</option></term> | |
150 | <term><option>--directory=</option></term> | |
151 | ||
152 | <listitem><para>Directory to use as file system root for the | |
153 | container.</para> | |
154 | ||
155 | <para>If neither <option>--directory=</option>, nor | |
156 | <option>--image=</option> is specified the directory is | |
32b64cce RM |
157 | determined by searching for a directory named the same as the |
158 | machine name specified with <option>--machine=</option>. See | |
159 | <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
160 | section "Files and Directories" for the precise search path.</para> | |
161 | ||
162 | <para>If neither <option>--directory=</option>, | |
163 | <option>--image=</option>, nor <option>--machine=</option> | |
164 | are specified, the current directory will | |
165 | be used. May not be specified together with | |
798d3a52 ZJS |
166 | <option>--image=</option>.</para></listitem> |
167 | </varlistentry> | |
168 | ||
169 | <varlistentry> | |
170 | <term><option>--template=</option></term> | |
171 | ||
17cbb288 LP |
172 | <listitem><para>Directory or <literal>btrfs</literal> subvolume to use as template for the container's root |
173 | directory. If this is specified and the container's root directory (as configured by | |
174 | <option>--directory=</option>) does not yet exist it is created as <literal>btrfs</literal> snapshot (if | |
175 | supported) or plain directory (otherwise) and populated from this template tree. Ideally, the specified | |
176 | template path refers to the root of a <literal>btrfs</literal> subvolume, in which case a simple copy-on-write | |
177 | snapshot is taken, and populating the root directory is instant. If the specified template path does not refer | |
178 | to the root of a <literal>btrfs</literal> subvolume (or not even to a <literal>btrfs</literal> file system at | |
179 | all), the tree is copied (though possibly in a copy-on-write scheme — if the file system supports that), which | |
180 | can be substantially more time-consuming. May not be specified together with <option>--image=</option> or | |
3fe22bb4 LP |
181 | <option>--ephemeral</option>.</para> |
182 | ||
183 | <para>Note that this switch leaves host name, machine ID and | |
184 | all other settings that could identify the instance | |
185 | unmodified.</para></listitem> | |
798d3a52 ZJS |
186 | </varlistentry> |
187 | ||
188 | <varlistentry> | |
189 | <term><option>-x</option></term> | |
190 | <term><option>--ephemeral</option></term> | |
191 | ||
0f3be6ca LP |
192 | <listitem><para>If specified, the container is run with a temporary snapshot of its file system that is removed |
193 | immediately when the container terminates. May not be specified together with | |
3fe22bb4 LP |
194 | <option>--template=</option>.</para> |
195 | <para>Note that this switch leaves host name, machine ID and | |
196 | all other settings that could identify the instance | |
197 | unmodified.</para></listitem> | |
798d3a52 ZJS |
198 | </varlistentry> |
199 | ||
200 | <varlistentry> | |
201 | <term><option>-i</option></term> | |
202 | <term><option>--image=</option></term> | |
203 | ||
204 | <listitem><para>Disk image to mount the root directory for the | |
205 | container from. Takes a path to a regular file or to a block | |
206 | device node. The file or block device must contain | |
207 | either:</para> | |
208 | ||
209 | <itemizedlist> | |
210 | <listitem><para>An MBR partition table with a single | |
211 | partition of type 0x83 that is marked | |
212 | bootable.</para></listitem> | |
213 | ||
214 | <listitem><para>A GUID partition table (GPT) with a single | |
215 | partition of type | |
216 | 0fc63daf-8483-4772-8e79-3d69d8477de4.</para></listitem> | |
217 | ||
218 | <listitem><para>A GUID partition table (GPT) with a marked | |
219 | root partition which is mounted as the root directory of the | |
220 | container. Optionally, GPT images may contain a home and/or | |
221 | a server data partition which are mounted to the appropriate | |
222 | places in the container. All these partitions must be | |
223 | identified by the partition types defined by the <ulink | |
28a0ad81 | 224 | url="https://www.freedesktop.org/wiki/Specifications/DiscoverablePartitionsSpec/">Discoverable |
798d3a52 | 225 | Partitions Specification</ulink>.</para></listitem> |
58abb66f LP |
226 | |
227 | <listitem><para>No partition table, and a single file system spanning the whole image.</para></listitem> | |
798d3a52 ZJS |
228 | </itemizedlist> |
229 | ||
0f3be6ca LP |
230 | <para>On GPT images, if an EFI System Partition (ESP) is discovered, it is automatically mounted to |
231 | <filename>/efi</filename> (or <filename>/boot</filename> as fallback) in case a directory by this name exists | |
232 | and is empty.</para> | |
233 | ||
58abb66f LP |
234 | <para>Partitions encrypted with LUKS are automatically decrypted. Also, on GPT images dm-verity data integrity |
235 | hash partitions are set up if the root hash for them is specified using the <option>--root-hash=</option> | |
236 | option.</para> | |
237 | ||
0f3be6ca LP |
238 | <para>Any other partitions, such as foreign partitions or swap partitions are not mounted. May not be specified |
239 | together with <option>--directory=</option>, <option>--template=</option>.</para></listitem> | |
798d3a52 | 240 | </varlistentry> |
58abb66f LP |
241 | |
242 | <varlistentry> | |
243 | <term><option>--root-hash=</option></term> | |
244 | ||
245 | <listitem><para>Takes a data integrity (dm-verity) root hash specified in hexadecimal. This option enables data | |
246 | integrity checks using dm-verity, if the used image contains the appropriate integrity data (see above). The | |
ef3116b5 | 247 | specified hash must match the root hash of integrity data, and is usually at least 256 bits (and hence 64 |
41488e1f LP |
248 | formatted hexadecimal characters) long (in case of SHA256 for example). If this option is not specified, but |
249 | the image file carries the <literal>user.verity.roothash</literal> extended file attribute (see <citerefentry | |
250 | project='man-pages'><refentrytitle>xattr</refentrytitle><manvolnum>7</manvolnum></citerefentry>), then the root | |
251 | hash is read from it, also as formatted hexadecimal characters. If the extended file attribute is not found (or | |
ef3116b5 ZJS |
252 | is not supported by the underlying file system), but a file with the <filename>.roothash</filename> suffix is |
253 | found next to the image file, bearing otherwise the same name, the root hash is read from it and automatically | |
254 | used, also as formatted hexadecimal characters.</para></listitem> | |
58abb66f | 255 | </varlistentry> |
798d3a52 | 256 | |
7732f92b LP |
257 | <varlistentry> |
258 | <term><option>-a</option></term> | |
259 | <term><option>--as-pid2</option></term> | |
260 | ||
261 | <listitem><para>Invoke the shell or specified program as process ID (PID) 2 instead of PID 1 (init). By | |
3f2d1365 AJ |
262 | default, if neither this option nor <option>--boot</option> is used, the selected program is run as the process |
263 | with PID 1, a mode only suitable for programs that are aware of the special semantics that the process with | |
264 | PID 1 has on UNIX. For example, it needs to reap all processes reparented to it, and should implement | |
7732f92b LP |
265 | <command>sysvinit</command> compatible signal handling (specifically: it needs to reboot on SIGINT, reexecute |
266 | on SIGTERM, reload configuration on SIGHUP, and so on). With <option>--as-pid2</option> a minimal stub init | |
3f2d1365 | 267 | process is run as PID 1 and the selected program is executed as PID 2 (and hence does not need to implement any |
7732f92b LP |
268 | special semantics). The stub init process will reap processes as necessary and react appropriately to |
269 | signals. It is recommended to use this mode to invoke arbitrary commands in containers, unless they have been | |
270 | modified to run correctly as PID 1. Or in other words: this switch should be used for pretty much all commands, | |
271 | except when the command refers to an init or shell implementation, as these are generally capable of running | |
a6b5216c | 272 | correctly as PID 1. This option may not be combined with <option>--boot</option>.</para> |
7732f92b LP |
273 | </listitem> |
274 | </varlistentry> | |
275 | ||
798d3a52 ZJS |
276 | <varlistentry> |
277 | <term><option>-b</option></term> | |
278 | <term><option>--boot</option></term> | |
279 | ||
3f2d1365 | 280 | <listitem><para>Automatically search for an init program and invoke it as PID 1, instead of a shell or a user |
7732f92b | 281 | supplied program. If this option is used, arguments specified on the command line are used as arguments for the |
3f2d1365 | 282 | init program. This option may not be combined with <option>--as-pid2</option>.</para> |
7732f92b LP |
283 | |
284 | <para>The following table explains the different modes of invocation and relationship to | |
285 | <option>--as-pid2</option> (see above):</para> | |
286 | ||
287 | <table> | |
288 | <title>Invocation Mode</title> | |
289 | <tgroup cols='2' align='left' colsep='1' rowsep='1'> | |
290 | <colspec colname="switch" /> | |
291 | <colspec colname="explanation" /> | |
292 | <thead> | |
293 | <row> | |
294 | <entry>Switch</entry> | |
295 | <entry>Explanation</entry> | |
296 | </row> | |
297 | </thead> | |
298 | <tbody> | |
299 | <row> | |
300 | <entry>Neither <option>--as-pid2</option> nor <option>--boot</option> specified</entry> | |
4447e799 | 301 | <entry>The passed parameters are interpreted as the command line, which is executed as PID 1 in the container.</entry> |
7732f92b LP |
302 | </row> |
303 | ||
304 | <row> | |
305 | <entry><option>--as-pid2</option> specified</entry> | |
4447e799 | 306 | <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 |
307 | </row> |
308 | ||
309 | <row> | |
310 | <entry><option>--boot</option> specified</entry> | |
3f2d1365 | 311 | <entry>An init program is automatically searched for and run as PID 1 in the container. The passed parameters are used as invocation parameters for this process.</entry> |
7732f92b LP |
312 | </row> |
313 | ||
314 | </tbody> | |
315 | </tgroup> | |
316 | </table> | |
b09c0bba LP |
317 | |
318 | <para>Note that <option>--boot</option> is the default mode of operation if the | |
319 | <filename>systemd-nspawn@.service</filename> template unit file is used.</para> | |
7732f92b | 320 | </listitem> |
798d3a52 ZJS |
321 | </varlistentry> |
322 | ||
5f932eb9 LP |
323 | <varlistentry> |
324 | <term><option>--chdir=</option></term> | |
325 | ||
326 | <listitem><para>Change to the specified working directory before invoking the process in the container. Expects | |
327 | an absolute path in the container's file system namespace.</para></listitem> | |
328 | </varlistentry> | |
329 | ||
b53ede69 PW |
330 | <varlistentry> |
331 | <term><option>--pivot-root=</option></term> | |
332 | ||
333 | <listitem><para>Pivot the specified directory to <filename>/</filename> inside the container, and either unmount the | |
334 | container's old root, or pivot it to another specified directory. Takes one of: a path argument — in which case the | |
335 | specified path will be pivoted to <filename>/</filename> and the old root will be unmounted; or a colon-separated pair | |
336 | of new root path and pivot destination for the old root. The new root path will be pivoted to <filename>/</filename>, | |
337 | and the old <filename>/</filename> will be pivoted to the other directory. Both paths must be absolute, and are resolved | |
338 | in the container's file system namespace.</para> | |
339 | ||
340 | <para>This is for containers which have several bootable directories in them; for example, several | |
3797fd0a ZJS |
341 | <ulink url="https://ostree.readthedocs.io/en/latest/">OSTree</ulink> deployments. It emulates the behavior of |
342 | the boot loader and initial RAM disk which normally select which directory to mount as the root and start the | |
343 | container's PID 1 in.</para></listitem> | |
b53ede69 PW |
344 | </varlistentry> |
345 | ||
798d3a52 ZJS |
346 | <varlistentry> |
347 | <term><option>-u</option></term> | |
348 | <term><option>--user=</option></term> | |
349 | ||
350 | <listitem><para>After transitioning into the container, change | |
351 | to the specified user-defined in the container's user | |
352 | database. Like all other systemd-nspawn features, this is not | |
353 | a security feature and provides protection against accidental | |
354 | destructive operations only.</para></listitem> | |
355 | </varlistentry> | |
356 | ||
357 | <varlistentry> | |
358 | <term><option>-M</option></term> | |
359 | <term><option>--machine=</option></term> | |
360 | ||
361 | <listitem><para>Sets the machine name for this container. This | |
362 | name may be used to identify this container during its runtime | |
363 | (for example in tools like | |
364 | <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
365 | and similar), and is used to initialize the container's | |
366 | hostname (which the container can choose to override, | |
367 | however). If not specified, the last component of the root | |
368 | directory path of the container is used, possibly suffixed | |
369 | with a random identifier in case <option>--ephemeral</option> | |
370 | mode is selected. If the root directory selected is the host's | |
371 | root directory the host's hostname is used as default | |
372 | instead.</para></listitem> | |
373 | </varlistentry> | |
374 | ||
3a9530e5 LP |
375 | <varlistentry> |
376 | <term><option>--hostname=</option></term> | |
377 | ||
378 | <listitem><para>Controls the hostname to set within the container, if different from the machine name. Expects | |
379 | a valid hostname as argument. If this option is used, the kernel hostname of the container will be set to this | |
380 | value, otherwise it will be initialized to the machine name as controlled by the <option>--machine=</option> | |
381 | option described above. The machine name is used for various aspect of identification of the container from the | |
382 | outside, the kernel hostname configurable with this option is useful for the container to identify itself from | |
383 | the inside. It is usually a good idea to keep both forms of identification synchronized, in order to avoid | |
384 | confusion. It is hence recommended to avoid usage of this option, and use <option>--machine=</option> | |
385 | exclusively. Note that regardless whether the container's hostname is initialized from the name set with | |
386 | <option>--hostname=</option> or the one set with <option>--machine=</option>, the container can later override | |
387 | its kernel hostname freely on its own as well.</para> | |
388 | </listitem> | |
389 | </varlistentry> | |
390 | ||
798d3a52 ZJS |
391 | <varlistentry> |
392 | <term><option>--uuid=</option></term> | |
393 | ||
394 | <listitem><para>Set the specified UUID for the container. The | |
395 | init system will initialize | |
396 | <filename>/etc/machine-id</filename> from this if this file is | |
e01ff70a MS |
397 | not set yet. Note that this option takes effect only if |
398 | <filename>/etc/machine-id</filename> in the container is | |
399 | unpopulated.</para></listitem> | |
798d3a52 ZJS |
400 | </varlistentry> |
401 | ||
402 | <varlistentry> | |
4deb5503 | 403 | <term><option>-S</option></term> |
798d3a52 ZJS |
404 | <term><option>--slice=</option></term> |
405 | ||
cd2dfc6f LP |
406 | <listitem><para>Make the container part of the specified slice, instead of the default |
407 | <filename>machine.slice</filename>. This applies only if the machine is run in its own scope unit, i.e. if | |
408 | <option>--keep-unit</option> isn't used.</para> | |
f36933fe LP |
409 | </listitem> |
410 | </varlistentry> | |
411 | ||
412 | <varlistentry> | |
413 | <term><option>--property=</option></term> | |
414 | ||
cd2dfc6f LP |
415 | <listitem><para>Set a unit property on the scope unit to register for the machine. This applies only if the |
416 | machine is run in its own scope unit, i.e. if <option>--keep-unit</option> isn't used. Takes unit property | |
417 | assignments in the same format as <command>systemctl set-property</command>. This is useful to set memory | |
418 | limits and similar for container.</para> | |
798d3a52 ZJS |
419 | </listitem> |
420 | </varlistentry> | |
421 | ||
03cfe0d5 LP |
422 | <varlistentry> |
423 | <term><option>--private-users=</option></term> | |
424 | ||
d2e5535f LP |
425 | <listitem><para>Controls user namespacing. If enabled, the container will run with its own private set of UNIX |
426 | user and group ids (UIDs and GIDs). This involves mapping the private UIDs/GIDs used in the container (starting | |
427 | with the container's root user 0 and up) to a range of UIDs/GIDs on the host that are not used for other | |
428 | purposes (usually in the range beyond the host's UID/GID 65536). The parameter may be specified as follows:</para> | |
429 | ||
430 | <orderedlist> | |
2dd67817 | 431 | <listitem><para>If one or two colon-separated numbers are specified, user namespacing is turned on. The first |
ae209204 ZJS |
432 | parameter specifies the first host UID/GID to assign to the container, the second parameter specifies the |
433 | number of host UIDs/GIDs to assign to the container. If the second parameter is omitted, 65536 UIDs/GIDs are | |
434 | assigned.</para></listitem> | |
435 | ||
436 | <listitem><para>If the parameter is omitted, or true, user namespacing is turned on. The UID/GID range to | |
437 | use is determined automatically from the file ownership of the root directory of the container's directory | |
438 | tree. To use this option, make sure to prepare the directory tree in advance, and ensure that all files and | |
439 | directories in it are owned by UIDs/GIDs in the range you'd like to use. Also, make sure that used file ACLs | |
440 | exclusively reference UIDs/GIDs in the appropriate range. If this mode is used the number of UIDs/GIDs | |
441 | assigned to the container for use is 65536, and the UID/GID of the root directory must be a multiple of | |
442 | 65536.</para></listitem> | |
443 | ||
444 | <listitem><para>If the parameter is false, user namespacing is turned off. This is the default.</para> | |
445 | </listitem> | |
446 | ||
447 | <listitem><para>The special value <literal>pick</literal> turns on user namespacing. In this case the UID/GID | |
448 | range is automatically chosen. As first step, the file owner of the root directory of the container's | |
449 | directory tree is read, and it is checked that it is currently not used by the system otherwise (in | |
450 | particular, that no other container is using it). If this check is successful, the UID/GID range determined | |
2dd67817 | 451 | this way is used, similar to the behavior if "yes" is specified. If the check is not successful (and thus |
ae209204 ZJS |
452 | the UID/GID range indicated in the root directory's file owner is already used elsewhere) a new – currently |
453 | unused – UID/GID range of 65536 UIDs/GIDs is randomly chosen between the host UID/GIDs of 524288 and | |
454 | 1878982656, always starting at a multiple of 65536. This setting implies | |
455 | <option>--private-users-chown</option> (see below), which has the effect that the files and directories in | |
456 | the container's directory tree will be owned by the appropriate users of the range picked. Using this option | |
2dd67817 | 457 | makes user namespace behavior fully automatic. Note that the first invocation of a previously unused |
ae209204 ZJS |
458 | container image might result in picking a new UID/GID range for it, and thus in the (possibly expensive) file |
459 | ownership adjustment operation. However, subsequent invocations of the container will be cheap (unless of | |
460 | course the picked UID/GID range is assigned to a different use by then).</para></listitem> | |
d2e5535f LP |
461 | </orderedlist> |
462 | ||
463 | <para>It is recommended to assign at least 65536 UIDs/GIDs to each container, so that the usable UID/GID range in the | |
464 | container covers 16 bit. For best security, do not assign overlapping UID/GID ranges to multiple containers. It is | |
465 | hence a good idea to use the upper 16 bit of the host 32-bit UIDs/GIDs as container identifier, while the lower 16 | |
2dd67817 | 466 | bit encode the container UID/GID used. This is in fact the behavior enforced by the |
d2e5535f LP |
467 | <option>--private-users=pick</option> option.</para> |
468 | ||
469 | <para>When user namespaces are used, the GID range assigned to each container is always chosen identical to the | |
470 | UID range.</para> | |
471 | ||
472 | <para>In most cases, using <option>--private-users=pick</option> is the recommended option as it enhances | |
473 | container security massively and operates fully automatically in most cases.</para> | |
474 | ||
475 | <para>Note that the picked UID/GID range is not written to <filename>/etc/passwd</filename> or | |
476 | <filename>/etc/group</filename>. In fact, the allocation of the range is not stored persistently anywhere, | |
aa10469e LP |
477 | except in the file ownership of the files and directories of the container.</para> |
478 | ||
479 | <para>Note that when user namespacing is used file ownership on disk reflects this, and all of the container's | |
480 | files and directories are owned by the container's effective user and group IDs. This means that copying files | |
481 | from and to the container image requires correction of the numeric UID/GID values, according to the UID/GID | |
482 | shift applied.</para></listitem> | |
03cfe0d5 LP |
483 | </varlistentry> |
484 | ||
d2e5535f LP |
485 | <varlistentry> |
486 | <term><option>--private-users-chown</option></term> | |
487 | ||
488 | <listitem><para>If specified, all files and directories in the container's directory tree will adjusted so that | |
489 | they are owned to the appropriate UIDs/GIDs selected for the container (see above). This operation is | |
490 | potentially expensive, as it involves descending and iterating through the full directory tree of the | |
491 | container. Besides actual file ownership, file ACLs are adjusted as well.</para> | |
492 | ||
493 | <para>This option is implied if <option>--private-users=pick</option> is used. This option has no effect if | |
494 | user namespacing is not used.</para></listitem> | |
495 | </varlistentry> | |
03cfe0d5 | 496 | |
6265bde2 ZJS |
497 | <varlistentry> |
498 | <term><option>-U</option></term> | |
499 | ||
500 | <listitem><para>If the kernel supports the user namespaces feature, equivalent to | |
501 | <option>--private-users=pick --private-users-chown</option>, otherwise equivalent to | |
502 | <option>--private-users=no</option>.</para> | |
503 | ||
504 | <para>Note that <option>-U</option> is the default if the | |
505 | <filename>systemd-nspawn@.service</filename> template unit file is used.</para> | |
506 | ||
507 | <para>Note: it is possible to undo the effect of <option>--private-users-chown</option> (or | |
508 | <option>-U</option>) on the file system by redoing the operation with the first UID of 0:</para> | |
509 | ||
510 | <programlisting>systemd-nspawn … --private-users=0 --private-users-chown</programlisting> | |
511 | </listitem> | |
512 | </varlistentry> | |
513 | ||
798d3a52 ZJS |
514 | <varlistentry> |
515 | <term><option>--private-network</option></term> | |
516 | ||
517 | <listitem><para>Disconnect networking of the container from | |
518 | the host. This makes all network interfaces unavailable in the | |
519 | container, with the exception of the loopback device and those | |
520 | specified with <option>--network-interface=</option> and | |
521 | configured with <option>--network-veth</option>. If this | |
522 | option is specified, the CAP_NET_ADMIN capability will be | |
523 | added to the set of capabilities the container retains. The | |
bc96c63c ZJS |
524 | latter may be disabled by using <option>--drop-capability=</option>. |
525 | If this option is not specified (or implied by one of the options | |
526 | listed below), the container will have full access to the host network. | |
527 | </para></listitem> | |
798d3a52 ZJS |
528 | </varlistentry> |
529 | ||
d7bea6b6 DP |
530 | <varlistentry> |
531 | <term><option>--network-namespace-path=</option></term> | |
532 | ||
533 | <listitem><para>Takes the path to a file representing a kernel | |
534 | network namespace that the container shall run in. The specified path | |
535 | should refer to a (possibly bind-mounted) network namespace file, as | |
536 | exposed by the kernel below <filename>/proc/$PID/ns/net</filename>. | |
537 | This makes the container enter the given network namespace. One of the | |
538 | typical use cases is to give a network namespace under | |
539 | <filename>/run/netns</filename> created by <citerefentry | |
540 | project='man-pages'><refentrytitle>ip-netns</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
541 | for example, <option>--network-namespace-path=/run/netns/foo</option>. | |
542 | Note that this option cannot be used together with other | |
543 | network-related options, such as <option>--private-network</option> | |
544 | or <option>--network-interface=</option>.</para></listitem> | |
545 | </varlistentry> | |
546 | ||
798d3a52 ZJS |
547 | <varlistentry> |
548 | <term><option>--network-interface=</option></term> | |
549 | ||
550 | <listitem><para>Assign the specified network interface to the | |
551 | container. This will remove the specified interface from the | |
552 | calling namespace and place it in the container. When the | |
553 | container terminates, it is moved back to the host namespace. | |
554 | Note that <option>--network-interface=</option> implies | |
555 | <option>--private-network</option>. This option may be used | |
556 | more than once to add multiple network interfaces to the | |
557 | container.</para></listitem> | |
558 | </varlistentry> | |
559 | ||
560 | <varlistentry> | |
561 | <term><option>--network-macvlan=</option></term> | |
562 | ||
563 | <listitem><para>Create a <literal>macvlan</literal> interface | |
564 | of the specified Ethernet network interface and add it to the | |
565 | container. A <literal>macvlan</literal> interface is a virtual | |
566 | interface that adds a second MAC address to an existing | |
567 | physical Ethernet link. The interface in the container will be | |
568 | named after the interface on the host, prefixed with | |
569 | <literal>mv-</literal>. Note that | |
570 | <option>--network-macvlan=</option> implies | |
571 | <option>--private-network</option>. This option may be used | |
572 | more than once to add multiple network interfaces to the | |
573 | container.</para></listitem> | |
574 | </varlistentry> | |
575 | ||
576 | <varlistentry> | |
577 | <term><option>--network-ipvlan=</option></term> | |
578 | ||
579 | <listitem><para>Create an <literal>ipvlan</literal> interface | |
580 | of the specified Ethernet network interface and add it to the | |
581 | container. An <literal>ipvlan</literal> interface is a virtual | |
582 | interface, similar to a <literal>macvlan</literal> interface, | |
583 | which uses the same MAC address as the underlying interface. | |
584 | The interface in the container will be named after the | |
585 | interface on the host, prefixed with <literal>iv-</literal>. | |
586 | Note that <option>--network-ipvlan=</option> implies | |
587 | <option>--private-network</option>. This option may be used | |
588 | more than once to add multiple network interfaces to the | |
589 | container.</para></listitem> | |
590 | </varlistentry> | |
591 | ||
592 | <varlistentry> | |
593 | <term><option>-n</option></term> | |
594 | <term><option>--network-veth</option></term> | |
595 | ||
5e7423ff LP |
596 | <listitem><para>Create a virtual Ethernet link (<literal>veth</literal>) between host and container. The host |
597 | side of the Ethernet link will be available as a network interface named after the container's name (as | |
598 | specified with <option>--machine=</option>), prefixed with <literal>ve-</literal>. The container side of the | |
599 | Ethernet link will be named <literal>host0</literal>. The <option>--network-veth</option> option implies | |
600 | <option>--private-network</option>.</para> | |
601 | ||
602 | <para>Note that | |
603 | <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
604 | includes by default a network file <filename>/usr/lib/systemd/network/80-container-ve.network</filename> | |
605 | matching the host-side interfaces created this way, which contains settings to enable automatic address | |
606 | provisioning on the created virtual link via DHCP, as well as automatic IP routing onto the host's external | |
607 | network interfaces. It also contains <filename>/usr/lib/systemd/network/80-container-host0.network</filename> | |
608 | matching the container-side interface created this way, containing settings to enable client side address | |
609 | assignment via DHCP. In case <filename>systemd-networkd</filename> is running on both the host and inside the | |
610 | container, automatic IP communication from the container to the host is thus available, with further | |
611 | connectivity to the external network.</para> | |
b09c0bba LP |
612 | |
613 | <para>Note that <option>--network-veth</option> is the default if the | |
614 | <filename>systemd-nspawn@.service</filename> template unit file is used.</para> | |
5e7423ff | 615 | </listitem> |
798d3a52 ZJS |
616 | </varlistentry> |
617 | ||
f6d6bad1 LP |
618 | <varlistentry> |
619 | <term><option>--network-veth-extra=</option></term> | |
620 | ||
621 | <listitem><para>Adds an additional virtual Ethernet link | |
622 | between host and container. Takes a colon-separated pair of | |
623 | host interface name and container interface name. The latter | |
624 | may be omitted in which case the container and host sides will | |
625 | be assigned the same name. This switch is independent of | |
ccddd104 | 626 | <option>--network-veth</option>, and — in contrast — may be |
f6d6bad1 LP |
627 | used multiple times, and allows configuration of the network |
628 | interface names. Note that <option>--network-bridge=</option> | |
629 | has no effect on interfaces created with | |
630 | <option>--network-veth-extra=</option>.</para></listitem> | |
631 | </varlistentry> | |
632 | ||
798d3a52 ZJS |
633 | <varlistentry> |
634 | <term><option>--network-bridge=</option></term> | |
635 | ||
5e7423ff LP |
636 | <listitem><para>Adds the host side of the Ethernet link created with <option>--network-veth</option> to the |
637 | specified Ethernet bridge interface. Expects a valid network interface name of a bridge device as | |
638 | argument. Note that <option>--network-bridge=</option> implies <option>--network-veth</option>. If this option | |
639 | is used, the host side of the Ethernet link will use the <literal>vb-</literal> prefix instead of | |
798d3a52 ZJS |
640 | <literal>ve-</literal>.</para></listitem> |
641 | </varlistentry> | |
642 | ||
938d2579 LP |
643 | <varlistentry> |
644 | <term><option>--network-zone=</option></term> | |
645 | ||
646 | <listitem><para>Creates a virtual Ethernet link (<literal>veth</literal>) to the container and adds it to an | |
647 | automatically managed Ethernet bridge interface. The bridge interface is named after the passed argument, | |
648 | prefixed with <literal>vz-</literal>. The bridge interface is automatically created when the first container | |
649 | configured for its name is started, and is automatically removed when the last container configured for its | |
650 | name exits. Hence, each bridge interface configured this way exists only as long as there's at least one | |
651 | container referencing it running. This option is very similar to <option>--network-bridge=</option>, besides | |
652 | this automatic creation/removal of the bridge device.</para> | |
653 | ||
654 | <para>This setting makes it easy to place multiple related containers on a common, virtual Ethernet-based | |
655 | broadcast domain, here called a "zone". Each container may only be part of one zone, but each zone may contain | |
656 | any number of containers. Each zone is referenced by its name. Names may be chosen freely (as long as they form | |
657 | valid network interface names when prefixed with <literal>vz-</literal>), and it is sufficient to pass the same | |
cf917c27 | 658 | name to the <option>--network-zone=</option> switch of the various concurrently running containers to join |
938d2579 LP |
659 | them in one zone.</para> |
660 | ||
661 | <para>Note that | |
662 | <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
663 | includes by default a network file <filename>/usr/lib/systemd/network/80-container-vz.network</filename> | |
664 | matching the bridge interfaces created this way, which contains settings to enable automatic address | |
665 | provisioning on the created virtual network via DHCP, as well as automatic IP routing onto the host's external | |
666 | network interfaces. Using <option>--network-zone=</option> is hence in most cases fully automatic and | |
667 | sufficient to connect multiple local containers in a joined broadcast domain to the host, with further | |
668 | connectivity to the external network.</para> | |
669 | </listitem> | |
670 | </varlistentry> | |
671 | ||
798d3a52 ZJS |
672 | <varlistentry> |
673 | <term><option>-p</option></term> | |
674 | <term><option>--port=</option></term> | |
675 | ||
676 | <listitem><para>If private networking is enabled, maps an IP | |
677 | port on the host onto an IP port on the container. Takes a | |
678 | protocol specifier (either <literal>tcp</literal> or | |
679 | <literal>udp</literal>), separated by a colon from a host port | |
680 | number in the range 1 to 65535, separated by a colon from a | |
681 | container port number in the range from 1 to 65535. The | |
682 | protocol specifier and its separating colon may be omitted, in | |
683 | which case <literal>tcp</literal> is assumed. The container | |
7c918141 | 684 | port number and its colon may be omitted, in which case the |
798d3a52 | 685 | same port as the host port is implied. This option is only |
a8eaaee7 | 686 | supported if private networking is used, such as with |
938d2579 | 687 | <option>--network-veth</option>, <option>--network-zone=</option> |
798d3a52 ZJS |
688 | <option>--network-bridge=</option>.</para></listitem> |
689 | </varlistentry> | |
690 | ||
691 | <varlistentry> | |
692 | <term><option>-Z</option></term> | |
693 | <term><option>--selinux-context=</option></term> | |
694 | ||
695 | <listitem><para>Sets the SELinux security context to be used | |
696 | to label processes in the container.</para> | |
697 | </listitem> | |
698 | </varlistentry> | |
699 | ||
700 | <varlistentry> | |
701 | <term><option>-L</option></term> | |
702 | <term><option>--selinux-apifs-context=</option></term> | |
703 | ||
704 | <listitem><para>Sets the SELinux security context to be used | |
705 | to label files in the virtual API file systems in the | |
706 | container.</para> | |
707 | </listitem> | |
708 | </varlistentry> | |
709 | ||
710 | <varlistentry> | |
711 | <term><option>--capability=</option></term> | |
712 | ||
a30504ed AJ |
713 | <listitem><para>List one or more additional capabilities to grant the container. |
714 | Takes a comma-separated list of capability names, see | |
798d3a52 | 715 | <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> |
a30504ed AJ |
716 | for more information. Note that the following capabilities will be granted in any way: |
717 | CAP_AUDIT_CONTROL, CAP_AUDIT_WRITE, CAP_CHOWN, CAP_DAC_OVERRIDE, CAP_DAC_READ_SEARCH, | |
718 | CAP_FOWNER, CAP_FSETID, CAP_IPC_OWNER, CAP_KILL, CAP_LEASE, CAP_LINUX_IMMUTABLE, | |
719 | CAP_MKNOD, CAP_NET_BIND_SERVICE, CAP_NET_BROADCAST, CAP_NET_RAW, CAP_SETFCAP, | |
720 | CAP_SETGID, CAP_SETPCAP, CAP_SETUID, CAP_SYS_ADMIN, CAP_SYS_BOOT, CAP_SYS_CHROOT, | |
721 | CAP_SYS_NICE, CAP_SYS_PTRACE, CAP_SYS_RESOURCE, CAP_SYS_TTY_CONFIG. Also CAP_NET_ADMIN | |
722 | is retained if <option>--private-network</option> is specified. If the special value | |
723 | <literal>all</literal> is passed, all capabilities are retained.</para></listitem> | |
798d3a52 ZJS |
724 | </varlistentry> |
725 | ||
726 | <varlistentry> | |
727 | <term><option>--drop-capability=</option></term> | |
728 | ||
729 | <listitem><para>Specify one or more additional capabilities to | |
730 | drop for the container. This allows running the container with | |
731 | fewer capabilities than the default (see | |
732 | above).</para></listitem> | |
733 | </varlistentry> | |
734 | ||
66edd963 LP |
735 | <varlistentry> |
736 | <term><option>--no-new-privileges=</option></term> | |
737 | ||
738 | <listitem><para>Takes a boolean argument. Specifies the value of the <constant>PR_SET_NO_NEW_PRIVS</constant> | |
739 | flag for the container payload. Defaults to off. When turned on the payload code of the container cannot | |
740 | acquire new privileges, i.e. the "setuid" file bit as well as file system capabilities will not have an effect | |
741 | anymore. See <citerefentry | |
742 | project='man-pages'><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry> for details | |
743 | about this flag. </para></listitem> | |
744 | </varlistentry> | |
745 | ||
960e4569 LP |
746 | <varlistentry> |
747 | <term><option>--system-call-filter=</option></term> | |
748 | ||
749 | <listitem><para>Alter the system call filter applied to containers. Takes a space-separated list of system call | |
750 | names or group names (the latter prefixed with <literal>@</literal>, as listed by the | |
c7fc3c4c LP |
751 | <command>syscall-filter</command> command of |
752 | <citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>). Passed | |
960e4569 LP |
753 | system calls will be permitted. The list may optionally be prefixed by <literal>~</literal>, in which case all |
754 | listed system calls are prohibited. If this command line option is used multiple times the configured lists are | |
755 | combined. If both a positive and a negative list (that is one system call list without and one with the | |
96bedbe2 LP |
756 | <literal>~</literal> prefix) are configured, the negative list takes precedence over the positive list. Note |
757 | that <command>systemd-nspawn</command> always implements a system call whitelist (as opposed to a blacklist), | |
758 | and this command line option hence adds or removes entries from the default whitelist, depending on the | |
960e4569 LP |
759 | <literal>~</literal> prefix. Note that the applied system call filter is also altered implicitly if additional |
760 | capabilities are passed using the <command>--capabilities=</command>.</para></listitem> | |
761 | </varlistentry> | |
762 | ||
bf428efb LP |
763 | <varlistentry> |
764 | <term><option>--rlimit=</option></term> | |
765 | ||
766 | <listitem><para>Sets the specified POSIX resource limit for the container payload. Expects an assignment of the | |
767 | form | |
768 | <literal><replaceable>LIMIT</replaceable>=<replaceable>SOFT</replaceable>:<replaceable>HARD</replaceable></literal> | |
769 | or <literal><replaceable>LIMIT</replaceable>=<replaceable>VALUE</replaceable></literal>, where | |
770 | <replaceable>LIMIT</replaceable> should refer to a resource limit type, such as | |
771 | <constant>RLIMIT_NOFILE</constant> or <constant>RLIMIT_NICE</constant>. The <replaceable>SOFT</replaceable> and | |
772 | <replaceable>HARD</replaceable> fields should refer to the numeric soft and hard resource limit values. If the | |
1b2ad5d9 | 773 | second form is used, <replaceable>VALUE</replaceable> may specify a value that is used both as soft and hard |
bf428efb LP |
774 | limit. In place of a numeric value the special string <literal>infinity</literal> may be used to turn off |
775 | resource limiting for the specific type of resource. This command line option may be used multiple times to | |
1b2ad5d9 | 776 | control limits on multiple limit types. If used multiple times for the same limit type, the last use |
bf428efb LP |
777 | wins. For details about resource limits see <citerefentry |
778 | project='man-pages'><refentrytitle>setrlimit</refentrytitle><manvolnum>2</manvolnum></citerefentry>. By default | |
779 | resource limits for the container's init process (PID 1) are set to the same values the Linux kernel originally | |
780 | passed to the host init system. Note that some resource limits are enforced on resources counted per user, in | |
781 | particular <constant>RLIMIT_NPROC</constant>. This means that unless user namespacing is deployed | |
782 | (i.e. <option>--private-users=</option> is used, see above), any limits set will be applied to the resource | |
783 | usage of the same user on all local containers as well as the host. This means particular care needs to be | |
784 | taken with these limits as they might be triggered by possibly less trusted code. Example: | |
785 | <literal>--rlimit=RLIMIT_NOFILE=8192:16384</literal>.</para></listitem> | |
786 | </varlistentry> | |
787 | ||
81f345df LP |
788 | <varlistentry> |
789 | <term><option>--oom-score-adjust=</option></term> | |
790 | ||
791 | <listitem><para>Changes the OOM ("Out Of Memory") score adjustment value for the container payload. This controls | |
792 | <filename>/proc/self/oom_score_adj</filename> which influences the preference with which this container is | |
793 | terminated when memory becomes scarce. For details see <citerefentry | |
794 | project='man-pages'><refentrytitle>proc</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Takes an | |
795 | integer in the range -1000…1000.</para></listitem> | |
796 | </varlistentry> | |
797 | ||
d107bb7d LP |
798 | <varlistentry> |
799 | <term><option>--cpu-affinity=</option></term> | |
800 | ||
801 | <listitem><para>Controls the CPU affinity of the container payload. Takes a comma separated list of CPU numbers | |
802 | or number ranges (the latter's start and end value separated by dashes). See <citerefentry | |
803 | project='man-pages'><refentrytitle>sched_setaffinity</refentrytitle><manvolnum>2</manvolnum></citerefentry> for | |
804 | details.</para></listitem> | |
805 | </varlistentry> | |
806 | ||
c6c8f6e2 LP |
807 | <varlistentry> |
808 | <term><option>--kill-signal=</option></term> | |
809 | ||
1752d69a LP |
810 | <listitem><para>Specify the process signal to send to the container's PID 1 when nspawn itself receives |
811 | <constant>SIGTERM</constant>, in order to trigger an orderly shutdown of the container. Defaults to | |
812 | <constant>SIGRTMIN+3</constant> if <option>--boot</option> is used (on systemd-compatible init systems | |
813 | <constant>SIGRTMIN+3</constant> triggers an orderly shutdown). If <option>--boot</option> is not used and this | |
814 | option is not specified the container's processes are terminated abrubtly via <constant>SIGKILL</constant>. For | |
815 | a list of valid signals, see <citerefentry | |
816 | project='man-pages'><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para></listitem> | |
c6c8f6e2 LP |
817 | </varlistentry> |
818 | ||
798d3a52 ZJS |
819 | <varlistentry> |
820 | <term><option>--link-journal=</option></term> | |
821 | ||
822 | <listitem><para>Control whether the container's journal shall | |
823 | be made visible to the host system. If enabled, allows viewing | |
824 | the container's journal files from the host (but not vice | |
825 | versa). Takes one of <literal>no</literal>, | |
826 | <literal>host</literal>, <literal>try-host</literal>, | |
827 | <literal>guest</literal>, <literal>try-guest</literal>, | |
828 | <literal>auto</literal>. If <literal>no</literal>, the journal | |
829 | is not linked. If <literal>host</literal>, the journal files | |
830 | are stored on the host file system (beneath | |
831 | <filename>/var/log/journal/<replaceable>machine-id</replaceable></filename>) | |
832 | and the subdirectory is bind-mounted into the container at the | |
833 | same location. If <literal>guest</literal>, the journal files | |
834 | are stored on the guest file system (beneath | |
835 | <filename>/var/log/journal/<replaceable>machine-id</replaceable></filename>) | |
836 | and the subdirectory is symlinked into the host at the same | |
837 | location. <literal>try-host</literal> and | |
838 | <literal>try-guest</literal> do the same but do not fail if | |
2dd67817 | 839 | the host does not have persistent journaling enabled. If |
798d3a52 ZJS |
840 | <literal>auto</literal> (the default), and the right |
841 | subdirectory of <filename>/var/log/journal</filename> exists, | |
842 | it will be bind mounted into the container. If the | |
843 | subdirectory does not exist, no linking is performed. | |
844 | Effectively, booting a container once with | |
845 | <literal>guest</literal> or <literal>host</literal> will link | |
846 | the journal persistently if further on the default of | |
b09c0bba LP |
847 | <literal>auto</literal> is used.</para> |
848 | ||
849 | <para>Note that <option>--link-journal=try-guest</option> is the default if the | |
850 | <filename>systemd-nspawn@.service</filename> template unit file is used.</para></listitem> | |
798d3a52 ZJS |
851 | </varlistentry> |
852 | ||
853 | <varlistentry> | |
854 | <term><option>-j</option></term> | |
855 | ||
856 | <listitem><para>Equivalent to | |
857 | <option>--link-journal=try-guest</option>.</para></listitem> | |
858 | </varlistentry> | |
859 | ||
09d423e9 LP |
860 | <varlistentry> |
861 | <term><option>--resolv-conf=</option></term> | |
862 | ||
863 | <listitem><para>Configures how <filename>/etc/resolv.conf</filename> inside of the container (i.e. DNS | |
864 | configuration synchronization from host to container) shall be handled. Takes one of <literal>off</literal>, | |
865 | <literal>copy-host</literal>, <literal>copy-static</literal>, <literal>bind-host</literal>, | |
866 | <literal>bind-static</literal>, <literal>delete</literal> or <literal>auto</literal>. If set to | |
867 | <literal>off</literal> the <filename>/etc/resolv.conf</filename> file in the container is left as it is | |
868 | included in the image, and neither modified nor bind mounted over. If set to <literal>copy-host</literal>, the | |
869 | <filename>/etc/resolv.conf</filename> file from the host is copied into the container. Similar, if | |
870 | <literal>bind-host</literal> is used, the file is bind mounted from the host into the container. If set to | |
871 | <literal>copy-static</literal> the static <filename>resolv.conf</filename> file supplied with | |
872 | <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> is | |
873 | copied into the container, and correspondingly <literal>bind-static</literal> bind mounts it there. If set to | |
874 | <literal>delete</literal> the <filename>/etc/resolv.conf</filename> file in the container is deleted if it | |
875 | exists. Finally, if set to <literal>auto</literal> the file is left as it is if private networking is turned on | |
876 | (see <option>--private-network</option>). Otherwise, if <filename>systemd-resolved.service</filename> is | |
877 | connectible its static <filename>resolv.conf</filename> file is used, and if not the host's | |
878 | <filename>/etc/resolv.conf</filename> file is used. In the latter cases the file is copied if the image is | |
879 | writable, and bind mounted otherwise. It's recommended to use <literal>copy</literal> if the container shall be | |
880 | able to make changes to the DNS configuration on its own, deviating from the host's settings. Otherwise | |
881 | <literal>bind</literal> is preferable, as it means direct changes to <filename>/etc/resolv.conf</filename> in | |
882 | the container are not allowed, as it is a read-only bind mount (but note that if the container has enough | |
883 | privileges, it might simply go ahead and unmount the bind mount anyway). Note that both if the file is bind | |
884 | mounted and if it is copied no further propagation of configuration is generally done after the one-time early | |
885 | initialization (this is because the file is usually updated through copying and renaming). Defaults to | |
886 | <literal>auto</literal>.</para></listitem> | |
887 | </varlistentry> | |
888 | ||
1688841f LP |
889 | <varlistentry> |
890 | <term><option>--timezone=</option></term> | |
891 | ||
892 | <listitem><para>Configures how <filename>/etc/localtime</filename> inside of the container (i.e. local timezone | |
893 | synchronization from host to container) shall be handled. Takes one of <literal>off</literal>, | |
894 | <literal>copy</literal>, <literal>bind</literal>, <literal>symlink</literal>, <literal>delete</literal> or | |
895 | <literal>auto</literal>. If set to <literal>off</literal> the <filename>/etc/localtime</filename> file in the | |
896 | container is left as it is included in the image, and neither modified nor bind mounted over. If set to | |
897 | <literal>copy</literal> the <filename>/etc/localtime</filename> file of the host is copied into the | |
898 | container. Similar, if <literal>bind</literal> is used, it is bind mounted from the host into the container. If | |
899 | set to <literal>symlink</literal> a symlink from <filename>/etc/localtime</filename> in the container is | |
900 | created pointing to the matching the timezone file of the container that matches the timezone setting on the | |
901 | host. If set to <literal>delete</literal> the file in the container is deleted, should it exist. If set to | |
902 | <literal>auto</literal> and the <filename>/etc/localtime</filename> file of the host is a symlink, then | |
903 | <literal>symlink</literal> mode is used, and <literal>copy</literal> otherwise, except if the image is | |
904 | read-only in which case <literal>bind</literal> is used instead. Defaults to | |
905 | <literal>auto</literal>.</para></listitem> | |
906 | </varlistentry> | |
907 | ||
798d3a52 ZJS |
908 | <varlistentry> |
909 | <term><option>--read-only</option></term> | |
910 | ||
911 | <listitem><para>Mount the root file system read-only for the | |
912 | container.</para></listitem> | |
913 | </varlistentry> | |
914 | ||
915 | <varlistentry> | |
916 | <term><option>--bind=</option></term> | |
917 | <term><option>--bind-ro=</option></term> | |
918 | ||
86c0dd4a | 919 | <listitem><para>Bind mount a file or directory from the host into the container. Takes one of: a path |
c7a4890c LP |
920 | argument — in which case the specified path will be mounted from the host to the same path in the container, or |
921 | a colon-separated pair of paths — in which case the first specified path is the source in the host, and the | |
922 | second path is the destination in the container, or a colon-separated triple of source path, destination path | |
86c0dd4a | 923 | and mount options. The source path may optionally be prefixed with a <literal>+</literal> character. If so, the |
c7a4890c LP |
924 | source path is taken relative to the image's root directory. This permits setting up bind mounts within the |
925 | container image. The source path may be specified as empty string, in which case a temporary directory below | |
926 | the host's <filename>/var/tmp</filename> directory is used. It is automatically removed when the container is | |
927 | shut down. Mount options are comma-separated and currently, only <option>rbind</option> and | |
928 | <option>norbind</option> are allowed, controlling whether to create a recursive or a regular bind | |
929 | mount. Defaults to "rbind". Backslash escapes are interpreted, so <literal>\:</literal> may be used to embed | |
930 | colons in either path. This option may be specified multiple times for creating multiple independent bind | |
994a6364 LP |
931 | mount points. The <option>--bind-ro=</option> option creates read-only bind mounts.</para> |
932 | ||
933 | <para>Note that when this option is used in combination with <option>--private-users</option>, the resulting | |
934 | mount points will be owned by the <constant>nobody</constant> user. That's because the mount and its files and | |
935 | directories continue to be owned by the relevant host users and groups, which do not exist in the container, | |
936 | and thus show up under the wildcard UID 65534 (nobody). If such bind mounts are created, it is recommended to | |
937 | make them read-only, using <option>--bind-ro=</option>.</para></listitem> | |
798d3a52 ZJS |
938 | </varlistentry> |
939 | ||
940 | <varlistentry> | |
941 | <term><option>--tmpfs=</option></term> | |
942 | ||
943 | <listitem><para>Mount a tmpfs file system into the container. | |
944 | Takes a single absolute path argument that specifies where to | |
945 | mount the tmpfs instance to (in which case the directory | |
946 | access mode will be chosen as 0755, owned by root/root), or | |
947 | optionally a colon-separated pair of path and mount option | |
b938cb90 | 948 | string that is used for mounting (in which case the kernel |
798d3a52 ZJS |
949 | default for access mode and owner will be chosen, unless |
950 | otherwise specified). This option is particularly useful for | |
951 | mounting directories such as <filename>/var</filename> as | |
952 | tmpfs, to allow state-less systems, in particular when | |
ffcd3e89 | 953 | combined with <option>--read-only</option>. |
b938cb90 | 954 | Backslash escapes are interpreted in the path, so |
ffcd3e89 RM |
955 | <literal>\:</literal> may be used to embed colons in the path. |
956 | </para></listitem> | |
798d3a52 ZJS |
957 | </varlistentry> |
958 | ||
5a8af538 LP |
959 | <varlistentry> |
960 | <term><option>--overlay=</option></term> | |
961 | <term><option>--overlay-ro=</option></term> | |
962 | ||
963 | <listitem><para>Combine multiple directory trees into one | |
964 | overlay file system and mount it into the container. Takes a | |
965 | list of colon-separated paths to the directory trees to | |
966 | combine and the destination mount point.</para> | |
967 | ||
2eadf91c RM |
968 | <para>Backslash escapes are interpreted in the paths, so |
969 | <literal>\:</literal> may be used to embed colons in the paths. | |
970 | </para> | |
971 | ||
5a8af538 LP |
972 | <para>If three or more paths are specified, then the last |
973 | specified path is the destination mount point in the | |
974 | container, all paths specified before refer to directory trees | |
975 | on the host and are combined in the specified order into one | |
976 | overlay file system. The left-most path is hence the lowest | |
977 | directory tree, the second-to-last path the highest directory | |
978 | tree in the stacking order. If <option>--overlay-ro=</option> | |
b938cb90 | 979 | is used instead of <option>--overlay=</option>, a read-only |
5a8af538 | 980 | overlay file system is created. If a writable overlay file |
b938cb90 | 981 | system is created, all changes made to it are written to the |
5a8af538 LP |
982 | highest directory tree in the stacking order, i.e. the |
983 | second-to-last specified.</para> | |
984 | ||
985 | <para>If only two paths are specified, then the second | |
986 | specified path is used both as the top-level directory tree in | |
987 | the stacking order as seen from the host, as well as the mount | |
988 | point for the overlay file system in the container. At least | |
989 | two paths have to be specified.</para> | |
990 | ||
86c0dd4a | 991 | <para>The source paths may optionally be prefixed with <literal>+</literal> character. If so they are taken |
c7a4890c LP |
992 | relative to the image's root directory. The uppermost source path may also be specified as empty string, in |
993 | which case a temporary directory below the host's <filename>/var/tmp</filename> is used. The directory is | |
994 | removed automatically when the container is shut down. This behaviour is useful in order to make read-only | |
995 | container directories writable while the container is running. For example, use the | |
996 | <literal>--overlay=+/var::/var</literal> option in order to automatically overlay a writable temporary | |
997 | directory on a read-only <filename>/var</filename> directory.</para> | |
86c0dd4a | 998 | |
5a8af538 LP |
999 | <para>For details about overlay file systems, see <ulink |
1000 | url="https://www.kernel.org/doc/Documentation/filesystems/overlayfs.txt">overlayfs.txt</ulink>. Note | |
1001 | that the semantics of overlay file systems are substantially | |
1002 | different from normal file systems, in particular regarding | |
1003 | reported device and inode information. Device and inode | |
1004 | information may change for a file while it is being written | |
1005 | to, and processes might see out-of-date versions of files at | |
1006 | times. Note that this switch automatically derives the | |
1007 | <literal>workdir=</literal> mount option for the overlay file | |
1008 | system from the top-level directory tree, making it a sibling | |
1009 | of it. It is hence essential that the top-level directory tree | |
1010 | is not a mount point itself (since the working directory must | |
1011 | be on the same file system as the top-most directory | |
1012 | tree). Also note that the <literal>lowerdir=</literal> mount | |
1013 | option receives the paths to stack in the opposite order of | |
1014 | this switch.</para></listitem> | |
1015 | </varlistentry> | |
1016 | ||
798d3a52 | 1017 | <varlistentry> |
a5f1cb3b ZJS |
1018 | <term><option>-E <replaceable>NAME</replaceable>=<replaceable>VALUE</replaceable></option></term> |
1019 | <term><option>--setenv=<replaceable>NAME</replaceable>=<replaceable>VALUE</replaceable></option></term> | |
798d3a52 ZJS |
1020 | |
1021 | <listitem><para>Specifies an environment variable assignment | |
1022 | to pass to the init process in the container, in the format | |
1023 | <literal>NAME=VALUE</literal>. This may be used to override | |
1024 | the default variables or to set additional variables. This | |
1025 | parameter may be used more than once.</para></listitem> | |
1026 | </varlistentry> | |
1027 | ||
798d3a52 ZJS |
1028 | <varlistentry> |
1029 | <term><option>--register=</option></term> | |
1030 | ||
cd2dfc6f LP |
1031 | <listitem><para>Controls whether the container is registered with |
1032 | <citerefentry><refentrytitle>systemd-machined</refentrytitle><manvolnum>8</manvolnum></citerefentry>. Takes a | |
1033 | boolean argument, which defaults to <literal>yes</literal>. This option should be enabled when the container | |
1034 | runs a full Operating System (more specifically: a system and service manager as PID 1), and is useful to | |
1035 | ensure that the container is accessible via | |
1036 | <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> and shown by | |
1037 | tools such as <citerefentry | |
1038 | project='man-pages'><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry>. If the container | |
1039 | does not run a service manager, it is recommended to set this option to | |
1040 | <literal>no</literal>.</para></listitem> | |
798d3a52 ZJS |
1041 | </varlistentry> |
1042 | ||
1043 | <varlistentry> | |
1044 | <term><option>--keep-unit</option></term> | |
1045 | ||
bb849957 LP |
1046 | <listitem><para>Instead of creating a transient scope unit to run the container in, simply use the service or |
1047 | scope unit <command>systemd-nspawn</command> has been invoked in. If <option>--register=yes</option> is set | |
1048 | this unit is registered with | |
1049 | <citerefentry><refentrytitle>systemd-machined</refentrytitle><manvolnum>8</manvolnum></citerefentry>. This | |
1050 | switch should be used if <command>systemd-nspawn</command> is invoked from within a service unit, and the | |
1051 | service unit's sole purpose is to run a single <command>systemd-nspawn</command> container. This option is not | |
1052 | available if run from a user session.</para> | |
cd2dfc6f | 1053 | <para>Note that passing <option>--keep-unit</option> disables the effect of <option>--slice=</option> and |
bb849957 LP |
1054 | <option>--property=</option>. Use <option>--keep-unit</option> and <option>--register=no</option> in |
1055 | combination to disable any kind of unit allocation or registration with | |
1056 | <command>systemd-machined</command>.</para></listitem> | |
798d3a52 ZJS |
1057 | </varlistentry> |
1058 | ||
1059 | <varlistentry> | |
1060 | <term><option>--personality=</option></term> | |
1061 | ||
1062 | <listitem><para>Control the architecture ("personality") | |
1063 | reported by | |
3ba3a79d | 1064 | <citerefentry project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry> |
798d3a52 ZJS |
1065 | in the container. Currently, only <literal>x86</literal> and |
1066 | <literal>x86-64</literal> are supported. This is useful when | |
1067 | running a 32-bit container on a 64-bit host. If this setting | |
1068 | is not used, the personality reported in the container is the | |
1069 | same as the one reported on the host.</para></listitem> | |
1070 | </varlistentry> | |
1071 | ||
1072 | <varlistentry> | |
1073 | <term><option>-q</option></term> | |
1074 | <term><option>--quiet</option></term> | |
1075 | ||
1076 | <listitem><para>Turns off any status output by the tool | |
1077 | itself. When this switch is used, the only output from nspawn | |
1078 | will be the console output of the container OS | |
1079 | itself.</para></listitem> | |
1080 | </varlistentry> | |
1081 | ||
1082 | <varlistentry> | |
f757855e LP |
1083 | <term><option>--volatile</option></term> |
1084 | <term><option>--volatile=</option><replaceable>MODE</replaceable></term> | |
798d3a52 ZJS |
1085 | |
1086 | <listitem><para>Boots the container in volatile mode. When no | |
1087 | mode parameter is passed or when mode is specified as | |
b938cb90 | 1088 | <option>yes</option>, full volatile mode is enabled. This |
a8eaaee7 | 1089 | means the root directory is mounted as a mostly unpopulated |
798d3a52 | 1090 | <literal>tmpfs</literal> instance, and |
cd72d204 JE |
1091 | <filename>/usr</filename> from the OS tree is mounted into it |
1092 | in read-only mode (the system thus starts up with read-only OS | |
5164c3b4 ZJS |
1093 | image, but pristine state and configuration, any changes |
1094 | are lost on shutdown). When the mode parameter | |
b938cb90 | 1095 | is specified as <option>state</option>, the OS tree is |
798d3a52 | 1096 | mounted read-only, but <filename>/var</filename> is mounted as |
a8eaaee7 | 1097 | a <literal>tmpfs</literal> instance into it (the system thus |
798d3a52 | 1098 | starts up with read-only OS resources and configuration, but |
a8eaaee7 | 1099 | pristine state, and any changes to the latter are lost on |
798d3a52 | 1100 | shutdown). When the mode parameter is specified as |
b938cb90 | 1101 | <option>no</option> (the default), the whole OS tree is made |
798d3a52 ZJS |
1102 | available writable.</para> |
1103 | ||
91214a37 LP |
1104 | <para>This option provides similar functionality for containers as the <literal>systemd.volatile=</literal> |
1105 | kernel command line switch provides for host systems. See | |
1106 | <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry> for | |
1107 | details.</para> | |
1108 | ||
1109 | <para>Note that enabling this setting will only work correctly with operating systems in the container that can | |
1110 | boot up with only <filename>/usr</filename> mounted, and are able to automatically populate | |
1111 | <filename>/var</filename>, and also <filename>/etc</filename> in case of | |
1112 | <literal>--volatile=yes</literal>.</para></listitem> | |
798d3a52 ZJS |
1113 | </varlistentry> |
1114 | ||
f757855e LP |
1115 | <varlistentry> |
1116 | <term><option>--settings=</option><replaceable>MODE</replaceable></term> | |
1117 | ||
1118 | <listitem><para>Controls whether | |
1119 | <command>systemd-nspawn</command> shall search for and use | |
1120 | additional per-container settings from | |
1121 | <filename>.nspawn</filename> files. Takes a boolean or the | |
1122 | special values <option>override</option> or | |
1123 | <option>trusted</option>.</para> | |
1124 | ||
b938cb90 | 1125 | <para>If enabled (the default), a settings file named after the |
f757855e LP |
1126 | machine (as specified with the <option>--machine=</option> |
1127 | setting, or derived from the directory or image file name) | |
1128 | with the suffix <filename>.nspawn</filename> is searched in | |
1129 | <filename>/etc/systemd/nspawn/</filename> and | |
1130 | <filename>/run/systemd/nspawn/</filename>. If it is found | |
1131 | there, its settings are read and used. If it is not found | |
b938cb90 | 1132 | there, it is subsequently searched in the same directory as the |
f757855e | 1133 | image file or in the immediate parent of the root directory of |
b938cb90 | 1134 | the container. In this case, if the file is found, its settings |
f757855e | 1135 | will be also read and used, but potentially unsafe settings |
b938cb90 | 1136 | are ignored. Note that in both these cases, settings on the |
4f76ef04 | 1137 | command line take precedence over the corresponding settings |
f757855e LP |
1138 | from loaded <filename>.nspawn</filename> files, if both are |
1139 | specified. Unsafe settings are considered all settings that | |
1140 | elevate the container's privileges or grant access to | |
1141 | additional resources such as files or directories of the | |
1142 | host. For details about the format and contents of | |
b938cb90 | 1143 | <filename>.nspawn</filename> files, consult |
f757855e LP |
1144 | <citerefentry><refentrytitle>systemd.nspawn</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> |
1145 | ||
b938cb90 JE |
1146 | <para>If this option is set to <option>override</option>, the |
1147 | file is searched, read and used the same way, however, the order of | |
f757855e LP |
1148 | precedence is reversed: settings read from the |
1149 | <filename>.nspawn</filename> file will take precedence over | |
1150 | the corresponding command line options, if both are | |
1151 | specified.</para> | |
1152 | ||
b938cb90 | 1153 | <para>If this option is set to <option>trusted</option>, the |
f757855e | 1154 | file is searched, read and used the same way, but regardless |
a8eaaee7 | 1155 | of being found in <filename>/etc/systemd/nspawn/</filename>, |
f757855e LP |
1156 | <filename>/run/systemd/nspawn/</filename> or next to the image |
1157 | file or container root directory, all settings will take | |
b938cb90 | 1158 | effect, however, command line arguments still take precedence |
f757855e LP |
1159 | over corresponding settings.</para> |
1160 | ||
b938cb90 | 1161 | <para>If disabled, no <filename>.nspawn</filename> file is read |
f757855e LP |
1162 | and no settings except the ones on the command line are in |
1163 | effect.</para></listitem> | |
1164 | </varlistentry> | |
1165 | ||
9c1e04d0 | 1166 | <varlistentry> |
b09c0bba | 1167 | <term><option>--notify-ready=</option></term> |
9c1e04d0 AP |
1168 | |
1169 | <listitem><para>Configures support for notifications from the container's init process. | |
b09c0bba | 1170 | <option>--notify-ready=</option> takes a boolean (<option>no</option> and <option>yes</option>). |
9c1e04d0 AP |
1171 | With option <option>no</option> systemd-nspawn notifies systemd |
1172 | with a <literal>READY=1</literal> message when the init process is created. | |
1173 | With option <option>yes</option> systemd-nspawn waits for the | |
1174 | <literal>READY=1</literal> message from the init process in the container | |
1175 | before sending its own to systemd. For more details about notifications | |
1176 | see <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>).</para></listitem> | |
1177 | </varlistentry> | |
1178 | ||
798d3a52 ZJS |
1179 | <xi:include href="standard-options.xml" xpointer="help" /> |
1180 | <xi:include href="standard-options.xml" xpointer="version" /> | |
1181 | </variablelist> | |
1182 | ||
1183 | </refsect1> | |
1184 | ||
1185 | <refsect1> | |
1186 | <title>Examples</title> | |
1187 | ||
1188 | <example> | |
12c4ee0a ZJS |
1189 | <title>Download a |
1190 | <ulink url="https://getfedora.org">Fedora</ulink> image and start a shell in it</title> | |
798d3a52 | 1191 | |
3797fd0a | 1192 | <programlisting># machinectl pull-raw --verify=no \ |
7a8aa0ec ZJS |
1193 | https://download.fedoraproject.org/pub/fedora/linux/releases/&fedora_latest_version;/Cloud/x86_64/images/Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86_64.raw.xz |
1194 | # systemd-nspawn -M Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86_64.raw</programlisting> | |
e0ea94c1 | 1195 | |
798d3a52 ZJS |
1196 | <para>This downloads an image using |
1197 | <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
1198 | and opens a shell in it.</para> | |
1199 | </example> | |
e0ea94c1 | 1200 | |
798d3a52 ZJS |
1201 | <example> |
1202 | <title>Build and boot a minimal Fedora distribution in a container</title> | |
8f7a3c14 | 1203 | |
7a8aa0ec | 1204 | <programlisting># dnf -y --releasever=&fedora_latest_version; --installroot=/var/lib/machines/f&fedora_latest_version; \ |
3797fd0a ZJS |
1205 | --disablerepo='*' --enablerepo=fedora --enablerepo=updates install \ |
1206 | systemd passwd dnf fedora-release vim-minimal | |
7a8aa0ec | 1207 | # systemd-nspawn -bD /var/lib/machines/f&fedora_latest_version;</programlisting> |
8f7a3c14 | 1208 | |
798d3a52 | 1209 | <para>This installs a minimal Fedora distribution into the |
7a8aa0ec | 1210 | directory <filename noindex='true'>/var/lib/machines/f&fedora_latest_version;</filename> |
55107232 ZJS |
1211 | and then boots an OS in a namespace container in it. Because the installation |
1212 | is located underneath the standard <filename>/var/lib/machines/</filename> | |
1213 | directory, it is also possible to start the machine using | |
7a8aa0ec | 1214 | <command>systemd-nspawn -M f&fedora_latest_version;</command>.</para> |
798d3a52 | 1215 | </example> |
8f7a3c14 | 1216 | |
798d3a52 ZJS |
1217 | <example> |
1218 | <title>Spawn a shell in a container of a minimal Debian unstable distribution</title> | |
8f7a3c14 | 1219 | |
7f8b3d1d | 1220 | <programlisting># debootstrap unstable ~/debian-tree/ |
25f5971b | 1221 | # systemd-nspawn -D ~/debian-tree/</programlisting> |
8f7a3c14 | 1222 | |
798d3a52 ZJS |
1223 | <para>This installs a minimal Debian unstable distribution into |
1224 | the directory <filename>~/debian-tree/</filename> and then | |
1225 | spawns a shell in a namespace container in it.</para> | |
12c4ee0a ZJS |
1226 | |
1227 | <para><command>debootstrap</command> supports | |
1228 | <ulink url="https://www.debian.org">Debian</ulink>, | |
1229 | <ulink url="https://www.ubuntu.com">Ubuntu</ulink>, | |
1230 | and <ulink url="https://www.tanglu.org">Tanglu</ulink> | |
1231 | out of the box, so the same command can be used to install any of those. For other | |
1232 | distributions from the Debian family, a mirror has to be specified, see | |
1233 | <citerefentry project='die-net'><refentrytitle>debootstrap</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
1234 | </para> | |
798d3a52 | 1235 | </example> |
8f7a3c14 | 1236 | |
798d3a52 | 1237 | <example> |
12c4ee0a ZJS |
1238 | <title>Boot a minimal |
1239 | <ulink url="https://www.archlinux.org">Arch Linux</ulink> distribution in a container</title> | |
68562936 | 1240 | |
798d3a52 | 1241 | <programlisting># pacstrap -c -d ~/arch-tree/ base |
68562936 WG |
1242 | # systemd-nspawn -bD ~/arch-tree/</programlisting> |
1243 | ||
ff9b60f3 | 1244 | <para>This installs a minimal Arch Linux distribution into the |
798d3a52 ZJS |
1245 | directory <filename>~/arch-tree/</filename> and then boots an OS |
1246 | in a namespace container in it.</para> | |
1247 | </example> | |
68562936 | 1248 | |
f518ee04 | 1249 | <example> |
12c4ee0a ZJS |
1250 | <title>Install the |
1251 | <ulink url="https://software.opensuse.org/distributions/tumbleweed">OpenSUSE Tumbleweed</ulink> | |
1252 | rolling distribution</title> | |
f518ee04 ZJS |
1253 | |
1254 | <programlisting># zypper --root=/var/lib/machines/tumbleweed ar -c \ | |
1255 | https://download.opensuse.org/tumbleweed/repo/oss tumbleweed | |
1256 | # zypper --root=/var/lib/machines/tumbleweed refresh | |
1257 | # zypper --root=/var/lib/machines/tumbleweed install --no-recommends \ | |
1258 | systemd shadow zypper openSUSE-release vim | |
1259 | # systemd-nspawn -M tumbleweed passwd root | |
1260 | # systemd-nspawn -M tumbleweed -b</programlisting> | |
1261 | </example> | |
1262 | ||
798d3a52 | 1263 | <example> |
17cbb288 | 1264 | <title>Boot into an ephemeral snapshot of the host system</title> |
f9f4dd51 | 1265 | |
798d3a52 | 1266 | <programlisting># systemd-nspawn -D / -xb</programlisting> |
f9f4dd51 | 1267 | |
17cbb288 LP |
1268 | <para>This runs a copy of the host system in a snapshot which is removed immediately when the container |
1269 | exits. All file system changes made during runtime will be lost on shutdown, hence.</para> | |
798d3a52 | 1270 | </example> |
f9f4dd51 | 1271 | |
798d3a52 ZJS |
1272 | <example> |
1273 | <title>Run a container with SELinux sandbox security contexts</title> | |
a8828ed9 | 1274 | |
798d3a52 | 1275 | <programlisting># chcon system_u:object_r:svirt_sandbox_file_t:s0:c0,c1 -R /srv/container |
3797fd0a ZJS |
1276 | # systemd-nspawn -L system_u:object_r:svirt_sandbox_file_t:s0:c0,c1 \ |
1277 | -Z system_u:system_r:svirt_lxc_net_t:s0:c0,c1 -D /srv/container /bin/sh</programlisting> | |
798d3a52 | 1278 | </example> |
b53ede69 PW |
1279 | |
1280 | <example> | |
1281 | <title>Run a container with an OSTree deployment</title> | |
1282 | ||
3797fd0a ZJS |
1283 | <programlisting># systemd-nspawn -b -i ~/image.raw \ |
1284 | --pivot-root=/ostree/deploy/$OS/deploy/$CHECKSUM:/sysroot \ | |
1285 | --bind=+/sysroot/ostree/deploy/$OS/var:/var</programlisting> | |
b53ede69 | 1286 | </example> |
798d3a52 ZJS |
1287 | </refsect1> |
1288 | ||
1289 | <refsect1> | |
1290 | <title>Exit status</title> | |
1291 | ||
1292 | <para>The exit code of the program executed in the container is | |
1293 | returned.</para> | |
1294 | </refsect1> | |
1295 | ||
1296 | <refsect1> | |
1297 | <title>See Also</title> | |
1298 | <para> | |
1299 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
f757855e | 1300 | <citerefentry><refentrytitle>systemd.nspawn</refentrytitle><manvolnum>5</manvolnum></citerefentry>, |
798d3a52 ZJS |
1301 | <citerefentry project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
1302 | <citerefentry project='mankier'><refentrytitle>dnf</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
798d3a52 ZJS |
1303 | <citerefentry project='die-net'><refentrytitle>debootstrap</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
1304 | <citerefentry project='archlinux'><refentrytitle>pacman</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
f518ee04 | 1305 | <citerefentry project='mankier'><refentrytitle>zypper</refentrytitle><manvolnum>8</manvolnum></citerefentry>, |
798d3a52 ZJS |
1306 | <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>, |
1307 | <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
3ba3a79d | 1308 | <citerefentry project='man-pages'><refentrytitle>btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry> |
798d3a52 ZJS |
1309 | </para> |
1310 | </refsect1> | |
8f7a3c14 LP |
1311 | |
1312 | </refentry> |