1 package PVE
::LXC
::Config
;
6 use PVE
::AbstractConfig
;
7 use PVE
::Cluster
qw(cfs_register_file);
8 use PVE
::DataCenterConfig
;
11 use PVE
::JSONSchema
qw(get_standard_option);
14 use base
qw(PVE::AbstractConfig);
16 my $nodename = PVE
::INotify
::nodename
();
17 my $lock_handles = {};
18 my $lockdir = "/run/lock/lxc";
20 mkdir "/etc/pve/nodes/$nodename/lxc";
21 my $MAX_MOUNT_POINTS = 256;
22 my $MAX_UNUSED_DISKS = $MAX_MOUNT_POINTS;
24 # BEGIN implemented abstract methods from PVE::AbstractConfig
30 sub __config_max_unused_disks
{
33 return $MAX_UNUSED_DISKS;
36 sub config_file_lock
{
37 my ($class, $vmid) = @_;
39 return "$lockdir/pve-config-${vmid}.lock";
43 my ($class, $vmid, $node) = @_;
45 $node = $nodename if !$node;
46 return "nodes/$node/lxc/$vmid.conf";
49 sub mountpoint_backup_enabled
{
50 my ($class, $mp_key, $mountpoint) = @_;
55 if ($mp_key eq 'rootfs') {
58 } elsif ($mountpoint->{type
} ne 'volume') {
60 $reason = 'not a volume';
61 } elsif ($mountpoint->{backup
}) {
68 return wantarray ?
($enabled, $reason) : $enabled;
72 my ($class, $feature, $conf, $storecfg, $snapname, $running, $backup_only) = @_;
76 if ($feature eq 'copy' || $feature eq 'clone') {
77 $opts = {'valid_target_formats' => ['raw', 'subvol']};
80 $class->foreach_volume($conf, sub {
81 my ($ms, $mountpoint) = @_;
83 return if $err; # skip further test
84 return if $backup_only && !$class->mountpoint_backup_enabled($ms, $mountpoint);
87 if !PVE
::Storage
::volume_has_feature
($storecfg, $feature,
88 $mountpoint->{volume
},
89 $snapname, $running, $opts);
95 sub __snapshot_save_vmstate
{
96 my ($class, $vmid, $conf, $snapname, $storecfg) = @_;
97 die "implement me - snapshot_save_vmstate\n";
100 sub __snapshot_check_running
{
101 my ($class, $vmid) = @_;
102 return PVE
::LXC
::check_running
($vmid);
105 sub __snapshot_check_freeze_needed
{
106 my ($class, $vmid, $config, $save_vmstate) = @_;
108 my $ret = $class->__snapshot_check_running($vmid);
112 sub __snapshot_freeze
{
113 my ($class, $vmid, $unfreeze) = @_;
116 eval { PVE
::LXC
::thaw
($vmid); };
119 PVE
::LXC
::freeze
($vmid);
120 PVE
::LXC
::sync_container_namespace
($vmid);
124 sub __snapshot_create_vol_snapshot
{
125 my ($class, $vmid, $ms, $mountpoint, $snapname) = @_;
127 my $storecfg = PVE
::Storage
::config
();
129 return if $snapname eq 'vzdump' &&
130 !$class->mountpoint_backup_enabled($ms, $mountpoint);
132 PVE
::Storage
::volume_snapshot
($storecfg, $mountpoint->{volume
}, $snapname);
135 sub __snapshot_delete_remove_drive
{
136 my ($class, $snap, $remove_drive) = @_;
138 if ($remove_drive eq 'vmstate') {
139 die "implement me - saving vmstate\n";
141 my $value = $snap->{$remove_drive};
142 my $mountpoint = $class->parse_volume($remove_drive, $value, 1);
143 delete $snap->{$remove_drive};
145 $class->add_unused_volume($snap, $mountpoint->{volume
})
146 if ($mountpoint->{type
} eq 'volume');
150 sub __snapshot_delete_vmstate_file
{
151 my ($class, $snap, $force) = @_;
153 die "implement me - saving vmstate\n";
156 sub __snapshot_delete_vol_snapshot
{
157 my ($class, $vmid, $ms, $mountpoint, $snapname, $unused) = @_;
159 return if $snapname eq 'vzdump' &&
160 !$class->mountpoint_backup_enabled($ms, $mountpoint);
162 my $storecfg = PVE
::Storage
::config
();
163 PVE
::Storage
::volume_snapshot_delete
($storecfg, $mountpoint->{volume
}, $snapname);
164 push @$unused, $mountpoint->{volume
};
167 sub __snapshot_rollback_vol_possible
{
168 my ($class, $mountpoint, $snapname) = @_;
170 my $storecfg = PVE
::Storage
::config
();
171 PVE
::Storage
::volume_rollback_is_possible
($storecfg, $mountpoint->{volume
}, $snapname);
174 sub __snapshot_rollback_vol_rollback
{
175 my ($class, $mountpoint, $snapname) = @_;
177 my $storecfg = PVE
::Storage
::config
();
178 PVE
::Storage
::volume_snapshot_rollback
($storecfg, $mountpoint->{volume
}, $snapname);
181 sub __snapshot_rollback_vm_stop
{
182 my ($class, $vmid) = @_;
184 PVE
::LXC
::vm_stop
($vmid, 1)
185 if $class->__snapshot_check_running($vmid);
188 sub __snapshot_rollback_vm_start
{
189 my ($class, $vmid, $vmstate, $data);
191 die "implement me - save vmstate\n";
194 sub __snapshot_rollback_get_unused
{
195 my ($class, $conf, $snap) = @_;
199 $class->foreach_volume($conf, sub {
200 my ($vs, $volume) = @_;
202 return if $volume->{type
} ne 'volume';
205 my $volid = $volume->{volume
};
207 $class->foreach_volume($snap, sub {
208 my ($ms, $mountpoint) = @_;
211 return if ($mountpoint->{type
} ne 'volume');
214 if ($mountpoint->{volume
} && $mountpoint->{volume
} eq $volid);
217 push @$unused, $volid if !$found;
223 # END implemented abstract methods from PVE::AbstractConfig
225 # BEGIN JSON config code
227 cfs_register_file
('/lxc/', \
&parse_pct_config
, \
&write_pct_config
);
230 my $valid_mount_option_re = qr/(noatime|nodev|nosuid|noexec)/;
232 sub is_valid_mount_option
{
234 return $option =~ $valid_mount_option_re;
241 format
=> 'pve-lxc-mp-string',
242 format_description
=> 'volume',
243 description
=> 'Volume, device or directory to mount into the container.',
247 format
=> 'disk-size',
248 format_description
=> 'DiskSize',
249 description
=> 'Volume size (read only value).',
254 description
=> 'Explicitly enable or disable ACL support.',
260 description
=> 'Extra mount options for rootfs/mps.',
261 format_description
=> 'opt[;opt...]',
262 pattern
=> qr/$valid_mount_option_re(;$valid_mount_option_re)*/,
266 description
=> 'Read-only mount point',
271 description
=> 'Enable user quotas inside the container (not supported with zfs subvolumes)',
276 description
=> 'Will include this volume to a storage replica job.',
282 description
=> 'Mark this non-volume mount point as available on multiple nodes (see \'nodes\')',
283 verbose_description
=> "Mark this non-volume mount point as available on all nodes.\n\nWARNING: This option does not share the mount point automatically, it assumes it is shared already!",
289 PVE
::JSONSchema
::register_standard_option
('pve-ct-rootfs', {
290 type
=> 'string', format
=> $rootfs_desc,
291 description
=> "Use volume as container root.",
295 my $features_desc = {
299 description
=> "Allow mounting file systems of specific types."
300 ." This should be a list of file system types as used with the mount command."
301 ." Note that this can have negative effects on the container's security."
302 ." With access to a loop device, mounting a file can circumvent the mknod"
303 ." permission of the devices cgroup, mounting an NFS file system can"
304 ." block the host's I/O completely and prevent it from rebooting, etc.",
305 format_description
=> 'fstype;fstype;...',
306 pattern
=> qr/[a-zA-Z0-9_; ]+/,
312 description
=> "Allow nesting."
313 ." Best used with unprivileged containers with additional id mapping."
314 ." Note that this will expose procfs and sysfs contents of the host"
321 description
=> "For unprivileged containers only: Allow the use of the keyctl() system call."
322 ." This is required to use docker inside a container."
323 ." By default unprivileged containers will see this system call as non-existent."
324 ." This is mostly a workaround for systemd-networkd, as it will treat it as a fatal"
325 ." error when some keyctl() operations are denied by the kernel due to lacking permissions."
326 ." Essentially, you can choose between running systemd-networkd or docker.",
332 description
=> "Allow using 'fuse' file systems in a container."
333 ." Note that interactions between fuse and the freezer cgroup can potentially cause I/O deadlocks.",
339 description
=> "Allow unprivileged containers to use mknod() to add certain device nodes."
340 ." This requires a kernel with seccomp trap to user space support (5.3 or newer)."
341 ." This is experimental.",
347 description
=> "Mount /sys in unprivileged containers as `rw` instead of `mixed`."
348 ." This can break networking under newer (>= v245) systemd-network use."
356 description
=> "Lock/unlock the VM.",
357 enum
=> [qw(backup create destroyed disk fstrim migrate mounted rollback snapshot snapshot-delete)],
362 description
=> "Specifies whether a VM will be started during system bootup.",
365 startup
=> get_standard_option
('pve-startup-order'),
369 description
=> "Enable/disable Template.",
375 enum
=> ['amd64', 'i386', 'arm64', 'armhf'],
376 description
=> "OS architecture type.",
382 enum
=> [qw(debian ubuntu centos fedora opensuse archlinux alpine gentoo unmanaged)],
383 description
=> "OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.",
388 description
=> "Attach a console device (/dev/console) to the container.",
394 description
=> "Specify the number of tty available to the container",
402 description
=> "The number of cores assigned to the container. A container can use all available cores by default.",
409 description
=> "Limit of CPU usage.\n\nNOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.",
417 description
=> "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0.",
425 description
=> "Amount of RAM for the VM in MB.",
432 description
=> "Amount of SWAP for the VM in MB.",
438 description
=> "Set a host name for the container.",
439 type
=> 'string', format
=> 'dns-name',
445 description
=> "Container description. Only used on the configuration web interface.",
449 type
=> 'string', format
=> 'dns-name-list',
450 description
=> "Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
454 type
=> 'string', format
=> 'address-list',
455 description
=> "Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
459 type
=> 'string', format
=> 'pve-ct-timezone',
460 description
=> "Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab",
462 rootfs
=> get_standard_option
('pve-ct-rootfs'),
465 type
=> 'string', format
=> 'pve-configid',
467 description
=> "Parent snapshot name. This is used internally, and should not be modified.",
471 description
=> "Timestamp for snapshots.",
477 description
=> "Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).",
479 enum
=> ['shell', 'console', 'tty'],
485 description
=> "Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.",
491 description
=> "Makes the container run as unprivileged user. (Should not be modified manually.)",
497 format
=> $features_desc,
498 description
=> "Allow containers access to advanced features.",
503 format
=> 'pve-volume-id',
504 description
=> 'Script that will be exectued during various steps in the containers lifetime.',
507 type
=> 'string', format
=> 'pve-tag-list',
508 description
=> 'Tags of the Container. This is only meta information.',
513 my $valid_lxc_conf_keys = {
514 'lxc.apparmor.profile' => 1,
515 'lxc.apparmor.allow_incomplete' => 1,
516 'lxc.apparmor.allow_nesting' => 1,
517 'lxc.apparmor.raw' => 1,
518 'lxc.selinux.context' => 1,
522 'lxc.signal.halt' => 1,
523 'lxc.signal.reboot' => 1,
524 'lxc.signal.stop' => 1,
527 'lxc.console.logfile' => 1,
528 'lxc.console.path' => 1,
530 'lxc.devtty.dir' => 1,
531 'lxc.hook.autodev' => 1,
534 'lxc.mount.fstab' => 1,
535 'lxc.mount.entry' => 1,
536 'lxc.mount.auto' => 1,
537 'lxc.rootfs.path' => 'lxc.rootfs.path is auto generated from rootfs',
538 'lxc.rootfs.mount' => 1,
539 'lxc.rootfs.options' => 'lxc.rootfs.options is not supported' .
540 ', please use mount point options in the "rootfs" key',
546 'lxc.seccomp.profile' => 1,
547 'lxc.seccomp.notify.proxy' => 1,
548 'lxc.seccomp.notify.cookie' => 1,
550 'lxc.hook.pre-start' => 1,
551 'lxc.hook.pre-mount' => 1,
552 'lxc.hook.mount' => 1,
553 'lxc.hook.start' => 1,
554 'lxc.hook.stop' => 1,
555 'lxc.hook.post-stop' => 1,
556 'lxc.hook.clone' => 1,
557 'lxc.hook.destroy' => 1,
558 'lxc.hook.version' => 1,
559 'lxc.log.level' => 1,
561 'lxc.start.auto' => 1,
562 'lxc.start.delay' => 1,
563 'lxc.start.order' => 1,
565 'lxc.environment' => 1,
567 # All these are namespaced via CLONE_NEWIPC (see namespaces(7)).
568 'lxc.sysctl.fs.mqueue' => 1,
569 'lxc.sysctl.kernel.msgmax' => 1,
570 'lxc.sysctl.kernel.msgmnb' => 1,
571 'lxc.sysctl.kernel.msgmni' => 1,
572 'lxc.sysctl.kernel.sem' => 1,
573 'lxc.sysctl.kernel.shmall' => 1,
574 'lxc.sysctl.kernel.shmmax' => 1,
575 'lxc.sysctl.kernel.shmmni' => 1,
576 'lxc.sysctl.kernel.shm_rmid_forced' => 1,
579 my $deprecated_lxc_conf_keys = {
580 # Deprecated (removed with lxc 3.0):
581 'lxc.aa_profile' => 'lxc.apparmor.profile',
582 'lxc.aa_allow_incomplete' => 'lxc.apparmor.allow_incomplete',
583 'lxc.console' => 'lxc.console.path',
584 'lxc.devttydir' => 'lxc.tty.dir',
585 'lxc.haltsignal' => 'lxc.signal.halt',
586 'lxc.rebootsignal' => 'lxc.signal.reboot',
587 'lxc.stopsignal' => 'lxc.signal.stop',
588 'lxc.id_map' => 'lxc.idmap',
589 'lxc.init_cmd' => 'lxc.init.cmd',
590 'lxc.loglevel' => 'lxc.log.level',
591 'lxc.logfile' => 'lxc.log.file',
592 'lxc.mount' => 'lxc.mount.fstab',
593 'lxc.network.type' => 'lxc.net.INDEX.type',
594 'lxc.network.flags' => 'lxc.net.INDEX.flags',
595 'lxc.network.link' => 'lxc.net.INDEX.link',
596 'lxc.network.mtu' => 'lxc.net.INDEX.mtu',
597 'lxc.network.name' => 'lxc.net.INDEX.name',
598 'lxc.network.hwaddr' => 'lxc.net.INDEX.hwaddr',
599 'lxc.network.ipv4' => 'lxc.net.INDEX.ipv4.address',
600 'lxc.network.ipv4.gateway' => 'lxc.net.INDEX.ipv4.gateway',
601 'lxc.network.ipv6' => 'lxc.net.INDEX.ipv6.address',
602 'lxc.network.ipv6.gateway' => 'lxc.net.INDEX.ipv6.gateway',
603 'lxc.network.script.up' => 'lxc.net.INDEX.script.up',
604 'lxc.network.script.down' => 'lxc.net.INDEX.script.down',
605 'lxc.pts' => 'lxc.pty.max',
606 'lxc.se_context' => 'lxc.selinux.context',
607 'lxc.seccomp' => 'lxc.seccomp.profile',
608 'lxc.tty' => 'lxc.tty.max',
609 'lxc.utsname' => 'lxc.uts.name',
612 sub is_valid_lxc_conf_key
{
613 my ($vmid, $key) = @_;
614 if ($key =~ /^lxc\.limit\./) {
615 warn "vm $vmid - $key: lxc.limit.* was renamed to lxc.prlimit.*\n";
618 if (defined(my $new_name = $deprecated_lxc_conf_keys->{$key})) {
619 warn "vm $vmid - $key is deprecated and was renamed to $new_name\n";
622 my $validity = $valid_lxc_conf_keys->{$key};
623 return $validity if defined($validity);
624 return 1 if $key =~ /^lxc\.cgroup2?\./ # allow all cgroup values
625 || $key =~ /^lxc\.prlimit\./ # allow all prlimits
626 || $key =~ /^lxc\.net\./; # allow custom network definitions
630 our $netconf_desc = {
634 description
=> "Network interface type.",
639 format_description
=> 'string',
640 description
=> 'Name of the network device as seen from inside the container. (lxc.network.name)',
641 pattern
=> '[-_.\w\d]+',
645 format_description
=> 'bridge',
646 description
=> 'Bridge to attach the network device to.',
647 pattern
=> '[-_.\w\d]+',
650 hwaddr
=> get_standard_option
('mac-addr', {
651 description
=> 'The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)',
655 description
=> 'Maximum transfer unit of the interface. (lxc.network.mtu)',
656 minimum
=> 64, # minimum ethernet frame is 64 bytes
661 format
=> 'pve-ipv4-config',
662 format_description
=> '(IPv4/CIDR|dhcp|manual)',
663 description
=> 'IPv4 address in CIDR format.',
669 format_description
=> 'GatewayIPv4',
670 description
=> 'Default gateway for IPv4 traffic.',
675 format
=> 'pve-ipv6-config',
676 format_description
=> '(IPv6/CIDR|auto|dhcp|manual)',
677 description
=> 'IPv6 address in CIDR format.',
683 format_description
=> 'GatewayIPv6',
684 description
=> 'Default gateway for IPv6 traffic.',
689 description
=> "Controls whether this interface's firewall rules should be used.",
696 description
=> "VLAN tag for this interface.",
701 pattern
=> qr/\d+(?:;\d+)*/,
702 format_description
=> 'vlanid[;vlanid...]',
703 description
=> "VLAN ids to pass through the interface",
708 format_description
=> 'mbps',
709 description
=> "Apply rate limiting to the interface",
713 PVE
::JSONSchema
::register_format
('pve-lxc-network', $netconf_desc);
715 my $MAX_LXC_NETWORKS = 32;
716 for (my $i = 0; $i < $MAX_LXC_NETWORKS; $i++) {
717 $confdesc->{"net$i"} = {
719 type
=> 'string', format
=> $netconf_desc,
720 description
=> "Specifies network interfaces for the container.",
724 PVE
::JSONSchema
::register_format
('pve-ct-timezone', \
&verify_ct_timezone
);
725 sub verify_ct_timezone
{
726 my ($timezone, $noerr) = @_;
728 return if $timezone eq 'host'; # using host settings
730 PVE
::JSONSchema
::pve_verify_timezone
($timezone);
733 PVE
::JSONSchema
::register_format
('pve-lxc-mp-string', \
&verify_lxc_mp_string
);
734 sub verify_lxc_mp_string
{
735 my ($mp, $noerr) = @_;
739 # /. or /.. at the end
740 # ../ at the beginning
742 if($mp =~ m
@/\.\
.?
/@ ||
745 return undef if $noerr;
746 die "$mp contains illegal character sequences\n";
755 description
=> 'Whether to include the mount point in backups.',
756 verbose_description
=> 'Whether to include the mount point in backups '.
757 '(only used for volume mount points).',
762 format
=> 'pve-lxc-mp-string',
763 format_description
=> 'Path',
764 description
=> 'Path to the mount point as seen from inside the container '.
765 '(must not contain symlinks).',
766 verbose_description
=> "Path to the mount point as seen from inside the container.\n\n".
767 "NOTE: Must not contain any symlinks for security reasons."
770 PVE
::JSONSchema
::register_format
('pve-ct-mountpoint', $mp_desc);
776 format
=> 'pve-volume-id',
777 format_description
=> 'volume',
778 description
=> 'The volume that is not used currently.',
782 for (my $i = 0; $i < $MAX_MOUNT_POINTS; $i++) {
783 $confdesc->{"mp$i"} = {
785 type
=> 'string', format
=> $mp_desc,
786 description
=> "Use volume as container mount point.",
791 for (my $i = 0; $i < $MAX_UNUSED_DISKS; $i++) {
792 $confdesc->{"unused$i"} = {
794 type
=> 'string', format
=> $unused_desc,
795 description
=> "Reference to unused volumes. This is used internally, and should not be modified manually.",
799 sub parse_pct_config
{
800 my ($filename, $raw) = @_;
802 return undef if !defined($raw);
805 digest
=> Digest
::SHA
::sha1_hex
($raw),
810 $filename =~ m
|/lxc/(\d
+).conf
$|
811 || die "got strange filename '$filename'";
819 my @lines = split(/\n/, $raw);
820 foreach my $line (@lines) {
821 next if $line =~ m/^\s*$/;
823 if ($line =~ m/^\[pve:pending\]\s*$/i) {
824 $section = 'pending';
825 $conf->{description
} = $descr if $descr;
827 $conf = $res->{$section} = {};
829 } elsif ($line =~ m/^\[([a-z][a-z0-9_\-]+)\]\s*$/i) {
831 $conf->{description
} = $descr if $descr;
833 $conf = $res->{snapshots
}->{$section} = {};
837 if ($line =~ m/^\#(.*)\s*$/) {
838 $descr .= PVE
::Tools
::decode_text
($1) . "\n";
842 if ($line =~ m/^(lxc\.[a-z0-9_\-\.]+)(:|\s*=)\s*(.*?)\s*$/) {
845 my $validity = is_valid_lxc_conf_key
($vmid, $key);
846 if ($validity eq 1) {
847 push @{$conf->{lxc
}}, [$key, $value];
848 } elsif (my $errmsg = $validity) {
849 warn "vm $vmid - $key: $errmsg\n";
851 warn "vm $vmid - unable to parse config: $line\n";
853 } elsif ($line =~ m/^(description):\s*(.*\S)\s*$/) {
854 $descr .= PVE
::Tools
::decode_text
($2);
855 } elsif ($line =~ m/snapstate:\s*(prepare|delete)\s*$/) {
856 $conf->{snapstate
} = $1;
857 } elsif ($line =~ m/^delete:\s*(.*\S)\s*$/) {
859 if ($section eq 'pending') {
860 $conf->{delete} = $value;
862 warn "vm $vmid - property 'delete' is only allowed in [pve:pending]\n";
864 } elsif ($line =~ m/^([a-z][a-z_]*\d*):\s*(\S.*)\s*$/) {
867 eval { $value = PVE
::LXC
::Config-
>check_type($key, $value); };
868 warn "vm $vmid - unable to parse value of '$key' - $@" if $@;
869 $conf->{$key} = $value;
871 warn "vm $vmid - unable to parse config: $line\n";
875 $conf->{description
} = $descr if $descr;
877 delete $res->{snapstate
}; # just to be sure
882 sub write_pct_config
{
883 my ($filename, $conf) = @_;
885 delete $conf->{snapstate
}; # just to be sure
887 my $volidlist = PVE
::LXC
::Config-
>get_vm_volumes($conf);
888 my $used_volids = {};
889 foreach my $vid (@$volidlist) {
890 $used_volids->{$vid} = 1;
893 # remove 'unusedX' settings if the volume is still used
894 foreach my $key (keys %$conf) {
895 my $value = $conf->{$key};
896 if ($key =~ m/^unused/ && $used_volids->{$value}) {
897 delete $conf->{$key};
901 my $generate_raw_config = sub {
906 # add description as comment to top of file
907 my $descr = $conf->{description
} || '';
908 foreach my $cl (split(/\n/, $descr)) {
909 $raw .= '#' . PVE
::Tools
::encode_text
($cl) . "\n";
912 foreach my $key (sort keys %$conf) {
913 next if $key eq 'digest' || $key eq 'description' ||
914 $key eq 'pending' || $key eq 'snapshots' ||
915 $key eq 'snapname' || $key eq 'lxc';
916 my $value = $conf->{$key};
917 die "detected invalid newline inside property '$key'\n"
919 $raw .= "$key: $value\n";
922 if (my $lxcconf = $conf->{lxc
}) {
923 foreach my $entry (@$lxcconf) {
924 my ($k, $v) = @$entry;
932 my $raw = &$generate_raw_config($conf);
934 if (scalar(keys %{$conf->{pending
}})){
935 $raw .= "\n[pve:pending]\n";
936 $raw .= &$generate_raw_config($conf->{pending
});
939 foreach my $snapname (sort keys %{$conf->{snapshots
}}) {
940 $raw .= "\n[$snapname]\n";
941 $raw .= &$generate_raw_config($conf->{snapshots
}->{$snapname});
947 sub update_pct_config
{
948 my ($class, $vmid, $conf, $running, $param, $delete, $revert) = @_;
950 my $storage_cfg = PVE
::Storage
::config
();
952 foreach my $opt (@$revert) {
953 delete $conf->{pending
}->{$opt};
954 $class->remove_from_pending_delete($conf, $opt); # also remove from deletion queue
957 # write updates to pending section
958 my $modified = {}; # record modified options
960 foreach my $opt (@$delete) {
961 if (!defined($conf->{$opt}) && !defined($conf->{pending
}->{$opt})) {
962 warn "cannot delete '$opt' - not set in current configuration!\n";
965 $modified->{$opt} = 1;
966 if ($opt eq 'memory' || $opt eq 'rootfs' || $opt eq 'ostype') {
967 die "unable to delete required option '$opt'\n";
968 } elsif ($opt =~ m/^unused(\d+)$/) {
969 $class->check_protection($conf, "can't remove CT $vmid drive '$opt'");
970 } elsif ($opt =~ m/^mp(\d+)$/) {
971 $class->check_protection($conf, "can't remove CT $vmid drive '$opt'");
972 } elsif ($opt eq 'unprivileged') {
973 die "unable to delete read-only option: '$opt'\n";
975 $class->add_to_pending_delete($conf, $opt);
978 my $check_content_type = sub {
980 my $sid = PVE
::Storage
::parse_volume_id
($mp->{volume
});
981 my $storage_config = PVE
::Storage
::storage_config
($storage_cfg, $sid);
982 die "storage '$sid' does not allow content type 'rootdir' (Container)\n"
983 if !$storage_config->{content
}->{rootdir
};
986 foreach my $opt (sort keys %$param) { # add/change
987 $modified->{$opt} = 1;
988 my $value = $param->{$opt};
989 if ($opt =~ m/^mp(\d+)$/ || $opt eq 'rootfs') {
990 $class->check_protection($conf, "can't update CT $vmid drive '$opt'");
991 my $mp = $class->parse_volume($opt, $value);
992 $check_content_type->($mp) if ($mp->{type
} eq 'volume');
993 } elsif ($opt eq 'hookscript') {
994 PVE
::GuestHelpers
::check_hookscript
($value);
995 } elsif ($opt eq 'nameserver') {
996 $value = PVE
::LXC
::verify_nameserver_list
($value);
997 } elsif ($opt eq 'searchdomain') {
998 $value = PVE
::LXC
::verify_searchdomain_list
($value);
999 } elsif ($opt eq 'unprivileged') {
1000 die "unable to modify read-only option: '$opt'\n";
1002 $conf->{pending
}->{$opt} = $value;
1003 $class->remove_from_pending_delete($conf, $opt);
1006 my $changes = $class->cleanup_pending($conf);
1010 $class->vmconfig_hotplug_pending($vmid, $conf, $storage_cfg, $modified, $errors);
1012 $class->vmconfig_apply_pending($vmid, $conf, $storage_cfg, $modified, $errors);
1019 my ($class, $key, $value) = @_;
1021 die "unknown setting '$key'\n" if !$confdesc->{$key};
1023 my $type = $confdesc->{$key}->{type
};
1025 if (!defined($value)) {
1026 die "got undefined value\n";
1029 if ($value =~ m/[\n\r]/) {
1030 die "property contains a line feed\n";
1033 if ($type eq 'boolean') {
1034 return 1 if ($value eq '1') || ($value =~ m/^(on|yes|true)$/i);
1035 return 0 if ($value eq '0') || ($value =~ m/^(off|no|false)$/i);
1036 die "type check ('boolean') failed - got '$value'\n";
1037 } elsif ($type eq 'integer') {
1038 return int($1) if $value =~ m/^(\d+)$/;
1039 die "type check ('integer') failed - got '$value'\n";
1040 } elsif ($type eq 'number') {
1041 return $value if $value =~ m/^(\d+)(\.\d+)?$/;
1042 die "type check ('number') failed - got '$value'\n";
1043 } elsif ($type eq 'string') {
1044 if (my $fmt = $confdesc->{$key}->{format
}) {
1045 PVE
::JSONSchema
::check_format
($fmt, $value);
1050 die "internal error"
1055 # add JSON properties for create and set function
1056 sub json_config_properties
{
1057 my ($class, $prop) = @_;
1059 foreach my $opt (keys %$confdesc) {
1060 next if $opt eq 'parent' || $opt eq 'snaptime';
1061 next if $prop->{$opt};
1062 $prop->{$opt} = $confdesc->{$opt};
1068 my $parse_ct_mountpoint_full = sub {
1069 my ($class, $desc, $data, $noerr) = @_;
1074 eval { $res = PVE
::JSONSchema
::parse_property_string
($desc, $data) };
1076 return undef if $noerr;
1080 if (defined(my $size = $res->{size
})) {
1081 $size = PVE
::JSONSchema
::parse_size
($size);
1082 if (!defined($size)) {
1083 return undef if $noerr;
1084 die "invalid size: $size\n";
1086 $res->{size
} = $size;
1089 $res->{type
} = $class->classify_mountpoint($res->{volume
});
1094 sub print_ct_mountpoint
{
1095 my ($class, $info, $nomp) = @_;
1096 my $skip = [ 'type' ];
1097 push @$skip, 'mp' if $nomp;
1098 return PVE
::JSONSchema
::print_property_string
($info, $mp_desc, $skip);
1102 my ($class, $key, $volume_string, $noerr) = @_;
1104 if ($key eq 'rootfs') {
1105 my $res = $parse_ct_mountpoint_full->($class, $rootfs_desc, $volume_string, $noerr);
1106 $res->{mp
} = '/' if defined($res);
1108 } elsif ($key =~ m/^mp\d+$/) {
1109 return $parse_ct_mountpoint_full->($class, $mp_desc, $volume_string, $noerr);
1110 } elsif ($key =~ m/^unused\d+$/) {
1111 return $parse_ct_mountpoint_full->($class, $unused_desc, $volume_string, $noerr);
1114 die "parse_volume - unknown type: $key\n";
1118 my ($class, $key, $volume) = @_;
1120 return $class->print_ct_mountpoint($volume, $key eq 'rootfs');
1129 sub print_lxc_network
{
1130 my ($class, $net) = @_;
1131 return PVE
::JSONSchema
::print_property_string
($net, $netconf_desc);
1134 sub parse_lxc_network
{
1135 my ($class, $data) = @_;
1139 return $res if !$data;
1141 $res = PVE
::JSONSchema
::parse_property_string
($netconf_desc, $data);
1143 $res->{type
} = 'veth';
1144 if (!$res->{hwaddr
}) {
1145 my $dc = PVE
::Cluster
::cfs_read_file
('datacenter.cfg');
1146 $res->{hwaddr
} = PVE
::Tools
::random_ether_addr
($dc->{mac_prefix
});
1152 sub parse_features
{
1153 my ($class, $data) = @_;
1154 return {} if !$data;
1155 return PVE
::JSONSchema
::parse_property_string
($features_desc, $data);
1159 my ($class, $name) = @_;
1161 return defined($confdesc->{$name});
1163 # END JSON config code
1165 my $LXC_FASTPLUG_OPTIONS= {
1177 sub vmconfig_hotplug_pending
{
1178 my ($class, $vmid, $conf, $storecfg, $selection, $errors) = @_;
1180 my $pid = PVE
::LXC
::find_lxc_pid
($vmid);
1181 my $rootdir = "/proc/$pid/root";
1183 my $add_hotplug_error = sub {
1184 my ($opt, $msg) = @_;
1185 $errors->{$opt} = "unable to hotplug $opt: $msg";
1188 foreach my $opt (sort keys %{$conf->{pending
}}) { # add/change
1189 next if $selection && !$selection->{$opt};
1190 if ($LXC_FASTPLUG_OPTIONS->{$opt}) {
1191 $conf->{$opt} = delete $conf->{pending
}->{$opt};
1195 my $cgroup = PVE
::LXC
::CGroup-
>new($vmid);
1197 # There's no separate swap size to configure, there's memory and "total"
1198 # memory (iow. memory+swap). This means we have to change them together.
1199 my $hotplug_memory_done;
1200 my $hotplug_memory = sub {
1201 my ($wanted_memory, $wanted_swap) = @_;
1203 $wanted_memory = int($wanted_memory * 1024 * 1024) if defined($wanted_memory);
1204 $wanted_swap = int($wanted_swap * 1024 * 1024) if defined($wanted_swap);
1205 $cgroup->change_memory_limit($wanted_memory, $wanted_swap);
1207 $hotplug_memory_done = 1;
1210 my $pending_delete_hash = $class->parse_pending_delete($conf->{pending
}->{delete});
1211 # FIXME: $force deletion is not implemented for CTs
1212 foreach my $opt (sort keys %$pending_delete_hash) {
1213 next if $selection && !$selection->{$opt};
1215 if ($LXC_FASTPLUG_OPTIONS->{$opt}) {
1217 } elsif ($opt =~ m/^unused(\d+)$/) {
1218 PVE
::LXC
::delete_mountpoint_volume
($storecfg, $vmid, $conf->{$opt})
1219 if !$class->is_volume_in_use($conf, $conf->{$opt}, 1, 1);
1220 } elsif ($opt eq 'swap') {
1221 $hotplug_memory->(undef, 0);
1222 } elsif ($opt eq 'cpulimit') {
1223 $cgroup->change_cpu_quota(-1, 100000);
1224 } elsif ($opt eq 'cpuunits') {
1225 $cgroup->change_cpu_shares(undef, $confdesc->{cpuunits
}->{default});
1226 } elsif ($opt =~ m/^net(\d)$/) {
1228 PVE
::Network
::veth_delete
("veth${vmid}i$netid");
1230 die "skip\n"; # skip non-hotpluggable opts
1234 $add_hotplug_error->($opt, $err) if $err ne "skip\n";
1236 delete $conf->{$opt};
1237 $class->remove_from_pending_delete($conf, $opt);
1241 foreach my $opt (sort keys %{$conf->{pending
}}) {
1242 next if $opt eq 'delete'; # just to be sure
1243 next if $selection && !$selection->{$opt};
1244 my $value = $conf->{pending
}->{$opt};
1246 if ($opt eq 'cpulimit') {
1247 my $quota = 100000 * $value;
1248 $cgroup->change_cpu_quota(int(100000 * $value), 100000);
1249 } elsif ($opt eq 'cpuunits') {
1250 $cgroup->change_cpu_shares($value, $confdesc->{cpuunits
}->{default});
1251 } elsif ($opt =~ m/^net(\d+)$/) {
1253 my $net = $class->parse_lxc_network($value);
1254 $value = $class->print_lxc_network($net);
1255 PVE
::LXC
::update_net
($vmid, $conf, $opt, $net, $netid, $rootdir);
1256 } elsif ($opt eq 'memory' || $opt eq 'swap') {
1257 if (!$hotplug_memory_done) { # don't call twice if both opts are passed
1258 $hotplug_memory->($conf->{pending
}->{memory
}, $conf->{pending
}->{swap
});
1260 } elsif ($opt =~ m/^mp(\d+)$/) {
1261 if (!PVE
::LXC
::Tools
::can_use_new_mount_api
()) {
1265 if (exists($conf->{$opt})) {
1266 die "skip\n"; # don't try to hotplug over existing mp
1269 $class->apply_pending_mountpoint($vmid, $conf, $opt, $storecfg, 1);
1270 # apply_pending_mountpoint modifies the value if it creates a new disk
1271 $value = $conf->{pending
}->{$opt};
1273 die "skip\n"; # skip non-hotpluggable
1277 $add_hotplug_error->($opt, $err) if $err ne "skip\n";
1279 $conf->{$opt} = $value;
1280 delete $conf->{pending
}->{$opt};
1285 sub vmconfig_apply_pending
{
1286 my ($class, $vmid, $conf, $storecfg, $selection, $errors) = @_;
1288 my $add_apply_error = sub {
1289 my ($opt, $msg) = @_;
1290 my $err_msg = "unable to apply pending change $opt : $msg";
1291 $errors->{$opt} = $err_msg;
1295 my $pending_delete_hash = $class->parse_pending_delete($conf->{pending
}->{delete});
1296 # FIXME: $force deletion is not implemented for CTs
1297 foreach my $opt (sort keys %$pending_delete_hash) {
1298 next if $selection && !$selection->{$opt};
1300 if ($opt =~ m/^mp(\d+)$/) {
1301 my $mp = $class->parse_volume($opt, $conf->{$opt});
1302 if ($mp->{type
} eq 'volume') {
1303 $class->add_unused_volume($conf, $mp->{volume
})
1304 if !$class->is_volume_in_use($conf, $conf->{$opt}, 1, 1);
1306 } elsif ($opt =~ m/^unused(\d+)$/) {
1307 PVE
::LXC
::delete_mountpoint_volume
($storecfg, $vmid, $conf->{$opt})
1308 if !$class->is_volume_in_use($conf, $conf->{$opt}, 1, 1);
1312 $add_apply_error->($opt, $err);
1314 delete $conf->{$opt};
1315 $class->remove_from_pending_delete($conf, $opt);
1319 $class->cleanup_pending($conf);
1321 foreach my $opt (sort keys %{$conf->{pending
}}) { # add/change
1322 next if $opt eq 'delete'; # just to be sure
1323 next if $selection && !$selection->{$opt};
1325 if ($opt =~ m/^mp(\d+)$/) {
1326 $class->apply_pending_mountpoint($vmid, $conf, $opt, $storecfg, 0);
1327 } elsif ($opt =~ m/^net(\d+)$/) {
1329 my $net = $class->parse_lxc_network($conf->{pending
}->{$opt});
1330 $conf->{pending
}->{$opt} = $class->print_lxc_network($net);
1334 $add_apply_error->($opt, $err);
1336 $conf->{$opt} = delete $conf->{pending
}->{$opt};
1341 my $rescan_volume = sub {
1342 my ($storecfg, $mp) = @_;
1344 $mp->{size
} = PVE
::Storage
::volume_size_info
($storecfg, $mp->{volume
}, 5);
1346 warn "Could not rescan volume size - $@\n" if $@;
1349 sub apply_pending_mountpoint
{
1350 my ($class, $vmid, $conf, $opt, $storecfg, $running) = @_;
1352 my $mp = $class->parse_volume($opt, $conf->{pending
}->{$opt});
1353 my $old = $conf->{$opt};
1354 if ($mp->{type
} eq 'volume') {
1355 if ($mp->{volume
} =~ $PVE::LXC
::NEW_DISK_RE
) {
1356 my $original_value = $conf->{pending
}->{$opt};
1357 my $vollist = PVE
::LXC
::create_disks
(
1360 { $opt => $original_value },
1365 # Re-parse mount point:
1366 my $mp = $class->parse_volume($opt, $conf->{pending
}->{$opt});
1368 PVE
::LXC
::mountpoint_hotplug
($vmid, $conf, $opt, $mp, $storecfg);
1372 PVE
::LXC
::destroy_disks
($storecfg, $vollist);
1373 # The pending-changes code collects errors but keeps on looping through further
1374 # pending changes, so unroll the change in $conf as well if destroy_disks()
1376 $conf->{pending
}->{$opt} = $original_value;
1381 die "skip\n" if $running && defined($old); # TODO: "changing" mount points?
1382 $rescan_volume->($storecfg, $mp);
1384 PVE
::LXC
::mountpoint_hotplug
($vmid, $conf, $opt, $mp, $storecfg);
1386 $conf->{pending
}->{$opt} = $class->print_ct_mountpoint($mp);
1390 if (defined($old)) {
1391 my $mp = $class->parse_volume($opt, $old);
1392 if ($mp->{type
} eq 'volume') {
1393 $class->add_unused_volume($conf, $mp->{volume
})
1394 if !$class->is_volume_in_use($conf, $conf->{$opt}, 1, 1);
1399 sub classify_mountpoint
{
1400 my ($class, $vol) = @_;
1401 if ($vol =~ m!^/!) {
1402 return 'device' if $vol =~ m!^/dev/!;
1408 my $__is_volume_in_use = sub {
1409 my ($class, $config, $volid) = @_;
1412 $class->foreach_volume($config, sub {
1413 my ($ms, $mountpoint) = @_;
1415 $used = $mountpoint->{type
} eq 'volume' && $mountpoint->{volume
} eq $volid;
1421 sub is_volume_in_use_by_snapshots
{
1422 my ($class, $config, $volid) = @_;
1424 if (my $snapshots = $config->{snapshots
}) {
1425 foreach my $snap (keys %$snapshots) {
1426 return 1 if $__is_volume_in_use->($class, $snapshots->{$snap}, $volid);
1433 sub is_volume_in_use
{
1434 my ($class, $config, $volid, $include_snapshots, $include_pending) = @_;
1435 return 1 if $__is_volume_in_use->($class, $config, $volid);
1436 return 1 if $include_snapshots && $class->is_volume_in_use_by_snapshots($config, $volid);
1437 return 1 if $include_pending && $__is_volume_in_use->($class, $config->{pending
}, $volid);
1441 sub has_dev_console
{
1442 my ($class, $conf) = @_;
1444 return !(defined($conf->{console
}) && !$conf->{console
});
1448 my ($class, $conf, $keyname) = @_;
1450 if (my $lxcconf = $conf->{lxc
}) {
1451 foreach my $entry (@$lxcconf) {
1452 my ($key, undef) = @$entry;
1453 return 1 if $key eq $keyname;
1461 my ($class, $conf) = @_;
1463 return $conf->{tty
} // $confdesc->{tty
}->{default};
1467 my ($class, $conf) = @_;
1469 return $conf->{cmode
} // $confdesc->{cmode
}->{default};
1472 sub valid_volume_keys
{
1473 my ($class, $reverse) = @_;
1475 my @names = ('rootfs');
1477 for (my $i = 0; $i < $MAX_MOUNT_POINTS; $i++) {
1478 push @names, "mp$i";
1481 return $reverse ?
reverse @names : @names;
1484 sub get_vm_volumes
{
1485 my ($class, $conf, $excludes) = @_;
1489 $class->foreach_volume($conf, sub {
1490 my ($ms, $mountpoint) = @_;
1492 return if $excludes && $ms eq $excludes;
1494 my $volid = $mountpoint->{volume
};
1495 return if !$volid || $mountpoint->{type
} ne 'volume';
1497 my ($sid, $volname) = PVE
::Storage
::parse_volume_id
($volid, 1);
1500 push @$vollist, $volid;
1506 sub get_replicatable_volumes
{
1507 my ($class, $storecfg, $vmid, $conf, $cleanup, $noerr) = @_;
1511 my $test_volid = sub {
1512 my ($volid, $mountpoint) = @_;
1516 my $mptype = $mountpoint->{type
};
1517 my $replicate = $mountpoint->{replicate
} // 1;
1519 if ($mptype ne 'volume') {
1520 # skip bindmounts if replicate = 0 even for cleanup,
1521 # since bind mounts could not have been replicated ever
1522 return if !$replicate;
1523 die "unable to replicate mountpoint type '$mptype'\n";
1526 my ($storeid, $volname) = PVE
::Storage
::parse_volume_id
($volid, $noerr);
1527 return if !$storeid;
1529 my $scfg = PVE
::Storage
::storage_config
($storecfg, $storeid);
1530 return if $scfg->{shared
};
1532 my ($path, $owner, $vtype) = PVE
::Storage
::path
($storecfg, $volid);
1533 return if !$owner || ($owner != $vmid);
1535 die "unable to replicate volume '$volid', type '$vtype'\n" if $vtype ne 'images';
1537 return if !$cleanup && !$replicate;
1539 if (!PVE
::Storage
::volume_has_feature
($storecfg, 'replicate', $volid)) {
1540 return if $cleanup || $noerr;
1541 die "missing replicate feature on volume '$volid'\n";
1544 $volhash->{$volid} = 1;
1547 $class->foreach_volume($conf, sub {
1548 my ($ms, $mountpoint) = @_;
1549 $test_volid->($mountpoint->{volume
}, $mountpoint);
1552 foreach my $snapname (keys %{$conf->{snapshots
}}) {
1553 my $snap = $conf->{snapshots
}->{$snapname};
1554 $class->foreach_volume($snap, sub {
1555 my ($ms, $mountpoint) = @_;
1556 $test_volid->($mountpoint->{volume
}, $mountpoint);
1560 # add 'unusedX' volumes to volhash
1561 foreach my $key (keys %$conf) {
1562 if ($key =~ m/^unused/) {
1563 $test_volid->($conf->{$key}, { type
=> 'volume', replicate
=> 1 });
1570 sub get_backup_volumes
{
1571 my ($class, $conf) = @_;
1573 my $return_volumes = [];
1575 my $test_mountpoint = sub {
1576 my ($key, $volume) = @_;
1578 my ($included, $reason) = $class->mountpoint_backup_enabled($key, $volume);
1580 push @$return_volumes, {
1582 included
=> $included,
1584 volume_config
=> $volume,
1588 PVE
::LXC
::Config-
>foreach_volume($conf, $test_mountpoint);
1590 return $return_volumes;