X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd-nspawn.xml;h=bec233c1ca9eb9c056df7dc72a385483b3de8a16;hp=03c39fc3def88631ff30b51abe06ac1d4293e554;hb=f4889f656b477887b02caa5e9d27387309c75a87;hpb=687d0825a4636b1841dc0c01fbcbf3160dddab74 diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index 03c39fc3d..bec233c1c 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -8,16 +8,16 @@ Copyright 2010 Lennart Poettering systemd is free software; you can redistribute it and/or modify it - under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or + 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 (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 - General Public License for more details. + Lesser General Public License for more details. - You should have received a copy of the GNU General Public License + You should have received a copy of the GNU Lesser General Public License along with systemd; If not, see . --> @@ -49,7 +49,17 @@ - systemd-nspawn OPTIONS COMMAND ARGS + systemd-nspawn + OPTIONS + COMMAND + ARGS + + + + systemd-nspawn + -b + OPTIONS + ARGS @@ -69,11 +79,12 @@ to various kernel interfaces in the container to read-only, such as /sys, /proc/sys or - /selinux. 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. + /sys/fs/selinux. 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. Note that even though these security precautions are taken systemd-nspawn is not @@ -86,15 +97,18 @@ involved with boot and systems management. In contrast to - chroot1 - systemd-nspawn may be used to boot - full Linux-based operating systems in a - container. + chroot1 systemd-nspawn + may be used to boot full Linux-based operating systems + in a container. Use a tool like - debootstrap8 or mock1 + yum8, + debootstrap8, + or + pacman8 to set up an OS directory tree suitable as file system - hierarchy for systemd-nspawn containers. + hierarchy for systemd-nspawn + containers. Note that systemd-nspawn will mount file systems private to the container to @@ -109,19 +123,56 @@ see each other. The PID namespace separation of the two containers is complete and the containers will share very few runtime objects except for the - underlying file system. + underlying file system. Use + machinectl1's + login command to request an + additional login prompt in a running container. + + systemd-nspawn implements the + Container + Interface specification. + + As a safety check + systemd-nspawn will verify the + existence of /etc/os-release in + the container tree before starting the container (see + os-release5). 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. + + + + Incompatibility with Auditing + + Note that the kernel auditing subsystem is + currently broken when used together with + containers. We hence recommend turning it off entirely + by booting with audit=0 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. Options - If no arguments are passed the container is set - up and a shell started in it, otherwise the passed - command and arguments are executed in it. The - following options are understood: + If option is specified, the + arguments are used as arguments for the init + binary. Otherwise, COMMAND + specifies the program to launch in the container, and + the remaining arguments are used as arguments for this + program. If is not used and no + arguments are specifed, a shell is launched in the + container. + + The following options are understood: + Prints a short help @@ -129,19 +180,39 @@ + + + Prints a version string + and exits. + + + + - Directory to use as file system root for the namespace - container. If omitted the current + container. If omitted, the current directory will be used. + + + + Automatically search + for an init binary and invoke it + instead of a shell or a user supplied + program. If this option is used, arguments + specified on the command line are used + as arguments for the init binary. + + + + + - Run the command under specified user, create home @@ -152,6 +223,178 @@ + + + + + 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. + + + + + + Make the container + part of the specified slice, instead + of the + machine.slice. + + + + + + + Set the specified UUID + for the container. The init system + will initialize + /etc/machine-id + from this if this file is not set yet. + + + + + + + Turn off networking in + the container. This makes all network + interfaces unavailable in the + container, with the exception of the + loopback device. + + + + + + Mount the root file + system read-only for the + container. + + + + + + List one or more + additional capabilities to grant the + container. Takes a comma-separated + list of capability names, see + capabilities7 + for more information. Note that the + following capabilities will be granted + in any way: CAP_CHOWN, + 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, + CAP_SYS_RESOURCE, CAP_SYS_BOOT, + CAP_AUDIT_WRITE, + CAP_AUDIT_CONTROL. + + + + + + Specify one or more + additional capabilities to drop for + the container. This allows running the + container with fewer capabilities than + the default (see above). + + + + + + 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 + no, + host, + guest, + auto. If + no, the journal is + not linked. If host, + the journal files are stored on the + host file system (beneath + /var/log/journal/machine-id) + and the subdirectory is bind-mounted + into the container at the same + location. If guest, + the journal files are stored on the + guest file system (beneath + /var/log/journal/machine-id) + and the subdirectory is symlinked into the host + at the same location. If + auto (the default), + and the right subdirectory of + /var/log/journal + exists, it will be bind mounted + into the container. If the + subdirectory does not exist, no + linking is performed. Effectively, + booting a container once with + guest or + host will link the + journal persistently if further on + the default of auto + is used. + + + + + + Equivalent to + . + + + + + + + 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 + creates read-only bind + mount. + + + + + + Specifies an + environment variable assignment to + pass to the init process in the + container, in the format + NAME=VALUE. This + may be used to override the default + variables or to set additional + variables. This parameter may be used + more than once. + + @@ -159,30 +402,61 @@ Example 1 - # debootstrap --arch=amd64 unstable debian-tree/ -# systemd-nspawn -D debian-tree/ + # yum -y --releasever=19 --nogpg --installroot=/srv/mycontainer --disablerepo='*' --enablerepo=fedora install systemd passwd yum fedora-release vim-minimal +# systemd-nspawn -bD /srv/mycontainer + + This installs a minimal Fedora distribution into + the directory /srv/mycontainer/ and + then boots an OS in a namespace container in + it. + + + + Example 2 + + # debootstrap --arch=amd64 unstable ~/debian-tree/ +# systemd-nspawn -D ~/debian-tree/ This installs a minimal Debian unstable distribution into the directory - debian-tree/ and then spawns a + ~/debian-tree/ and then spawns a shell in a namespace container in it. + + + + Example 3 + # pacstrap -c -d ~/arch-tree/ base +# systemd-nspawn -bD ~/arch-tree/ + + This installs a mimimal Arch Linux distribution into + the directory ~/arch-tree/ and then + boots an OS in a namespace container in it. - Example 2 + Example 4 - # mock --init -# systemd-nspawn -D /var/lib/mock/fedora-rawhide-x86_64/root/ /bin/systemd systemd.log_level=debug + # mv ~/arch-tree /var/lib/container/arch +# systemctl enable systemd-nspawn@arch.service +# systemctl start systemd-nspawn@arch.service - This installs a minimal Fedora distribution into - a subdirectory of /var/lib/mock/ - and then boots an OS in a namespace container in it, - with systemd as init system, configured for debug - logging. + This makes the Arch Linux container part of the + multi-user.target on the host. + + + + Example 5 + + # btrfs subvolume snapshot / /.tmp +# systemd-nspawn --private-network -D /.tmp -b + + This runs a copy of the host system in a + btrfs snapshot. + Exit status @@ -195,8 +469,11 @@ systemd1, chroot1, - debootstrap8 - mock1 + yum8, + debootstrap8, + pacman8, + systemd.slice5, + machinectl1