path: root/share/man/compute-tools.7

'\" t
.\"     Title: container-tools
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 20190304
.\"    Manual: Open Infrastructure
.\"    Source: compute-tools
.\"  Language: English
.\"
.TH "CONTAINER\-TOOLS" "7" "20190304" "compute\-tools" "Open Infrastructure"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
compute-tools \- Manage systemd\-nspawn containers
.SH "DESCRIPTION"
.PP
"[A Linux container] is an operating\-system\-level virtualization environment for running multiple isolated Linux systems (containers) on a single Linux control host\&."
.RS 4
 \(em Wikipedia (https://en\&.wikipedia\&.org/wiki/LXC)
.RE
.sp
compute\-tools provides the system integration for managing containers using systemd\-nspawn\&.
.SH "DOWNLOAD"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Upstream Releases:
https://get\&.open\-infrastructure\&.net/software/compute\-tools/upstream
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Upstream Sources:
https://git\&.open\-infrastructure\&.net/software/compute\-tools
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Debian Releases:
https://get\&.open\-infrastructure\&.net/software/compute\-tools/debian
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Debian Sources:
https://git\&.progress\-linux\&.org/users/daniel/debian/packages/open\-infrastructure\-compute\-tools
.RE
.SH "INSTALLATION"
.SS "SOURCE"
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  1." 4.2
.\}
sudo apt install asciidoc git docbook\-xml docbook\-xsl libxml2\-utils make xsltproc dbus systemd\-container
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  2." 4.2
.\}
git clone
https://git\&.open\-infrastructure\&.net/software/compute\-tools
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 3.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  3." 4.2
.\}
cd compute\-tools && sudo make install
.RE
.SS "DEBIAN 9 (STRETCH) AND NEWER"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
sudo apt install container\-tools
.RE
.SH "DEVELOPMENT"
.sp
Bug reports, feature requests, help, patches, support and everything else are welcome on the Open Infrastructure Software Mailing List:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
https://lists\&.open\-infrastructure\&.net/listinfo/software
.RE
.sp
Please base patches against the \fInext\fR Git branch using common sense:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
https://www\&.kernel\&.org/doc/Documentation/SubmittingPatches
.RE
.sp
Debian specific bugs can also be reported in the Debian Bug Tracking System:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
https://bugs\&.debian\&.org
.RE
.SH "KNOWN LIMITATIONS"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
This version of compute\-tools currently do not work with systemd\-networkd and depend on ifupdown\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Using overlay, the upper directory can not be an NFS mount due to limitations in Linux\*(Aq overlay filesystem, see
https://git\&.kernel\&.org/cgit/linux/kernel/git/torvalds/linux\&.git/tree/Documentation/filesystems/overlayfs\&.txt
.RE
.SH "USAGE"
.PP
\fBCreate a new container:\fR
.RS 4
sudo container create \-n NAME
.RE
.PP
\fBStart a container:\fR
.RS 4
sudo container start \-n NAME
.RE
.PP
\fBStop a container:\fR
.RS 4
sudo container stop \-n NAME
.RE
.PP
\fBRemove a container:\fR
.RS 4
sudo container remove \-n NAME
.RE
.PP
\fBList container on the system:\fR
.RS 4
sudo container list
.RE
.PP
\fBShow container version:\fR
.RS 4
container version
.RE
.sp
See container(1) for a list of all container commands\&.
.SH "LINKS"
.PP
\fB2016\-02\-24: Systemd vs\&. Docker\fR
.RS 4
https://lwn\&.net/Articles/676831/
.RE
.PP
\fB2015\-06\-10: Systemd and containers\fR
.RS 4
https://lwn\&.net/Articles/647634/
.RE
.PP
\fB2014\-07\-07: Control groups\fR
.RS 4
https://lwn\&.net/Articles/604609/
.RE
.PP
\fB2013\-11\-13: Systemd\-Nspawn is Chroot on Steroids [LinuxCon Europe]\fR
.RS 4
https://www\&.youtube\&.com/watch?v=s7LlUs5D9p4
.RE
.PP
\fB2013\-11\-03: Creating containers with systemd\-nspawn\fR
.RS 4
https://lwn\&.net/Articles/572957/
.RE
.PP
\fB2013\-02\-06: Systemd lightweight containers\fR
.RS 4
https://lwn\&.net/Articles/536033/
.RE
.PP
\fB2013\-01\-04: Namespaces in operation\fR
.RS 4
https://lwn\&.net/Articles/531114/
.RE
.SH "AUTHORS"
.sp
compute\-tools were written by Daniel Baumann <daniel\&.baumann@open\-infrastructure\&.net> and others\&.