2011-03-15 22:51:41 +03:00
<?xml version='1.0'?> <!-- * - nxml - * -->
< !DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!--
This file is part of systemd.
Copyright 2010 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
2012-04-12 02:20:58 +04:00
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
2011-03-15 22:51:41 +03:00
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2012-04-12 02:20:58 +04:00
Lesser General Public License for more details.
2011-03-15 22:51:41 +03:00
2012-04-12 02:20:58 +04:00
You should have received a copy of the GNU Lesser General Public License
2011-03-15 22:51:41 +03:00
along with systemd; If not, see <http: / / w w w . g n u . o r g / l i c e n s e s /> .
-->
<refentry id= "systemd-nspawn" >
<refentryinfo >
<title > systemd-nspawn</title>
<productname > systemd</productname>
<authorgroup >
<author >
<contrib > Developer</contrib>
<firstname > Lennart</firstname>
<surname > Poettering</surname>
<email > lennart@poettering.net</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta >
<refentrytitle > systemd-nspawn</refentrytitle>
<manvolnum > 1</manvolnum>
</refmeta>
<refnamediv >
<refname > systemd-nspawn</refname>
<refpurpose > Spawn a namespace container for debugging, testing and building</refpurpose>
</refnamediv>
<refsynopsisdiv >
<cmdsynopsis >
2013-01-13 01:55:04 +04:00
<command > systemd-nspawn</command>
<arg choice= "opt" rep= "repeat" > OPTIONS</arg>
2013-02-28 07:25:40 +04:00
<arg choice= "opt" > <replaceable > COMMAND</replaceable>
<arg choice= "opt" rep= "repeat" > ARGS</arg>
</arg>
</cmdsynopsis>
<cmdsynopsis >
<command > systemd-nspawn</command>
<arg choice= "plain" > -b</arg>
<arg choice= "opt" rep= "repeat" > OPTIONS</arg>
2013-01-13 01:55:04 +04:00
<arg choice= "opt" rep= "repeat" > ARGS</arg>
2011-03-15 22:51:41 +03:00
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
<para > <command > systemd-nspawn</command> may be used to
run a command or OS in a light-weight namespace
container. In many ways it is similar to
<citerefentry > <refentrytitle > chroot</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
but more powerful since it fully virtualizes the file
2011-06-18 17:40:20 +04:00
system hierarchy, as well as the process tree, the
2011-03-15 22:51:41 +03:00
various IPC subsystems and the host and domain
name.</para>
<para > <command > systemd-nspawn</command> limits access
to various kernel interfaces in the container to
read-only, such as <filename > /sys</filename> ,
<filename > /proc/sys</filename> or
2011-08-02 06:55:10 +04:00
<filename > /sys/fs/selinux</filename> . Network
interfaces and the system clock may not be changed
from within the container. Device nodes may not be
created. The host system cannot be rebooted and kernel
modules may not be loaded from within the
container.</para>
2011-03-15 22:51:41 +03:00
<para > Note that even though these security precautions
are taken <command > systemd-nspawn</command> is not
suitable for secure container setups. Many of the
security features may be circumvented and are hence
primarily useful to avoid accidental changes to the
host system from the container. The intended use of
this program is debugging and testing as well as
building of packages, distributions and software
involved with boot and systems management.</para>
<para > In contrast to
<citerefentry > <refentrytitle > chroot</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry>
<command > systemd-nspawn</command> may be used to boot
full Linux-based operating systems in a
container.</para>
<para > Use a tool like
2013-01-29 04:44:33 +04:00
<citerefentry > <refentrytitle > yum</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> ,
2012-04-24 15:14:27 +04:00
<citerefentry > <refentrytitle > debootstrap</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry>
2013-01-29 04:44:33 +04:00
or
<citerefentry > <refentrytitle > pacman</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry>
2011-03-15 22:51:41 +03:00
to set up an OS directory tree suitable as file system
2012-04-24 15:14:27 +04:00
hierarchy for <command > systemd-nspawn</command>
containers.</para>
2011-03-15 22:51:41 +03:00
<para > Note that <command > systemd-nspawn</command> will
mount file systems private to the container to
<filename > /dev</filename> ,
2011-03-25 07:07:20 +03:00
<filename > /run</filename> and similar. These will
2011-03-15 22:51:41 +03:00
not be visible outside of the container, and their
contents will be lost when the container exits.</para>
<para > Note that running two
<command > systemd-nspawn</command> containers from the
same directory tree will not make processes in them
2011-06-18 17:40:20 +04:00
see each other. The PID namespace separation of the
2011-03-15 22:51:41 +03:00
two containers is complete and the containers will
share very few runtime objects except for the
2013-01-13 01:55:04 +04:00
underlying file system. It is however possible to
enter an existing container, see
<link linkend= 'example-nsenter' > Example 4</link> below.
</para>
2012-06-28 20:58:56 +04:00
<para > <command > systemd-nspawn</command> implements the
<ulink
url="http://www.freedesktop.org/wiki/Software/systemd/ContainerInterface">Container
Interface</ulink> specification.</para>
2013-05-06 23:04:31 +04:00
<para > As a safety check
<command > systemd-nspawn</command> will verify the
2013-06-22 02:55:18 +04:00
existence of <filename > /etc/os-release</filename> in
2013-05-06 23:04:31 +04:00
the container tree before starting the container (see
<citerefentry > <refentrytitle > os-release</refentrytitle> <manvolnum > 5</manvolnum> </citerefentry> ). It
might be necessary to add this file to the container
tree manually if the OS of the container is too old to
contain this file out-of-the-box.</para>
2013-05-10 02:14:12 +04:00
</refsect1>
<refsect1 >
<title > Incompatibility with Auditing</title>
2013-05-09 17:32:27 +04:00
<para > Note that the kernel auditing subsystem is
currently broken when used together with
containers. We hence recommend turning it off entirely
2013-05-10 02:14:12 +04:00
by booting with <literal > audit=0</literal> on the
kernel command line, or by turning it off at kernel
build time. If auditing is enabled in the kernel
operating systems booted in an nspawn container might
refuse log-in attempts.</para>
2011-03-15 22:51:41 +03:00
</refsect1>
<refsect1 >
<title > Options</title>
2013-02-28 07:25:40 +04:00
<para > If option <option > -b</option> is specified, the
arguments are used as arguments for the init
binary. Otherwise, <replaceable > COMMAND</replaceable>
specifies the program to launch in the container, and
the remaining arguments are used as arguments for this
program. If <option > -b</option> is not used and no
arguments are specifed, a shell is launched in the
container.</para>
<para > The following options are understood:</para>
2011-03-15 22:51:41 +03:00
<variablelist >
<varlistentry >
2011-08-02 06:49:37 +04:00
<term > <option > -h</option> </term>
2013-02-13 13:39:22 +04:00
<term > <option > --help</option> </term>
2011-03-15 22:51:41 +03:00
<listitem > <para > Prints a short help
text and exits.</para> </listitem>
</varlistentry>
2013-01-12 01:03:49 +04:00
<varlistentry >
<term > <option > --version</option> </term>
<listitem > <para > Prints a version string
and exits.</para> </listitem>
</varlistentry>
2011-03-15 22:51:41 +03:00
<varlistentry >
2011-08-20 02:20:41 +04:00
<term > <option > -D</option> </term>
2013-02-13 13:39:22 +04:00
<term > <option > --directory=</option> </term>
2011-03-15 22:51:41 +03:00
<listitem > <para > Directory to use as
file system root for the namespace
container. If omitted the current
directory will be
used.</para> </listitem>
</varlistentry>
2012-04-22 15:37:24 +04:00
<varlistentry >
<term > <option > -b</option> </term>
2013-02-13 13:39:22 +04:00
<term > <option > --boot</option> </term>
2012-04-22 15:37:24 +04:00
<listitem > <para > Automatically search
for an init binary and invoke it
instead of a shell or a user supplied
2013-02-28 07:25:40 +04:00
program. If this option is used, arguments
specified on the command line are used
as arguments for the init binary.
</para> </listitem>
2012-04-22 15:37:24 +04:00
</varlistentry>
2011-06-29 16:22:46 +04:00
<varlistentry >
2011-08-02 06:55:10 +04:00
<term > <option > -u</option> </term>
2013-02-13 13:39:22 +04:00
<term > <option > --user=</option> </term>
2011-06-29 16:22:46 +04:00
<listitem > <para > Run the command
under specified user, create home
directory and cd into it. As rest
of systemd-nspawn, this is not
the security feature and limits
against accidental changes only.
</para> </listitem>
</varlistentry>
2013-04-16 06:36:06 +04:00
<varlistentry >
<term > <option > -M</option> </term>
<term > <option > --machine=</option> </term>
<listitem > <para > Sets the machine name
for this container. This name may be
used to identify this container on the
host, and is used to initialize the
container's hostname (which the
container can choose to override,
however). If not specified the last
component of the root directory of the
container is used.</para> </listitem>
</varlistentry>
2012-04-22 16:48:21 +04:00
<varlistentry >
<term > <option > --uuid=</option> </term>
2013-06-27 23:51:44 +04:00
<listitem > <para > Set the specified UUID
2012-04-22 16:48:21 +04:00
for the container. The init system
will initialize
<filename > /etc/machine-id</filename>
from this if this file is not set yet.
</para> </listitem>
</varlistentry>
2012-04-11 15:27:19 +04:00
<varlistentry >
<term > <option > -C</option> </term>
2013-02-13 13:39:22 +04:00
<term > <option > --controllers=</option> </term>
2012-04-11 15:27:19 +04:00
<listitem > <para > Makes the container appear in
2012-09-14 19:19:23 +04:00
other hierarchies than the name=systemd:/ one.
2012-04-11 15:27:19 +04:00
Takes a comma-separated list of controllers.
</para> </listitem>
</varlistentry>
2011-08-02 06:49:37 +04:00
<varlistentry >
2011-08-02 07:24:58 +04:00
<term > <option > --private-network</option> </term>
2011-08-02 06:49:37 +04:00
<listitem > <para > Turn off networking in
the container. This makes all network
interfaces unavailable in the
container, with the exception of the
loopback device.</para> </listitem>
</varlistentry>
2012-04-25 17:11:20 +04:00
<varlistentry >
<term > <option > --read-only</option> </term>
<listitem > <para > Mount the root file
2013-06-27 23:51:44 +04:00
system read-only for the
2012-04-25 17:11:20 +04:00
container.</para> </listitem>
</varlistentry>
2012-06-28 15:44:39 +04:00
<varlistentry >
<term > <option > --capability=</option> </term>
<listitem > <para > List one or more
additional capabilities to grant the
2013-06-27 23:51:44 +04:00
container. Takes a comma-separated
2012-06-28 15:44:39 +04:00
list of capability names, see
<citerefentry > <refentrytitle > capabilities</refentrytitle> <manvolnum > 7</manvolnum> </citerefentry>
for more information. Note that the
2013-01-18 21:13:01 +04:00
following capabilities will be granted
in any way: CAP_CHOWN,
2012-06-28 15:44:39 +04:00
CAP_DAC_OVERRIDE, CAP_DAC_READ_SEARCH,
CAP_FOWNER, CAP_FSETID, CAP_IPC_OWNER,
CAP_KILL, CAP_LEASE,
CAP_LINUX_IMMUTABLE,
CAP_NET_BIND_SERVICE,
CAP_NET_BROADCAST, CAP_NET_RAW,
CAP_SETGID, CAP_SETFCAP, CAP_SETPCAP,
CAP_SETUID, CAP_SYS_ADMIN,
CAP_SYS_CHROOT, CAP_SYS_NICE,
CAP_SYS_PTRACE, CAP_SYS_TTY_CONFIG,
2013-01-18 21:13:01 +04:00
CAP_SYS_RESOURCE, CAP_SYS_BOOT,
CAP_AUDIT_WRITE,
CAP_AUDIT_CONTROL.</para> </listitem>
2012-06-28 15:44:39 +04:00
</varlistentry>
2012-07-19 04:02:39 +04:00
<varlistentry >
<term > <option > --link-journal=</option> </term>
<listitem > <para > Control whether the
container's journal shall be made
visible to the host system. If enabled
allows viewing the container's journal
files from the host (but not vice
versa). Takes one of
<literal > no</literal> ,
<literal > host</literal> ,
<literal > guest</literal> ,
<literal > auto</literal> . If
2012-10-02 12:58:31 +04:00
<literal > no</literal> , the journal is
not linked. If <literal > host</literal> ,
2012-07-19 04:02:39 +04:00
the journal files are stored on the
2012-10-02 12:58:31 +04:00
host file system (beneath
2013-02-14 07:46:37 +04:00
<filename > /var/log/journal/<replaceable > machine-id</replaceable> </filename> )
2012-10-02 12:58:31 +04:00
and the subdirectory is bind-mounted
2012-07-19 04:02:39 +04:00
into the container at the same
2012-10-02 12:58:31 +04:00
location. If <literal > guest</literal> ,
2012-07-19 04:02:39 +04:00
the journal files are stored on the
2012-10-02 12:58:31 +04:00
guest file system (beneath
2013-02-14 07:46:37 +04:00
<filename > /var/log/journal/<replaceable > machine-id</replaceable> </filename> )
2012-10-02 12:58:31 +04:00
and the subdirectory is symlinked into the host
2012-07-19 04:02:39 +04:00
at the same location. If
2012-10-02 12:58:31 +04:00
<literal > auto</literal> (the default),
and the right subdirectory of
2012-07-19 04:02:39 +04:00
<filename > /var/log/journal</filename>
2012-10-02 12:58:31 +04:00
exists, it will be bind mounted
into the container. If the
subdirectory doesn't exist, no
linking is performed. Effectively,
booting a container once with
2012-07-19 04:02:39 +04:00
<literal > guest</literal> or
<literal > host</literal> will link the
2012-10-02 12:58:31 +04:00
journal persistently if further on
2012-07-19 04:02:39 +04:00
the default of <literal > auto</literal>
is used.</para> </listitem>
</varlistentry>
<varlistentry >
<term > <option > -j</option> </term>
<listitem > <para > Equivalent to
<option > --link-journal=guest</option> .</para> </listitem>
</varlistentry>
2013-02-25 21:21:13 +04:00
<varlistentry >
<term > <option > --bind=</option> </term>
<term > <option > --bind-ro=</option> </term>
<listitem > <para > Bind mount a file or
directory from the host into the
container. Either takes a path
argument -- in which case the
specified path will be mounted from
the host to the same path in the
container --, or a colon-separated
pair of paths -- in which case the
first specified path is the source in
the host, and the second path is the
destination in the container. The
<option > --bind-ro=</option> option
creates read-only bind
mount.</para> </listitem>
</varlistentry>
2011-03-15 22:51:41 +03:00
</variablelist>
</refsect1>
<refsect1 >
<title > Example 1</title>
2013-01-18 21:22:55 +04:00
<programlisting > # yum -y --releasever=19 --nogpg --installroot=/srv/mycontainer --disablerepo='*' --enablerepo=fedora install systemd passwd yum fedora-release vim-minimal
# systemd-nspawn -bD /srv/mycontainer</programlisting>
2011-03-15 22:51:41 +03:00
2012-04-24 15:14:27 +04:00
<para > This installs a minimal Fedora distribution into
2013-05-03 08:55:20 +04:00
the directory <filename noindex= 'true' > /srv/mycontainer/</filename> and
2013-01-18 21:22:55 +04:00
then boots an OS in a namespace container in
it.</para>
2011-03-15 22:51:41 +03:00
</refsect1>
<refsect1 >
<title > Example 2</title>
2012-04-24 15:14:27 +04:00
<programlisting > # debootstrap --arch=amd64 unstable ~/debian-tree/
# systemd-nspawn -D ~/debian-tree/</programlisting>
2011-03-15 22:51:41 +03:00
2012-04-24 15:14:27 +04:00
<para > This installs a minimal Debian unstable
distribution into the directory
<filename > ~/debian-tree/</filename> and then spawns a
shell in a namespace container in it.</para>
2011-03-15 22:51:41 +03:00
</refsect1>
2013-01-26 21:15:32 +04:00
<refsect1 >
<title > Example 3</title>
<programlisting > # pacstrap -c -d ~/arch-tree/ base
# systemd-nspawn -bD ~/arch-tree/</programlisting>
<para > This installs a mimimal Arch Linux distribution into
the directory <filename > ~/arch-tree/</filename> and then
boots an OS in a namespace container in it.</para>
</refsect1>
2013-01-13 01:55:04 +04:00
<refsect1 id= 'example-nsenter' >
<title > Example 4</title>
<para > To enter the container, PID of one of the
processes sharing the new namespaces must be used.
<command > systemd-nspawn</command> prints the PID
(as viewed from the outside) of the launched process,
and it can be used to enter the container.</para>
2013-04-16 07:54:56 +04:00
<programlisting > # nsenter -m -u -i -n -p -t $PID</programlisting>
2013-01-13 01:55:04 +04:00
<para > <citerefentry > <refentrytitle > nsenter</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry>
is part of
<ulink url= "https://github.com/karelzak/util-linux" > util-linux</ulink> .
Kernel support for entering namespaces was added in
Linux 3.8.</para>
</refsect1>
2011-03-15 22:51:41 +03:00
<refsect1 >
<title > Exit status</title>
<para > The exit code of the program executed in the
container is returned.</para>
</refsect1>
<refsect1 >
<title > See Also</title>
<para >
<citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > chroot</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
2013-01-13 01:55:04 +04:00
<citerefentry > <refentrytitle > unshare</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
2012-04-24 15:14:27 +04:00
<citerefentry > <refentrytitle > yum</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> ,
2013-01-29 04:44:33 +04:00
<citerefentry > <refentrytitle > debootstrap</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry> ,
2013-01-26 21:15:32 +04:00
<citerefentry > <refentrytitle > pacman</refentrytitle> <manvolnum > 8</manvolnum> </citerefentry>
2011-03-15 22:51:41 +03:00
</para>
</refsect1>
</refentry>