fog-vsphere 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0274b352d3f0ba9537632985666d0b9ab20b7377
-  data.tar.gz: 04fe32fe536cebb26e20aa1259aff7fbd27f11fe
+  metadata.gz: d70aa872274ad6369ff9abccb2f116eda6a5e9f9
+  data.tar.gz: 4946c00124f4948ed32a177054f34a8c19427e16
 SHA512:
-  metadata.gz: a41b6cb9084bfe613cb9ac940e1dca77b8d508c29a6c4561c5d8921aac88480bd0f218360f359bca7f817a69109fdf8175857aa9759c39b4a07df81fc9b66168
-  data.tar.gz: c74aab1fa50371cb87bb0ddcf3feed952bdf9400a54759b3e68457648d9e72fc74f26aefe9813c25bfafa3af5dd66e8e473d4f89f08ff3f05d44af27b6792035
+  metadata.gz: 6b7e631c01fa5d2e1a412ff1a9106d37239644f6ce5dcb42ef0b603ce338af6ce373bd0458a277b32211c1c5f7cb9b1a919a6dd999dea3fecd4534a7991ed2f4
+  data.tar.gz: d877b5c7c0fbedbd284e7bd782302989162ce0d9e57daed93e4c63ea136b91b54a743b2d65c7b680717971965b89dca8834439185bca10b6a5509aa2c5c48166

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v1.4.0
+
+* Add ability for VMs to have multiple SCSI controllers
+
 ## v1.3.0
 
 * Add the add_vm_controller method

data/lib/fog/vsphere/compute.rb

@@ -100,6 +100,7 @@ module Fog
       request :list_vm_customvalues
       request :list_customfields
       request :get_vm_first_scsi_controller
+      request :list_vm_scsi_controllers
       request :set_vm_customvalue
       request :vm_take_snapshot
       request :list_vm_snapshots

data/lib/fog/vsphere/models/compute/server.rb

@@ -6,6 +6,7 @@ module Fog
       class Server < Fog::Compute::Server
         extend Fog::Deprecation
         deprecate(:ipaddress, :public_ip_address)
+        deprecate(:scsi_controller, :scsi_controllers)
 
         # This will be the instance uuid which is globally unique across
         # a vSphere deployment.
@@ -45,7 +46,7 @@ module Fog
         attribute :instance_uuid # move this --> id
         attribute :guest_id
         attribute :hardware_version
-        attribute :scsi_controller # this is the first scsi controller. Right now no more of them can be used.
+        attribute :scsi_controllers, :type => :array
         attribute :cpuHotAddEnabled
         attribute :memoryHotAddEnabled
         attribute :firmware
@@ -57,7 +58,7 @@ module Fog
           initialize_interfaces
           initialize_volumes
           initialize_customvalues
-          initialize_scsi_controller
+          initialize_scsi_controllers
         end
 
         # Lazy Loaded Attributes
@@ -255,8 +256,12 @@ module Fog
           attributes[:customvalues] ||= id.nil? ? [] : service.customvalues( :vm => self )
         end
 
+        def scsi_controllers
+          self.attributes[:scsi_controllers] ||= service.list_vm_scsi_controllers(id)
+        end
+
         def scsi_controller
-          self.attributes[:scsi_controller] ||= service.get_vm_first_scsi_controller(id)
+          scsi_controllers.first
         end
 
         def folder
@@ -313,7 +318,7 @@ module Fog
 
         def initialize_volumes
           if attributes[:volumes] and attributes[:volumes].is_a?(Array)
-            self.attributes[:volumes].map! { |vol| vol.is_a?(Hash) ? service.volumes.new(vol) : vol }
+            self.attributes[:volumes].map! { |vol| vol.is_a?(Hash) ? service.volumes.new({:server => self}.merge(vol)) : vol }
           end
         end
 
@@ -323,9 +328,20 @@ module Fog
           end
         end
 
-        def initialize_scsi_controller
-          if attributes[:scsi_controller] and attributes[:scsi_controller].is_a?(Hash)
-            Fog::Compute::Vsphere::SCSIController.new(self.attributes[:scsi_controller])
+        def initialize_scsi_controllers
+          if attributes[:scsi_controllers] && attributes[:scsi_controllers].is_a?(Array)
+            self.attributes[:scsi_controllers].map! do |controller|
+              controller.is_a?(Hash) ? Fog::Compute::Vsphere::SCSIController.new(controller) : controller
+            end
+          elsif attributes[:scsi_controller] && attributes[:scsi_controller].is_a?(Hash)
+            self.attributes[:scsi_controllers] = [
+              Fog::Compute::Vsphere::SCSIController.new(self.attributes[:scsi_controller])
+            ]
+          elsif attributes[:volumes] && attributes[:volumes].is_a?(Array) && !attributes[:volumes].empty?
+            # Create a default scsi controller if there are any disks but no controller defined
+            self.attributes[:scsi_controllers] = [
+              Fog::Compute::Vsphere::SCSIController.new
+            ]
           end
         end
       end

