]>
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 | 30 | |
14e97811 OB |
31 | Containers are a lightweight alternative to fully virtualized machines (VMs). |
32 | They use the kernel of the host system that they run on, instead of emulating a | |
33 | full operating system (OS). This means that containers can access resources on | |
34 | the host system directly. | |
4a2ae9ed | 35 | |
6d718b9b TL |
36 | The runtime costs for containers is low, usually negligible. However, there are |
37 | some drawbacks that need be considered: | |
4a2ae9ed | 38 | |
fd7fb228 DW |
39 | * Only Linux distributions can be run in Proxmox Containers. It is not possible to run |
40 | other operating systems like, for example, FreeBSD or Microsoft Windows | |
6d718b9b | 41 | inside a container. |
4a2ae9ed | 42 | |
6d718b9b | 43 | * For security reasons, access to host resources needs to be restricted. |
fd7fb228 DW |
44 | Therefore, containers run in their own separate namespaces. Additionally some |
45 | syscalls (user space requests to the Linux kernel) are not allowed within containers. | |
4a2ae9ed | 46 | |
fd7fb228 | 47 | {pve} uses https://linuxcontainers.org/lxc/introduction/[Linux Containers (LXC)] as its underlying |
6d718b9b | 48 | container technology. The ``Proxmox Container Toolkit'' (`pct`) simplifies the |
fd7fb228 DW |
49 | usage and management of LXC, by providing an interface that abstracts |
50 | complex tasks. | |
4a2ae9ed | 51 | |
14e97811 OB |
52 | Containers are tightly integrated with {pve}. This means that they are aware of |
53 | the cluster setup, and they can use the same network and storage resources as | |
54 | virtual machines. You can also use the {pve} firewall, or manage containers | |
55 | using the HA framework. | |
4a2ae9ed | 56 | |
fd7fb228 DW |
57 | Our primary goal is to offer an environment that provides the benefits of using a |
58 | VM, but without the additional overhead. This means that Proxmox Containers can | |
59 | be categorized as ``System Containers'', rather than ``Application Containers''. | |
4a2ae9ed | 60 | |
fd7fb228 DW |
61 | NOTE: If you want to run application containers, for example, 'Docker' images, it |
62 | is recommended that you run them inside a Proxmox Qemu VM. This will give you | |
63 | all the advantages of application containerization, while also providing the | |
64 | benefits that VMs offer, such as strong isolation from the host and the ability | |
65 | to live-migrate, which otherwise isn't possible with containers. | |
4a2ae9ed DM |
66 | |
67 | ||
99f6ae1a DM |
68 | Technology Overview |
69 | ------------------- | |
70 | ||
71 | * LXC (https://linuxcontainers.org/) | |
72 | ||
6d718b9b | 73 | * Integrated into {pve} graphical web user interface (GUI) |
99f6ae1a DM |
74 | |
75 | * Easy to use command line tool `pct` | |
76 | ||
77 | * Access via {pve} REST API | |
78 | ||
6d718b9b | 79 | * 'lxcfs' to provide containerized /proc file system |
99f6ae1a | 80 | |
6d718b9b | 81 | * Control groups ('cgroups') for resource isolation and limitation |
99f6ae1a | 82 | |
6d718b9b | 83 | * 'AppArmor' and 'seccomp' to improve security |
99f6ae1a | 84 | |
14e97811 | 85 | * Modern Linux kernels |
99f6ae1a | 86 | |
a645c907 | 87 | * Image based deployment (xref:pct_supported_distributions[templates]) |
99f6ae1a | 88 | |
6d718b9b | 89 | * Uses {pve} xref:chapter_storage[storage library] |
99f6ae1a | 90 | |
14e97811 | 91 | * Container setup from host (network, DNS, storage, etc.) |
99f6ae1a | 92 | |
69ab602f | 93 | |
a645c907 OB |
94 | [[pct_supported_distributions]] |
95 | Supported Distributions | |
109ca764 | 96 | ----------------------- |
a645c907 OB |
97 | |
98 | List of officially supported distributions can be found below. | |
99 | ||
100 | Templates for the following distributions are available through our | |
101 | repositories. You can use xref:pct_container_images[pveam] tool or the | |
102 | Graphical User Interface to download them. | |
103 | ||
104 | Alpine Linux | |
109ca764 | 105 | ~~~~~~~~~~~~ |
a645c907 OB |
106 | |
107 | [quote, 'https://alpinelinux.org'] | |
108 | ____ | |
70292f72 TL |
109 | Alpine Linux is a security-oriented, lightweight Linux distribution based on |
110 | musl libc and busybox. | |
a645c907 OB |
111 | ____ |
112 | ||
fc9c969d TL |
113 | For currently supported releases see: |
114 | ||
115 | https://alpinelinux.org/releases/ | |
a645c907 | 116 | |
109ca764 TL |
117 | Arch Linux |
118 | ~~~~~~~~~~ | |
a645c907 | 119 | |
70292f72 | 120 | [quote, 'https://archlinux.org/'] |
a645c907 | 121 | ____ |
70292f72 | 122 | Arch Linux, a lightweight and flexible Linux® distribution that tries to Keep It Simple. |
a645c907 OB |
123 | ____ |
124 | ||
e1508ce8 TL |
125 | Arch Linux is using a rolling-release model, see its wiki for more details: |
126 | ||
127 | https://wiki.archlinux.org/title/Arch_Linux | |
a645c907 OB |
128 | |
129 | CentOS, Almalinux, Rocky Linux | |
109ca764 | 130 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
a645c907 | 131 | |
109ca764 TL |
132 | CentOS / CentOS Stream |
133 | ^^^^^^^^^^^^^^^^^^^^^^ | |
a645c907 OB |
134 | |
135 | [quote, 'https://centos.org'] | |
136 | ____ | |
70292f72 | 137 | The CentOS Linux distribution is a stable, predictable, manageable and |
a645c907 | 138 | reproducible platform derived from the sources of Red Hat Enterprise Linux |
70292f72 | 139 | (RHEL) |
a645c907 OB |
140 | ____ |
141 | ||
e1508ce8 TL |
142 | For currently supported releases see: |
143 | ||
a645c907 OB |
144 | https://wiki.centos.org/About/Product |
145 | ||
109ca764 TL |
146 | Almalinux |
147 | ^^^^^^^^^ | |
a645c907 OB |
148 | |
149 | [quote, 'https://almalinux.org'] | |
150 | ____ | |
70292f72 TL |
151 | An Open Source, community owned and governed, forever-free enterprise Linux |
152 | distribution, focused on long-term stability, providing a robust | |
153 | production-grade platform. AlmaLinux OS is 1:1 binary compatible with RHEL® and | |
154 | pre-Stream CentOS. | |
a645c907 OB |
155 | ____ |
156 | ||
157 | ||
e1508ce8 TL |
158 | For currently supported releases see: |
159 | ||
a645c907 OB |
160 | https://en.wikipedia.org/wiki/AlmaLinux#Releases |
161 | ||
109ca764 TL |
162 | Rocky Linux |
163 | ^^^^^^^^^^^ | |
a645c907 OB |
164 | |
165 | [quote, 'https://rockylinux.org'] | |
166 | ____ | |
70292f72 TL |
167 | Rocky Linux is a community enterprise operating system designed to be 100% |
168 | bug-for-bug compatible with America's top enterprise Linux distribution now | |
169 | that its downstream partner has shifted direction. | |
a645c907 OB |
170 | ____ |
171 | ||
e1508ce8 TL |
172 | For currently supported releases see: |
173 | ||
a645c907 OB |
174 | https://en.wikipedia.org/wiki/Rocky_Linux#Releases |
175 | ||
a645c907 | 176 | Debian |
109ca764 | 177 | ~~~~~~ |
a645c907 OB |
178 | |
179 | [quote, 'https://www.debian.org/intro/index#software'] | |
180 | ____ | |
70292f72 | 181 | Debian is a free operating system, developed and maintained by the Debian |
a645c907 | 182 | project. A free Linux distribution with thousands of applications to meet our |
70292f72 | 183 | users' needs. |
a645c907 OB |
184 | ____ |
185 | ||
e1508ce8 TL |
186 | For currently supported releases see: |
187 | ||
a645c907 OB |
188 | https://www.debian.org/releases/stable/releasenotes |
189 | ||
190 | Devuan | |
109ca764 | 191 | ~~~~~~ |
a645c907 OB |
192 | |
193 | [quote, 'https://www.devuan.org'] | |
194 | ____ | |
70292f72 | 195 | Devuan GNU+Linux is a fork of Debian without systemd that allows users to |
a645c907 | 196 | reclaim control over their system by avoiding unnecessary entanglements and |
70292f72 | 197 | ensuring Init Freedom. |
a645c907 OB |
198 | ____ |
199 | ||
e1508ce8 TL |
200 | For currently supported releases see: |
201 | ||
202 | https://www.devuan.org/os/releases | |
a645c907 OB |
203 | |
204 | Fedora | |
109ca764 | 205 | ~~~~~~ |
a645c907 OB |
206 | |
207 | [quote, 'https://getfedora.org'] | |
208 | ____ | |
70292f72 | 209 | Fedora creates an innovative, free, and open source platform for hardware, |
a645c907 | 210 | clouds, and containers that enables software developers and community members |
70292f72 | 211 | to build tailored solutions for their users. |
a645c907 OB |
212 | ____ |
213 | ||
e1508ce8 TL |
214 | For currently supported releases see: |
215 | ||
a645c907 OB |
216 | https://fedoraproject.org/wiki/Releases |
217 | ||
218 | Gentoo | |
109ca764 | 219 | ~~~~~~ |
a645c907 OB |
220 | |
221 | [quote, 'https://www.gentoo.org'] | |
222 | ____ | |
70292f72 | 223 | a highly flexible, source-based Linux distribution. |
a645c907 OB |
224 | ____ |
225 | ||
e1508ce8 TL |
226 | Gentoo is using a rolling-release model. |
227 | ||
a645c907 | 228 | OpenSUSE |
109ca764 | 229 | ~~~~~~~~ |
a645c907 OB |
230 | |
231 | [quote, 'https://www.opensuse.org'] | |
232 | ____ | |
70292f72 | 233 | The makers' choice for sysadmins, developers and desktop users. |
a645c907 OB |
234 | ____ |
235 | ||
e1508ce8 TL |
236 | For currently supported releases see: |
237 | ||
a645c907 OB |
238 | https://get.opensuse.org/leap/ |
239 | ||
240 | Ubuntu | |
109ca764 | 241 | ~~~~~~ |
a645c907 | 242 | |
70292f72 | 243 | [quote, 'https://ubuntu.com/'] |
a645c907 | 244 | ____ |
70292f72 TL |
245 | Ubuntu is the modern, open source operating system on Linux for the enterprise |
246 | server, desktop, cloud, and IoT. | |
a645c907 OB |
247 | ____ |
248 | ||
e1508ce8 TL |
249 | For currently supported releases see: |
250 | ||
a645c907 OB |
251 | https://wiki.ubuntu.com/Releases |
252 | ||
80c0adcb | 253 | [[pct_container_images]] |
d61bab51 DM |
254 | Container Images |
255 | ---------------- | |
256 | ||
8c1189b6 | 257 | Container images, sometimes also referred to as ``templates'' or |
69ab602f | 258 | ``appliances'', are `tar` archives which contain everything to run a container. |
d61bab51 | 259 | |
a645c907 OB |
260 | {pve} itself provides a variety of basic templates for the |
261 | xref:pct_supported_distributions[most common Linux distributions]. They can be | |
262 | downloaded using the GUI or the `pveam` (short for {pve} Appliance Manager) | |
263 | command line utility. Additionally, https://www.turnkeylinux.org/[TurnKey | |
264 | Linux] container templates are also available to download. | |
d61bab51 | 265 | |
2a368b1e TL |
266 | The list of available templates is updated daily through the 'pve-daily-update' |
267 | timer. You can also trigger an update manually by executing: | |
3a6fa247 | 268 | |
14e97811 OB |
269 | ---- |
270 | # pveam update | |
271 | ---- | |
3a6fa247 | 272 | |
14e97811 | 273 | To view the list of available images run: |
3a6fa247 | 274 | |
14e97811 OB |
275 | ---- |
276 | # pveam available | |
277 | ---- | |
3a6fa247 | 278 | |
8c1189b6 FG |
279 | You can restrict this large list by specifying the `section` you are |
280 | interested in, for example basic `system` images: | |
3a6fa247 DM |
281 | |
282 | .List available system images | |
283 | ---- | |
284 | # pveam available --section system | |
151bbda8 TL |
285 | system alpine-3.12-default_20200823_amd64.tar.xz |
286 | system alpine-3.13-default_20210419_amd64.tar.xz | |
287 | system alpine-3.14-default_20210623_amd64.tar.xz | |
288 | system archlinux-base_20210420-1_amd64.tar.gz | |
14e97811 | 289 | system centos-7-default_20190926_amd64.tar.xz |
151bbda8 | 290 | system centos-8-default_20201210_amd64.tar.xz |
14e97811 | 291 | system debian-9.0-standard_9.7-1_amd64.tar.gz |
151bbda8 TL |
292 | system debian-10-standard_10.7-1_amd64.tar.gz |
293 | system devuan-3.0-standard_3.0_amd64.tar.gz | |
294 | system fedora-33-default_20201115_amd64.tar.xz | |
295 | system fedora-34-default_20210427_amd64.tar.xz | |
296 | system gentoo-current-default_20200310_amd64.tar.xz | |
297 | system opensuse-15.2-default_20200824_amd64.tar.xz | |
14e97811 OB |
298 | system ubuntu-16.04-standard_16.04.5-1_amd64.tar.gz |
299 | system ubuntu-18.04-standard_18.04.1-1_amd64.tar.gz | |
151bbda8 TL |
300 | system ubuntu-20.04-standard_20.04-1_amd64.tar.gz |
301 | system ubuntu-20.10-standard_20.10-1_amd64.tar.gz | |
302 | system ubuntu-21.04-standard_21.04-1_amd64.tar.gz | |
3a6fa247 DM |
303 | ---- |
304 | ||
69ab602f | 305 | Before you can use such a template, you need to download them into one of your |
2a368b1e TL |
306 | storages. If you're unsure to which one, you can simply use the `local` named |
307 | storage for that purpose. For clustered installations, it is preferred to use a | |
308 | shared storage so that all nodes can access those images. | |
3a6fa247 | 309 | |
14e97811 OB |
310 | ---- |
311 | # pveam download local debian-10.0-standard_10.0-1_amd64.tar.gz | |
312 | ---- | |
3a6fa247 | 313 | |
69ab602f TL |
314 | You are now ready to create containers using that image, and you can list all |
315 | downloaded images on storage `local` with: | |
24f73a63 DM |
316 | |
317 | ---- | |
318 | # pveam list local | |
14e97811 | 319 | local:vztmpl/debian-10.0-standard_10.0-1_amd64.tar.gz 219.95MB |
24f73a63 DM |
320 | ---- |
321 | ||
2a368b1e TL |
322 | TIP: You can also use the {pve} web interface GUI to download, list and delete |
323 | container templates. | |
324 | ||
325 | `pct` uses them to create a new container, for example: | |
326 | ||
327 | ---- | |
328 | # pct create 999 local:vztmpl/debian-10.0-standard_10.0-1_amd64.tar.gz | |
329 | ---- | |
330 | ||
69ab602f TL |
331 | The above command shows you the full {pve} volume identifiers. They include the |
332 | storage name, and most other {pve} commands can use them. For example you can | |
333 | delete that image later with: | |
24f73a63 | 334 | |
14e97811 OB |
335 | ---- |
336 | # pveam remove local:vztmpl/debian-10.0-standard_10.0-1_amd64.tar.gz | |
337 | ---- | |
d61bab51 | 338 | |
690cd737 | 339 | |
f3afbb70 | 340 | [[pct_settings]] |
4f785ca7 DM |
341 | Container Settings |
342 | ------------------ | |
343 | ||
304eb5a9 EK |
344 | [[pct_general]] |
345 | General Settings | |
346 | ~~~~~~~~~~~~~~~~ | |
347 | ||
1ff5e4e8 | 348 | [thumbnail="screenshot/gui-create-ct-general.png"] |
2225402c | 349 | |
304eb5a9 EK |
350 | General settings of a container include |
351 | ||
352 | * the *Node* : the physical server on which the container will run | |
69ab602f TL |
353 | * the *CT ID*: a unique number in this {pve} installation used to identify your |
354 | container | |
304eb5a9 EK |
355 | * *Hostname*: the hostname of the container |
356 | * *Resource Pool*: a logical group of containers and VMs | |
357 | * *Password*: the root password of the container | |
358 | * *SSH Public Key*: a public key for connecting to the root account over SSH | |
359 | * *Unprivileged container*: this option allows to choose at creation time | |
69ab602f | 360 | if you want to create a privileged or unprivileged container. |
304eb5a9 | 361 | |
14e97811 OB |
362 | Unprivileged Containers |
363 | ^^^^^^^^^^^^^^^^^^^^^^^ | |
364 | ||
69ab602f TL |
365 | Unprivileged containers use a new kernel feature called user namespaces. |
366 | The root UID 0 inside the container is mapped to an unprivileged user outside | |
367 | the container. This means that most security issues (container escape, resource | |
14e97811 OB |
368 | abuse, etc.) in these containers will affect a random unprivileged user, and |
369 | would be a generic kernel security bug rather than an LXC issue. The LXC team | |
370 | thinks unprivileged containers are safe by design. | |
371 | ||
372 | This is the default option when creating a new container. | |
373 | ||
69ab602f TL |
374 | NOTE: If the container uses systemd as an init system, please be aware the |
375 | systemd version running inside the container should be equal to or greater than | |
376 | 220. | |
14e97811 | 377 | |
304eb5a9 EK |
378 | |
379 | Privileged Containers | |
380 | ^^^^^^^^^^^^^^^^^^^^^ | |
381 | ||
c02ac25b TL |
382 | Security in containers is achieved by using mandatory access control 'AppArmor' |
383 | restrictions, 'seccomp' filters and Linux kernel namespaces. The LXC team | |
384 | considers this kind of container as unsafe, and they will not consider new | |
385 | container escape exploits to be security issues worthy of a CVE and quick fix. | |
386 | That's why privileged containers should only be used in trusted environments. | |
304eb5a9 | 387 | |
304eb5a9 | 388 | |
9a5e9443 | 389 | [[pct_cpu]] |
9a5e9443 DM |
390 | CPU |
391 | ~~~ | |
392 | ||
1ff5e4e8 | 393 | [thumbnail="screenshot/gui-create-ct-cpu.png"] |
097aa949 | 394 | |
14e97811 OB |
395 | You can restrict the number of visible CPUs inside the container using the |
396 | `cores` option. This is implemented using the Linux 'cpuset' cgroup | |
69ab602f TL |
397 | (**c**ontrol *group*). |
398 | A special task inside `pvestatd` tries to distribute running containers among | |
399 | available CPUs periodically. | |
400 | To view the assigned CPUs run the following command: | |
9a5e9443 DM |
401 | |
402 | ---- | |
403 | # pct cpusets | |
404 | --------------------- | |
405 | 102: 6 7 | |
406 | 105: 2 3 4 5 | |
407 | 108: 0 1 | |
408 | --------------------- | |
409 | ---- | |
410 | ||
14e97811 OB |
411 | Containers use the host kernel directly. All tasks inside a container are |
412 | handled by the host CPU scheduler. {pve} uses the Linux 'CFS' (**C**ompletely | |
413 | **F**air **S**cheduler) scheduler by default, which has additional bandwidth | |
414 | control options. | |
9a5e9443 DM |
415 | |
416 | [horizontal] | |
0725e3c6 | 417 | |
69ab602f TL |
418 | `cpulimit`: :: You can use this option to further limit assigned CPU time. |
419 | Please note that this is a floating point number, so it is perfectly valid to | |
420 | assign two cores to a container, but restrict overall CPU consumption to half a | |
421 | core. | |
9a5e9443 DM |
422 | + |
423 | ---- | |
424 | cores: 2 | |
425 | cpulimit: 0.5 | |
426 | ---- | |
427 | ||
69ab602f TL |
428 | `cpuunits`: :: This is a relative weight passed to the kernel scheduler. The |
429 | larger the number is, the more CPU time this container gets. Number is relative | |
430 | to the weights of all the other running containers. The default is 1024. You | |
431 | can use this setting to prioritize some containers. | |
9a5e9443 DM |
432 | |
433 | ||
434 | [[pct_memory]] | |
435 | Memory | |
436 | ~~~~~~ | |
437 | ||
1ff5e4e8 | 438 | [thumbnail="screenshot/gui-create-ct-memory.png"] |
097aa949 | 439 | |
9a5e9443 DM |
440 | Container memory is controlled using the cgroup memory controller. |
441 | ||
442 | [horizontal] | |
443 | ||
69ab602f TL |
444 | `memory`: :: Limit overall memory usage. This corresponds to the |
445 | `memory.limit_in_bytes` cgroup setting. | |
9a5e9443 | 446 | |
69ab602f TL |
447 | `swap`: :: Allows the container to use additional swap memory from the host |
448 | swap space. This corresponds to the `memory.memsw.limit_in_bytes` cgroup | |
449 | setting, which is set to the sum of both value (`memory + swap`). | |
9a5e9443 | 450 | |
4f785ca7 DM |
451 | |
452 | [[pct_mount_points]] | |
9e44e493 DM |
453 | Mount Points |
454 | ~~~~~~~~~~~~ | |
eeecce95 | 455 | |
1ff5e4e8 | 456 | [thumbnail="screenshot/gui-create-ct-root-disk.png"] |
097aa949 | 457 | |
14e97811 | 458 | The root mount point is configured with the `rootfs` property. You can |
69ab602f TL |
459 | configure up to 256 additional mount points. The corresponding options are |
460 | called `mp0` to `mp255`. They can contain the following settings: | |
01639994 FG |
461 | |
462 | include::pct-mountpoint-opts.adoc[] | |
463 | ||
69ab602f TL |
464 | Currently there are three types of mount points: storage backed mount points, |
465 | bind mounts, and device mounts. | |
9e44e493 | 466 | |
5eba0743 | 467 | .Typical container `rootfs` configuration |
4c3b5c77 DM |
468 | ---- |
469 | rootfs: thin1:base-100-disk-1,size=8G | |
470 | ---- | |
471 | ||
472 | ||
5eba0743 | 473 | Storage Backed Mount Points |
4c3b5c77 | 474 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
01639994 | 475 | |
9e44e493 | 476 | Storage backed mount points are managed by the {pve} storage subsystem and come |
eeecce95 WB |
477 | in three different flavors: |
478 | ||
5eba0743 | 479 | - Image based: these are raw images containing a single ext4 formatted file |
eeecce95 | 480 | system. |
5eba0743 | 481 | - ZFS subvolumes: these are technically bind mounts, but with managed storage, |
eeecce95 WB |
482 | and thus allow resizing and snapshotting. |
483 | - Directories: passing `size=0` triggers a special case where instead of a raw | |
484 | image a directory is created. | |
485 | ||
03782251 FG |
486 | NOTE: The special option syntax `STORAGE_ID:SIZE_IN_GB` for storage backed |
487 | mount point volumes will automatically allocate a volume of the specified size | |
69ab602f TL |
488 | on the specified storage. For example, calling |
489 | ||
490 | ---- | |
491 | pct set 100 -mp0 thin1:10,mp=/path/in/container | |
492 | ---- | |
493 | ||
494 | will allocate a 10GB volume on the storage `thin1` and replace the volume ID | |
495 | place holder `10` with the allocated volume ID, and setup the moutpoint in the | |
496 | container at `/path/in/container` | |
03782251 | 497 | |
4c3b5c77 | 498 | |
5eba0743 | 499 | Bind Mount Points |
4c3b5c77 | 500 | ^^^^^^^^^^^^^^^^^ |
01639994 | 501 | |
9baca183 FG |
502 | Bind mounts allow you to access arbitrary directories from your Proxmox VE host |
503 | inside a container. Some potential use cases are: | |
504 | ||
505 | - Accessing your home directory in the guest | |
506 | - Accessing an USB device directory in the guest | |
acccc49b | 507 | - Accessing an NFS mount from the host in the guest |
9baca183 | 508 | |
eeecce95 | 509 | Bind mounts are considered to not be managed by the storage subsystem, so you |
9baca183 | 510 | cannot make snapshots or deal with quotas from inside the container. With |
eeecce95 | 511 | unprivileged containers you might run into permission problems caused by the |
9baca183 FG |
512 | user mapping and cannot use ACLs. |
513 | ||
8c1189b6 | 514 | NOTE: The contents of bind mount points are not backed up when using `vzdump`. |
eeecce95 | 515 | |
69ab602f TL |
516 | WARNING: For security reasons, bind mounts should only be established using |
517 | source directories especially reserved for this purpose, e.g., a directory | |
518 | hierarchy under `/mnt/bindmounts`. Never bind mount system directories like | |
519 | `/`, `/var` or `/etc` into a container - this poses a great security risk. | |
9baca183 FG |
520 | |
521 | NOTE: The bind mount source path must not contain any symlinks. | |
522 | ||
523 | For example, to make the directory `/mnt/bindmounts/shared` accessible in the | |
55eeea33 OB |
524 | container with ID `100` under the path `/shared`, add a configuration line such as: |
525 | ||
526 | ---- | |
527 | mp0: /mnt/bindmounts/shared,mp=/shared | |
528 | ---- | |
529 | ||
530 | into `/etc/pve/lxc/100.conf`. | |
531 | ||
532 | Or alternatively use the `pct` tool: | |
533 | ||
534 | ---- | |
535 | pct set 100 -mp0 /mnt/bindmounts/shared,mp=/shared | |
536 | ---- | |
537 | ||
538 | to achieve the same result. | |
6b707f2c | 539 | |
4c3b5c77 | 540 | |
5eba0743 | 541 | Device Mount Points |
4c3b5c77 | 542 | ^^^^^^^^^^^^^^^^^^^ |
fe154a4f | 543 | |
7432d78e FG |
544 | Device mount points allow to mount block devices of the host directly into the |
545 | container. Similar to bind mounts, device mounts are not managed by {PVE}'s | |
546 | storage subsystem, but the `quota` and `acl` options will be honored. | |
547 | ||
548 | NOTE: Device mount points should only be used under special circumstances. In | |
549 | most cases a storage backed mount point offers the same performance and a lot | |
550 | more features. | |
551 | ||
69ab602f TL |
552 | NOTE: The contents of device mount points are not backed up when using |
553 | `vzdump`. | |
01639994 | 554 | |
4c3b5c77 | 555 | |
80c0adcb | 556 | [[pct_container_network]] |
f5c351f0 DM |
557 | Network |
558 | ~~~~~~~ | |
04c569f6 | 559 | |
1ff5e4e8 | 560 | [thumbnail="screenshot/gui-create-ct-network.png"] |
097aa949 | 561 | |
69ab602f TL |
562 | You can configure up to 10 network interfaces for a single container. |
563 | The corresponding options are called `net0` to `net9`, and they can contain the | |
564 | following setting: | |
bac8c385 DM |
565 | |
566 | include::pct-network-opts.adoc[] | |
04c569f6 DM |
567 | |
568 | ||
139a9019 DM |
569 | [[pct_startup_and_shutdown]] |
570 | Automatic Start and Shutdown of Containers | |
571 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
572 | ||
14e97811 OB |
573 | To automatically start a container when the host system boots, select the |
574 | option 'Start at boot' in the 'Options' panel of the container in the web | |
575 | interface or run the following command: | |
139a9019 | 576 | |
14e97811 OB |
577 | ---- |
578 | # pct set CTID -onboot 1 | |
579 | ---- | |
139a9019 | 580 | |
4dbeb548 DM |
581 | .Start and Shutdown Order |
582 | // use the screenshot from qemu - its the same | |
1ff5e4e8 | 583 | [thumbnail="screenshot/gui-qemu-edit-start-order.png"] |
4dbeb548 | 584 | |
69ab602f TL |
585 | If you want to fine tune the boot order of your containers, you can use the |
586 | following parameters: | |
139a9019 | 587 | |
69ab602f TL |
588 | * *Start/Shutdown order*: Defines the start order priority. For example, set it |
589 | to 1 if you want the CT to be the first to be started. (We use the reverse | |
590 | startup order for shutdown, so a container with a start order of 1 would be | |
591 | the last to be shut down) | |
592 | * *Startup delay*: Defines the interval between this container start and | |
593 | subsequent containers starts. For example, set it to 240 if you want to wait | |
594 | 240 seconds before starting other containers. | |
139a9019 | 595 | * *Shutdown timeout*: Defines the duration in seconds {pve} should wait |
69ab602f TL |
596 | for the container to be offline after issuing a shutdown command. |
597 | By default this value is set to 60, which means that {pve} will issue a | |
598 | shutdown request, wait 60s for the machine to be offline, and if after 60s | |
599 | the machine is still online will notify that the shutdown action failed. | |
139a9019 | 600 | |
69ab602f TL |
601 | Please note that containers without a Start/Shutdown order parameter will |
602 | always start after those where the parameter is set, and this parameter only | |
139a9019 DM |
603 | makes sense between the machines running locally on a host, and not |
604 | cluster-wide. | |
605 | ||
0f7778ac DW |
606 | If you require a delay between the host boot and the booting of the first |
607 | container, see the section on | |
608 | xref:first_guest_boot_delay[Proxmox VE Node Management]. | |
609 | ||
610 | ||
c2c8eb89 DC |
611 | Hookscripts |
612 | ~~~~~~~~~~~ | |
613 | ||
614 | You can add a hook script to CTs with the config property `hookscript`. | |
615 | ||
14e97811 OB |
616 | ---- |
617 | # pct set 100 -hookscript local:snippets/hookscript.pl | |
618 | ---- | |
c2c8eb89 | 619 | |
69ab602f TL |
620 | It will be called during various phases of the guests lifetime. For an example |
621 | and documentation see the example script under | |
c2c8eb89 | 622 | `/usr/share/pve-docs/examples/guest-example-hookscript.pl`. |
139a9019 | 623 | |
bf7f598a TL |
624 | Security Considerations |
625 | ----------------------- | |
626 | ||
627 | Containers use the kernel of the host system. This exposes an attack surface | |
628 | for malicious users. In general, full virtual machines provide better | |
656d8b21 | 629 | isolation. This should be considered if containers are provided to unknown or |
bf7f598a TL |
630 | untrusted people. |
631 | ||
632 | To reduce the attack surface, LXC uses many security features like AppArmor, | |
633 | CGroups and kernel namespaces. | |
634 | ||
c02ac25b TL |
635 | AppArmor |
636 | ~~~~~~~~ | |
637 | ||
bf7f598a TL |
638 | AppArmor profiles are used to restrict access to possibly dangerous actions. |
639 | Some system calls, i.e. `mount`, are prohibited from execution. | |
640 | ||
641 | To trace AppArmor activity, use: | |
642 | ||
643 | ---- | |
644 | # dmesg | grep apparmor | |
645 | ---- | |
646 | ||
c02ac25b TL |
647 | Although it is not recommended, AppArmor can be disabled for a container. This |
648 | brings security risks with it. Some syscalls can lead to privilege escalation | |
649 | when executed within a container if the system is misconfigured or if a LXC or | |
650 | Linux Kernel vulnerability exists. | |
651 | ||
652 | To disable AppArmor for a container, add the following line to the container | |
653 | configuration file located at `/etc/pve/lxc/CTID.conf`: | |
654 | ||
655 | ---- | |
76aaaeab | 656 | lxc.apparmor.profile = unconfined |
c02ac25b TL |
657 | ---- |
658 | ||
659 | WARNING: Please note that this is not recommended for production use. | |
660 | ||
661 | ||
17238cd3 WB |
662 | [[pct_cgroup]] |
663 | Control Groups ('cgroup') | |
664 | ~~~~~~~~~~~~~~~~~~~~~~~~~ | |
665 | ||
666 | 'cgroup' is a kernel | |
667 | mechanism used to hierarchically organize processes and distribute system | |
668 | resources. | |
669 | ||
670 | The main resources controlled via 'cgroups' are CPU time, memory and swap | |
671 | limits, and access to device nodes. 'cgroups' are also used to "freeze" a | |
672 | container before taking snapshots. | |
673 | ||
674 | There are 2 versions of 'cgroups' currently available, | |
675 | https://www.kernel.org/doc/html/v5.11/admin-guide/cgroup-v1/index.html[legacy] | |
676 | and | |
677 | https://www.kernel.org/doc/html/v5.11/admin-guide/cgroup-v2.html['cgroupv2']. | |
678 | ||
679 | Since {pve} 7.0, the default is a pure 'cgroupv2' environment. Previously a | |
680 | "hybrid" setup was used, where resource control was mainly done in 'cgroupv1' | |
681 | with an additional 'cgroupv2' controller which could take over some subsystems | |
682 | via the 'cgroup_no_v1' kernel command line parameter. (See the | |
683 | https://www.kernel.org/doc/html/latest/admin-guide/kernel-parameters.html[kernel | |
684 | parameter documentation] for details.) | |
685 | ||
75d3c2be TL |
686 | [[pct_cgroup_compat]] |
687 | CGroup Version Compatibility | |
688 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
17238cd3 WB |
689 | The main difference between pure 'cgroupv2' and the old hybrid environments |
690 | regarding {pve} is that with 'cgroupv2' memory and swap are now controlled | |
691 | independently. The memory and swap settings for containers can map directly to | |
692 | these values, whereas previously only the memory limit and the limit of the | |
693 | *sum* of memory and swap could be limited. | |
694 | ||
695 | Another important difference is that the 'devices' controller is configured in a | |
696 | completely different way. Because of this, file system quotas are currently not | |
697 | supported in a pure 'cgroupv2' environment. | |
698 | ||
c80d381a SI |
699 | 'cgroupv2' support by the container's OS is needed to run in a pure 'cgroupv2' |
700 | environment. Containers running 'systemd' version 231 or newer support | |
701 | 'cgroupv2' footnote:[this includes all newest major versions of container | |
702 | templates shipped by {pve}], as do containers not using 'systemd' as init | |
703 | system footnote:[for example Alpine Linux]. | |
704 | ||
75d3c2be TL |
705 | [NOTE] |
706 | ==== | |
707 | CentOS 7 and Ubuntu 16.10 are two prominent Linux distributions releases, | |
708 | which have a 'systemd' version that is too old to run in a 'cgroupv2' | |
709 | environment, you can either | |
c80d381a | 710 | |
75d3c2be TL |
711 | * Upgrade the whole distribution to a newer release. For the examples above, that |
712 | could be Ubuntu 18.04 or 20.04, and CentOS 8 (or RHEL/CentOS derivatives like | |
713 | AlmaLinux or Rocky Linux). This has the benefit to get the newest bug and | |
714 | security fixes, often also new features, and moving the EOL date in the future. | |
715 | ||
716 | * Upgrade the Containers systemd version. If the distribution provides a | |
717 | backports repository this can be an easy and quick stop-gap measurement. | |
718 | ||
719 | * Move the container, or its services, to a Virtual Machine. Virtual Machines | |
720 | have a much less interaction with the host, that's why one can install | |
721 | decades old OS versions just fine there. | |
722 | ||
723 | * Switch back to the legacy 'cgroup' controller. Note that while it can be a | |
724 | valid solution, it's not a permanent one. There's a high likelihood that a | |
725 | future {pve} major release, for example 8.0, cannot support the legacy | |
726 | controller anymore. | |
727 | ==== | |
728 | ||
729 | [[pct_cgroup_change_version]] | |
730 | Changing CGroup Version | |
731 | ^^^^^^^^^^^^^^^^^^^^^^^ | |
732 | ||
733 | TIP: If file system quotas are not required and all containers support 'cgroupv2', | |
c80d381a | 734 | it is recommended to stick to the new default. |
17238cd3 WB |
735 | |
736 | To switch back to the previous version the following kernel command line | |
737 | parameter can be used: | |
738 | ||
739 | ---- | |
740 | systemd.unified_cgroup_hierarchy=0 | |
741 | ---- | |
742 | ||
743 | See xref:sysboot_edit_kernel_cmdline[this section] on editing the kernel boot | |
744 | command line on where to add the parameter. | |
745 | ||
746 | // TODO: seccomp a bit more. | |
c02ac25b TL |
747 | // TODO: pve-lxc-syscalld |
748 | ||
749 | ||
0892a2c2 TL |
750 | Guest Operating System Configuration |
751 | ------------------------------------ | |
752 | ||
753 | {pve} tries to detect the Linux distribution in the container, and modifies | |
754 | some files. Here is a short list of things done at container startup: | |
755 | ||
756 | set /etc/hostname:: to set the container name | |
757 | ||
758 | modify /etc/hosts:: to allow lookup of the local hostname | |
759 | ||
760 | network setup:: pass the complete network setup to the container | |
761 | ||
762 | configure DNS:: pass information about DNS servers | |
763 | ||
764 | adapt the init system:: for example, fix the number of spawned getty processes | |
765 | ||
766 | set the root password:: when creating a new container | |
767 | ||
768 | rewrite ssh_host_keys:: so that each container has unique keys | |
769 | ||
770 | randomize crontab:: so that cron does not start at the same time on all containers | |
771 | ||
772 | Changes made by {PVE} are enclosed by comment markers: | |
773 | ||
774 | ---- | |
775 | # --- BEGIN PVE --- | |
776 | <data> | |
777 | # --- END PVE --- | |
778 | ---- | |
779 | ||
780 | Those markers will be inserted at a reasonable location in the file. If such a | |
781 | section already exists, it will be updated in place and will not be moved. | |
782 | ||
783 | Modification of a file can be prevented by adding a `.pve-ignore.` file for it. | |
784 | For instance, if the file `/etc/.pve-ignore.hosts` exists then the `/etc/hosts` | |
785 | file will not be touched. This can be a simple empty file created via: | |
786 | ||
787 | ---- | |
788 | # touch /etc/.pve-ignore.hosts | |
789 | ---- | |
790 | ||
791 | Most modifications are OS dependent, so they differ between different | |
792 | distributions and versions. You can completely disable modifications by | |
793 | manually setting the `ostype` to `unmanaged`. | |
794 | ||
795 | OS type detection is done by testing for certain files inside the | |
3d5c55fc TL |
796 | container. {pve} first checks the `/etc/os-release` file |
797 | footnote:[/etc/os-release replaces the multitude of per-distribution | |
798 | release files https://manpages.debian.org/stable/systemd/os-release.5.en.html]. | |
799 | If that file is not present, or it does not contain a clearly recognizable | |
800 | distribution identifier the following distribution specific release files are | |
801 | checked. | |
0892a2c2 TL |
802 | |
803 | Ubuntu:: inspect /etc/lsb-release (`DISTRIB_ID=Ubuntu`) | |
804 | ||
805 | Debian:: test /etc/debian_version | |
806 | ||
807 | Fedora:: test /etc/fedora-release | |
808 | ||
809 | RedHat or CentOS:: test /etc/redhat-release | |
810 | ||
811 | ArchLinux:: test /etc/arch-release | |
812 | ||
813 | Alpine:: test /etc/alpine-release | |
814 | ||
815 | Gentoo:: test /etc/gentoo-release | |
816 | ||
817 | NOTE: Container start fails if the configured `ostype` differs from the auto | |
818 | detected type. | |
819 | ||
820 | ||
b0df9949 TL |
821 | [[pct_container_storage]] |
822 | Container Storage | |
823 | ----------------- | |
824 | ||
825 | The {pve} LXC container storage model is more flexible than traditional | |
826 | container storage models. A container can have multiple mount points. This | |
827 | makes it possible to use the best suited storage for each application. | |
828 | ||
829 | For example the root file system of the container can be on slow and cheap | |
830 | storage while the database can be on fast and distributed storage via a second | |
831 | mount point. See section <<pct_mount_points, Mount Points>> for further | |
832 | details. | |
833 | ||
834 | Any storage type supported by the {pve} storage library can be used. This means | |
835 | that containers can be stored on local (for example `lvm`, `zfs` or directory), | |
836 | shared external (like `iSCSI`, `NFS`) or even distributed storage systems like | |
837 | Ceph. Advanced storage features like snapshots or clones can be used if the | |
838 | underlying storage supports them. The `vzdump` backup tool can use snapshots to | |
839 | provide consistent container backups. | |
840 | ||
841 | Furthermore, local devices or local directories can be mounted directly using | |
842 | 'bind mounts'. This gives access to local resources inside a container with | |
843 | practically zero overhead. Bind mounts can be used as an easy way to share data | |
844 | between containers. | |
845 | ||
846 | ||
847 | FUSE Mounts | |
848 | ~~~~~~~~~~~ | |
849 | ||
850 | WARNING: Because of existing issues in the Linux kernel's freezer subsystem the | |
851 | usage of FUSE mounts inside a container is strongly advised against, as | |
852 | containers need to be frozen for suspend or snapshot mode backups. | |
853 | ||
854 | If FUSE mounts cannot be replaced by other mounting mechanisms or storage | |
855 | technologies, it is possible to establish the FUSE mount on the Proxmox host | |
856 | and use a bind mount point to make it accessible inside the container. | |
857 | ||
858 | ||
859 | Using Quotas Inside Containers | |
860 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
861 | ||
862 | Quotas allow to set limits inside a container for the amount of disk space that | |
863 | each user can use. | |
864 | ||
17238cd3 WB |
865 | NOTE: This currently requires the use of legacy 'cgroups'. |
866 | ||
b0df9949 TL |
867 | NOTE: This only works on ext4 image based storage types and currently only |
868 | works with privileged containers. | |
869 | ||
870 | Activating the `quota` option causes the following mount options to be used for | |
871 | a mount point: | |
872 | `usrjquota=aquota.user,grpjquota=aquota.group,jqfmt=vfsv0` | |
873 | ||
874 | This allows quotas to be used like on any other system. You can initialize the | |
875 | `/aquota.user` and `/aquota.group` files by running: | |
876 | ||
877 | ---- | |
878 | # quotacheck -cmug / | |
879 | # quotaon / | |
880 | ---- | |
881 | ||
882 | Then edit the quotas using the `edquota` command. Refer to the documentation of | |
883 | the distribution running inside the container for details. | |
884 | ||
885 | NOTE: You need to run the above commands for every mount point by passing the | |
886 | mount point's path instead of just `/`. | |
887 | ||
888 | ||
889 | Using ACLs Inside Containers | |
890 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
891 | ||
892 | The standard Posix **A**ccess **C**ontrol **L**ists are also available inside | |
893 | containers. ACLs allow you to set more detailed file ownership than the | |
894 | traditional user/group/others model. | |
895 | ||
896 | ||
897 | Backup of Container mount points | |
898 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
899 | ||
900 | To include a mount point in backups, enable the `backup` option for it in the | |
901 | container configuration. For an existing mount point `mp0` | |
902 | ||
903 | ---- | |
904 | mp0: guests:subvol-100-disk-1,mp=/root/files,size=8G | |
905 | ---- | |
906 | ||
907 | add `backup=1` to enable it. | |
908 | ||
909 | ---- | |
910 | mp0: guests:subvol-100-disk-1,mp=/root/files,size=8G,backup=1 | |
911 | ---- | |
912 | ||
913 | NOTE: When creating a new mount point in the GUI, this option is enabled by | |
914 | default. | |
915 | ||
916 | To disable backups for a mount point, add `backup=0` in the way described | |
917 | above, or uncheck the *Backup* checkbox on the GUI. | |
918 | ||
919 | Replication of Containers mount points | |
920 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
921 | ||
922 | By default, additional mount points are replicated when the Root Disk is | |
923 | replicated. If you want the {pve} storage replication mechanism to skip a mount | |
924 | point, you can set the *Skip replication* option for that mount point. | |
925 | As of {pve} 5.0, replication requires a storage of type `zfspool`. Adding a | |
926 | mount point to a different type of storage when the container has replication | |
927 | configured requires to have *Skip replication* enabled for that mount point. | |
928 | ||
929 | ||
51e33128 FG |
930 | Backup and Restore |
931 | ------------------ | |
932 | ||
5eba0743 | 933 | |
2175e37b FG |
934 | Container Backup |
935 | ~~~~~~~~~~~~~~~~ | |
936 | ||
69ab602f TL |
937 | It is possible to use the `vzdump` tool for container backup. Please refer to |
938 | the `vzdump` manual page for details. | |
8c1189b6 | 939 | |
51e33128 | 940 | |
2175e37b FG |
941 | Restoring Container Backups |
942 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
943 | ||
69ab602f TL |
944 | Restoring container backups made with `vzdump` is possible using the `pct |
945 | restore` command. By default, `pct restore` will attempt to restore as much of | |
946 | the backed up container configuration as possible. It is possible to override | |
947 | the backed up configuration by manually setting container options on the | |
948 | command line (see the `pct` manual page for details). | |
2175e37b | 949 | |
8c1189b6 | 950 | NOTE: `pvesm extractconfig` can be used to view the backed up configuration |
2175e37b FG |
951 | contained in a vzdump archive. |
952 | ||
953 | There are two basic restore modes, only differing by their handling of mount | |
954 | points: | |
955 | ||
4c3b5c77 | 956 | |
8c1189b6 FG |
957 | ``Simple'' Restore Mode |
958 | ^^^^^^^^^^^^^^^^^^^^^^^ | |
2175e37b | 959 | |
69ab602f TL |
960 | If neither the `rootfs` parameter nor any of the optional `mpX` parameters are |
961 | explicitly set, the mount point configuration from the backed up configuration | |
962 | file is restored using the following steps: | |
2175e37b FG |
963 | |
964 | . Extract mount points and their options from backup | |
324efba3 FG |
965 | . Create volumes for storage backed mount points on the storage provided with |
966 | the `storage` parameter (default: `local`). | |
2175e37b | 967 | . Extract files from backup archive |
69ab602f TL |
968 | . Add bind and device mount points to restored configuration (limited to root |
969 | user) | |
2175e37b FG |
970 | |
971 | NOTE: Since bind and device mount points are never backed up, no files are | |
972 | restored in the last step, but only the configuration options. The assumption | |
973 | is that such mount points are either backed up with another mechanism (e.g., | |
974 | NFS space that is bind mounted into many containers), or not intended to be | |
975 | backed up at all. | |
976 | ||
977 | This simple mode is also used by the container restore operations in the web | |
978 | interface. | |
979 | ||
4c3b5c77 | 980 | |
8c1189b6 FG |
981 | ``Advanced'' Restore Mode |
982 | ^^^^^^^^^^^^^^^^^^^^^^^^^ | |
2175e37b FG |
983 | |
984 | By setting the `rootfs` parameter (and optionally, any combination of `mpX` | |
8c1189b6 | 985 | parameters), the `pct restore` command is automatically switched into an |
2175e37b | 986 | advanced mode. This advanced mode completely ignores the `rootfs` and `mpX` |
69ab602f TL |
987 | configuration options contained in the backup archive, and instead only uses |
988 | the options explicitly provided as parameters. | |
2175e37b | 989 | |
69ab602f TL |
990 | This mode allows flexible configuration of mount point settings at restore |
991 | time, for example: | |
2175e37b FG |
992 | |
993 | * Set target storages, volume sizes and other options for each mount point | |
69ab602f | 994 | individually |
2175e37b FG |
995 | * Redistribute backed up files according to new mount point scheme |
996 | * Restore to device and/or bind mount points (limited to root user) | |
997 | ||
51e33128 | 998 | |
8c1189b6 | 999 | Managing Containers with `pct` |
04c569f6 DM |
1000 | ------------------------------ |
1001 | ||
6d718b9b TL |
1002 | The ``Proxmox Container Toolkit'' (`pct`) is the command line tool to manage |
1003 | {pve} containers. It enables you to create or destroy containers, as well as | |
1004 | control the container execution (start, stop, reboot, migrate, etc.). It can be | |
1005 | used to set parameters in the config file of a container, for example the | |
1006 | network configuration or memory limits. | |
5eba0743 | 1007 | |
04c569f6 DM |
1008 | CLI Usage Examples |
1009 | ~~~~~~~~~~~~~~~~~~ | |
1010 | ||
69ab602f TL |
1011 | Create a container based on a Debian template (provided you have already |
1012 | downloaded the template via the web interface) | |
04c569f6 | 1013 | |
14e97811 OB |
1014 | ---- |
1015 | # pct create 100 /var/lib/vz/template/cache/debian-10.0-standard_10.0-1_amd64.tar.gz | |
1016 | ---- | |
04c569f6 DM |
1017 | |
1018 | Start container 100 | |
1019 | ||
14e97811 OB |
1020 | ---- |
1021 | # pct start 100 | |
1022 | ---- | |
04c569f6 DM |
1023 | |
1024 | Start a login session via getty | |
1025 | ||
14e97811 OB |
1026 | ---- |
1027 | # pct console 100 | |
1028 | ---- | |
04c569f6 DM |
1029 | |
1030 | Enter the LXC namespace and run a shell as root user | |
1031 | ||
14e97811 OB |
1032 | ---- |
1033 | # pct enter 100 | |
1034 | ---- | |
04c569f6 DM |
1035 | |
1036 | Display the configuration | |
1037 | ||
14e97811 OB |
1038 | ---- |
1039 | # pct config 100 | |
1040 | ---- | |
04c569f6 | 1041 | |
69ab602f TL |
1042 | Add a network interface called `eth0`, bridged to the host bridge `vmbr0`, set |
1043 | the address and gateway, while it's running | |
04c569f6 | 1044 | |
14e97811 OB |
1045 | ---- |
1046 | # pct set 100 -net0 name=eth0,bridge=vmbr0,ip=192.168.15.147/24,gw=192.168.15.1 | |
1047 | ---- | |
04c569f6 DM |
1048 | |
1049 | Reduce the memory of the container to 512MB | |
1050 | ||
14e97811 OB |
1051 | ---- |
1052 | # pct set 100 -memory 512 | |
1053 | ---- | |
0585f29a | 1054 | |
87927c65 DJ |
1055 | Destroying a container always removes it from Access Control Lists and it always |
1056 | removes the firewall configuration of the container. You have to activate | |
1057 | '--purge', if you want to additionally remove the container from replication jobs, | |
1058 | backup jobs and HA resource configurations. | |
1059 | ||
1060 | ---- | |
1061 | # pct destroy 100 --purge | |
1062 | ---- | |
1063 | ||
66aecccb AL |
1064 | Move a mount point volume to a different storage. |
1065 | ||
1066 | ---- | |
1067 | # pct move-volume 100 mp0 other-storage | |
1068 | ---- | |
1069 | ||
1070 | Reassign a volume to a different CT. This will remove the volume `mp0` from | |
1071 | the source CT and attaches it as `mp1` to the target CT. In the background | |
1072 | the volume is being renamed so that the name matches the new owner. | |
1073 | ||
1074 | ---- | |
1075 | # pct move-volume 100 mp0 --target-vmid 200 --target-volume mp1 | |
1076 | ---- | |
87927c65 | 1077 | |
04c569f6 | 1078 | |
fe57a420 FG |
1079 | Obtaining Debugging Logs |
1080 | ~~~~~~~~~~~~~~~~~~~~~~~~ | |
1081 | ||
1082 | In case `pct start` is unable to start a specific container, it might be | |
59b89a69 OB |
1083 | helpful to collect debugging output by passing the `--debug` flag (replace `CTID` with |
1084 | the container's CTID): | |
fe57a420 | 1085 | |
14e97811 | 1086 | ---- |
59b89a69 OB |
1087 | # pct start CTID --debug |
1088 | ---- | |
1089 | ||
97e4455e TL |
1090 | Alternatively, you can use the following `lxc-start` command, which will save |
1091 | the debug log to the file specified by the `-o` output option: | |
59b89a69 OB |
1092 | |
1093 | ---- | |
1094 | # lxc-start -n CTID -F -l DEBUG -o /tmp/lxc-CTID.log | |
14e97811 | 1095 | ---- |
fe57a420 | 1096 | |
69ab602f | 1097 | This command will attempt to start the container in foreground mode, to stop |
59b89a69 | 1098 | the container run `pct shutdown CTID` or `pct stop CTID` in a second terminal. |
fe57a420 | 1099 | |
59b89a69 | 1100 | The collected debug log is written to `/tmp/lxc-CTID.log`. |
fe57a420 FG |
1101 | |
1102 | NOTE: If you have changed the container's configuration since the last start | |
1103 | attempt with `pct start`, you need to run `pct start` at least once to also | |
1104 | update the configuration used by `lxc-start`. | |
1105 | ||
33f50e04 DC |
1106 | [[pct_migration]] |
1107 | Migration | |
1108 | --------- | |
1109 | ||
1110 | If you have a cluster, you can migrate your Containers with | |
1111 | ||
14e97811 OB |
1112 | ---- |
1113 | # pct migrate <ctid> <target> | |
1114 | ---- | |
33f50e04 DC |
1115 | |
1116 | This works as long as your Container is offline. If it has local volumes or | |
14e97811 | 1117 | mount points defined, the migration will copy the content over the network to |
ba021358 | 1118 | the target host if the same storage is defined there. |
33f50e04 | 1119 | |
656d8b21 | 1120 | Running containers cannot live-migrated due to technical limitations. You can |
4c82550d TL |
1121 | do a restart migration, which shuts down, moves and then starts a container |
1122 | again on the target node. As containers are very lightweight, this results | |
1123 | normally only in a downtime of some hundreds of milliseconds. | |
1124 | ||
1125 | A restart migration can be done through the web interface or by using the | |
1126 | `--restart` flag with the `pct migrate` command. | |
33f50e04 | 1127 | |
69ab602f TL |
1128 | A restart migration will shut down the Container and kill it after the |
1129 | specified timeout (the default is 180 seconds). Then it will migrate the | |
1130 | Container like an offline migration and when finished, it starts the Container | |
1131 | on the target node. | |
c7bc47af DM |
1132 | |
1133 | [[pct_configuration]] | |
1134 | Configuration | |
1135 | ------------- | |
1136 | ||
69ab602f TL |
1137 | The `/etc/pve/lxc/<CTID>.conf` file stores container configuration, where |
1138 | `<CTID>` is the numeric ID of the given container. Like all other files stored | |
1139 | inside `/etc/pve/`, they get automatically replicated to all other cluster | |
1140 | nodes. | |
c7bc47af DM |
1141 | |
1142 | NOTE: CTIDs < 100 are reserved for internal purposes, and CTIDs need to be | |
1143 | unique cluster wide. | |
1144 | ||
1145 | .Example Container Configuration | |
1146 | ---- | |
1147 | ostype: debian | |
1148 | arch: amd64 | |
1149 | hostname: www | |
1150 | memory: 512 | |
1151 | swap: 512 | |
1152 | net0: bridge=vmbr0,hwaddr=66:64:66:64:64:36,ip=dhcp,name=eth0,type=veth | |
1153 | rootfs: local:107/vm-107-disk-1.raw,size=7G | |
1154 | ---- | |
1155 | ||
69ab602f | 1156 | The configuration files are simple text files. You can edit them using a normal |
da9679b6 | 1157 | text editor, for example, `vi` or `nano`. |
69ab602f TL |
1158 | This is sometimes useful to do small corrections, but keep in mind that you |
1159 | need to restart the container to apply such changes. | |
c7bc47af | 1160 | |
69ab602f TL |
1161 | For that reason, it is usually better to use the `pct` command to generate and |
1162 | modify those files, or do the whole thing using the GUI. | |
1163 | Our toolkit is smart enough to instantaneously apply most changes to running | |
da9679b6 | 1164 | containers. This feature is called ``hot plug'', and there is no need to restart |
69ab602f | 1165 | the container in that case. |
c7bc47af | 1166 | |
da9679b6 | 1167 | In cases where a change cannot be hot-plugged, it will be registered as a |
69ab602f TL |
1168 | pending change (shown in red color in the GUI). |
1169 | They will only be applied after rebooting the container. | |
14e97811 | 1170 | |
c7bc47af DM |
1171 | |
1172 | File Format | |
1173 | ~~~~~~~~~~~ | |
1174 | ||
69ab602f TL |
1175 | The container configuration file uses a simple colon separated key/value |
1176 | format. Each line has the following format: | |
c7bc47af DM |
1177 | |
1178 | ----- | |
1179 | # this is a comment | |
1180 | OPTION: value | |
1181 | ----- | |
1182 | ||
69ab602f TL |
1183 | Blank lines in those files are ignored, and lines starting with a `#` character |
1184 | are treated as comments and are also ignored. | |
c7bc47af | 1185 | |
69ab602f | 1186 | It is possible to add low-level, LXC style configuration directly, for example: |
c7bc47af | 1187 | |
14e97811 OB |
1188 | ---- |
1189 | lxc.init_cmd: /sbin/my_own_init | |
1190 | ---- | |
c7bc47af DM |
1191 | |
1192 | or | |
1193 | ||
14e97811 OB |
1194 | ---- |
1195 | lxc.init_cmd = /sbin/my_own_init | |
1196 | ---- | |
c7bc47af | 1197 | |
14e97811 | 1198 | The settings are passed directly to the LXC low-level tools. |
c7bc47af DM |
1199 | |
1200 | ||
1201 | [[pct_snapshots]] | |
1202 | Snapshots | |
1203 | ~~~~~~~~~ | |
1204 | ||
69ab602f TL |
1205 | When you create a snapshot, `pct` stores the configuration at snapshot time |
1206 | into a separate snapshot section within the same configuration file. For | |
1207 | example, after creating a snapshot called ``testsnapshot'', your configuration | |
1208 | file will look like this: | |
c7bc47af DM |
1209 | |
1210 | .Container configuration with snapshot | |
1211 | ---- | |
1212 | memory: 512 | |
1213 | swap: 512 | |
1214 | parent: testsnaphot | |
1215 | ... | |
1216 | ||
1217 | [testsnaphot] | |
1218 | memory: 512 | |
1219 | swap: 512 | |
1220 | snaptime: 1457170803 | |
1221 | ... | |
1222 | ---- | |
1223 | ||
69ab602f TL |
1224 | There are a few snapshot related properties like `parent` and `snaptime`. The |
1225 | `parent` property is used to store the parent/child relationship between | |
1226 | snapshots. `snaptime` is the snapshot creation time stamp (Unix epoch). | |
c7bc47af DM |
1227 | |
1228 | ||
1229 | [[pct_options]] | |
1230 | Options | |
1231 | ~~~~~~~ | |
1232 | ||
1233 | include::pct.conf.5-opts.adoc[] | |
1234 | ||
1235 | ||
2a11aa70 DM |
1236 | Locks |
1237 | ----- | |
1238 | ||
69ab602f TL |
1239 | Container migrations, snapshots and backups (`vzdump`) set a lock to prevent |
1240 | incompatible concurrent actions on the affected container. Sometimes you need | |
1241 | to remove such a lock manually (e.g., after a power failure). | |
2a11aa70 | 1242 | |
14e97811 OB |
1243 | ---- |
1244 | # pct unlock <CTID> | |
1245 | ---- | |
2a11aa70 | 1246 | |
69ab602f TL |
1247 | CAUTION: Only do this if you are sure the action which set the lock is no |
1248 | longer running. | |
2a11aa70 | 1249 | |
fe57a420 | 1250 | |
0c6b782f | 1251 | ifdef::manvolnum[] |
3bd9d0cf DM |
1252 | |
1253 | Files | |
1254 | ------ | |
1255 | ||
1256 | `/etc/pve/lxc/<CTID>.conf`:: | |
1257 | ||
1258 | Configuration file for the container '<CTID>'. | |
1259 | ||
1260 | ||
0c6b782f DM |
1261 | include::pve-copyright.adoc[] |
1262 | endif::manvolnum[] |