Implement memory ballooning in kvm
[ganeti-local] / lib / ovf.py
index 073b3f5..ef87ae3 100644 (file)
@@ -45,6 +45,11 @@ try:
 except ImportError:
   import elementtree.ElementTree as ET
 
+try:
+  ParseError = ET.ParseError # pylint: disable=E1103
+except AttributeError:
+  ParseError = None
+
 from ganeti import constants
 from ganeti import errors
 from ganeti import utils
@@ -72,10 +77,16 @@ FILE_EXTENSIONS = [
 ]
 
 COMPRESSION_TYPE = "gzip"
+NO_COMPRESSION = [None, "identity"]
 COMPRESS = "compression"
 DECOMPRESS = "decompression"
 ALLOWED_ACTIONS = [COMPRESS, DECOMPRESS]
 
+VMDK = "vmdk"
+RAW = "raw"
+COW = "cow"
+ALLOWED_FORMATS = [RAW, COW, VMDK]
+
 # ResourceType values
 RASD_TYPE = {
   "vcpus": "3",
@@ -85,6 +96,12 @@ RASD_TYPE = {
   "disk": "17",
 }
 
+SCSI_SUBTYPE = "lsilogic"
+VS_TYPE = {
+  "ganeti": "ganeti-ovf",
+  "external": "vmx-04",
+}
+
 # AllocationUnits values and conversion
 ALLOCATION_UNITS = {
   'b': ["bytes", "b"],
@@ -111,18 +128,33 @@ TAGS = "tags"
 VERSION = "version"
 
 # Instance IDs of System and SCSI controller
-SYSTEM_ID = 0
-SCSI_ID = 3
+INSTANCE_ID = {
+  "system": 0,
+  "vcpus": 1,
+  "memory": 2,
+  "scsi": 3,
+}
 
 # Disk format descriptions
 DISK_FORMAT = {
-  "raw": "http://en.wikipedia.org/wiki/Byte",
-  "vmdk": "http://www.vmware.com/interfaces/specifications/vmdk.html"
+  RAW: "http://en.wikipedia.org/wiki/Byte",
+  VMDK: "http://www.vmware.com/interfaces/specifications/vmdk.html"
           "#monolithicSparse",
-  "cow": "http://www.gnome.org/~markmc/qcow-image-format.html",
+  COW: "http://www.gnome.org/~markmc/qcow-image-format.html",
 }
 
 
+def CheckQemuImg():
+  """ Make sure that qemu-img is present before performing operations.
+
+  @raise errors.OpPrereqError: when qemu-img was not found in the system
+
+  """
+  if not constants.QEMUIMG_PATH:
+    raise errors.OpPrereqError("qemu-img not found at build time, unable"
+                               " to continue")
+
+
 def LinkFile(old_path, prefix=None, suffix=None, directory=None):
   """Create link with a given prefix and suffix.
 
@@ -194,7 +226,7 @@ class OVFReader(object):
     self.tree = ET.ElementTree()
     try:
       self.tree.parse(input_path)
-    except xml.parsers.expat.ExpatError, err:
+    except (ParseError, xml.parsers.expat.ExpatError), err:
       raise errors.OpPrereqError("Error while reading %s file: %s" %
                                  (OVF_EXT, err))
 
@@ -571,8 +603,14 @@ class OVFWriter(object):
 
   @type tree: ET.ElementTree
   @ivar tree: XML tree that we are constructing
+  @type virtual_system_type: string
+  @ivar virtual_system_type: value of vssd:VirtualSystemType, for external usage
+    in VMWare this requires to be vmx
   @type hardware_list: list
   @ivar hardware_list: list of items prepared for VirtualHardwareSection
+  @type next_instance_id: int
+  @ivar next_instance_id: next instance id to be used when creating elements on
+    hardware_list
 
   """
   def __init__(self, has_gnt_section):
@@ -593,8 +631,13 @@ class OVFWriter(object):
     }
     if has_gnt_section:
       env_attribs["xmlns:gnt"] = GANETI_SCHEMA
+      self.virtual_system_type = VS_TYPE["ganeti"]
+    else:
+      self.virtual_system_type = VS_TYPE["external"]
     self.tree = ET.Element("Envelope", attrib=env_attribs)
     self.hardware_list = []
+    # INSTANCE_ID contains statically assigned IDs, starting from 0
+    self.next_instance_id = len(INSTANCE_ID) # FIXME: hackish
 
   def SaveDisksData(self, disks):
     """Convert disk information to certain OVF sections.
@@ -605,6 +648,7 @@ class OVFWriter(object):
     """
     references = ET.SubElement(self.tree, "References")
     disk_section = ET.SubElement(self.tree, "DiskSection")
+    SubElementText(disk_section, "Info", "Virtual disk information")
     for counter, disk in enumerate(disks):
       file_id = "file%s" % counter
       disk_id = "disk%s" % counter
@@ -627,10 +671,12 @@ class OVFWriter(object):
       # Item in VirtualHardwareSection creation
       disk_item = ET.Element("Item")
       SubElementText(disk_item, "rasd:ElementName", disk_id)
-      SubElementText(disk_item, "rasd:ResourceType", RASD_TYPE["disk"])
       SubElementText(disk_item, "rasd:HostResource", "ovf:/disk/%s" % disk_id)
-      SubElementText(disk_item, "rasd:Parent", SCSI_ID)
+      SubElementText(disk_item, "rasd:InstanceID", self.next_instance_id)
+      SubElementText(disk_item, "rasd:Parent", INSTANCE_ID["scsi"])
+      SubElementText(disk_item, "rasd:ResourceType", RASD_TYPE["disk"])
       self.hardware_list.append(disk_item)
+      self.next_instance_id += 1
 
   def SaveNetworksData(self, networks):
     """Convert network information to NetworkSection.
@@ -640,6 +686,7 @@ class OVFWriter(object):
 
     """
     network_section = ET.SubElement(self.tree, "NetworkSection")
+    SubElementText(network_section, "Info", "List of logical networks")
     for counter, network in enumerate(networks):
       network_name = "%s%s" % (network["mode"], counter)
       network_attrib = {"ovf:name": network_name}
@@ -647,12 +694,14 @@ class OVFWriter(object):
 
       # Item in VirtualHardwareSection creation
       network_item = ET.Element("Item")
+      SubElementText(network_item, "rasd:Address", network["mac"])
+      SubElementText(network_item, "rasd:Connection", network_name)
       SubElementText(network_item, "rasd:ElementName", network_name)
+      SubElementText(network_item, "rasd:InstanceID", self.next_instance_id)
       SubElementText(network_item, "rasd:ResourceType",
         RASD_TYPE["ethernet-adapter"])
-      SubElementText(network_item, "rasd:Connection", network_name)
-      SubElementText(network_item, "rasd:Address", network["mac"])
       self.hardware_list.append(network_item)
+      self.next_instance_id += 1
 
   @staticmethod
   def _SaveNameAndParams(root, data):
@@ -720,26 +769,29 @@ class OVFWriter(object):
     assert(memory > 0)
     vs_attrib = {"ovf:id": name}
     virtual_system = ET.SubElement(self.tree, "VirtualSystem", attrib=vs_attrib)
+    SubElementText(virtual_system, "Info", "A virtual machine")
 
     name_section = ET.SubElement(virtual_system, "Name")
     name_section.text = name
     os_attrib = {"ovf:id": "0"}
-    ET.SubElement(virtual_system, "OperatingSystemSection",
+    os_section = ET.SubElement(virtual_system, "OperatingSystemSection",
       attrib=os_attrib)
+    SubElementText(os_section, "Info", "Installed guest operating system")
     hardware_section = ET.SubElement(virtual_system, "VirtualHardwareSection")
+    SubElementText(hardware_section, "Info", "Virtual hardware requirements")
 
     # System description
     system = ET.SubElement(hardware_section, "System")
     SubElementText(system, "vssd:ElementName", "Virtual Hardware Family")
-    SubElementText(system, "vssd:InstanceId", SYSTEM_ID)
+    SubElementText(system, "vssd:InstanceID", INSTANCE_ID["system"])
     SubElementText(system, "vssd:VirtualSystemIdentifier", name)
-    SubElementText(system, "vssd:VirtualSystemType", "ganeti-ovf")
+    SubElementText(system, "vssd:VirtualSystemType", self.virtual_system_type)
 
     # Item for vcpus
     vcpus_item = ET.SubElement(hardware_section, "Item")
     SubElementText(vcpus_item, "rasd:ElementName",
       "%s virtual CPU(s)" % vcpus)
-    SubElementText(vcpus_item, "rasd:InstanceID", "1")
+    SubElementText(vcpus_item, "rasd:InstanceID", INSTANCE_ID["vcpus"])
     SubElementText(vcpus_item, "rasd:ResourceType", RASD_TYPE["vcpus"])
     SubElementText(vcpus_item, "rasd:VirtualQuantity", vcpus)
 
@@ -747,20 +799,20 @@ class OVFWriter(object):
     memory_item = ET.SubElement(hardware_section, "Item")
     SubElementText(memory_item, "rasd:AllocationUnits", "byte * 2^20")
     SubElementText(memory_item, "rasd:ElementName", "%sMB of memory" % memory)
-    SubElementText(memory_item, "rasd:InstanceID", "2")
+    SubElementText(memory_item, "rasd:InstanceID", INSTANCE_ID["memory"])
     SubElementText(memory_item, "rasd:ResourceType", RASD_TYPE["memory"])
     SubElementText(memory_item, "rasd:VirtualQuantity", memory)
 
     # Item for scsi controller
     scsi_item = ET.SubElement(hardware_section, "Item")
-    SubElementText(scsi_item, "rasd:Address", SYSTEM_ID)
+    SubElementText(scsi_item, "rasd:Address", INSTANCE_ID["system"])
     SubElementText(scsi_item, "rasd:ElementName", "scsi_controller0")
+    SubElementText(scsi_item, "rasd:InstanceID", INSTANCE_ID["scsi"])
+    SubElementText(scsi_item, "rasd:ResourceSubType", SCSI_SUBTYPE)
     SubElementText(scsi_item, "rasd:ResourceType", RASD_TYPE["scsi-controller"])
-    SubElementText(scsi_item, "rasd:InstanceId", "3")
 
     # Other items - from self.hardware_list
-    for counter, item in enumerate(self.hardware_list):
-      SubElementText(item, "rasd:InstanceID", counter + 4)
+    for item in self.hardware_list:
       hardware_section.append(item)
 
   def PrettyXmlDump(self):
@@ -875,6 +927,7 @@ class Converter(object):
     @raise errors.OpPrereqError: convertion of the disk failed
 
     """
+    CheckQemuImg()
     disk_file = os.path.basename(disk_path)
     (disk_name, disk_extension) = os.path.splitext(disk_file)
     if disk_extension != disk_format:
@@ -885,7 +938,7 @@ class Converter(object):
       prefix=disk_name, dir=self.output_dir)
     self.temp_file_manager.Add(new_disk_path)
     args = [
-      "qemu-img",
+      constants.QEMUIMG_PATH,
       "convert",
       "-O",
       disk_format,
@@ -912,7 +965,8 @@ class Converter(object):
     @raise errors.OpPrereqError: format information cannot be retrieved
 
     """
-    args = ["qemu-img", "info", disk_path]
+    CheckQemuImg()
+    args = [constants.QEMUIMG_PATH, "info", disk_path]
     run_result = utils.RunCmd(args, cwd=os.getcwd())
     if run_result.failed:
       raise errors.OpPrereqError("Gathering info about the disk using qemu-img"
@@ -1276,6 +1330,7 @@ class OVFImporter(Converter):
       information or size information is invalid or creation failed
 
     """
+    CheckQemuImg()
     assert self.options.disks
     results = {}
     for (disk_id, disk_desc) in self.options.disks:
@@ -1288,7 +1343,7 @@ class OVFImporter(Converter):
                                      (disk_id, disk_desc["size"]))
         new_path = utils.PathJoin(self.output_dir, str(disk_id))
         args = [
-          "qemu-img",
+          constants.QEMUIMG_PATH,
           "create",
           "-f",
           "raw",
@@ -1324,7 +1379,7 @@ class OVFImporter(Converter):
                                    " paths or paths outside main OVF directory")
       disk, _ = os.path.splitext(disk_name)
       disk_path = utils.PathJoin(self.input_dir, disk_name)
-      if disk_compression:
+      if disk_compression not in NO_COMPRESSION:
         _, disk_path = self._CompressDisk(disk_path, disk_compression,
           DECOMPRESS)
         disk, _ = os.path.splitext(disk)
@@ -1709,8 +1764,9 @@ class OVFExporter(Converter):
     logging.info("Preparing tarball for the OVF package")
     open(tar_path, mode="w").close()
     ova_package = tarfile.open(name=tar_path, mode="w")
-    for file_name in files_list:
-      ova_package.add(file_name)
+    for file_path in files_list:
+      file_name = os.path.basename(file_path)
+      ova_package.add(file_path, arcname=file_name)
     ova_package.close()
 
   def Save(self):