data/lib/fog/vsphere/models/compute/volume.rb

@@ -5,6 +5,7 @@ module Fog
         DISK_SIZE_TO_GB = 1048576
         identity :id
 
+        has_one :server, Server
         attribute :datastore
         attribute :storage_pod
         attribute :mode
@@ -16,12 +17,9 @@ module Fog
         attribute :size_gb
         attribute :key
         attribute :unit_number
-        attribute :server_id
-
-        def initialize(attributes={} )
-          # Assign server first to prevent race condition with persisted?
-          self.server_id = attributes.delete(:server_id)
+        attribute :controller_key, :type => :integer, :default => 1000
 
+        def initialize(attributes={})
           super defaults.merge(attributes)
         end
 
@@ -48,25 +46,7 @@ module Fog
           raise Fog::Errors::Error.new('Resaving an existing object may create a duplicate') if persisted?
           requires :server_id, :size, :datastore
 
-          # When adding volumes to vsphere, if our unit_number is 7 or higher, vsphere will increment the unit_number
-          # This is due to SCSI ID 7 being reserved for the pvscsi controller
-          # When referring to a volume that already added using a unit_id of 7 or higher, we must refer to the actual SCSI ID
-          if unit_number.nil?
-            # Vsphere maps unit_numbers 7 and greater to a higher SCSI ID since the pvscsi driver reserves SCSI ID 7
-            used_unit_numbers = server.volumes.map { |volume| volume.unit_number < 7 ? volume.unit_number : volume.unit_number - 1 }
-            max_unit_number = used_unit_numbers.max
-
-            if max_unit_number > server.volumes.size
-              # If the max ID exceeds the number of volumes, there must be a hole in the range. Find a hole and use it.
-              self.unit_number = max_unit_number.times.to_a.find { |i| used_unit_numbers.exclude?(i) }
-            else
-              self.unit_number = max_unit_number + 1
-            end
-          else
-            if server.volumes.any? { |volume| volume.unit_number == self.unit_number && volume.id != self.id }
-              raise "A volume already exists with that unit_number, so we can't save the new volume"
-            end
-          end
+          set_unit_number
 
           data = service.add_vm_volume(self)
 
@@ -80,6 +60,7 @@ module Fog
 
             self.id = created.id
             self.key = created.key
+            self.controller_key = created.controllerKey
             self.filename = created.filename
 
             true
@@ -88,9 +69,22 @@ module Fog
           end
         end
 
-        def server
-          requires :server_id
-          service.servers.get(server_id)
+        def server_id
+          requires :server
+          server.id
+        end
+
+        def set_unit_number
+          # When adding volumes to vsphere, if our unit_number is 7 or higher, vsphere will increment the unit_number
+          # This is due to SCSI ID 7 being reserved for the pvscsi controller
+          # When referring to a volume that already added using a unit_id of 7 or higher, we must refer to the actual SCSI ID
+          if unit_number.nil?
+            self.unit_number = calculate_free_unit_number
+          else
+            if server.volumes.select { |vol| vol.controller_key == controller_key }.any? { |volume| volume.unit_number == self.unit_number && volume.id != self.id }
+              raise "A volume already exists with that unit_number, so we can't save the new volume"
+            end
+          end
         end
 
         private
@@ -102,6 +96,17 @@ module Fog
             :mode => "persistent"
           }
         end
+
+        def calculate_free_unit_number
+          requires :controller_key
+
+          # Vsphere maps unit_numbers 7 and greater to a higher SCSI ID since the pvscsi driver reserves SCSI ID 7
+          used_unit_numbers = server.volumes
+            .select { |vol| vol.unit_number && vol.controller_key == controller_key }.map(&:unit_number) + [7]
+          free_unit_numbers = (0..15).to_a - used_unit_numbers
+
+          free_unit_numbers.first
+        end
       end
     end
   end

data/lib/fog/vsphere/models/compute/volumes.rb

@@ -20,7 +20,7 @@ module Fog
               raise 'volumes should have vm or template'
             end
 
-          self.each { |volume| volume.server_id = server.id }
+          self.each { |volume| volume.server = server }
           self
         end
 

data/lib/fog/vsphere/requests/compute/create_vm.rb

@@ -20,7 +20,7 @@ module Fog
           vm_cfg[:cpuHotAddEnabled] = attributes[:cpuHotAddEnabled] if attributes.key?(:cpuHotAddEnabled)
           vm_cfg[:memoryHotAddEnabled] = attributes[:memoryHotAddEnabled] if attributes.key?(:memoryHotAddEnabled)
           vm_cfg[:firmware] = attributes[:firmware] if attributes.key?(:firmware)
