← Back to branch summary

~ubuntu-branches/ubuntu/quantal/lxc/quantal-201208301614

« back to all changes in this revision

Viewing changes to doc/lxc.conf.5

  • Committer: Bazaar Package Importer
  • Author(s): Guido Trotter
  • Date: 2010-06-28 10:15:48 UTC
  • mto: (1.1.4 upstream) (3.1.5 sid)
  • mto: This revision was merged to the branch mainline in revision 7.
  • Revision ID: james.westby@ubuntu.com-20100628101548-vexhggdo6x9cpwtk
Import upstream version 0.7.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/lxc.conf.5
3
3
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
4
4
.\" Please send any bug reports, improvements, comments, patches, 
5
5
.\" etc. to Steve Cheng <steve@ggi-project.org>.
6
 
.TH "LXC.CONF" "5" "22 January 2010" "" ""
 
6
.TH "LXC.CONF" "5" "24 June 2010" "" ""
7
7
 
8
8
.SH NAME
9
9
lxc.conf \- linux container configuration file
159
159
instance, making this private to it. The value specifies
160
160
the maximum number of pseudo ttys allowed for a pts
161
161
instance (this limitation is not implemented yet).
 
162
.SS "CONTAINER SYSTEM CONSOLE"
 
163
.PP
 
164
If the container is configured with a root filesystem and the
 
165
inittab file is setup to use the console, you may want to specify
 
166
where goes the output of this console.
 
167
.TP
 
168
\fB     lxc.console \fR
 
169
Specify a path to a file where the console output will
 
170
be written.
162
171
.SS "CONSOLE THROUGH THE TTYS"
163
172
.PP
164
173
If the container is configured with a root filesystem and the
191
200
fstab format.
192
201
.SS "ROOT FILE SYSTEM"
193
202
.PP
194
 
The root file system is the location where the container will
195
 
chroot.
 
203
The root file system of the container can be different than that
 
204
of the host system.
196
205
.TP
197
206
\fB     lxc.rootfs \fR
198
 
specify a file location containing the new file tree for
199
 
a root file system.
 
207
specify a directory to become the root of the container.
 
208
If not specified, the container shares its root file
 
209
system with the host.
 
210
.TP
 
211
\fB     lxc.rootfs.mount \fR
 
212
where to recursively bind \fBlxc.rootfs\fR
 
213
before pivoting.  This is to ensure success of the
 
214
\fBpivot_root\fR(8)
 
215
syscall.  Any directory suffices, the default should
 
216
generally work.
 
217
.TP
 
218
\fB     lxc.pivotdir \fR
 
219
where to pivot the original root file system under
 
220
\fBlxc.rootfs\fR, specified relatively to
 
221
that.  The default is \fImnt\fR\&.
 
222
It is created if necessary, and also removed after
 
223
unmounting everything from it during container setup.
200
224
.SS "CONTROL GROUP"
201
225
.PP
202
226
The control group section contains the configuration for the
228
252
sys_module. See
229
253
\fBcapabilities\fR(7),
230
254
.SH "EXAMPLES"
 
255
.PP
 
256
In addition to the few examples given below, you will find
 
257
some other examples of configuration file in /usr/share/doc/lxc/examples
231
258
.SS "NETWORK"
232
259
.PP
233
260
This configuration sets up a container to use a veth pair
235
262
configured before on the system by the administrator). The
236
263
virtual network device visible in the container is renamed to
237
264
eth0.
238
 
.TP
239
 
\fBlxc.utsname = myhostname\fR
240
 
.TP
241
 
\fBlxc.network.type = veth\fR
242
 
.TP
243
 
\fBlxc.network.flags = up\fR
244
 
.TP
245
 
\fBlxc.network.link = br0\fR
246
 
.TP
247
 
\fBlxc.network.name = eth0\fR
248
 
.TP
249
 
\fBlxc.network.hwaddr = 4a:49:43:49:79:bf\fR
250
 
