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