opennebula 5.12.12 → 5.13.80.pre

data/lib/virtual_wire.rb

@@ -0,0 +1,158 @@
+# -------------------------------------------------------------------------- #
+# 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.                                             #
+#--------------------------------------------------------------------------- #
+module NSXDriver
+
+    # Class VirtualWire NSX-V Network
+    class VirtualWire < LogicalSwitch
+
+        # CONSTRUCTOR
+        def initialize(nsx_client, ls_id = nil, tz_id = nil, ls_data = nil)
+            super(nsx_client)
+            if ls_id
+                initialize_with_id(ls_id)
+            else
+                if tz_id && ls_data
+                    begin
+                        @ls_id = new_logical_switch(ls_data, tz_id)
+                    rescue NSXError::IncorrectResponseCodeError => e
+                        raise 'VirtualWire not created in NSX Manager: ' \
+                              "#{e.message}"
+                    end
+                    unless @ls_id
+                        raise 'Virtual Wire not created in NSX Manager: ' \
+                              'generic error'
+                    end
+
+                    # Construct URL of the created logical switch
+                    @url_ls = NSXConstants::NSXV_LS_SECTION + @ls_id
+                    @ls_vni = ls_vni
+                    @ls_name = ls_name
+                    @tz_id = ls_tz
+                    @tenant_id = 'virtual wire tenant'
+                    @guest_vlan_allowed = false
+                end
+            end
+        end
+
+        # Creates a VirtualWire from its name
+        def self.new_from_name(nsx_client, ls_name)
+            virtualwire = new(nsx_client)
+            ls_id = virtualwire.ls_id_from_name(nsx_client, ls_name)
+            unless ls_id
+                error_msg = "VirtualWire with name: #{ls_name} not found"
+                error = NSXError::ObjectNotFound
+                        .new(error_msg)
+                raise error
+            end
+
+            # initialize_with_id(@ls_id)
+            virtualwire.initialize_with_id(ls_id)
+            virtualwire
+        end
+
+        # Creates a VirtualWire from its id
+        def initialize_with_id(ls_id)
+            @ls_id = ls_id
+            # Construct URL of the created logical switch
+            @url_ls = NSXConstants::NSXV_LS_SECTION + \
+                      @ls_id
+            # Raise an error if VirtualWire id doesn't exists
+            unless ls?
+                error_msg = "VirtualWire with id: #{ls_id} not found"
+                error = NSXError::ObjectNotFound
+                        .new(error_msg)
+                raise error
+            end
+
+            @ls_vni =  ls_vni
+            @ls_name = ls_name
+            @tz_id = ls_tz
+            @tenant_id = 'virtual wire tenant'
+            @guest_vlan_allowed = false
+        end
+
+        # Get the logical switch id from its name
+        def ls_id_from_name(nsx_client, name)
+            url = NSXConstants::NSXV_LS_SECTION
+            virtualwires = nsx_client
+                           .get(url)
+                           .xpath(NSXConstants::NSXV_LS_XPATH)
+            virtualwires.each do |virtualwire|
+                lsname_arr = name.split(/-sid-/)
+                lsname = lsname_arr[-1].split('-', 2)[-1]
+                lsid = lsname_arr[0].split(/vxw-dvs-\w.-/)[-1]
+                if virtualwire.xpath('name').text == lsname &&
+                   virtualwire.xpath('objectId').text == lsid
+                    return virtualwire.xpath('objectId').text
+                end
+            end
+            nil
+        end
+
+        # METHODS
+
+        # Check if logical switch exists
+        def ls?
+            @nsx_client.get(@url_ls) ? true : false
+        end
+
+        # Get logical switch's name
+        def ls_name
+            @nsx_client.get(@url_ls)
+                       .xpath(NSXConstants::NSXV_LS_NAME_XPATH).text
+        end
+
+        # Get logical switch's vni
+        def ls_vni
+            @nsx_client.get(@url_ls)
+                       .xpath(NSXConstants::NSXV_LS_VNI_XPATH).text
+        end
+
+        # Get the Transport Zone of the logical switch
+        def ls_tz
+            @nsx_client.get(@url_ls)
+                       .xpath(NSXConstants::NSXV_TZ_XPATH).text
+        end
+
+        # Get the logical switch reference into vcenter
+        def ls_vcenter_ref
+            @nsx_client.get(@url_ls)
+                       .xpath(NSXConstants::NSXV_LS_BACKING_XPATH)
+                       .text
+        end
+
+        # Get the distributed virtual switch's ref associated to a LS
+        def ls_dvs_ref
+            @nsx_client.get(@url_ls)
+                       .xpath(NSXConstants::NSXV_LS_OBJECTID_XPATH)
+                       .text
+        end
+
+        # Create a new logical switch (NSX-V: virtualwire)
+        def new_logical_switch(ls_data, tz_id)
+            url = "#{NSXConstants::NSXV_TZ_SECTION}#{tz_id}" \
+                  '/virtualwires'
+            @nsx_client.post(url, ls_data)
+        end
+
+        # Delete a logical switch
+        def delete_logical_switch
+            @nsx_client.delete(@url_ls)
+        end
+
+    end
+
+end