.TP
251
 
\fBlxc.network.ipv4 = 1.2.3.5/24\fR
252
 
.TP
253
 
\fBlxc.network.ipv6 = 2003:db8:1:0:214:1234:fe0b:3597\fR
 
265
 
 
266
.nf
 
267
        lxc.utsname = myhostname
 
268
        lxc.network.type = veth
 
269
        lxc.network.flags = up
 
270
        lxc.network.link = br0
 
271
        lxc.network.name = eth0
 
272
        lxc.network.hwaddr = 4a:49:43:49:79:bf
 
273
        lxc.network.ipv4 = 1.2.3.5/24
 
274
        lxc.network.ipv6 = 2003:db8:1:0:214:1234:fe0b:3597
 
275
      
 
276
.fi
254
277
.SS "CONTROL GROUP"
255
278
.PP
256
279
This configuration will setup several control groups for
257
280
the application, cpuset.cpus restricts usage of the defined cpu,
258
281
cpus.share prioritize the control group, devices.allow makes
259
282
usable the specified devices.
260
 
.TP
261
 
\fBlxc.cgroup.cpuset.cpus = 0,1\fR
262
 
.TP
263
 
\fBlxc.cgroup.cpu.shares = 1234\fR
264
 
.TP
265
 
\fBlxc.cgroup.devices.deny = a\fR
266
 
.TP
267
 
\fBlxc.cgroup.devices.allow = c 1:3 rw\fR
268
 
.TP
269
 
\fBlxc.cgroup.devices.allow = b 8:0 rw\fR
 
283
 
 
284
.nf
 
285
        lxc.cgroup.cpuset.cpus = 0,1
 
286
        lxc.cgroup.cpu.shares = 1234
 
287
        lxc.cgroup.devices.deny = a
 
288
        lxc.cgroup.devices.allow = c 1:3 rw
 
289
        lxc.cgroup.devices.allow = b 8:0 rw
 
290
      
 
291
.fi
270
292
.SS "COMPLEX CONFIGURATION"
271
293
.PP
272
294
This example show a complex configuration making a complex
273
295
network stack, using the control groups, setting a new hostname,
274
 
mounting some locations and a changing the root file
275
 
system.
276
 
.TP
277
 
\fBlxc.utsname = complex\fR
278
 
.TP
279
 
\fBlxc.network.type = veth\fR
280
 
.TP
281
 
\fBlxc.network.flags = up\fR
282
 
.TP
283
 
\fBlxc.network.link = br0\fR
284
 
.TP
285
 
\fBlxc.network.hwaddr = 4a:49:43:49:79:bf\fR
286
 
.TP
287
 
\fBlxc.network.ipv4 = 1.2.3.5/24\fR
288
 
.TP
289
 
\fBlxc.network.ipv6 = 2003:db8:1:0:214:1234:fe0b:3597\fR
290
 
.TP
291
 
\fBlxc.network.ipv6 = 2003:db8:1:0:214:5432:feab:3588\fR
292
 
.TP
293
 
\fBlxc.network.type = macvlan\fR
294
 
.TP
295
 
\fBlxc.network.flags = up\fR
296
 
.TP
297
 
\fBlxc.network.link = eth0\fR
298
 
.TP
299
 
\fBlxc.network.hwaddr = 4a:49:43:49:79:bd\fR
300
 
.TP
301
 
\fBlxc.network.ipv4 = 1.2.3.4/24\fR
302
 
.TP
303
 
\fBlxc.network.ipv4 = 192.168.10.125/24\fR
304
 
.TP
305
 
\fBlxc.network.ipv6 = 2003:db8:1:0:214:1234:fe0b:3596\fR
306
 
.TP
307
 
\fBlxc.network.type = phys\fR
308
 
.TP
309
 
\fBlxc.network.flags = up\fR
310
 
.TP
311
 
\fBlxc.network.link = dummy0\fR
312
 
.TP
313
 