-          vm_cfg[:bootOptions] = boot_options(attributes) if attributes.key?(:boot_order) || attributes.key?(:boot_retry)
+          vm_cfg[:bootOptions] = boot_options(attributes, vm_cfg) if attributes.key?(:boot_order) || attributes.key?(:boot_retry)
           resource_pool = if attributes[:resource_pool] && attributes[:resource_pool] != 'Resources'
                             get_raw_resource_pool(attributes[:resource_pool], attributes[:cluster], attributes[:datacenter])
                           else
@@ -97,9 +97,12 @@ module Fog
             devices << nics.map { |nic| create_interface(nic, nics.index(nic), :add, attributes) }
           end
 
+          if (scsi_controllers = (attributes[:scsi_controllers] || attributes["scsi_controller"]))
+            devices << scsi_controllers.each_with_index.map { |controller, index| create_controller(controller, index) }
+          end
+
           if (disks = attributes[:volumes])
-            devices << create_controller(attributes[:scsi_controller]||attributes["scsi_controller"]||{})
-            devices << disks.map { |disk| create_disk(disk, disks.index(disk), :add, 1000, get_storage_pod(attributes)) }
+            devices << disks.map { |disk| create_disk(disk, :add, get_storage_pod(attributes)) }
           end
 
           if (cdroms = attributes[:cdroms])
@@ -108,12 +111,12 @@ module Fog
           devices.flatten
         end
 
-        def boot_options attributes
+        def boot_options(attributes, vm_cfg)
           # NOTE: you must be using vsphere_rev 5.0 or greater to set boot_order
           # e.g. Fog::Compute.new(provider: "vsphere", vsphere_rev: "5.5", etc)
           options = {}
           if @vsphere_rev.to_f >= 5 and attributes[:boot_order]
-            options[:bootOrder] = boot_order(attributes)
+            options[:bootOrder] = boot_order(attributes, vm_cfg)
           end
 
           # Set attributes[:boot_retry] to a delay in miliseconds to enable boot retries
@@ -121,11 +124,11 @@ module Fog
             options[:bootRetryEnabled] = true
             options[:bootRetryDelay]   = attributes[:boot_retry]
           end
-                   
+
           options.empty? ? nil : RbVmomi::VIM::VirtualMachineBootOptions.new(options)
         end
 
-        def boot_order attributes
+        def boot_order(attributes, vm_cfg)
           # attributes[:boot_order] may be an array like this ['network', 'disk']
           # stating, that we want to prefer network boots over disk boots
           boot_order = []
@@ -142,18 +145,17 @@ module Fog
                 end
               end
             when 'disk'
-              if disks = attributes[:volumes]
-                disks.each do |disk|
-                  # we allow booting from all harddisks, the first disk has the highest priority
-                  boot_order << RbVmomi::VIM::VirtualMachineBootOptionsBootableDiskDevice.new(
-                    :deviceKey => disk.key || get_disk_device_key(disks.index(disk)),
-                  )
-                end
+              disks = vm_cfg[:deviceChange].map {|dev| dev[:device]}.select { |dev| dev.is_a? RbVmomi::VIM::VirtualDisk }
+              disks.each do |disk|
+                # we allow booting from all harddisks, the first disk has the highest priority
+                boot_order << RbVmomi::VIM::VirtualMachineBootOptionsBootableDiskDevice.new(
+                  :deviceKey => get_disk_device_key(disk.controllerKey, disk.unitNumber)
+                )
               end
             when 'cdrom'
-              boot_order << RbVmomi::VIM::VirtualMachineBootOptionsBootableCdromDevice.new()
+              boot_order << RbVmomi::VIM::VirtualMachineBootOptionsBootableCdromDevice.new
             when 'floppy'
-              boot_order << RbVmomi::VIM::VirtualMachineBootOptionsBootableFloppyDevice.new()
+              boot_order << RbVmomi::VIM::VirtualMachineBootOptionsBootableFloppyDevice.new
             else
               raise "failed to create boot device because \"#{boot_device}\" is unknown"
             end
@@ -161,17 +163,11 @@ module Fog
           boot_order
         end
 
-        def get_disk_device_key(index)
+        def get_disk_device_key(controller_key, unit_number)
+          # controller key is based on 1000 + controller bus
           # disk key is based on 2000 + the SCSI ID + the controller bus * 16