data/lib/vm_device.rb

@@ -0,0 +1,80 @@
+module VirtualMachineDevice
+
+    ############################################################################
+    # Device Classes
+    ############################################################################
+    # Device base class
+    #
+    # @param id [Integer] The OpenNebula resource id
+    # @param one_res [XMLElement] The OpenNebula representation of the object
+    # @param vc_res [vCenter_class_specific] vCenter object representation
+    ############################################################################
+    class Device
+
+        def initialize(id, one_res, vc_res)
+            @id      = id
+            @one_res = one_res
+            @vc_res  = vc_res
+        end
+
+        def id
+            raise_if_no_exists_in_one
+            @id
+        end
+
+        def one_item
+            raise_if_no_exists_in_one
+            @one_res
+        end
+
+        def vc_item
+            raise_if_no_exists_in_vcenter
+            @vc_res
+        end
+
+        def one?
+            !@one_res.nil?
+        end
+
+        def exists?
+            !@vc_res.nil?
+        end
+
+        # Fails if the device is not present in OpenNebula
+        def raise_if_no_exists_in_one
+            raise 'OpenNebula device does not exist at the moment' unless one?
+        end
+
+        # Fails if the device is not present in vCenter
+        def raise_if_no_exists_in_vcenter
+            raise 'vCenter device does not exist at the moment' unless exists?
+        end
+
+        def no_exists?
+            !exists?
+        end
+
+        def synced?
+            one? && exists?
+        end
+
+        def unsynced?
+            !synced?
+        end
+
+        def detached?
+            !one?
+        end
+
+        def managed?
+            raise_if_no_exists_in_one
+
+            return unless @one_res
+
+            !(@one_res['OPENNEBULA_MANAGED'] &&
+              @one_res['OPENNEBULA_MANAGED'].downcase == 'no')
+        end
+
+    end
+
+end

data/lib/vm_disk.rb

@@ -0,0 +1,202 @@
+# -------------------------------------------------------------------------- #
+# 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.                                             #
+#--------------------------------------------------------------------------- #
+module VirtualMachineDevice
+
+    # Disk class
+    class Disk < Device
+
+        attr_reader :size
+
+        # Create the OpenNebula disk representation
+        # Allow us to create the class without vCenter representation
+        # example: attached disks not synced with vCenter
+        def self.one_disk(id, one_res)
+            new(id, one_res, nil)
+        end
+
+        # Create the vCenter disk representation
+        # Allow us to create the class without OpenNebula representation
+        # example: detached disks that not exists in OpenNebula
+        def self.vc_disk(vc_res)
+            new(nil, nil, vc_res)
+        end
+
+        def storpod?
+            raise_if_no_exists_in_one
+            @one_res['VCENTER_DS_REF'].start_with?('group-')
+        end
+
+        def device
+            raise_if_no_exists_in_vcenter
+            @vc_res[:device]
+        end
+
+        def node
+            raise_if_no_exists_in_vcenter
+            @vc_res[:tag]
+        end
+
+        def path
+            raise_if_no_exists_in_vcenter
+            @vc_res[:path_wo_ds]
+        end
+
+        def ds
+            raise_if_no_exists_in_vcenter
+            @vc_res[:datastore]
+        end
+
+        def image_ds_ref
+            raise_if_no_exists_in_one
+            @one_res['VCENTER_DS_REF']
+        end
+
+        def key
+            raise_if_no_exists_in_vcenter
+            @vc_res[:key]
+        end
+
+        def prefix
+            raise_if_no_exists_in_vcenter
+            @vc_res[:prefix]
+        end
+
+        def type
+            raise_if_no_exists_in_vcenter
+            @vc_res[:type]
+        end
+
+        def file
+            path.split('/').last
+        end
+
+        def cd?
+            raise_if_no_exists_in_vcenter
+            @vc_res[:type] == 'CDROM'
+        end
+
+        def config(action)
+            raise_if_no_exists_in_vcenter
+
+            config = {}
+
+            case action
+            when :delete
+                if managed?
+                    key = "opennebula.mdisk.#{@id}"
+                else
+                    key = "opennebula.disk.#{@id}"
+                end
+
+                config[:key] = key
+                config[:value] = ''
+            when :resize
+                if new_size
+                    d = device
+                    d.capacityInKB = new_size
+                    config[:device] = d
+                    config[:operation] = :edit
+                end
+            when :attach
+                puts 'not supported'
+            end
+
+            config
+        end
+
+        def persistent?
+            raise_if_no_exists_in_one
+            @one_res['PERSISTENT'] == 'YES'
+        end
+
+        def volatile?
+            raise_if_no_exists_in_one
+            @one_res['TYPE'] && @one_res['TYPE'].downcase == 'fs'
+        end
+
+        def cloned?
+            raise_if_no_exists_in_one
+            @one_res['SOURCE'] != @vc_res[:path_wo_ds]
+        end
+
+        def connected?
+            raise_if_no_exists_in_vcenter
+            @vc_res[:device].connectable.connected
+        end
+
+        def boot_dev
+            if cd?
+                RbVmomi::VIM.VirtualMachineBootOptionsBootableCdromDevice()
+            else
+                RbVmomi::VIM.VirtualMachineBootOptionsBootableDiskDevice(
+                    :deviceKey => device.key
+                )
+            end
+        end
+
+        def change_size(size)
+            size = size.to_i
+
+            if @one_res['ORIGINAL_SIZE'] &&
+               @one_res['ORIGINAL_SIZE'].to_i >= size
+                raise "'disk-resize' cannot decrease the disk's size"
+            end
+
+            @size = size
+        end
+
+        # Shrink not supported (nil). Size is in KB
+        def new_size
+            return @size * 1024 if @size
+
+            return unless @one_res['ORIGINAL_SIZE']
+
+            osize = @one_res['ORIGINAL_SIZE'].to_i
+            nsize = @one_res['SIZE'].to_i
+            nsize > osize ? nsize * 1024 : nil
+        end
+
+        def destroy
+            return if cd?
+
+            raise_if_no_exists_in_vcenter
+
+            ds = VCenterDriver::Datastore.new(self.ds)
+            img_path = path
+
+            begin
+                img_dir = File.dirname(img_path)
+                search_params = ds.get_search_params(
+                    ds['name'],
+                    img_dir,
+                    File.basename(img_path)
+                )
+                search_task = ds['browser']
+                              .SearchDatastoreSubFolders_Task(search_params)
+                search_task.wait_for_completion
+                ds.delete_virtual_disk(img_path)
+                ds.rm_directory(img_dir) if ds.dir_empty?(img_dir)
+            rescue StandardError => e
+                if !e.message.start_with?('FileNotFound')
+                    # Ignore FileNotFound
+                    raise e.message
+                end
+            end
+        end
+
+    end
+
+end

