summaryrefslogtreecommitdiffstats
path: root/share/man/container-tools.7
blob: adf3c6526c4c6ffa49bb2ee3839df92f6762e179 (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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
'\" t
.\"     Title: container-tools
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 20170701
.\"    Manual: Open Infrastructure
.\"    Source: container-tools
.\"  Language: English
.\"
.TH "CONTAINER\-TOOLS" "7" "20170701" "container\-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"
container-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
container\-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://files\&.open\-infrastructure\&.net/software/container\-tools/upstream
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Upstream Sources:
https://sources\&.open\-infrastructure\&.net/software/container\-tools
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Debian Releases:
https://files\&.open\-infrastructure\&.net/software/container\-tools/debian
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Debian Sources:
https://sources\&.progress\-linux\&.org/users/daniel/debian/packages/open\-infrastructure\-container\-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 net\-tools
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  2." 4.2
.\}
git clone
https://sources\&.open\-infrastructure\&.net/software/container\-tools
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 3.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  3." 4.2
.\}
cd container\-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 container\-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\-tools 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
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Daniel Baumann <daniel\&.baumann@open\-infrastructure\&.net>
.RE