diff options
Diffstat (limited to 'share/man/compute-tools.7')
| -rw-r--r-- | share/man/compute-tools.7 | 194 |
1 files changed, 194 insertions, 0 deletions
diff --git a/share/man/compute-tools.7 b/share/man/compute-tools.7 new file mode 100644 index 0000000..d6b62df --- /dev/null +++ b/share/man/compute-tools.7 @@ -0,0 +1,194 @@ +.\" Open Infrastructure: compute-tools +.\" +.\" Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net> +.\" +.\" SPDX-License-Identifier: GPL-3.0+ +.\" +.\" This program 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 3 of the License, or +.\" (at your option) any later version. +.\" +.\" This program 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. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program. If not, see <https://www.gnu.org/licenses/>. +.\" +. +.TH COMPUTE-TOOLS 7 compute-tools "Open Infrastructure" +.SH NAME +compute-tools \- Manage systemd-nspawn containers +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH DESCRIPTION +.sp +[A Linux container] is an operating\-system\-level virtualization environment for +running multiple isolated Linux systems (containers) on a single Linux control +host. +.INDENT 0.0 +.INDENT 3.5 +\-\- Wikipedia (\fI\%https://en.wikipedia.org/wiki/LXC\fP) +.UNINDENT +.UNINDENT +.sp +\fBcompute\-tools\fP provides the system integration for managing containers using +systemd\-nspawn(1). +.SH DOWNLOAD +.nf +Upstream Releases: +\fI\%https://get.open\-infrastructure.net/software/compute\-tools/upstream\fP +.fi +.sp +.nf +Upstream Sources: +\fI\%https://git.open\-infrastructure.net/software/compute\-tools\fP +.fi +.sp +.nf +Debian Releases: +\fI\%https://get.open\-infrastructure.net/software/compute\-tools/debian\fP +.fi +.sp +.nf +Debian Sources: +\fI\%https://git.progress\-linux.org/users/daniel/debian/packages/open\-infrastructure\-compute\-tools\fP +.fi +.sp +.SH INSTALLATION +.SS Source +.nf +$ sudo apt install git make python3\-docutils dbus systemd\-container +$ git clone \fI\%https://git.open\-infrastructure.net/software/compute\-tools\fP +$ cd compute\-tools && sudo make install +.fi +.sp +.SS Debian 9 (stretch) and newer +.nf +$ sudo apt install compute\-tools +.fi +.sp +.SH DEVELOPMENT +.sp +Bug reports, feature requests, help, patches, support and everything else are +welcome on the Open Infrastructure Software Mailing List +(\fI\%https://lists.open\-infrastructure.net/listinfo/software\fP). +.sp +Please base patches against the \(aqnext\(aq Git branch using common sense +(\fI\%https://www.kernel.org/doc/Documentation/SubmittingPatches\fP). +.sp +Debian specific bugs can also be reported in the Debian Bug Tracking System +(\fI\%https://bugs.debian.org\fP). +.SH KNOWN LIMITATIONS +.sp +This version of compute\-tools currently do not work with systemd\-networkd and +depend on ifupdown. +.sp +Using overlay, the upper directory can not be an NFS mount due to limitations in +Linux\(aq overlay filesystem +(\fI\%https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/filesystems/overlayfs.txt\fP). +.SH USAGE +.INDENT 0.0 +.TP +.B Build a new container: +sudo container build \-n NAME +.TP +.B Start a container: +sudo container start \-n NAME +.TP +.B Stop a container: +sudo container stop \-n NAME +.TP +.B Remove a container: +sudo container remove \-n NAME +.TP +.B List container on the system: +sudo container list +.TP +.B Show container version: +container version +.UNINDENT +.sp +See container(1) for a list of all container commands. +.SH LINKS +.nf +* 2016\-02\-24: Systemd vs. Docker +.in +2 +(\fI\%https://lwn.net/Articles/676831/\fP) +.in -2 +.fi +.sp +.nf +* 2015\-06\-10: Systemd and containers +.in +2 +(\fI\%https://lwn.net/Articles/647634/\fP) +.in -2 +.fi +.sp +.nf +* 2014\-07\-07: Control groups +.in +2 +(\fI\%https://lwn.net/Articles/604609/\fP) +.in -2 +.fi +.sp +.nf +* 2013\-11\-13: Systemd\-Nspawn is Chroot on Steroids [LinuxCon Europe] +.in +2 +(\fI\%https://www.youtube.com/watch?v=s7LlUs5D9p4\fP) +.in -2 +.fi +.sp +.nf +* 2013\-11\-03: Creating containers with systemd\-nspawn +.in +2 +(\fI\%https://lwn.net/Articles/572957/\fP) +.in -2 +.fi +.sp +.nf +* 2013\-02\-06: Systemd lightweight containers +.in +2 +(\fI\%https://lwn.net/Articles/536033/\fP) +.in -2 +.fi +.sp +.nf +* 2013\-01\-04: Namespaces in operation +.in +2 +(\fI\%https://lwn.net/Articles/531114/\fP) +.in -2 +.fi +.sp +.SH AUTHORS +.sp +compute\-tools were written by Daniel Baumann +<\fI\%daniel.baumann@open\-infrastructure.net\fP> and others. +. |