2 # Copyright (C) 2015 Richard W.M. Jones <rjones@redhat.com>
3 # Copyright (C) 2015 Red Hat Inc.
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 use File::Temp qw(tempdir);
26 use POSIX qw(_exit setgid setuid strftime);
33 import-to-ovirt.pl - Import virtual machine disk image to RHEV or oVirt
37 sudo ./import-to-ovirt.pl disk.img server:/esd
39 sudo ./import-to-ovirt.pl disk.img /esd_mountpoint
43 This tool should B<only> be used if the guest can already run on KVM.
45 B<If you need to convert the guest from some foreign hypervisor, like VMware, Xen or Hyper-V, you should use L<virt-v2v(1)> instead.>
49 Import a KVM guest to the Export Storage Domain of your RHEV or oVirt
50 system. The NFS mount of the Export Storage Domain is C<server:/esd>.
52 sudo ./import-to-ovirt.pl disk.img server:/esd
54 Import a KVM guest to an already-mounted Export Storage Domain:
56 sudo ./import-to-ovirt.pl disk.img /esd_mountpoint
58 If the single guest has multiple disks, use:
60 sudo ./import-to-ovirt.pl disk1.img [disk2.img [...]] server:/esd
62 If you are importing multiple guests then you must import each one
63 separately. Do not use multiple disk parameters if each disk comes
64 from a different guest.
68 This is a command line script for importing a KVM virtual machine to
69 RHEV or oVirt. The script assumes that the guest can already run on
70 KVM, ie. that it was previously running on KVM and has the required
71 drivers. If the guest comes from a foreign hypervisor like VMware,
72 Xen or Hyper-V, use L<virt-v2v(1)> instead.
74 This script only imports the guest into the oVirt "Export Storage
75 Domain" (ESD). After the import is complete, you must then go to the
76 oVirt user interface, go to the C<Storage> tab, select the right ESD,
77 and use C<VM Import> to take the guest from the ESD to the data
78 domain. This process is outside the scope of this script, but could
79 be automated using the oVirt API.
85 ./import-to-ovirt.pl [list of disks] server:/esd
87 If you are unclear about the C<server:/esd> parameter, go to the oVirt
88 Storage tab, select the C<Domain Type> C<Export> and look in the
89 C<General> tab under C<Path>.
91 If the ESD is already mounted on your machine (or if you are using a
92 non-NFS ESD), then you can supply a direct path to the mountpoint
95 ./import-to-ovirt.pl [list of disks] /esd_mountpoint
97 The list of disks should all belong to a single guest (most guests
98 will only have a single disk). If you want to import multiple guests,
99 you must run the script multiple times.
101 Importing from OVA etc is not supported. Try C<ovirt-image-uploader>
102 (if the OVA was exported from oVirt), or L<virt-v2v(1)> (if the OVA
103 was exported from VMware).
107 You probably need to run this script as root, because it has to create
108 files on the ESD as a special C<vdsm> user (UID:GID C<36:36>).
110 It may also be possible to run the script as the vdsm user. But if
111 you run it as some non-root, non-vdsm user, then oVirt won't be able
112 to read the data from the ESD and will give an error.
114 NFS "root squash" should be turned off on the NFS server, since it
115 stops us from creating files as the vdsm user. Also NFSv4 may not
116 work unless you have set up idmap correctly (good luck!)
118 =head2 Network card and disk model
120 (See also L</TO DO> below)
122 Currently this script doesn't add a network card to the guest. You
123 will need to add one yourself in the C<VM Import> tab when importing
126 Similarly, the script always adds the disks as virtio-blk devices. If
127 the guest is expecting IDE, SCSI or virtio-scsi, you will need to
128 change the disk type when importing the guest.
140 Display brief help and exit.
148 Display the manual page and exit.
152 my $memory_mb = 1024;
156 Set the memory size I<in megabytes>. The default is 1024.
164 Set the guest name. If not present, a name is made up based on
165 the filename of the first disk.
173 Set the number of virtual CPUs. The default is 1.
177 my $vmtype = "Desktop";
179 =item B<--vmtype> Desktop
181 =item B<--vmtype> Server
183 Set the VmType field in the OVF. It must be C<Desktop> or
184 C<Server>. The default is C<Desktop>.
194 GetOptions ("help|?" => \$help,
196 "memory=i" => \$memory_mb,
198 "vmtype=s" => \$vmtype,
200 or die "$0: unknown command line option\n";
202 pod2usage (1) if $help;
203 pod2usage (-exitval => 0, -verbose => 2) if $man;
205 # Get the parameters.
207 die "Use '$0 --man' to display the manual.\n"
210 my @disks = @ARGV[0 .. $#ARGV-1];
211 my $output = $ARGV[$#ARGV];
213 if (!defined $name) {
216 $name =~ s{\.[^.]+}{};
219 if ($vmtype =~ /^Desktop$/i) {
221 } elsif ($vmtype =~ /^Server$/i) {
224 die "$0: --vmtype parameter must be 'Desktop' or 'Server'\n"
227 # Open the guest in libguestfs so we can inspect it.
228 my $g = Sys::Guestfs->new ();
229 $g->set_program ("virt-import-to-ovirt");
230 $g->add_drive_opts ($_, readonly => 1) foreach (@disks);
232 my @roots = $g->inspect_os ();
234 die "$0: no operating system was found on the disk\n"
237 die "$0: either this is a multi-OS disk, or you passed multiple unrelated guest disks on the command line\n"
239 my $root = $roots[0];
241 # Save the inspection data.
242 my $type = $g->inspect_get_type ($root);
243 my $distro = $g->inspect_get_distro ($root);
244 my $arch = $g->inspect_get_arch ($root);
245 my $major_version = $g->inspect_get_major_version ($root);
246 my $minor_version = $g->inspect_get_major_version ($root);
247 my $product_name = $g->inspect_get_product_name ($root);
248 my $product_variant = $g->inspect_get_product_variant ($root);
250 # Get the virtual size of each disk.
253 push @virtual_sizes, $g->disk_virtual_size ($_);
258 # Map inspection data to RHEV ostype.
260 if ($type eq "linux" && $distro eq "rhel" && $major_version <= 6) {
261 if ($arch eq "x86_64") {
262 $ostype = "RHEL${major_version}x64"
264 $ostype = "RHEL$major_version"
267 elsif ($type eq "linux" && $distro eq "rhel") {
268 if ($arch eq "x86_64") {
269 $ostype = "rhel_${major_version}x64"
271 $ostype = "rhel_$major_version"
274 elsif ($type eq "linux") {
275 $ostype = "OtherLinux"
277 elsif ($type eq "windows" && $major_version == 5 && $minor_version == 1) {
278 $ostype = "WindowsXP"
280 elsif ($type eq "windows" && $major_version == 5 && $minor_version == 2) {
281 if ($product_name =~ /XP/) {
282 $ostype = "WindowsXP"
283 } elsif ($arch eq "x86_64") {
284 $ostype = "Windows2003x64"
286 $ostype = "Windows2003"
289 elsif ($type eq "windows" && $major_version == 6 && $minor_version == 0) {
290 if ($arch eq "x86_64") {
291 $ostype = "Windows2008x64"
293 $ostype = "Windows2008"
296 elsif ($type eq "windows" && $major_version == 6 && $minor_version == 1) {
297 if ($product_variant eq "Client") {
298 if ($arch eq "x86_64") {
299 $ostype = "Windows7x64"
304 $ostype = "Windows2008R2x64"
307 elsif ($type eq "windows" && $major_version == 6 && $minor_version == 2) {
308 if ($product_variant eq "Client") {
309 if ($arch eq "x86_64") {
310 $ostype = "windows_8x64"
312 $ostype = "windows_8"
315 $ostype = "windows_2012x64"
318 elsif ($type eq "windows" && $major_version == 6 && $minor_version == 3) {
319 $ostype = "windows_2012R2x64"
322 $ostype = "Unassigned"
325 # Mount the ESD if needed (or just check it exists).
328 $mountpoint = $output;
329 } elsif ($output =~ m{^.*:.*$}) {
331 $umount = $mountpoint = tempdir (CLEANUP => 1);
332 system ("mount", "-t", "nfs", $output, $mountpoint) == 0
333 or die "$0: mount $output failed: $?\n";
334 END { system ("umount", $umount) if defined $umount }
336 die "$0: ESD $output is not a directory or an NFS mountpoint\n"
339 # Check the ESD looks like an ESD.
340 my @entries = <$mountpoint/*>;
342 grep { m{/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$}i }
345 die "$0: does $output really point to an oVirt Export Storage Domain?\n"
348 die "$0: multiple GUIDs found in oVirt Export Storage Domain\n"
350 my $esd_uuid_dir = $entries[0];
351 my $esd_uuid = $esd_uuid_dir;
352 $esd_uuid =~ s{.*/}{};
354 if (! -d $esd_uuid_dir ||
355 ! -d "$esd_uuid_dir/images" ||
356 ! -d "$esd_uuid_dir/master" ||
357 ! -d "$esd_uuid_dir/master/vms") {
358 die "$0: $output doesn't look like an Export Storage Domain\n"
362 print "Importing $product_name to $output...\n";
364 # A helper function that forks and runs some code / a command as
365 # an alternate UID:GID.
371 die "fork: $!" unless defined $pid;
385 waitpid ($pid, 0) or die "waitpid: $!";
387 die "$0: run_as_vdsm: child process failed (status $?)\n";
394 local $_ = `uuidgen -r`;
396 die unless length $_ >= 30; # Sanity check.
400 # Generate some random UUIDs.
401 my $vm_uuid = uuidgen ();
404 push @image_uuids, uuidgen ();
408 push @vol_uuids, uuidgen ();
411 # Make sure the output is deleted on unsuccessful exit. We set
412 # $delete_output_on_exit to false at the end of the script.
413 my $delete_output_on_exit = 1;
415 if ($delete_output_on_exit) {
416 # Can't use run_as_vdsm in an END{} block.
417 foreach (@image_uuids) {
418 system ("rm", "-rf", "$esd_uuid_dir/images/$_");
420 system ("rm", "-rf", "$esd_uuid_dir/master/vms/$vm_uuid");
424 # Copy and convert the disk images.
427 my $iso_time = strftime ("%Y/%m/%d %H:%M:%S", gmtime ());
428 my $imported_by = "Imported by import-to-ovirt.pl";
431 for ($i = 0; $i < @disks; ++$i) {
432 my $input_file = $disks[$i];
433 my $image_uuid = $image_uuids[$i];
435 my $path = "$esd_uuid_dir/images/$image_uuid";
436 mkdir ($path, 0755) or die "mkdir: $path: $!";
438 my $output_file = "$esd_uuid_dir/images/$image_uuid/".$vol_uuids[$i];
440 open (my $fh, ">", $output_file) or die "open: $output_file: $!";
441 # Well done NFS root_squash, you make the world less secure.
442 chmod (0666, $output_file) or die "chmod: $output_file: $!";
444 print "Copying $input_file ...\n";
445 system ("qemu-img", "convert", "-p",
448 "-o", "compat=0.10", # for RHEL 6-based ovirt nodes
450 or die "qemu-img: $input_file: failed (status $?)";
451 push @real_sizes, -s $output_file;
453 my $size_in_sectors = $virtual_sizes[$i] / 512;
455 # Create .meta files per disk.
463 PUUID=00000000-0000-0000-0000-000000000000
466 SIZE=$size_in_sectors
469 DESCRIPTION=$imported_by
471 my $meta_file = $output_file . ".meta";
473 open (my $fh, ">", $meta_file) or die "open: $meta_file: $!";
479 print "Creating OVF metadata ...\n";
481 my $rasd_ns = "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData";
482 my $vssd_ns = "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData";
483 my $xsi_ns = "http://www.w3.org/2001/XMLSchema-instance";
484 my $ovf_ns = "http://schemas.dmtf.org/ovf/envelope/1/";
491 my @forced_ns_decls = keys %prefix_map;
493 my $w = XML::Writer->new (
496 PREFIX_MAP => \%prefix_map,
497 FORCED_NS_DECLS => \@forced_ns_decls,
502 $w->startTag ([$ovf_ns, "Envelope"],
503 [$ovf_ns, "version"] => "0.9");
504 $w->comment ($imported_by);
506 $w->startTag ("References");
508 for ($i = 0; $i < @disks; ++$i)
510 my $href = $image_uuids[$i] . "/" . $vol_uuids[$i];
511 $w->startTag ("File",
512 [$ovf_ns, "href"] => $href,
513 [$ovf_ns, "id"] => $vol_uuids[$i],
514 [$ovf_ns, "size"] => $virtual_sizes[$i],
515 [$ovf_ns, "description"] => $imported_by);
521 $w->startTag ("Section",
522 [$xsi_ns, "type"] => "ovf:NetworkSection_Type");
523 $w->startTag ("Info");
524 $w->characters ("List of networks");
528 $w->startTag ("Section",
529 [$xsi_ns, "type"] => "ovf:DiskSection_Type");
530 $w->startTag ("Info");
531 $w->characters ("List of Virtual Disks");
534 for ($i = 0; $i < @disks; ++$i)
536 my $virtual_size_in_gb = $virtual_sizes[$i];
537 $virtual_size_in_gb /= 1024;
538 $virtual_size_in_gb /= 1024;
539 $virtual_size_in_gb /= 1024;
540 my $real_size_in_gb = $real_sizes[$i];
541 $real_size_in_gb /= 1024;
542 $real_size_in_gb /= 1024;
543 $real_size_in_gb /= 1024;
544 my $href = $image_uuids[$i] . "/" . $vol_uuids[$i];
548 $boot_drive = "True";
550 $boot_drive = "False";
553 $w->startTag ("Disk",
554 [$ovf_ns, "diskId" ] => $vol_uuids[$i],
555 [$ovf_ns, "actual_size"] =>
556 sprintf ("%.0f", $real_size_in_gb),
558 sprintf ("%.0f", $virtual_size_in_gb),
559 [$ovf_ns, "fileRef"] => $href,
560 [$ovf_ns, "parentRef"] => "",
561 [$ovf_ns, "vm_snapshot_id"] => uuidgen (),
562 [$ovf_ns, "volume-format"] => "COW",
563 [$ovf_ns, "volume-type"] => "Sparse",
564 [$ovf_ns, "format"] => "http://en.wikipedia.org/wiki/Byte",
565 [$ovf_ns, "disk-interface"] => "VirtIO",
566 [$ovf_ns, "disk-type"] => "System",
567 [$ovf_ns, "boot"] => $boot_drive);
573 $w->startTag ("Content",
574 [$ovf_ns, "id"] => "out",
575 [$xsi_ns, "type"] => "ovf:VirtualSystem_Type");
576 $w->startTag ("Name");
577 $w->characters ($name);
579 $w->startTag ("TemplateId");
580 $w->characters ("00000000-0000-0000-0000-000000000000");
582 $w->startTag ("TemplateName");
583 $w->characters ("Blank");
585 $w->startTag ("Description");
586 $w->characters ($imported_by);
588 $w->startTag ("Domain");
590 $w->startTag ("CreationDate");
591 $w->characters ($iso_time);
593 $w->startTag ("IsInitilized"); # sic
594 $w->characters ("True");
596 $w->startTag ("IsAutoSuspend");
597 $w->characters ("False");
599 $w->startTag ("TimeZone");
601 $w->startTag ("IsStateless");
602 $w->characters ("False");
604 $w->startTag ("Origin");
605 $w->characters ("0");
607 $w->startTag ("VmType");
608 $w->characters ($vmtype);
610 $w->startTag ("DefaultDisplayType");
611 $w->characters ("1"); # qxl
614 $w->startTag ("Section",
615 [$ovf_ns, "id"] => $vm_uuid,
616 [$ovf_ns, "required"] => "false",
617 [$xsi_ns, "type"] => "ovf:OperatingSystemSection_Type");
618 $w->startTag ("Info");
619 $w->characters ($product_name);
621 $w->startTag ("Description");
622 $w->characters ($ostype);
626 $w->startTag ("Section",
627 [$xsi_ns, "type"] => "ovf:VirtualHardwareSection_Type");
628 $w->startTag ("Info");
629 $w->characters (sprintf ("%d CPU, %d Memory", $vcpus, $memory_mb));
632 $w->startTag ("Item");
633 $w->startTag ([$rasd_ns, "Caption"]);
634 $w->characters (sprintf ("%d virtual cpu", $vcpus));
636 $w->startTag ([$rasd_ns, "Description"]);
637 $w->characters ("Number of virtual CPU");
639 $w->startTag ([$rasd_ns, "InstanceId"]);
640 $w->characters ("1");
642 $w->startTag ([$rasd_ns, "ResourceType"]);
643 $w->characters ("3");
645 $w->startTag ([$rasd_ns, "num_of_sockets"]);
646 $w->characters ($vcpus);
648 $w->startTag ([$rasd_ns, "cpu_per_socket"]);
653 $w->startTag ("Item");
654 $w->startTag ([$rasd_ns, "Caption"]);
655 $w->characters (sprintf ("%d MB of memory", $memory_mb));
657 $w->startTag ([$rasd_ns, "Description"]);
658 $w->characters ("Memory Size");
660 $w->startTag ([$rasd_ns, "InstanceId"]);
661 $w->characters ("2");
663 $w->startTag ([$rasd_ns, "ResourceType"]);
664 $w->characters ("4");
666 $w->startTag ([$rasd_ns, "AllocationUnits"]);
667 $w->characters ("MegaBytes");
669 $w->startTag ([$rasd_ns, "VirtualQuantity"]);
670 $w->characters ($memory_mb);
674 $w->startTag ("Item");
675 $w->startTag ([$rasd_ns, "Caption"]);
676 $w->characters ("USB Controller");
678 $w->startTag ([$rasd_ns, "InstanceId"]);
679 $w->characters ("3");
681 $w->startTag ([$rasd_ns, "ResourceType"]);
682 $w->characters ("23");
684 $w->startTag ([$rasd_ns, "UsbPolicy"]);
685 $w->characters ("Disabled");
689 $w->startTag ("Item");
690 $w->startTag ([$rasd_ns, "Caption"]);
691 $w->characters ("Graphical Controller");
693 $w->startTag ([$rasd_ns, "InstanceId"]);
694 $w->characters (uuidgen ());
696 $w->startTag ([$rasd_ns, "ResourceType"]);
697 $w->characters ("20");
699 $w->startTag ("Type");
700 $w->characters ("video");
702 $w->startTag ([$rasd_ns, "VirtualQuantity"]);
703 $w->characters ("1");
705 $w->startTag ([$rasd_ns, "Device"]);
706 $w->characters ("qxl");
710 for ($i = 0; $i < @disks; ++$i)
712 my $href = $image_uuids[$i] . "/" . $vol_uuids[$i];
714 $w->startTag ("Item");
716 $w->startTag ([$rasd_ns, "Caption"]);
717 $w->characters ("Drive " . ($i+1));
719 $w->startTag ([$rasd_ns, "InstanceId"]);
720 $w->characters ($vol_uuids[$i]);
722 $w->startTag ([$rasd_ns, "ResourceType"]);
723 $w->characters ("17");
725 $w->startTag ("Type");
726 $w->characters ("disk");
728 $w->startTag ([$rasd_ns, "HostResource"]);
729 $w->characters ($href);
731 $w->startTag ([$rasd_ns, "Parent"]);
732 $w->characters ("00000000-0000-0000-0000-000000000000");
734 $w->startTag ([$rasd_ns, "Template"]);
735 $w->characters ("00000000-0000-0000-0000-000000000000");
737 $w->startTag ([$rasd_ns, "ApplicationList"]);
739 $w->startTag ([$rasd_ns, "StorageId"]);
740 $w->characters ($esd_uuid);
742 $w->startTag ([$rasd_ns, "StoragePoolId"]);
743 $w->characters ("00000000-0000-0000-0000-000000000000");
745 $w->startTag ([$rasd_ns, "CreationDate"]);
746 $w->characters ($iso_time);
748 $w->startTag ([$rasd_ns, "LastModified"]);
749 $w->characters ($iso_time);
751 $w->startTag ([$rasd_ns, "last_modified_date"]);
752 $w->characters ($iso_time);
758 $w->endTag ("Section"); # ovf:VirtualHardwareSection_Type
760 $w->endTag ("Content");
762 $w->endTag ([$ovf_ns, "Envelope"]);
765 my $ovf = $w->to_string;
767 #print "OVF:\n$ovf\n";
769 my $ovf_dir = "$esd_uuid_dir/master/vms/$vm_uuid";
771 mkdir ($ovf_dir, 0755) or die "mkdir: $ovf_dir: $!";
773 my $ovf_file = "$ovf_dir/$vm_uuid.ovf";
775 open (my $fh, ">", $ovf_file) or die "open: $ovf_file: $!";
780 $delete_output_on_exit = 0;
782 print "OVF written to $ovf_file\n";
784 print "Import finished without errors. Now go to the Storage tab ->\n";
785 print "Export Storage Domain -> VM Import, and import the guest.\n";
796 Add a network card to the OVF. The problem is detecting what
797 network devices the guest can support.
801 Detect what disk models (eg. IDE, virtio-blk, virtio-scsi) the
802 guest can support and add the correct type of disk.
806 =head1 DEBUGGING IMPORT FAILURES
808 When you export to the ESD, and then import that guest through the
809 oVirt / RHEV-M UI, you may encounter an import failure. Diagnosing
810 these failures is infuriatingly difficult as the UI generally hides
811 the true reason for the failure.
813 There are two log files of interest. The first is stored on the oVirt
814 engine / RHEV-M server itself, and is called
815 F</var/log/ovirt-engine/engine.log>
817 The second file, which is the most useful, is found on the SPM host
818 (SPM stands for "Storage Pool Manager"). This is a oVirt node that is
819 elected to do all metadata modifications in the data center, such as
820 image or snapshot creation. You can find out which host is the
821 current SPM from the "Hosts" tab "Spm Status" column. Once you have
822 located the SPM, log into it and grab the file
823 F</var/log/vdsm/vdsm.log> which will contain detailed error messages
824 from low-level commands.
828 L<https://bugzilla.redhat.com/show_bug.cgi?id=998279>,
829 L<https://bugzilla.redhat.com/show_bug.cgi?id=1049604>,
831 L<engine-image-uploader(8)>.
835 Richard W.M. Jones <rjones@redhat.com>
839 Copyright (C) 2015 Richard W.M. Jones <rjones@redhat.com>
841 Copyright (C) 2015 Red Hat Inc.
845 This program is free software; you can redistribute it and/or modify it
846 under the terms of the GNU General Public License as published by the
847 Free Software Foundation; either version 2 of the License, or (at your
848 option) any later version.
850 This program is distributed in the hope that it will be useful, but
851 WITHOUT ANY WARRANTY; without even the implied warranty of
852 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
853 General Public License for more details.
855 You should have received a copy of the GNU General Public License along
856 with this program; if not, write to the Free Software Foundation, Inc.,
857 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.