opennebula 5.12.12 → 5.13.80.pre

data/lib/opennebula/template_ext.rb

@@ -0,0 +1,325 @@
+# -------------------------------------------------------------------------- #
+# Copyright 2002-2021, OpenNebula Project, OpenNebula Systems                #
+#                                                                            #
+# Licensed under the Apache License, Version 2.0 (the "License"); you may    #
+# not use this file except in compliance with the License. You may obtain    #
+# a copy of the License at                                                   #
+#                                                                            #
+# http://www.apache.org/licenses/LICENSE-2.0                                 #
+#                                                                            #
+# Unless required by applicable law or agreed to in writing, software        #
+# distributed under the License is distributed on an "AS IS" BASIS,          #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   #
+# See the License for the specific language governing permissions and        #
+# limitations under the License.                                             #
+#--------------------------------------------------------------------------- #
+
+require 'securerandom'
+require 'opennebula/wait_ext'
+
+# Module to decorate Template class with additional helpers not directly
+# exposed through the OpenNebula XMLRPC API. The extensions include
+#   - mp_import helper that imports a template into a marketplace
+#
+# rubocop:disable Style/ClassAndModuleChildren
+module OpenNebula::TemplateExt
+
+    def self.extend_object(obj)
+        if !obj.is_a?(OpenNebula::Template)
+            raise StandardError, "Cannot extended #{obj.class} with TemplateExt"
+        end
+
+        class << obj
+
+            ####################################################################
+            # Public extended interface
+            ####################################################################
+
+            # ------------------------------------------------------------------
+            # Imports template into marketplace
+            #
+            # @param market [Integer] Market to import the Template
+            # @param import_all [Bool] true to import images too,
+            # @param template_name [String] Virtual Machine Template app name
+            #
+            # @return [String, Array]
+            #   - Error message in case of any or random generated template name
+            #   - Objects IDs
+            # ------------------------------------------------------------------
+            def mp_import(market, import_all, template_name = nil, opts = {})
+                opts = {
+                    :wait => false,
+                    :logger => nil
+                }.merge(opts)
+
+                ids    = []
+                images = []
+                logger = opts[:logger]
+
+                main_template = ''
+
+                #---------------------------------------------------------------
+                # Import all disks as IMAGE
+                #---------------------------------------------------------------
+                logger.info 'Processing VM disks' if logger
+
+                retrieve_xmlelements('TEMPLATE/DISK').each_with_index do
+                    |disk, idx|
+
+                    image = image_lookup(disk)
+
+                    if OpenNebula.is_error?(image)
+                        logger.fatal image.message if logger
+
+                        rollback(ids)
+                        return [image, ids]
+                    end
+
+                    logger.info "Adding disk with image #{image.id}" if logger
+
+                    tmpl, main = create_app_template(image, idx)
+
+                    if OpenNebula.is_error?(tmpl)
+                        logger.fatal tmpl.message if logger
+
+                        rollback(ids)
+                        return [tmpl, ids]
+                    end
+
+                    main_template << main
+
+                    next unless import_all
+
+                    logger.info 'Importing image to market place' if logger
+
+                    rc = create_app(tmpl, market)
+
+                    if OpenNebula.is_error?(rc)
+                        logger.fatal rc.message if logger
+
+                        rollback(ids)
+                        return [rc, ids]
+                    end
+
+                    images << image
+
+                    ids << rc
+                end
+
+                delete_element('TEMPLATE/DISK')
+
+                #---------------------------------------------------------------
+                # Import VM template
+                #---------------------------------------------------------------
+                logger.info 'Processing VM NICs' if logger
+
+                # Replace all nics by auto nics
+                nic_xpath   = '/VMTEMPLATE/TEMPLATE/NIC'
+                alias_xpath = '/VMTEMPLATE/TEMPLATE/NIC_ALIAS'
+
+                retrieve_xmlelements(nic_xpath).each do |nic|
+                    if nic['NETWORK']
+                        net = "[NETWORK=\"#{nic['NETWORK']}\"]"
+                    elsif nic['NETWORK_ID']
+                        net = "[NETWORK_ID=\"#{nic['NETWORK_ID']}\"]"
+                    end
+
+                    # NIC can be already in auto mode
+                    next unless net
+
+                    # If there are ALIAS the NIC can't be auto,
+                    # because this combination isn't supported by the core
+                    nic_alias = retrieve_xmlelements(alias_xpath)
+
+                    if !nic_alias || nic_alias.empty?
+                        nic.add_element("#{nic_xpath}#{net}",
+                                        'NETWORK_MODE' => 'auto')
+                    else
+                        # Add attribute to avoid empty elements
+                        nic.add_element("#{nic_xpath}#{net}", 'MARKET' => 'YES')
+                    end
+
+                    delete_nic_attributes(nic)
+                end
+
+                retrieve_xmlelements(alias_xpath).each do |nic|
+                    delete_nic_attributes(nic)
+                end
+
+                # Rename it to avoid clashing names
+                if template_name
+                    name = template_name
+                else
+                    name = "#{self['NAME']}-#{SecureRandom.hex[0..9]}"
+                end
+
+                main_template << <<-EOT
+                NAME      ="#{name}"
+                ORIGIN_ID ="-1\"
+                TYPE      ="VMTEMPLATE"
+                VERSION   ="#{OpenNebula::VERSION}"
+
+                APPTEMPLATE64 ="#{Base64.strict_encode64(template_str)}"
+                EOT
+
+                logger.info 'Creating VM app' if logger
+
+                rc = create_app(main_template, market)
+
+                if OpenNebula.is_error?(rc)
+                    logger.fatal rc.message if logger
+
+                    rollback(ids)
+                    return [rc, ids]
+                end
+
+                logger.info 'Waiting for image upload' if logger && opts[:wait]
+
+                images.each {|i| i.wait('READY') } if opts[:wait]
+
+                ids << rc
+
+                [name, ids]
+            end
+
+            ####################################################################
+            # Private methods
+            ####################################################################
+            private
+
+            #-------------------------------------------------------------------
+            # NIC and NIC Alias attributes to delete when importing template
+            # into marketplace.
+            #   @param nic [XMLElement] to delete attributes from
+            #-------------------------------------------------------------------
+            def delete_nic_attributes(nic)
+                %w[NETWORK NETWORK_ID NETWORK_UNAME SECURITY_GROUPS].each do |a|
+                    nic.delete_element(a)
+                end
+            end
+
+            #-------------------------------------------------------------------
+            # Create application template
+            #
+            # @param id   [Image] OpenNebula Image
+            # @param idx  [Integer] Image ID in VM template
+            #
+            # @return [String, String]
+            #   - app template
+            #   - content for VM template
+            #-------------------------------------------------------------------
+            def create_app_template(image, idx = 0)
+                # Wait until the image is READY to safe copy it to the MP
+                image.wait('READY') if Integer(image['STATE']) != 1
+
+                # Rename to avoid clashing names
+                app_name = "#{image['NAME']}-#{SecureRandom.hex[0..9]}"
+
+                dev_prefix = image['TEMPLATE/DEV_PREFIX']
+                img_type   = image.type_str
+
+                template64 = "TYPE=#{img_type}\n"
+                template64 << "DEV_PREFIX=\"#{dev_prefix}\"\n" if dev_prefix
+
+                template = <<-EOT
+                NAME      ="#{app_name}"
+                ORIGIN_ID ="#{image['ID']}"
+                TYPE      ="IMAGE"
+                VERSION   ="#{OpenNebula::VERSION}"
+
+                APPTEMPLATE64 = "#{Base64.strict_encode64(template64)}"
+                EOT
+
+                main_template = <<-EOT
+                DISK = [
+                    NAME = "#{img_type}_#{idx}",
+                    APP  = "#{app_name}"
+                ]
+                EOT
+
+                [template, main_template]
+            end
+
+            #-------------------------------------------------------------------
+            # Create application in marketplace
+            #
+            # @param template  [String]  APP template
+            # @param market_id [Integer] Marketplace to import it
+            #
+            # @return [Integer] APP ID
+            #-------------------------------------------------------------------
+            def create_app(template, market_id)
+                xml = OpenNebula::MarketPlaceApp.build_xml
+                app = OpenNebula::MarketPlaceApp.new(xml, @client)
+
+                rc  = app.allocate(template, market_id)
+
+                return rc if OpenNebula.is_error?(rc)
+
+                app.id
+            end
+
+            #-------------------------------------------------------------------
+            # Delete IDS apps
+            #
+            # @param ids [Array] Apps IDs to delete
+            #-------------------------------------------------------------------
+            def rollback(ids)
+                ids.each do |id|
+                    app = OpenNebula::MarketPlaceApp.new_with_id(id, @client)
+
+                    app.delete
+                end
+            end
+
+            #-------------------------------------------------------------------
+            # Lookup OpenNebula Images by name or id. Lookup is made on a cached
+            # image pool.
+            #
+            # @param id [Integer, nil] Image id
+            # @param name [String] Image name
+            #
+            # @return [Image]
+            #-------------------------------------------------------------------
+            def image_lookup(disk)
+                # Image pool cache for image id lookup
+                if @image_lookup_cache.nil?
+                    @image_lookup_cache = OpenNebula::ImagePool.new(@client)
+                    @image_lookup_cache.info
+                end
+
+                # Find image information, from ID or NAME. NAME uses the
+                # specified user or template owner namespaces
+                image = nil
+
+                image_id = disk['IMAGE_ID']
+
+                if image_id
+                    image = OpenNebula::Image.new_with_id(image_id, @client)
+                else
+                    name  = disk['IMAGE']
+                    uname = disk['IMAGE_UNAME']
+                    uname ||= self['UNAME']
+
+                    name.gsub!('"', '')
+                    image = @image_lookup_cache.find do |v|
+                        v['NAME'] == name && v['UNAME'] == uname
+                    end
+
+                    return Error.new("Image #{image} not found") if image.nil?
+                end
+
+                rc = image.info
+
+                return rc if OpenNebula.is_error? rc
+
+                image.extend(OpenNebula::WaitExt)
+
+                image
+            end
+
+        end
+    end
+
+end
+# rubocop:enable Style/ClassAndModuleChildren

