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