summaryrefslogtreecommitdiffstats
path: root/share/man/container-tools.7.txt
blob: b6c83d64302360afad6256fe391a3884bdcee405 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
// container-tools - Manage systemd-nspawn containers
// Copyright (C) 2014-2016 Daniel Baumann <daniel.baumann@open-infrastructure.net>
//
// 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 <http://www.gnu.org/licenses/>.

CONTAINER-TOOLS(7)
==================
:doctype: manpage
:man manual: Open Infrastructure
:man source: container-tools
:man version: {revnumber}


NAME
----
container-tools - Manage systemd-nspawn containers


DESCRIPTION
-----------
"[A Linux container] is an operating-system-level virtualization environment for running multiple isolated Linux systems (containers) on a single Linux control host."::
    -- Wikipedia (https://en.wikipedia.org/wiki/LXC)

container-tools provides the system integration for managing containers using systemd-nspawn.


DOWNLOAD
--------
  * Upstream Releases: https://files.open-infrastructure.net/software/container-tools/upstream
  * Upstream Sources: https://sources.open-infrastructure.net/software/container-tools
  * Debian Releases: https://files.open-infrastructure.net/software/container-tools/debian
  * Debian Sources: https://sources.progress-linux.org/users/daniel/debian/packages/open-infrastructure-container-tools


INSTALLATION
------------

SOURCE
~~~~~~
  1. sudo apt install asciidoc git docbook-xml docbook-xsl libxml2-utils make xsltproc dbus systemd-container
  2. git clone https://sources.open-infrastructure.net/software/container-tools
  3. cd container-tools && sudo make install

DEBIAN 9 (STRETCH) AND NEWER
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  * sudo apt install container-tools


DEVELOPMENT
-----------
Bug reports, feature requests, help, patches, support and everything else
are welcome on the Open Infrastructure Software Mailing List:

  * https://lists.open-infrastructure.net/listinfo/software

Please base patches against the 'next' Git branch using common sense:

  * https://www.kernel.org/doc/Documentation/SubmittingPatches

Debian specific bugs can also be reported in the Debian Bug Tracking System:

  * https://bugs.debian.org


KNOWN LIMITATIONS
-----------------
  * This version of container-tools currently do not work with systemd-networkd and depend on ifupdown.
  * Using overlay, the upper directory can not be an NFS mount due to limitations in Linux' overlay filesystem,
    see https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/filesystems/overlayfs.txt


USAGE
-----
*Create a new container:*::
	sudo container create -n NAME

*Start a container:*::
	sudo container start -n NAME

*Stop a container:*::
	sudo container stop -n NAME

*Remove a container:*::
	sudo container remove -n NAME

*List container on the system:*::
	sudo container list

*Show container-tools version:*::
	container version

See container(1) for a list of all container commands.


LINKS
-----
*2016-02-24: Systemd vs. Docker*::
	https://lwn.net/Articles/676831/

*2015-06-10: Systemd and containers*::
	https://lwn.net/Articles/647634/

*2014-07-07: Control groups*::
	https://lwn.net/Articles/604609/

*2013-11-13: Systemd-Nspawn is Chroot on Steroids [LinuxCon Europe]*::
	https://www.youtube.com/watch?v=s7LlUs5D9p4

*2013-11-03: Creating containers with systemd-nspawn*::
	https://lwn.net/Articles/572957/

*2013-02-06: Systemd lightweight containers*::
	https://lwn.net/Articles/536033/

*2013-01-04: Namespaces in operation*::
	https://lwn.net/Articles/531114/


AUTHORS
-------
  * Daniel Baumann <daniel.baumann@open-infrastructure.net>