X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd-nspawn.xml;h=0c6fb002891d63e2cdbaed074d46915deff07e0f;hp=aea50559f04f643e87ad6173390bc749f3a75663;hb=c4a5ddc9f29cf910fac9d814cd898b4cc2bd79b1;hpb=5aded369782f28255bc6b494ca905d7acaea7a56 diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index aea50559f..0c6fb0028 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -106,7 +106,7 @@ yum8, debootstrap8, or - pacman8 + pacman8 to set up an OS directory tree suitable as file system hierarchy for systemd-nspawn containers. @@ -165,14 +165,80 @@ Directory to use as - file system root for the container. If - neither - nor are + file system root for the container. + + If neither + , nor + is specified + the directory is determined as + /var/lib/machines/ + suffixed by the machine name as + specified with + . If + neither , + , nor + are specified, the current directory will - be used. May not be specified together with + be used. May not be specified together + with . + + + + Directory or + btrfs subvolume to + use as template for the container's + root directory. If this is specified + and the container's root directory (as + configured by + ) does + not yet exist it is created as + btrfs subvolume and + populated from this template + tree. Ideally, the specified template + path refers to the root of a + btrfs subvolume, in + which case a simple copy-on-write + snapshot is taken, and populating the + root directory is instant. If the + specified template path does not refer + to the root of a + btrfs subvolume (or + not even to a btrfs + file system at all), the tree is + copied, which can be substantially + more time-consuming. Note that if this + option is used the container's root + directory (in contrast to the template + directory!) must be located on a + btrfs file system, + so that the btrfs + subvolume may be created. May not be + specified together with + or + . + + + + + + + If specified, the + container is run with a temporary + btrfs snapshot of + its root directory (as configured with + ), that + is removed immediately when the + container terminates. This option is + only supported if the root file system + is btrfs. May not + be specified together with + or + . + + @@ -181,10 +247,13 @@ the root directory for the container from. Takes a path to a regular file or to a block device node. The file or - block device must contain a GUID - Partition Table with a root partition - which is mounted as the root directory - of the container. Optionally, it may + block device must contain either an + MBR partition table with a single + partition of type 0x83 that is marked + bootable, or a GUID partition table + with a root partition which is mounted + as the root directory of the + container. Optionally, GPT images may contain a home and/or a server data partition which are mounted to the appropriate places in the @@ -197,7 +266,9 @@ partitions, swap partitions or EFI system partitions are not mounted. May not be specified together with - . + , + or + . @@ -237,13 +308,22 @@ 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. + used to identify this container during + its runtime (for example in tools like + machinectl1 + and similar), 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 path of the container is + used, possibly suffixed with a random + identifier in case + mode is + selected. If the root directory + selected is the host's root directory + the host's hostname is used as default + instead. @@ -330,6 +410,7 @@ + Create a virtual @@ -365,6 +446,32 @@ of ve-. + + + + + If private networking + is enabled, maps an IP port on the + host onto an IP port on the + container. Takes a protocol specifier + (either tcp or + udp), separated by + a colon from a host port number in the + range 1 to 65535, separated by a colon + from a container port number in the + range from 1 to 65535. The protocol + specifier and its separating colon may + be omitted, in which case + tcp is assumed. + The container port number and its + colon may be ommitted, in which case + the same port as the host port is + implied. This option is only supported + if private networking is used, such as + or + . + + @@ -439,7 +546,9 @@ versa). Takes one of no, host, + try-host, guest, + try-guest, auto. If no, the journal is not linked. If host, @@ -453,8 +562,11 @@ 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), + at the same location. try-host + and try-guest do the same + but do not fail if the host does not have + persistent journalling enabled. + If auto (the default), and the right subdirectory of /var/log/journal exists, it will be bind mounted @@ -473,7 +585,7 @@ Equivalent to - . + . @@ -648,13 +760,13 @@ =MODE Boots the container in - volatile (ephemeral) mode. When no - mode parameter is passed or when mode - is specified as yes - full volatile mode is enabled. This - means the root directory is mounted as - mostly unpopulated - tmpfs instance, and + volatile mode. When no mode parameter + is passed or when mode is specified as + yes full volatile + mode is enabled. This means the root + directory is mounted as mostly + unpopulated tmpfs + instance, and /usr from the OS tree is mounted into it, read-only (the system thus starts up with @@ -668,12 +780,12 @@ as tmpfs instance into it (the system thus starts up with read-only OS resources and - configuration, but prestine state, any + configuration, but pristine state, any changes to the latter are lost on shutdown). When the mode parameter is specified as no - (the default) the whole OS tree is made - available writable. + (the default) the whole OS tree is + made available writable. Note that setting this to yes or @@ -694,69 +806,73 @@ - Example 1 + Examples + + Boot a minimal Fedora distribution in a container - # yum -y --releasever=19 --nogpg --installroot=/srv/mycontainer --disablerepo='*' --enablerepo=fedora install systemd passwd yum fedora-release vim-minimal + # yum -y --releasever=21 --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. - + This installs a minimal Fedora distribution into + the directory /srv/mycontainer/ and + then boots an OS in a namespace container in + it. + - - Example 2 + + Spawn a shell in a container of a minimal Debian unstable distribution - # debootstrap --arch=amd64 unstable ~/debian-tree/ + # 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 - shell in a namespace container in it. - + This installs a minimal Debian unstable + distribution into the directory + ~/debian-tree/ and then spawns a + shell in a namespace container in it. + - - Example 3 + + Boot a minimal Arch Linux distribution in a container - # pacstrap -c -d ~/arch-tree/ base + # 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. - + This installs a mimimal Arch Linux distribution into + the directory ~/arch-tree/ and then + boots an OS in a namespace container in it. + - - Example 4 + + Enable Arch Linux container on boot - # mv ~/arch-tree /var/lib/container/arch + # mv ~/arch-tree /var/lib/machines/arch # systemctl enable systemd-nspawn@arch.service # systemctl start systemd-nspawn@arch.service - This makes the Arch Linux container part of the - multi-user.target on the host. - - + This makes the Arch Linux container part of the + multi-user.target on the host. + + - - Example 5 + + Boot into an ephemeral <literal>btrfs</literal> snapshot of the host system - # btrfs subvolume snapshot / /.tmp -# systemd-nspawn --private-network -D /.tmp -b + # systemd-nspawn -D / -xb - This runs a copy of the host system in a - btrfs snapshot. - + This runs a copy of the host system in a + btrfs snapshot which is + removed immediately when the container + exits. All file system changes made during + runtime will be lost on shutdown, + hence. + - - Example 6 + + Run a container with SELinux sandbox security contexts - # chcon system_u:object_r:svirt_sandbox_file_t:s0:c0,c1 -R /srv/container + # chcon system_u:object_r:svirt_sandbox_file_t:s0:c0,c1 -R /srv/container # systemd-nspawn -L system_u:object_r:svirt_sandbox_file_t:s0:c0,c1 -Z system_u:system_r:svirt_lxc_net_t:s0:c0,c1 -D /srv/container /bin/sh - - This runs a container with SELinux sandbox security contexts. + @@ -773,9 +889,10 @@ chroot1, yum8, debootstrap8, - pacman8, + pacman8, systemd.slice5, - machinectl1 + machinectl1, + btrfs8