1 package PVE
::QemuServer
::Cloudinit
;
9 use MIME
::Base64
qw(encode_base64);
10 use Storable
qw(dclone);
12 use PVE
::Tools
qw(run_command file_set_contents);
15 use PVE
::QemuServer
::Helpers
;
17 use constant CLOUDINIT_DISK_SIZE
=> 4 * 1024 * 1024; # 4MiB in bytes
19 sub commit_cloudinit_disk
{
20 my ($conf, $vmid, $drive, $volname, $storeid, $files, $label) = @_;
22 my $path = "/run/pve/cloudinit/$vmid/";
24 foreach my $filepath (keys %$files) {
25 if ($filepath !~ m
@^(.*)\
/[^/]+$@) {
26 die "internal error: bad file name in cloud-init image: $filepath\n";
29 mkpath
"$path/$dirname";
31 my $contents = $files->{$filepath};
32 file_set_contents
("$path/$filepath", $contents);
35 my $storecfg = PVE
::Storage
::config
();
36 my $iso_path = PVE
::Storage
::path
($storecfg, $drive->{file
});
37 my $scfg = PVE
::Storage
::storage_config
($storecfg, $storeid);
38 my $format = PVE
::QemuServer
::qemu_img_format
($scfg, $volname);
40 my $size = eval { PVE
::Storage
::volume_size_info
($storecfg, $drive->{file
}) };
41 if (!defined($size) || $size <= 0) {
42 $volname =~ m/(vm-$vmid-cloudinit(.\Q$format\E)?)/;
45 PVE
::Storage
::vdisk_alloc
($storecfg, $storeid, $vmid, $format, $name, $size);
46 $size *= 1024; # vdisk alloc takes KB, qemu-img dd's osize takes byte
48 my $plugin = PVE
::Storage
::Plugin-
>lookup($scfg->{type
});
49 $plugin->activate_volume($storeid, $scfg, $volname);
51 print "generating cloud-init ISO\n";
54 ['genisoimage', '-quiet', '-iso-level', '3', '-R', '-V', $label, $path],
55 ['qemu-img', 'dd', '-n', '-f', 'raw', '-O', $format, 'isize=0', "osize=$size", "of=$iso_path"]
63 sub get_cloudinit_format
{
65 if (defined(my $format = $conf->{citype
})) {
69 # No format specified, default based on ostype because windows'
70 # cloudbased-init only supports configdrivev2, whereas on linux we need
71 # to use mac addresses because regular cloudinit doesn't map 'ethX' to
72 # the new predicatble network device naming scheme.
73 if (defined(my $ostype = $conf->{ostype
})) {
75 if PVE
::QemuServer
::Helpers
::windows_version
($ostype);
81 sub get_hostname_fqdn
{
82 my ($conf, $vmid) = @_;
83 my $hostname = $conf->{name
} // "VM$vmid";
85 if ($hostname =~ /\./) {
87 $hostname =~ s/\..*$//;
88 } elsif (my $search = $conf->{searchdomain
}) {
89 $fqdn = "$hostname.$search";
93 return ($hostname, $fqdn);
99 # Same logic as in pve-container, but without the testcase special case
100 my $host_resolv_conf = PVE
::INotify
::read_file
('resolvconf');
102 my $searchdomains = [
103 split(/\s+/, $conf->{searchdomain
} // $host_resolv_conf->{search
})
106 my $nameserver = $conf->{nameserver
};
107 if (!defined($nameserver)) {
108 $nameserver = [grep { $_ } $host_resolv_conf->@{qw(dns1 dns2 dns3)}];
110 $nameserver = [split(/\s+/, $nameserver)];
113 return ($searchdomains, $nameserver);
116 sub cloudinit_userdata
{
117 my ($conf, $vmid) = @_;
119 my ($hostname, $fqdn) = get_hostname_fqdn
($conf, $vmid);
121 my $content = "#cloud-config\n";
123 $content .= "hostname: $hostname\n";
124 $content .= "manage_etc_hosts: true\n";
125 $content .= "fqdn: $fqdn\n";
127 my $username = $conf->{ciuser
};
128 my $password = $conf->{cipassword
};
130 $content .= "user: $username\n" if defined($username);
131 $content .= "disable_root: False\n" if defined($username) && $username eq 'root';
132 $content .= "password: $password\n" if defined($password);
134 if (defined(my $keys = $conf->{sshkeys
})) {
135 $keys = URI
::Escape
::uri_unescape
($keys);
136 $keys = [map { my $key = $_; chomp $key; $key } split(/\n/, $keys)];
137 $keys = [grep { /\S/ } @$keys];
138 $content .= "ssh_authorized_keys:\n";
139 foreach my $k (@$keys) {
140 $content .= " - $k\n";
143 $content .= "chpasswd:\n";
144 $content .= " expire: False\n";
146 if (!defined($username) || $username ne 'root') {
147 $content .= "users:\n";
148 $content .= " - default\n";
151 $content .= "package_upgrade: true\n" if !defined($conf->{ciupgrade
}) || $conf->{ciupgrade
};
158 my ($addr, $mask) = split('/', $ip);
159 die "not a CIDR: $ip\n" if !defined $mask;
160 return ($addr, $PVE::Network
::ipv4_reverse_mask-
>[$mask]);
163 sub configdrive2_network
{
166 my $content = "auto lo\n";
167 $content .= "iface lo inet loopback\n\n";
169 my ($searchdomains, $nameservers) = get_dns_conf
($conf);
170 if ($nameservers && @$nameservers) {
171 $nameservers = join(' ', @$nameservers);
172 $content .= " dns_nameservers $nameservers\n";
174 if ($searchdomains && @$searchdomains) {
175 $searchdomains = join(' ', @$searchdomains);
176 $content .= " dns_search $searchdomains\n";
179 my @ifaces = grep { /^net(\d+)$/ } keys %$conf;
180 foreach my $iface (sort @ifaces) {
181 (my $id = $iface) =~ s/^net//;
182 next if !$conf->{"ipconfig$id"};
183 my $net = PVE
::QemuServer
::parse_ipconfig
($conf->{"ipconfig$id"});
186 $content .="auto $id\n";
188 if ($net->{ip
} eq 'dhcp') {
189 $content .= "iface $id inet dhcp\n";
191 my ($addr, $mask) = split_ip4
($net->{ip
});
192 $content .= "iface $id inet static\n";
193 $content .= " address $addr\n";
194 $content .= " netmask $mask\n";
195 $content .= " gateway $net->{gw}\n" if $net->{gw
};
199 if ($net->{ip6
} =~ /^(auto|dhcp)$/) {
200 $content .= "iface $id inet6 $1\n";
202 my ($addr, $mask) = split('/', $net->{ip6
});
203 $content .= "iface $id inet6 static\n";
204 $content .= " address $addr\n";
205 $content .= " netmask $mask\n";
206 $content .= " gateway $net->{gw6}\n" if $net->{gw6
};
214 sub configdrive2_gen_metadata
{
215 my ($user, $network) = @_;
217 my $uuid_str = Digest
::SHA
::sha1_hex
($user.$network);
218 return configdrive2_metadata
($uuid_str);
221 sub configdrive2_metadata
{
226 "network_config": { "content_path": "/content/0000" }
231 sub generate_configdrive2
{
232 my ($conf, $vmid, $drive, $volname, $storeid) = @_;
234 my ($user_data, $network_data, $meta_data, $vendor_data) = get_custom_cloudinit_files
($conf);
235 $user_data = cloudinit_userdata
($conf, $vmid) if !defined($user_data);
236 $network_data = configdrive2_network
($conf) if !defined($network_data);
237 $vendor_data = '' if !defined($vendor_data);
239 if (!defined($meta_data)) {
240 $meta_data = configdrive2_gen_metadata
($user_data, $network_data);
243 # we always allocate a 4MiB disk for cloudinit and with the overhead of the ISO
244 # make sure we always stay below it by keeping the sum of all files below 3 MiB
245 my $sum = length($user_data) + length($network_data) + length($meta_data) + length($vendor_data);
246 die "Cloud-Init sum of snippets too big (> 3 MiB)\n" if $sum > (3 * 1024 * 1024);
249 '/openstack/latest/user_data' => $user_data,
250 '/openstack/content/0000' => $network_data,
251 '/openstack/latest/meta_data.json' => $meta_data,
252 '/openstack/latest/vendor_data.json' => $vendor_data
254 commit_cloudinit_disk
($conf, $vmid, $drive, $volname, $storeid, $files, 'config-2');
257 sub generate_opennebula
{
258 my ($conf, $vmid, $drive, $volname, $storeid) = @_;
262 my $username = $conf->{ciuser
} || "root";
263 $content .= "USERNAME=$username\n" if defined($username);
265 if (defined(my $password = $conf->{cipassword
})) {
266 $content .= "CRYPTED_PASSWORD_BASE64=". encode_base64
($password) ."\n";
269 if (defined($conf->{sshkeys
})) {
270 my $keys = [ split(/\s*\n\s*/, URI
::Escape
::uri_unescape
($conf->{sshkeys
})) ];
271 $content .= "SSH_PUBLIC_KEY=\"". join("\n", $keys->@*) ."\"\n";
274 my ($hostname, $fqdn) = get_hostname_fqdn
($conf, $vmid);
275 $content .= "SET_HOSTNAME=$hostname\n";
277 my ($searchdomains, $nameservers) = get_dns_conf
($conf);
278 $content .= 'DNS="' . join(' ', @$nameservers) ."\"\n" if $nameservers && @$nameservers;
279 $content .= 'SEARCH_DOMAIN="'. join(' ', @$searchdomains) ."\"\n" if $searchdomains && @$searchdomains;
281 my $networkenabled = undef;
282 my @ifaces = grep { /^net(\d+)$/ } keys %$conf;
283 foreach my $iface (sort @ifaces) {
284 (my $id = $iface) =~ s/^net//;
285 my $net = PVE
::QemuServer
::parse_net
($conf->{$iface});
286 next if !$conf->{"ipconfig$id"};
287 my $ipconfig = PVE
::QemuServer
::parse_ipconfig
($conf->{"ipconfig$id"});
288 my $ethid = "ETH$id";
290 my $mac = lc $net->{hwaddr
};
292 if ($ipconfig->{ip
}) {
295 if ($ipconfig->{ip
} eq 'dhcp') {
296 $content .= "${ethid}_DHCP=YES\n";
298 my ($addr, $mask) = split_ip4
($ipconfig->{ip
});
299 $content .= "${ethid}_IP=$addr\n";
300 $content .= "${ethid}_MASK=$mask\n";
301 $content .= "${ethid}_MAC=$mac\n";
302 $content .= "${ethid}_GATEWAY=$ipconfig->{gw}\n" if $ipconfig->{gw
};
304 $content .= "${ethid}_MTU=$net->{mtu}\n" if $net->{mtu
};
307 if ($ipconfig->{ip6
}) {
309 if ($ipconfig->{ip6
} eq 'dhcp') {
310 $content .= "${ethid}_DHCP6=YES\n";
311 } elsif ($ipconfig->{ip6
} eq 'auto') {
312 $content .= "${ethid}_AUTO6=YES\n";
314 my ($addr, $mask) = split('/', $ipconfig->{ip6
});
315 $content .= "${ethid}_IP6=$addr\n";
316 $content .= "${ethid}_MASK6=$mask\n";
317 $content .= "${ethid}_MAC6=$mac\n";
318 $content .= "${ethid}_GATEWAY6=$ipconfig->{gw6}\n" if $ipconfig->{gw6
};
320 $content .= "${ethid}_MTU=$net->{mtu}\n" if $net->{mtu
};
324 $content .= "NETWORK=YES\n" if $networkenabled;
326 my $files = { '/context.sh' => $content };
327 commit_cloudinit_disk
($conf, $vmid, $drive, $volname, $storeid, $files, 'CONTEXT');
330 sub nocloud_network_v2
{
335 my $head = "version: 2\n"
340 my @ifaces = grep { /^net(\d+)$/ } keys %$conf;
341 foreach my $iface (sort @ifaces) {
342 (my $id = $iface) =~ s/^net//;
343 next if !$conf->{"ipconfig$id"};
345 # indentation - network interfaces are inside an 'ethernets' hash
348 my $net = PVE
::QemuServer
::parse_net
($conf->{$iface});
349 my $ipconfig = PVE
::QemuServer
::parse_ipconfig
($conf->{"ipconfig$id"});
351 my $mac = $net->{macaddr
}
352 or die "network interface '$iface' has no mac address\n";
354 $content .= "${i}$iface:\n";
356 $content .= "${i}match:\n"
357 . "${i} macaddress: \"$mac\"\n"
358 . "${i
}set-name
: eth
$id\n";
360 if (defined(my $ip = $ipconfig->{ip})) {
362 $content .= "${i
}dhcp4
: true
\n";
364 push @addresses, $ip;
367 if (defined(my $ip = $ipconfig->{ip6})) {
369 $content .= "${i
}dhcp6
: true
\n";
371 push @addresses, $ip;
375 $content .= "${i
}addresses
:\n";
376 $content .= "${i
}- '$_'\n" foreach @addresses;
378 if (defined(my $gw = $ipconfig->{gw})) {
379 $content .= "${i
}gateway4
: '$gw'\n";
381 if (defined(my $gw = $ipconfig->{gw6})) {
382 $content .= "${i
}gateway6
: '$gw'\n";
388 my ($searchdomains, $nameservers) = get_dns_conf($conf);
389 if ($searchdomains || $nameservers) {
390 $content .= "${i
}nameservers
:\n";
391 if (defined($nameservers) && @$nameservers) {
392 $content .= "${i
} addresses
:\n";
393 $content .= "${i
} - '$_'\n" foreach @$nameservers;
395 if (defined($searchdomains) && @$searchdomains) {
396 $content .= "${i
} search
:\n";
397 $content .= "${i
} - '$_'\n" foreach @$searchdomains;
402 return $head.$content;
405 sub nocloud_network {
408 my $content = "version
: 1\n"
411 my @ifaces = grep { /^net(\d+)$/ } keys %$conf;
412 foreach my $iface (sort @ifaces) {
413 (my $id = $iface) =~ s/^net//;
414 next if !$conf->{"ipconfig
$id"};
416 # indentation - network interfaces are inside an 'ethernets' hash
419 my $net = PVE::QemuServer::parse_net($conf->{$iface});
420 my $ipconfig = PVE::QemuServer::parse_ipconfig($conf->{"ipconfig
$id"});
422 my $mac = lc($net->{macaddr})
423 or die "network interface
'$iface' has no mac address
\n";
425 $content .= "${i
}- type
: physical
\n"
426 . "${i
} name
: eth
$id\n"
427 . "${i
} mac_address
: '$mac'\n"
430 if (defined(my $ip = $ipconfig->{ip})) {
432 $content .= "${i
}- type
: dhcp4
\n";
434 my ($addr, $mask) = split_ip4($ip);
435 $content .= "${i
}- type
: static
\n"
436 . "${i
} address
: '$addr'\n"
437 . "${i
} netmask
: '$mask'\n";
438 if (defined(my $gw = $ipconfig->{gw})) {
439 $content .= "${i
} gateway
: '$gw'\n";
443 if (defined(my $ip = $ipconfig->{ip6})) {
445 $content .= "${i
}- type
: dhcp6
\n";
446 } elsif ($ip eq 'auto') {
447 # SLAAC is only supported by cloud-init since 19.4
448 $content .= "${i
}- type
: ipv6_slaac
\n";
450 $content .= "${i
}- type
: static6
\n"
451 . "${i
} address
: '$ip'\n";
452 if (defined(my $gw = $ipconfig->{gw6})) {
453 $content .= "${i
} gateway
: '$gw'\n";
460 my ($searchdomains, $nameservers) = get_dns_conf($conf);
461 if ($searchdomains || $nameservers) {
462 $content .= "${i
}- type
: nameserver
\n";
463 if (defined($nameservers) && @$nameservers) {
464 $content .= "${i
} address
:\n";
465 $content .= "${i
} - '$_'\n" foreach @$nameservers;
467 if (defined($searchdomains) && @$searchdomains) {
468 $content .= "${i
} search
:\n";
469 $content .= "${i
} - '$_'\n" foreach @$searchdomains;
476 sub nocloud_metadata {
478 return "instance-id
: $uuid\n";
481 sub nocloud_gen_metadata {
482 my ($user, $network) = @_;
484 my $uuid_str = Digest::SHA::sha1_hex($user.$network);
485 return nocloud_metadata($uuid_str);
488 sub generate_nocloud {
489 my ($conf, $vmid, $drive, $volname, $storeid) = @_;
491 my ($user_data, $network_data, $meta_data, $vendor_data) = get_custom_cloudinit_files($conf);
492 $user_data = cloudinit_userdata($conf, $vmid) if !defined($user_data);
493 $network_data = nocloud_network($conf) if !defined($network_data);
494 $vendor_data = '' if !defined($vendor_data);
496 if (!defined($meta_data)) {
497 $meta_data = nocloud_gen_metadata($user_data, $network_data);
500 # we always allocate a 4MiB disk for cloudinit and with the overhead of the ISO
501 # make sure we always stay below it by keeping the sum of all files below 3 MiB
502 my $sum = length($user_data) + length($network_data) + length($meta_data) + length($vendor_data);
503 die "Cloud-Init sum of snippets too big
(> 3 MiB
)\n" if $sum > (3 * 1024 * 1024);
506 '/user-data' => $user_data,
507 '/network-config' => $network_data,
508 '/meta-data' => $meta_data,
509 '/vendor-data' => $vendor_data
511 commit_cloudinit_disk($conf, $vmid, $drive, $volname, $storeid, $files, 'cidata');
514 sub get_custom_cloudinit_files {
517 my $cicustom = $conf->{cicustom};
518 my $files = $cicustom ? PVE::JSONSchema::parse_property_string('pve-qm-cicustom', $cicustom) : {};
520 my $network_volid = $files->{network};
521 my $user_volid = $files->{user};
522 my $meta_volid = $files->{meta};
523 my $vendor_volid = $files->{vendor};
525 my $storage_conf = PVE::Storage::config();
528 if ($network_volid) {
529 $network_data = read_cloudinit_snippets_file($storage_conf, $network_volid);
534 $user_data = read_cloudinit_snippets_file($storage_conf, $user_volid);
539 $meta_data = read_cloudinit_snippets_file($storage_conf, $meta_volid);
544 $vendor_data = read_cloudinit_snippets_file($storage_conf, $vendor_volid);
547 return ($user_data, $network_data, $meta_data, $vendor_data);
550 sub read_cloudinit_snippets_file {
551 my ($storage_conf, $volid) = @_;
553 my ($vtype, undef) = PVE::Storage::parse_volname($storage_conf, $volid);
555 die "$volid is not in the snippets directory
\n" if $vtype ne 'snippets';
557 my $full_path = PVE::Storage::abs_filesystem_path($storage_conf, $volid, 1);
558 return PVE::Tools::file_get_contents($full_path, 1 * 1024 * 1024);
561 my $cloudinit_methods = {
562 configdrive2 => \&generate_configdrive2,
563 nocloud => \&generate_nocloud,
564 opennebula => \&generate_opennebula,
570 return !!$conf->{cloudinit}->%*;
573 sub generate_cloudinit_config {
574 my ($conf, $vmid) = @_;
576 my $format = get_cloudinit_format($conf);
578 my $has_changes = has_changes($conf);
580 PVE::QemuConfig->foreach_volume($conf, sub {
581 my ($ds, $drive) = @_;
583 my ($storeid, $volname) = PVE::Storage::parse_volume_id($drive->{file}, 1);
585 return if !$volname || $volname !~ m/vm-$vmid-cloudinit/;
587 my $generator = $cloudinit_methods->{$format}
588 or die "missing cloudinit methods
for format
'$format'\n";
590 $generator->($conf, $vmid, $drive, $volname, $storeid);
596 sub apply_cloudinit_config {
597 my ($conf, $vmid) = @_;
599 my $has_changes = generate_cloudinit_config($conf, $vmid);
602 delete $conf->{cloudinit};
603 PVE::QemuConfig->write_config($vmid, $conf);
610 sub dump_cloudinit_config {
611 my ($conf, $vmid, $type) = @_;
613 my $format = get_cloudinit_format($conf);
615 if ($type eq 'user') {
616 return cloudinit_userdata($conf, $vmid);
617 } elsif ($type eq 'network') {
618 if ($format eq 'nocloud') {
619 return nocloud_network($conf);
621 return configdrive2_network($conf);
623 } else { # metadata config
624 my $user = cloudinit_userdata($conf, $vmid);
625 if ($format eq 'nocloud') {
626 my $network = nocloud_network($conf);
627 return nocloud_gen_metadata($user, $network);
629 my $network = configdrive2_network($conf);
630 return configdrive2_gen_metadata($user, $network);