data/lib/opennebula/user.rb

@@ -34,7 +34,9 @@ module OpenNebula
             :update   => "user.update",
             :chauth   => "user.chauth",
             :quota    => "user.quota",
-            :login    => "user.login"
+            :login    => "user.login",
+            :enable   => "user.enable",
+            :disable  => "user.disable"
         }
 
         SELF      = -1
@@ -128,6 +130,16 @@ module OpenNebula
             super(USER_METHODS[:delete])
         end
 
+        # Enable the User
+        def enable()
+            set_enabled(true)
+        end
+
+        # Disable the User
+        def disable()
+            set_enabled(false)
+        end
+
         # Changes the password of the given User
         #
         # +password+ String containing the new password
@@ -230,5 +242,17 @@ module OpenNebula
             all_groups = self.retrieve_elements("GROUPS/ID")
             all_groups.collect! {|x| x.to_i}
         end
+
+    private
+
+        def set_enabled(enabled)
+            return Error.new('ID not defined') if !@pe_id
+
+            rc = @client.call(USER_METHODS[:enable], @pe_id, enabled)
+            rc = nil if !OpenNebula.is_error?(rc)
+
+            return rc
+        end
+
     end
 end

data/lib/opennebula/virtual_machine.rb

@@ -14,6 +14,7 @@
 # limitations under the License.                                             #
 #--------------------------------------------------------------------------- #
 
