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