data/lib/vm_folder.rb

@@ -0,0 +1,69 @@
+# -------------------------------------------------------------------------- #
+# 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.                                             #
+#--------------------------------------------------------------------------- #
+
+module VCenterDriver
+
+    # VirtualMachineFolder class
+    class VirtualMachineFolder
+
+        attr_accessor :item, :items
+
+        def initialize(item)
+            @item = item
+            check_item(@item, nil)
+            @items = {}
+        end
+
+        ########################################################################
+        # Builds a hash with Datastore-Ref / Datastore to be used as a cache
+        # @return [Hash] in the form
+        #   { ds_ref [Symbol] => Datastore object }
+        ########################################################################
+
+        def fetch!
+            VIClient.get_entities(@item, 'VirtualMachine').each do |item|
+                item_name = item._ref
+                @items[item_name.to_sym] = VirtualMachine.new_with_item(item)
+            end
+        end
+
+        def fetch_templates!
+            VIClient.get_entities(@item, 'VirtualMachine').each do |item|
+                if item.config.template
+                    item_name = item._ref
+                    @items[item_name.to_sym] = Template.new(item)
+                end
+            end
+        end
+
+        ########################################################################
+        # Returns a Datastore. Uses the cache if available.
+        # @param ref [Symbol] the vcenter ref
+        # @return Datastore
+        ########################################################################
+
+        def get(ref)
+            if !@items[ref.to_sym]
+                rbvmomi_dc = RbVmomi::VIM::Datastore.new(@item._connection, ref)
+                @items[ref.to_sym] = Datastore.new(rbvmomi_dc)
+            end
+
+            @items[ref.to_sym]
+        end
+
+    end
+
+end

data/lib/vm_helper.rb

@@ -0,0 +1,30 @@
+# -------------------------------------------------------------------------- #
+# 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.                                             #
+#--------------------------------------------------------------------------- #
+module VirtualMachineHelper
+
+    # This method raises an exception if the timeout is reached
+    # The exception needs to be handled in the VMM drivers and any
+    # process that uses this method
+    def wait_timeout(action, timeout = 300)
+        time_start = Time.now
+        until send(action)
+            sleep(1)
+            condition = (Time.now - time_start).to_i >= timeout
+            raise 'Reached deploy timeout' if condition
+        end
+    end
+
+end