+require 'opennebula/lockable_ext'
 require 'opennebula/pool_element'
 
 module OpenNebula
@@ -123,6 +124,9 @@ module OpenNebula
             DISK_RESIZE_POWEROFF
             DISK_RESIZE_UNDEPLOYED
             HOTPLUG_NIC_POWEROFF
+            HOTPLUG_RESIZE
+            HOTPLUG_SAVEAS_UNDEPLOYED
+            HOTPLUG_SAVEAS_STOPPED
         }
 
         SHORT_VM_STATES={
@@ -204,7 +208,10 @@ module OpenNebula
             "DISK_RESIZE"            => "drsz",
             "DISK_RESIZE_POWEROFF"   => "drsz",
             "DISK_RESIZE_UNDEPLOYED" => "drsz",
-            "HOTPLUG_NIC_POWEROFF"   => "hotp"
+            "HOTPLUG_NIC_POWEROFF"   => "hotp",
+            "HOTPLUG_RESIZE"         => "hotp",
+            "HOTPLUG_SAVEAS_UNDEPLOYED"  => "hotp",
+            "HOTPLUG_SAVEAS_STOPPED"     => "hotp"
         }
 
         HISTORY_ACTION=%w{none migrate live-migrate shutdown shutdown-hard
@@ -271,6 +278,8 @@ module OpenNebula
 
         # Class constructor
         def initialize(xml, client)
+            LockableExt.make_lockable(self, VM_METHODS)
+
             super(xml,client)
         end
 
@@ -701,9 +710,9 @@ module OpenNebula
             end
         end
 
-		#  Changes the attributes of a VM in power off, failure and undeploy
-		#  states
-		#  @param new_conf, string describing the new attributes. Each attribute
+        #  Changes the attributes of a VM in power off, failure and undeploy
+        #  states
+        #  @param new_conf, string describing the new attributes. Each attribute
         #  will replace the existing ones or delete it if empty. Attributes that
         #  can be updated are: INPUT/{TYPE, BUS}; RAW/{TYPE, DATA, DATA_VMX},
         #  OS/{BOOT, BOOTLOADER, ARCH, MACHINE, KERNEL, INITRD},
@@ -711,20 +720,10 @@ module OpenNebula
         #  and GRAPHICS/{TYPE, LISTEN, PASSWD, KEYMAP}
         # @return [nil, OpenNebula::Error] nil in case of success, Error
         #   otherwise
-		def updateconf(new_conf)
+        def updateconf(new_conf)
             return call(VM_METHODS[:updateconf], @pe_id, new_conf)
         end
 
-        # Lock a VM
-        def lock(level)
-            return call(VM_METHODS[:lock], @pe_id, level)
-        end
-
-        # Unlock a VM
-        def unlock()
-            return call(VM_METHODS[:unlock], @pe_id)
-        end
-
         ########################################################################
         # Helpers to get VirtualMachine information
         ########################################################################
@@ -771,205 +770,24 @@ module OpenNebula
             self['DEPLOY_ID']
         end
 
-        # Clones the VM's source Template, replacing the disks with live snapshots
-        # of the current disks. The VM capacity and NICs are also preserved
-        #
-        # @param name [String] Name for the new Template
-        # @param name [true,false,nil] Optional, true to make the saved images
-        # persistent, false make them non-persistent
-        #
-        # @return [Integer, OpenNebula::Error] the new Template ID in case of
-        #   success, error otherwise
-        REMOVE_VNET_ATTRS = %w{AR_ID BRIDGE CLUSTER_ID IP MAC TARGET NIC_ID
-            NETWORK_ID VN_MAD SECURITY_GROUPS VLAN_ID}
-
-        REMOVE_IMAGE_ATTRS = %w{DEV_PREFIX SOURCE ORIGINAL_SIZE SIZE
-            DISK_SNAPSHOT_TOTAL_SIZE DRIVER IMAGE_STATE SAVE CLONE READONLY
-            PERSISTENT TARGET ALLOW_ORPHANS CLONE_TARGET CLUSTER_ID DATASTORE
-            DATASTORE_ID DISK_ID DISK_TYPE IMAGE_ID IMAGE IMAGE_UNAME IMAGE_UID
-            LN_TARGET TM_MAD TYPE OPENNEBULA_MANAGED}
-
-        def save_as_template(name,description, persistent=nil)
-            img_ids = []
-            new_tid = nil
-            begin
-                rc = info()
-                raise if OpenNebula.is_error?(rc)
-
-                tid = self['TEMPLATE/TEMPLATE_ID']
-                if tid.nil? || tid.empty?
-                    rc = Error.new('VM has no template to be saved')
-                    raise
-                end
-
-                if state_str() != "POWEROFF"
-                    rc = Error.new("VM state must be POWEROFF, "<<
-                        "current state is #{state_str()}, #{lcm_state_str()}")
-                    raise
-                end
-
-                # Clone the source template
-                rc = OpenNebula::Template.new_with_id(tid, @client).clone(name)
-                raise if OpenNebula.is_error?(rc)
-
-                new_tid = rc
+        def wait_state(state, timeout=120)
+            extend OpenNebula::WaitExt
 
-                # Replace the original template's capacity with the actual VM values
-                replace = ""
-                if !description.nil?
-                    replace << "DESCRIPTION = \"#{description}\"\n"
-                end
-                cpu = self['TEMPLATE/CPU']
-                if !cpu.nil? && !cpu.empty?
-                    replace << "CPU = #{cpu}\n"
-                end
+            rc = wait2(state, 'LCM_INIT', timeout)
 
-                vcpu = self['TEMPLATE/VCPU']
-                if !vcpu.nil? && !vcpu.empty?
-                    replace << "VCPU = #{vcpu}\n"
-                end
-
-                mem = self['TEMPLATE/MEMORY']
-                if !mem.nil? && !mem.empty?
-                    replace << "MEMORY = #{mem}\n"
-                end
+            return Error.new("Timeout expired for state #{state}.") unless rc
 
-                self.each('TEMPLATE/DISK') do |disk|
-                    # While the previous snapshot is still in progress, we wait
-                    # indefinitely
-                    rc = info()
-                    raise if OpenNebula.is_error?(rc)
-
-                    steps = 0
-                    while lcm_state_str() == "HOTPLUG_SAVEAS_POWEROFF"
-                        if steps < 30
-                            sleep 1
-                        else
-                            sleep 15
-                        end
-
-                        rc = info()
-                        raise if OpenNebula.is_error?(rc)
-
-                        steps += 1
-                    end
-
-                    # If the VM is not busy with a previous disk snapshot, we wait
-                    # but this time with a timeout
-                    rc = wait_state("POWEROFF")
-                    raise if OpenNebula.is_error?(rc)
-
-                    disk_id = disk["DISK_ID"]
-                    if disk_id.nil? || disk_id.empty?
-                        rc = Error.new('The DISK_ID is missing from the VM template')
-                        raise
-                    end
-
-                    image_id           = disk["IMAGE_ID"]
-                    opennebula_managed = disk["OPENNEBULA_MANAGED"]
-                    type               = disk["TYPE"]
-
-                    REMOVE_IMAGE_ATTRS.each do |attr|
-                        disk.delete_element(attr)
-                    end
-
-                    if !image_id.nil? && !image_id.empty?
-                        if type == 'CDROM'
-                            replace << "DISK = [ IMAGE_ID = #{image_id}"
-                            if opennebula_managed
-                                replace << ", OPENNEBULA_MANAGED=#{opennebula_managed}"
-                            end
-                            replace << " ]\n"
-                        else
-                            rc = disk_saveas(disk_id.to_i,"#{name}-disk-#{disk_id}","",-1)
-
-                            raise if OpenNebula.is_error?(rc)
-
-                            if persistent == true
-                                OpenNebula::Image.new_with_id(rc.to_i, @client).persistent()
-                            end
-
-                            img_ids << rc.to_i
-
-                            disk_template = disk.template_like_str(".").tr("\n", ",\n")
-
-                            if disk_template.empty?
-                                replace << "DISK = [ IMAGE_ID = #{rc} ] \n"
-                            else
-                                replace << "DISK = [ IMAGE_ID = #{rc}, " <<
-                                    disk_template << " ] \n"
-                            end
-                        end
-                    else
-                        # Volatile disks cannot be saved, so the definition is copied
-                        replace << self.template_like_str(
-                            "TEMPLATE", true, "DISK[DISK_ID=#{disk_id}]") << "\n"
-                    end
-                end
-
-                self.each('TEMPLATE/NIC') do |nic|
-                    nic_id = nic["NIC_ID"]
-
-                    if nic_id.nil? || nic_id.empty?
-                        rc = Error.new('The NIC_ID is missing from the VM template')
-                        raise
-                    end
-
-                    REMOVE_VNET_ATTRS.each do |attr|
-                        # Remove every automatically generated value
-                        # The vnet will be referenced via NAME + UNAME (if defined)
-                        nic.delete_element(attr)
-                    end
-
-                    replace << "NIC = [ " << nic.template_like_str(".").tr("\n", ",\n") << " ] \n"
-                end
-
-                # Required by the Sunstone Cloud View
-                replace << "SAVED_TEMPLATE_ID = #{tid}\n"
-
-                new_tmpl = OpenNebula::Template.new_with_id(new_tid, @client)
-
-                rc = new_tmpl.update(replace, true)
-                raise if OpenNebula.is_error?(rc)
-
-                return new_tid
-
-            rescue
-                # Rollback. Delete the template and the images created
-                if !new_tid.nil?
-                    new_tmpl = OpenNebula::Template.new_with_id(new_tid, @client)
-                    new_tmpl.delete()
-                end
-
-                img_ids.each do |id|
-                    img = OpenNebula::Image.new_with_id(id, @client)
-                    img.delete()
-                end
-
-                return rc
-            end
+            true
         end
 
-        def wait_state(state, timeout=10)
-            vm_state = ""
-            lcm_state = ""
+        def wait_state2(state, lcm_state, timeout=120)
+            extend OpenNebula::WaitExt
 
-            timeout.times do
-                rc = info()
-                return rc if OpenNebula.is_error?(rc)
-
-                vm_state = state_str()
-                lcm_state = lcm_state_str()
-
-                if vm_state == state
-                    return true
-                end
+            rc = wait2(state, lcm_state, timeout)
 
-                sleep 1
-            end
+            return Error.new("Timeout expired for state #{state}.") unless rc
 
-            return Error.new("Timeout expired for state #{state}. "<<
-                "VM is in state #{vm_state}, #{lcm_state}")
+            true
         end
 
     private