-          # the scsi host adapter appears as SCSI ID 7, so we have to skip that
-          # host adapter key is based on 1000 + bus id
-          # fog assumes that there is only a single scsi controller, see device_change()
-          if (index > 6) then
-            _index = index + 1
-          else
-            _index = index
-          end
-          2000 + _index
+          controller_bus = controller_key - 1000
+          2000 + (controller_bus * 16) + unit_number
         end
 
         def create_nic_backing nic, attributes
@@ -204,9 +200,9 @@ module Fog
           }
         end
 
-        def create_controller options=nil
-          options=if options
-                    controller_default_options.merge(Hash[options.map{|k,v| [k.to_sym,v] }])
+        def create_controller(controller=nil, index = 0)
+          options=if controller
+                    controller_default_options.merge(controller.attributes)
                   else
                     controller_default_options
                   end
@@ -218,15 +214,15 @@ module Fog
           {
             :operation => options[:operation],
             :device    => controller_class.new({
-              :key       => options[:key],
-              :busNumber => options[:bus_id],
+              :key       => options[:key] || (1000 + index),
+              :busNumber => options[:bus_id] || index,
               :sharedBus => controller_get_shared_from_options(options),
             })
           }
         end
 
         def controller_default_options
-          {:operation => "add", :type => RbVmomi::VIM.VirtualLsiLogicController.class, :key => 1000, :bus_id => 0, :shared => false }
+          {:operation => :add, :type => RbVmomi::VIM.VirtualLsiLogicController.class, :shared => false }
         end
 
         def controller_get_shared_from_options options
@@ -241,30 +237,28 @@ module Fog
           end
         end
 
-        def create_disk disk, index = 0, operation = :add, controller_key = 1000, storage_pod = nil
-          if (index > 6) then
-            _index = index + 1
-          else
-            _index = index
-          end
+        def create_disk(disk, operation = :add, storage_pod = nil)
           # If we deploy the vm on a storage pod, datastore has to be an empty string
           if storage_pod
             datastore = ''
           else
             datastore = "[#{disk.datastore}]"
           end
+
+          disk.set_unit_number
+
           payload = {
             :operation     => operation,
             :fileOperation => operation == :add ? :create : :destroy,
             :device        => RbVmomi::VIM.VirtualDisk(
-              :key           => disk.key || _index,
+              :key           => -1,
               :backing       => RbVmomi::VIM.VirtualDiskFlatVer2BackingInfo(
                 :fileName        => datastore,
                 :diskMode        => disk.mode.to_sym,
                 :thinProvisioned => disk.thin
               ),
-              :controllerKey => controller_key,
-              :unitNumber    => _index,
+              :controllerKey => disk.controller_key,
+              :unitNumber    => disk.unit_number,
               :capacityInKB  => disk.size
             )
           }

data/lib/fog/vsphere/requests/compute/list_vm_scsi_controllers.rb

@@ -0,0 +1,24 @@
+module Fog
+  module Compute
+    class Vsphere
+      class Real
+        def list_vm_scsi_controllers(vm_id)
+          list_vm_scsi_controllers_raw(vm_id).map do |raw_controller|
+            Fog::Compute::Vsphere::SCSIController.new(raw_controller)
+          end
+        end
+
+        def list_vm_scsi_controllers_raw(vm_id)
+          get_vm_ref(vm_id).config.hardware.device.grep(RbVmomi::VIM::VirtualSCSIController).map do |ctrl|
+            {
+              :type    => ctrl.class.to_s,
+              :shared_bus  => ctrl.sharedBus.to_s,
+              :unit_number => ctrl.scsiCtlrUnitNumber,
+              :key => ctrl.key,
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fog/vsphere/requests/compute/list_vm_volumes.rb

@@ -38,7 +38,8 @@ module Fog
               :size => vol.capacityInKB,
               :name => vol.deviceInfo.label,
               :key => vol.key,
-              :unit_number => vol.unitNumber
+              :unit_number => vol.unitNumber,
+              :controller_key => vol.controllerKey
             }
           end
         end

data/lib/fog/vsphere/version.rb

@@ -1,5 +1,5 @@
 module Fog
   module Vsphere
-    VERSION = '1.3.0'
+    VERSION = '1.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fog-vsphere
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - J.R. Garcia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-17 00:00:00.000000000 Z
+date: 2016-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-core
@@ -228,6 +228,7 @@ files:
 - lib/fog/vsphere/requests/compute/list_vm_cdroms.rb
 - lib/fog/vsphere/requests/compute/list_vm_customvalues.rb
 - lib/fog/vsphere/requests/compute/list_vm_interfaces.rb
+- lib/fog/vsphere/requests/compute/list_vm_scsi_controllers.rb
 - lib/fog/vsphere/requests/compute/list_vm_snapshots.rb
 - lib/fog/vsphere/requests/compute/list_vm_volumes.rb
 - lib/fog/vsphere/requests/compute/modify_vm_cdrom.rb