pct.adoc: move "Guest Operating System Configuration" one level up
[pve-docs.git] / pct.adoc
1 [[chapter_pct]]
2 ifdef::manvolnum[]
3 pct(1)
4 ======
5 include::attributes.txt[]
6 :pve-toplevel:
7
8 NAME
9 ----
10
11 pct - Tool to manage Linux Containers (LXC) on Proxmox VE
12
13
14 SYNOPSIS
15 --------
16
17 include::pct.1-synopsis.adoc[]
18
19 DESCRIPTION
20 -----------
21 endif::manvolnum[]
22
23 ifndef::manvolnum[]
24 Proxmox Container Toolkit
25 =========================
26 include::attributes.txt[]
27 :pve-toplevel:
28 endif::manvolnum[]
29 ifdef::wiki[]
30 :title: Linux Container
31 endif::wiki[]
32
33 Containers are a lightweight alternative to fully virtualized
34 VMs. Instead of emulating a complete Operating System (OS), containers
35 simply use the OS of the host they run on. This implies that all
36 containers use the same kernel, and that they can access resources
37 from the host directly.
38
39 This is great because containers do not waste CPU power nor memory due
40 to kernel emulation. Container run-time costs are close to zero and
41 usually negligible. But there are also some drawbacks you need to
42 consider:
43
44 * You can only run Linux based OS inside containers, i.e. it is not
45   possible to run FreeBSD or MS Windows inside.
46
47 * For security reasons, access to host resources needs to be
48   restricted. This is done with AppArmor, SecComp filters and other
49   kernel features. Be prepared that some syscalls are not allowed
50   inside containers.
51
52 {pve} uses https://linuxcontainers.org/[LXC] as underlying container
53 technology. We consider LXC as low-level library, which provides
54 countless options. It would be too difficult to use those tools
55 directly. Instead, we provide a small wrapper called `pct`, the
56 "Proxmox Container Toolkit".
57
58 The toolkit is tightly coupled with {pve}. That means that it is aware
59 of the cluster setup, and it can use the same network and storage
60 resources as fully virtualized VMs. You can even use the {pve}
61 firewall, or manage containers using the HA framework.
62
63 Our primary goal is to offer an environment as one would get from a
64 VM, but without the additional overhead. We call this "System
65 Containers".
66
67 NOTE: If you want to run micro-containers (with docker, rkt, ...), it
68 is best to run them inside a VM.
69
70
71 Security Considerations
72 -----------------------
73
74 Containers use the same kernel as the host, so there is a big attack
75 surface for malicious users. You should consider this fact if you
76 provide containers to totally untrusted people. In general, fully
77 virtualized VMs provide better isolation.
78
79 The good news is that LXC uses many kernel security features like
80 AppArmor, CGroups and PID and user namespaces, which makes containers
81 usage quite secure. We distinguish two types of containers:
82
83
84 Privileged Containers
85 ~~~~~~~~~~~~~~~~~~~~~
86
87 Security is done by dropping capabilities, using mandatory access
88 control (AppArmor), SecComp filters and namespaces. The LXC team
89 considers this kind of container as unsafe, and they will not consider
90 new container escape exploits to be security issues worthy of a CVE
91 and quick fix. So you should use this kind of containers only inside a
92 trusted environment, or when no untrusted task is running as root in
93 the container.
94
95
96 Unprivileged Containers
97 ~~~~~~~~~~~~~~~~~~~~~~~
98
99 This kind of containers use a new kernel feature called user
100 namespaces. The root UID 0 inside the container is mapped to an
101 unprivileged user outside the container. This means that most security
102 issues (container escape, resource abuse, ...) in those containers
103 will affect a random unprivileged user, and so would be a generic
104 kernel security bug rather than an LXC issue. The LXC team thinks
105 unprivileged containers are safe by design.
106
107
108 Guest Operating System Configuration
109 ------------------------------------
110
111 We normally try to detect the operating system type inside the
112 container, and then modify some files inside the container to make
113 them work as expected. Here is a short list of things we do at
114 container startup:
115
116 set /etc/hostname:: to set the container name
117
118 modify /etc/hosts:: to allow lookup of the local hostname
119
120 network setup:: pass the complete network setup to the container
121
122 configure DNS:: pass information about DNS servers
123
124 adapt the init system:: for example, fix the number of spawned getty processes
125
126 set the root password:: when creating a new container
127
128 rewrite ssh_host_keys:: so that each container has unique keys
129
130 randomize crontab:: so that cron does not start at the same time on all containers
131
132 Changes made by {PVE} are enclosed by comment markers:
133
134 ----
135 # --- BEGIN PVE ---
136 <data>
137 # --- END PVE ---
138 ----
139
140 Those markers will be inserted at a reasonable location in the
141 file. If such a section already exists, it will be updated in place
142 and will not be moved.
143
144 Modification of a file can be prevented by adding a `.pve-ignore.`
145 file for it.  For instance, if the file `/etc/.pve-ignore.hosts`
146 exists then the `/etc/hosts` file will not be touched. This can be a
147 simple empty file creatd via:
148
149  # touch /etc/.pve-ignore.hosts
150
151 Most modifications are OS dependent, so they differ between different
152 distributions and versions. You can completely disable modifications
153 by manually setting the `ostype` to `unmanaged`.
154
155 OS type detection is done by testing for certain files inside the
156 container:
157
158 Ubuntu:: inspect /etc/lsb-release (`DISTRIB_ID=Ubuntu`)
159
160 Debian:: test /etc/debian_version
161
162 Fedora:: test /etc/fedora-release
163
164 RedHat or CentOS:: test /etc/redhat-release
165
166 ArchLinux:: test /etc/arch-release
167
168 Alpine:: test /etc/alpine-release
169
170 Gentoo:: test /etc/gentoo-release
171
172 NOTE: Container start fails if the configured `ostype` differs from the auto
173 detected type.
174
175
176 [[pct_configuration]]
177 Configuration
178 -------------
179
180 The `/etc/pve/lxc/<CTID>.conf` file stores container configuration,
181 where `<CTID>` is the numeric ID of the given container. Like all
182 other files stored inside `/etc/pve/`, they get automatically
183 replicated to all other cluster nodes.
184
185 NOTE: CTIDs < 100 are reserved for internal purposes, and CTIDs need to be
186 unique cluster wide.
187
188 .Example Container Configuration
189 ----
190 ostype: debian
191 arch: amd64
192 hostname: www
193 memory: 512
194 swap: 512
195 net0: bridge=vmbr0,hwaddr=66:64:66:64:64:36,ip=dhcp,name=eth0,type=veth
196 rootfs: local:107/vm-107-disk-1.raw,size=7G
197 ----
198
199 Those configuration files are simple text files, and you can edit them
200 using a normal text editor (`vi`, `nano`, ...). This is sometimes
201 useful to do small corrections, but keep in mind that you need to
202 restart the container to apply such changes.
203
204 For that reason, it is usually better to use the `pct` command to
205 generate and modify those files, or do the whole thing using the GUI.
206 Our toolkit is smart enough to instantaneously apply most changes to
207 running containers. This feature is called "hot plug", and there is no
208 need to restart the container in that case.
209
210
211 File Format
212 ~~~~~~~~~~~
213
214 Container configuration files use a simple colon separated key/value
215 format. Each line has the following format:
216
217 -----
218 # this is a comment
219 OPTION: value
220 -----
221
222 Blank lines in those files are ignored, and lines starting with a `#`
223 character are treated as comments and are also ignored.
224
225 It is possible to add low-level, LXC style configuration directly, for
226 example:
227
228  lxc.init_cmd: /sbin/my_own_init
229
230 or
231
232  lxc.init_cmd = /sbin/my_own_init
233
234 Those settings are directly passed to the LXC low-level tools.
235
236
237 [[pct_snapshots]]
238 Snapshots
239 ~~~~~~~~~
240
241 When you create a snapshot, `pct` stores the configuration at snapshot
242 time into a separate snapshot section within the same configuration
243 file. For example, after creating a snapshot called ``testsnapshot'',
244 your configuration file will look like this:
245
246 .Container configuration with snapshot
247 ----
248 memory: 512
249 swap: 512
250 parent: testsnaphot
251 ...
252
253 [testsnaphot]
254 memory: 512
255 swap: 512
256 snaptime: 1457170803
257 ...
258 ----
259
260 There are a few snapshot related properties like `parent` and
261 `snaptime`. The `parent` property is used to store the parent/child
262 relationship between snapshots. `snaptime` is the snapshot creation
263 time stamp (Unix epoch).
264
265
266 [[pct_options]]
267 Options
268 ~~~~~~~
269
270 include::pct.conf.5-opts.adoc[]
271
272
273 [[pct_container_images]]
274 Container Images
275 ----------------
276
277 Container images, sometimes also referred to as ``templates'' or
278 ``appliances'', are `tar` archives which contain everything to run a
279 container. You can think of it as a tidy container backup. Like most
280 modern container toolkits, `pct` uses those images when you create a
281 new container, for example:
282
283  pct create 999 local:vztmpl/debian-8.0-standard_8.0-1_amd64.tar.gz
284
285 {pve} itself ships a set of basic templates for most common
286 operating systems, and you can download them using the `pveam` (short
287 for {pve} Appliance Manager) command line utility. You can also
288 download https://www.turnkeylinux.org/[TurnKey Linux] containers using
289 that tool (or the graphical user interface).
290
291 Our image repositories contain a list of available images, and there
292 is a cron job run each day to download that list. You can trigger that
293 update manually with:
294
295  pveam update
296
297 After that you can view the list of available images using:
298
299  pveam available
300
301 You can restrict this large list by specifying the `section` you are
302 interested in, for example basic `system` images:
303
304 .List available system images
305 ----
306 # pveam available --section system
307 system          archlinux-base_2015-24-29-1_x86_64.tar.gz
308 system          centos-7-default_20160205_amd64.tar.xz
309 system          debian-6.0-standard_6.0-7_amd64.tar.gz
310 system          debian-7.0-standard_7.0-3_amd64.tar.gz
311 system          debian-8.0-standard_8.0-1_amd64.tar.gz
312 system          ubuntu-12.04-standard_12.04-1_amd64.tar.gz
313 system          ubuntu-14.04-standard_14.04-1_amd64.tar.gz
314 system          ubuntu-15.04-standard_15.04-1_amd64.tar.gz
315 system          ubuntu-15.10-standard_15.10-1_amd64.tar.gz
316 ----
317
318 Before you can use such a template, you need to download them into one
319 of your storages. You can simply use storage `local` for that
320 purpose. For clustered installations, it is preferred to use a shared
321 storage so that all nodes can access those images.
322
323  pveam download local debian-8.0-standard_8.0-1_amd64.tar.gz
324
325 You are now ready to create containers using that image, and you can
326 list all downloaded images on storage `local` with:
327
328 ----
329 # pveam list local
330 local:vztmpl/debian-8.0-standard_8.0-1_amd64.tar.gz  190.20MB
331 ----
332
333 The above command shows you the full {pve} volume identifiers. They include
334 the storage name, and most other {pve} commands can use them. For
335 example you can delete that image later with:
336
337  pveam remove local:vztmpl/debian-8.0-standard_8.0-1_amd64.tar.gz
338
339
340 [[pct_container_storage]]
341 Container Storage
342 -----------------
343
344 Traditional containers use a very simple storage model, only allowing
345 a single mount point, the root file system. This was further
346 restricted to specific file system types like `ext4` and `nfs`.
347 Additional mounts are often done by user provided scripts. This turned
348 out to be complex and error prone, so we try to avoid that now.
349
350 Our new LXC based container model is more flexible regarding
351 storage. First, you can have more than a single mount point. This
352 allows you to choose a suitable storage for each application. For
353 example, you can use a relatively slow (and thus cheap) storage for
354 the container root file system. Then you can use a second mount point
355 to mount a very fast, distributed storage for your database
356 application.
357
358 The second big improvement is that you can use any storage type
359 supported by the {pve} storage library. That means that you can store
360 your containers on local `lvmthin` or `zfs`, shared `iSCSI` storage,
361 or even on distributed storage systems like `ceph`. It also enables us
362 to use advanced storage features like snapshots and clones. `vzdump`
363 can also use the snapshot feature to provide consistent container
364 backups.
365
366 Last but not least, you can also mount local devices directly, or
367 mount local directories using bind mounts. That way you can access
368 local storage inside containers with zero overhead. Such bind mounts
369 also provide an easy way to share data between different containers.
370
371
372 Mount Points
373 ~~~~~~~~~~~~
374
375 The root mount point is configured with the `rootfs` property, and you can
376 configure up to 10 additional mount points. The corresponding options
377 are called `mp0` to `mp9`, and they can contain the following setting:
378
379 include::pct-mountpoint-opts.adoc[]
380
381 Currently there are basically three types of mount points: storage backed
382 mount points, bind mounts and device mounts.
383
384 .Typical container `rootfs` configuration
385 ----
386 rootfs: thin1:base-100-disk-1,size=8G
387 ----
388
389
390 Storage Backed Mount Points
391 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
392
393 Storage backed mount points are managed by the {pve} storage subsystem and come
394 in three different flavors:
395
396 - Image based: these are raw images containing a single ext4 formatted file
397   system.
398 - ZFS subvolumes: these are technically bind mounts, but with managed storage,
399   and thus allow resizing and snapshotting.
400 - Directories: passing `size=0` triggers a special case where instead of a raw
401   image a directory is created.
402
403
404 Bind Mount Points
405 ^^^^^^^^^^^^^^^^^
406
407 Bind mounts allow you to access arbitrary directories from your Proxmox VE host
408 inside a container. Some potential use cases are:
409
410 - Accessing your home directory in the guest
411 - Accessing an USB device directory in the guest
412 - Accessing an NFS mount from the host in the guest
413
414 Bind mounts are considered to not be managed by the storage subsystem, so you
415 cannot make snapshots or deal with quotas from inside the container. With
416 unprivileged containers you might run into permission problems caused by the
417 user mapping and cannot use ACLs.
418
419 NOTE: The contents of bind mount points are not backed up when using `vzdump`.
420
421 WARNING: For security reasons, bind mounts should only be established
422 using source directories especially reserved for this purpose, e.g., a
423 directory hierarchy under `/mnt/bindmounts`. Never bind mount system
424 directories like `/`, `/var` or `/etc` into a container - this poses a
425 great security risk.
426
427 NOTE: The bind mount source path must not contain any symlinks.
428
429 For example, to make the directory `/mnt/bindmounts/shared` accessible in the
430 container with ID `100` under the path `/shared`, use a configuration line like
431 `mp0: /mnt/bindmounts/shared,mp=/shared` in `/etc/pve/lxc/100.conf`.
432 Alternatively, use `pct set 100 -mp0 /mnt/bindmounts/shared,mp=/shared` to
433 achieve the same result.
434
435
436 Device Mount Points
437 ^^^^^^^^^^^^^^^^^^^
438
439 Device mount points allow to mount block devices of the host directly into the
440 container. Similar to bind mounts, device mounts are not managed by {PVE}'s
441 storage subsystem, but the `quota` and `acl` options will be honored.
442
443 NOTE: Device mount points should only be used under special circumstances. In
444 most cases a storage backed mount point offers the same performance and a lot
445 more features.
446
447 NOTE: The contents of device mount points are not backed up when using `vzdump`.
448
449
450 FUSE Mounts
451 ~~~~~~~~~~~
452
453 WARNING: Because of existing issues in the Linux kernel's freezer
454 subsystem the usage of FUSE mounts inside a container is strongly
455 advised against, as containers need to be frozen for suspend or
456 snapshot mode backups.
457
458 If FUSE mounts cannot be replaced by other mounting mechanisms or storage
459 technologies, it is possible to establish the FUSE mount on the Proxmox host
460 and use a bind mount point to make it accessible inside the container.
461
462
463 Using Quotas Inside Containers
464 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
465
466 Quotas allow to set limits inside a container for the amount of disk
467 space that each user can use.  This only works on ext4 image based
468 storage types and currently does not work with unprivileged
469 containers.
470
471 Activating the `quota` option causes the following mount options to be
472 used for a mount point:
473 `usrjquota=aquota.user,grpjquota=aquota.group,jqfmt=vfsv0`
474
475 This allows quotas to be used like you would on any other system. You
476 can initialize the `/aquota.user` and `/aquota.group` files by running
477
478 ----
479 quotacheck -cmug /
480 quotaon /
481 ----
482
483 and edit the quotas via the `edquota` command. Refer to the documentation
484 of the distribution running inside the container for details.
485
486 NOTE: You need to run the above commands for every mount point by passing
487 the mount point's path instead of just `/`.
488
489
490 Using ACLs Inside Containers
491 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
492
493 The standard Posix **A**ccess **C**ontrol **L**ists are also available inside containers.
494 ACLs allow you to set more detailed file ownership than the traditional user/
495 group/others model.
496
497
498 [[pct_container_network]]
499 Container Network
500 -----------------
501
502 You can configure up to 10 network interfaces for a single
503 container. The corresponding options are called `net0` to `net9`, and
504 they can contain the following setting:
505
506 include::pct-network-opts.adoc[]
507
508
509 Backup and Restore
510 ------------------
511
512
513 Container Backup
514 ~~~~~~~~~~~~~~~~
515
516 It is possible to use the `vzdump` tool for container backup. Please
517 refer to the `vzdump` manual page for details.
518
519
520 Restoring Container Backups
521 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
522
523 Restoring container backups made with `vzdump` is possible using the
524 `pct restore` command. By default, `pct restore` will attempt to restore as much
525 of the backed up container configuration as possible. It is possible to override
526 the backed up configuration by manually setting container options on the command
527 line (see the `pct` manual page for details).
528
529 NOTE: `pvesm extractconfig` can be used to view the backed up configuration
530 contained in a vzdump archive.
531
532 There are two basic restore modes, only differing by their handling of mount
533 points:
534
535
536 ``Simple'' Restore Mode
537 ^^^^^^^^^^^^^^^^^^^^^^^
538
539 If neither the `rootfs` parameter nor any of the optional `mpX` parameters
540 are explicitly set, the mount point configuration from the backed up
541 configuration file is restored using the following steps:
542
543 . Extract mount points and their options from backup
544 . Create volumes for storage backed mount points (on storage provided with the
545 `storage` parameter, or default local storage if unset)
546 . Extract files from backup archive
547 . Add bind and device mount points to restored configuration (limited to root user)
548
549 NOTE: Since bind and device mount points are never backed up, no files are
550 restored in the last step, but only the configuration options. The assumption
551 is that such mount points are either backed up with another mechanism (e.g.,
552 NFS space that is bind mounted into many containers), or not intended to be
553 backed up at all.
554
555 This simple mode is also used by the container restore operations in the web
556 interface.
557
558
559 ``Advanced'' Restore Mode
560 ^^^^^^^^^^^^^^^^^^^^^^^^^
561
562 By setting the `rootfs` parameter (and optionally, any combination of `mpX`
563 parameters), the `pct restore` command is automatically switched into an
564 advanced mode. This advanced mode completely ignores the `rootfs` and `mpX`
565 configuration options contained in the backup archive, and instead only
566 uses the options explicitly provided as parameters.
567
568 This mode allows flexible configuration of mount point settings at restore time,
569 for example:
570
571 * Set target storages, volume sizes and other options for each mount point
572 individually
573 * Redistribute backed up files according to new mount point scheme
574 * Restore to device and/or bind mount points (limited to root user)
575
576
577 Managing Containers with `pct`
578 ------------------------------
579
580 `pct` is the tool to manage Linux Containers on {pve}. You can create
581 and destroy containers, and control execution (start, stop, migrate,
582 ...). You can use pct to set parameters in the associated config file,
583 like network configuration or memory limits.
584
585
586 CLI Usage Examples
587 ~~~~~~~~~~~~~~~~~~
588
589 Create a container based on a Debian template (provided you have
590 already downloaded the template via the web interface)
591
592  pct create 100 /var/lib/vz/template/cache/debian-8.0-standard_8.0-1_amd64.tar.gz
593
594 Start container 100
595
596  pct start 100
597
598 Start a login session via getty
599
600  pct console 100
601
602 Enter the LXC namespace and run a shell as root user
603
604  pct enter 100
605
606 Display the configuration
607
608  pct config 100
609
610 Add a network interface called `eth0`, bridged to the host bridge `vmbr0`,
611 set the address and gateway, while it's running
612
613  pct set 100 -net0 name=eth0,bridge=vmbr0,ip=192.168.15.147/24,gw=192.168.15.1
614
615 Reduce the memory of the container to 512MB
616
617  pct set 100 -memory 512
618
619
620 Obtaining Debugging Logs
621 ~~~~~~~~~~~~~~~~~~~~~~~~
622
623 In case `pct start` is unable to start a specific container, it might be
624 helpful to collect debugging output by running `lxc-start` (replace `ID` with
625 the container's ID):
626
627  lxc-start -n ID -F -l DEBUG -o /tmp/lxc-ID.log
628
629 This command will attempt to start the container in foreground mode, to stop the container run `pct shutdown ID` or `pct stop ID` in a second terminal.
630
631 The collected debug log is written to `/tmp/lxc-ID.log`.
632
633 NOTE: If you have changed the container's configuration since the last start
634 attempt with `pct start`, you need to run `pct start` at least once to also
635 update the configuration used by `lxc-start`.
636
637 Locks
638 -----
639
640 Container migrations, snapshots and backups (`vzdump`) set a lock to
641 prevent incompatible concurrent actions on the affected container. Sometimes
642 you need to remove such a lock manually (e.g., after a power failure).
643
644  pct unlock <CTID>
645
646 CAUTION: Only do that if you are sure the action which set the lock is
647 no longer running.
648
649
650 Container Advantages
651 --------------------
652
653 * Simple, and fully integrated into {pve}. Setup looks similar to a normal
654   VM setup. 
655
656 ** Storage (ZFS, LVM, NFS, Ceph, ...)
657
658 ** Network
659
660 ** Authentication
661
662 ** Cluster
663
664 * Fast: minimal overhead, as fast as bare metal
665
666 * High density (perfect for idle workloads)
667
668 * REST API
669
670 * Direct hardware access
671
672
673 Technology Overview
674 -------------------
675
676 * Integrated into {pve} graphical user interface (GUI)
677
678 * LXC (https://linuxcontainers.org/)
679
680 * lxcfs to provide containerized /proc file system
681
682 * AppArmor
683
684 * CRIU: for live migration (planned)
685
686 * We use latest available kernels (4.4.X)
687
688 * Image based deployment (templates)
689
690 * Container setup from host (network, DNS, storage, ...)
691
692
693 ifdef::manvolnum[]
694
695 Files
696 ------
697
698 `/etc/pve/lxc/<CTID>.conf`::
699
700 Configuration file for the container '<CTID>'.
701
702
703 include::pve-copyright.adoc[]
704 endif::manvolnum[]
705
706
707
708
709
710
711