\fBlxc.network.hwaddr = 4a:49:43:49:79:ff\fR
314
 
.TP
315
 
\fBlxc.network.ipv4 = 1.2.3.6/24\fR
316
 
.TP
317
 
\fBlxc.network.ipv6 = 2003:db8:1:0:214:1234:fe0b:3297\fR
318
 
.TP
319
 
\fBlxc.cgroup.cpuset.cpus = 0,1\fR
320
 
.TP
321
 
\fBlxc.cgroup.cpu.shares = 1234\fR
322
 
.TP
323
 
\fBlxc.cgroup.devices.deny = a\fR
324
 
.TP
325
 
\fBlxc.cgroup.devices.allow = c 1:3 rw\fR
326
 
.TP
327
 
\fBlxc.cgroup.devices.allow = b 8:0 rw\fR
328
 
.TP
329
 
\fBlxc.mount = /etc/fstab.complex\fR
330
 
.TP
331
 
\fBlxc.mount.entry = /lib /root/myrootfs/lib none ro,bind 0 0\fR
332
 
.TP
333
 
\fBlxc.rootfs = /mnt/rootfs.complex\fR
334
 
.TP
335
 
\fBlxc.cap.drop = sys_module mknod setuid net_raw\fR
336
 
.TP
337
 
\fBlxc.cap.drop = mac_override\fR
 
296
mounting some locations and a changing root file system.
 
297
 
 
298
.nf
 
299
        lxc.utsname = complex
 
300
        lxc.network.type = veth
 
301
        lxc.network.flags = up
 
302
        lxc.network.link = br0
 
303
        lxc.network.hwaddr = 4a:49:43:49:79:bf
 
304
        lxc.network.ipv4 = 1.2.3.5/24
 
305
        lxc.network.ipv6 = 2003:db8:1:0:214:1234:fe0b:3597
 
306
        lxc.network.ipv6 = 2003:db8:1:0:214:5432:feab:3588
 
307
        lxc.network.type = macvlan
 
308
        lxc.network.flags = up
 
309
        lxc.network.link = eth0
 
310
        lxc.network.hwaddr = 4a:49:43:49:79:bd
 
311
        lxc.network.ipv4 = 1.2.3.4/24
 
312
        lxc.network.ipv4 = 192.168.10.125/24
 
313
        lxc.network.ipv6 = 2003:db8:1:0:214:1234:fe0b:3596
 
314
        lxc.network.type = phys
 
315
        lxc.network.flags = up
 
316
        lxc.network.link = dummy0
 
317
        lxc.network.hwaddr = 4a:49:43:49:79:ff
 
318
        lxc.network.ipv4 = 1.2.3.6/24
 
319
        lxc.network.ipv6 = 2003:db8:1:0:214:1234:fe0b:3297
 
320
        lxc.cgroup.cpuset.cpus = 0,1
 
321
        lxc.cgroup.cpu.shares = 1234
 
322
        lxc.cgroup.devices.deny = a
 
323
        lxc.cgroup.devices.allow = c 1:3 rw
 
324
        lxc.cgroup.devices.allow = b 8:0 rw
 
325
        lxc.mount = /etc/fstab.complex
 
326
        lxc.mount.entry = /lib /root/myrootfs/lib none ro,bind 0 0
 
327
        lxc.rootfs = /mnt/rootfs.complex
 
328
        lxc.cap.drop = sys_module mknod setuid net_raw
 
329
        lxc.cap.drop = mac_override
 
330
      
 
331
.fi
338
332
.SH "SEE ALSO"
339
333
.PP
340
334
\fBchroot\fR(1),
348
342
\fBlxc-start\fR(1),
349
343
\fBlxc-stop\fR(1),
350
344
\fBlxc-execute\fR(1),
 
345
\fBlxc-kill\fR(1),
351
346
\fBlxc-console\fR(1),
352
347
\fBlxc-monitor\fR(1),
353
348
\fBlxc-wait\fR(1),