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