X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fmachinectl.xml;h=f6729151ba9ab854bd7472b048f0f336f72e7609;hb=f407824d751a9cb31abfdf0343fe179e0efef259;hp=b50f03f36fdd998a960b120b4bb1c2215ccb3e28;hpb=d6ce17c7f02ed3facdb45f65f546e587c2f00950;p=elogind.git
diff --git a/man/machinectl.xml b/man/machinectl.xml
index b50f03f36..f6729151b 100644
--- a/man/machinectl.xml
+++ b/man/machinectl.xml
@@ -214,6 +214,18 @@
URL.
+
+
+
+ When used with the
+ or commands specifies the
+ compression format to use for the resulting file. Takes one of
+ uncompressed, xz,
+ gzip, bzip2. By default
+ the format is determined automatically from the image file
+ name passed.
+
+
@@ -508,16 +520,32 @@
set-limit [NAME] BYTESSets the maximum size in bytes a specific
- container or VM image, or all images may grow up to
- (quota). Takes either one or two parameters. The first,
+ container or VM image, or all images may grow up to on disk
+ (disk quota). Takes either one or two parameters. The first,
optional parameter refers to a container or VM image name. If
- specified the size limit of the specified images is
- changed. If omitted the overall size limit of the sum of all
- images stored locally is changed. The final argument specifies
- the size limit in bytes, possibly suffixed by the usual K, M,
- G, T units. If the size limit shall be disabled, specify
- - as size. This operation is currently only
- supported on btrfs subvolume images.
+ specified the size limit of the specified image is changed. If
+ omitted the overall size limit of the sum of all images stored
+ locally is changed. The final argument specifies the size
+ limit in bytes, possibly suffixed by the usual K, M, G, T
+ units. If the size limit shall be disabled, specify
+ - as size.
+
+ Note that per-container size limits are only supported
+ on btrfs file systems. Also note that if
+ set-limit is invoked without image
+ parameter, and /var/lib/machines is
+ empty, and the directory is not located on btrfs, a btrfs
+ loopback file is implicitly created as
+ /var/lib/machines.raw with the given
+ size, and mounted to
+ /var/lib/machines. The size of the
+ loopback may later be readjusted with
+ set-limit, as well. If such a
+ loopback-mounted /var/lib/machines
+ directory is used set-limit without image
+ name alters both the quota setting within the file system as
+ well as the loopback file and file system size
+ itself.
@@ -653,19 +681,78 @@
below.
+
+ import-tarFILE [NAME]
+ import-rawFILE [NAME]
+ Imports a TAR or RAW container or VM image,
+ and places it under the specified name in
+ /var/lib/machines/. When
+ import-tar is used the file specified as
+ first argument should be a tar archive, possibly compressed
+ with xz, gzip or bzip2. It will then be unpacked into its own
+ subvolume in /var/lib/machines. When
+ import-raw is used the file should be a
+ qcow2 or raw disk image, possibly compressed with xz, gzip or
+ bzip2. If the second argument (the resulting image name) is
+ not specified it is automatically derived from the file
+ name. If the file name is passed as - the
+ image is read from standard input, in which case the second
+ argument is mandatory.
+
+ Similar as with pull-tar,
+ pull-raw the file system
+ /var/lib/machines.raw is increased in
+ size of necessary and appropriate. Optionally the
+ switch may be used to create a
+ read-only container or VM image. No cryptographic validation
+ is done when importing the images.
+
+ Much like image downloads, ongoing imports may be listed
+ with list-transfers and aborted with
+ cancel-transfer.
+
+
+
+ export-tarNAME [FILE]
+ export-rawNAME [FILE]
+ Exports a TAR or RAW container or VM image and
+ stores it in the specified file. The first parameter should be
+ a VM or container image name. The second parameter should be a
+ file path the TAR or RAW image is written to. If the path ends
+ in .gz the file is compressed with gzip, if
+ it ends in .xz with xz, and if it ends in
+ .bz2 with bzip2. If the path ends in
+ neither the file is left uncompressed. If the second argument
+ is missing the image is written to standard output. The
+ compression may also be explicitly selected with the
+ switch. This is in particular
+ useful if the second parameter is left unspecified.
+
+ Much like image downloads and imports, ongoing exports
+ may be listed with list-transfers and
+ aborted with
+ cancel-transfer.
+
+ Note that currently only directory and subvolume images
+ may be exported as TAR images, and only raw disk images as RAW
+ images.
+
+
list-transfersShows a list of container or VM image
- downloads that are currently in progress.
+ downloads, imports and exports that are currently in
+ progress.
cancel-transfersID...
- Aborts download of the container or VM image
- with the specified ID. To list ongoing transfers and their
- IDs, use list-transfers.
+ Aborts a download, import or export of the
+ container or VM image with the specified ID. To list ongoing
+ transfers and their IDs, use
+ list-transfers.
@@ -686,6 +773,19 @@
/var/lib/machines/ to make them available for
control with machinectl.
+ Note that many image operations are only supported,
+ efficient or atomic on btrfs file systems. Due to this, if the
+ pull-tar, pull-raw,
+ pull-dkr, import-tar,
+ import-raw and set-limit
+ commands notice that /var/lib/machines is
+ empty and not located on btrfs, they will implicitly set up a
+ loopback file /var/lib/machines.raw
+ containing a btrfs file system that is mounted to
+ /var/lib/machines. The size of this loopback
+ file may be controlled dynamically with
+ set-limit.
+
Disk images are understood by
systemd-nspawn1
and machinectl in three formats:
@@ -755,6 +855,17 @@
index server to be specified with the
--dkr-index-url=.
+
+
+ Exports a container image as tar file
+
+ # machinectl export-tar fedora myfedora.tar.xz
+
+ Exports the container fedora in an
+ xz-compress tar file myfedora.tar.xz in the
+ current directory.
+
+
@@ -771,7 +882,11 @@
systemd-machined.service8,
systemd-nspawn1,
- systemd.special7
+ systemd.special7,
+ tar1,
+ xz1,
+ gzip1,
+ bzip21