fog-vsphere 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a75eea9b7c7c8861cbdd259740a3be4910ab46d
-  data.tar.gz: a7cc4a8d5fc471e589fada237661d54064480236
+  metadata.gz: 4f0eaac527da91308fec5066b89407f48b10c7ec
+  data.tar.gz: 150e3dc5e72cb0c27d617bf65b2d7db259edb609
 SHA512:
-  metadata.gz: 75979dcdf4fc9f215bb473b46a83480f73ce6992a1c36b9a9d527f471118b62b5f6844ce10a509007a48d7696636ad5a734a528e66c2c1fed32d1cead471808f
-  data.tar.gz: 0a22422a0bca780cb478dddef9b47b186848fb3a051a09c972002762cb04c800f22c4847cf7b5e95233ec9483470f32d50317153f962cd5d135c22da00c50109
+  metadata.gz: c03d49413d12ba37d6a02365932583cafc87634cafaf55c8bceadc687ef08a9e0f9134b7928eb2aed94099ef01ee395340d5b10f76351e3870c0e7e409baec5a
+  data.tar.gz: 2d78b5e76edff6315f2601fc1830ae395c2419b3e159632a3ad0261d2309c7271d3a303c16ad1b5883fa40ef73e43bfa8958ec92c868d1e0c32d3e78e7124da1

data/.travis.yml

@@ -6,8 +6,6 @@ matrix:
     - rvm: jruby-head
   fast_finish: true
   include:
-    - rvm: 1.8.7
-      gemfile: gemfiles/Gemfile.1.9.2-
     - rvm: 1.9.3
       gemfile: gemfiles/Gemfile.1.9.2+
     - rvm: 2.0.0
@@ -18,8 +16,6 @@ matrix:
       gemfile: Gemfile
     - rvm: 2.2.0
       gemfile: Gemfile
-    - rvm: jruby-18mode
-      gemfile: gemfiles/Gemfile.1.9.2-
     - rvm: jruby-19mode
       gemfile: gemfiles/Gemfile.1.9.2+
     - rvm: jruby-head

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+* Fix update_vm_interface
+* Add add folder.destroy
+* Implement CD-ROM options
+* Implement storage pods
+* Fix nil error when snapshots is called on a VM without snapshots
+* No longer support Ruby 1.8
+* Allow setting of boot order when using api > 5.0
+* Select the most recent API version instead of 4.1

data/CONTRIBUTORS.md

@@ -4,6 +4,7 @@
 * Carlos Sanchez <csanchez@maestrodev.com>
 * Chris Thompson <chris.thompson@govdelivery.com>
 * Chris Thompson <teaforthecat@gmail.com>
+* Christopher Oliver <coliver@datapipe.com>
 * Cyrus Team <cyrusteam@cyruslists.com>
 * Darren Foo <stonith@users.noreply.github.com>
 * Dominic Cleal <dcleal@redhat.com>
@@ -14,6 +15,8 @@
 * Francois Herbert <francois@herbert.org.nz>
 * Ivan Nečas <inecas@redhat.com>
 * Ivo Reznicek <ireznice@googlemail.com>
+* J.R. Garcia <jr@garciaole.com>
+* J.R. Garcia <jrg@vmware.com>
 * James Herdman <james.herdman@me.com>
 * Jeff McCune <jeff@puppetlabs.com>
 * Justin Clayton <justin.clayton@gettyimages.com>
@@ -42,11 +45,14 @@
 * Oscar Elfving <sofam84@gmail.com>
 * Paul Thornthwaite <paul@brightbox.co.uk>
 * Paul Thornthwaite <tokengeek@gmail.com>
+* Paulo Henrique Lopes Ribeiro <plribeiro3000@gmail.com>
+* Rich Daley <rdaley@williamhill.co.uk>
 * Rich Lane <rlane@club.cc.cmu.edu>
 * Samuel Keeley <samuel@dropbox.com>
 * Shlomi Zadok <shlomi@ben-hanna.com>
 * Simon Josi <me@yokto.net>
 * Tejas Ravindra Mandke <tejas@identified.com>
+* Timo Goebel <timo.goebel@dm.de>
 * Timur Alperovich <timur@maginatics.com>
 * Wesley Beary <geemus+github@gmail.com>
 * Wesley Beary <geemus@gmail.com>

data/fog-vsphere.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 1.8.7'
 
-  spec.add_runtime_dependency 'fog-core', '~> 1.32'
+  spec.add_runtime_dependency 'fog-core'
   spec.add_runtime_dependency 'rbvmomi', '~> 1.8'
 
   spec.add_development_dependency 'bundler', '~> 1.10'

data/lib/fog/vsphere/compute.rb

@@ -33,6 +33,8 @@ module Fog
       collection :networks
       model :datastore
       collection :datastores
+      model :storage_pod
+      collection :storage_pods
       model :folder
       collection :folders
       model :customvalue
@@ -41,6 +43,8 @@ module Fog
       collection :customfields
       model :scsicontroller
       model :process
+      model :cdrom
+      collection :cdroms
 
       request_path 'fog/vsphere/requests/compute'
       request :current_time
@@ -63,6 +67,8 @@ module Fog
       request :get_network
       request :list_datastores
       request :get_datastore
+      request :list_storage_pods
+      request :get_storage_pod
       request :list_compute_resources
       request :get_compute_resource
       request :list_templates
@@ -73,11 +79,14 @@ module Fog
       request :list_vm_interfaces
       request :modify_vm_interface
       request :modify_vm_volume
+      request :modify_vm_cdrom
       request :list_vm_volumes
+      request :list_vm_cdroms
       request :get_virtual_machine
       request :vm_reconfig_hardware
       request :vm_reconfig_memory
       request :vm_reconfig_cpus
+      request :vm_reconfig_cdrom
       request :vm_config_vnc
       request :create_folder
       request :list_server_types
@@ -93,6 +102,8 @@ module Fog
       request :list_child_snapshots
       request :revert_to_snapshot
       request :list_processes
+      request :upload_iso
+      request :folder_destroy
 
       module Shared
         attr_reader :vsphere_is_vcenter
@@ -237,6 +248,17 @@ module Fog
                       "status"  => "ok",
                       "summary" => "VM Network",
                      }],
+                 "cdroms" =>
+                    [{
+                      "name"                => "CD-/DVD-Drive 1",
+                      "filename"            => nil,
+                      "key"                 => 3000,
+                      "controller_key"      => 200,
+                      "unit_number"         => 0,
+                      "start_connected"     => false,
+                      "allow_guest_control" => true,
+                      "connected"           => false,
+                     }],
                  "hypervisor"       => "gunab.puppetlabs.lan",
                  "guest_id"         => "rhel6_64Guest",
                  "tools_state"      => "toolsOk",
@@ -308,7 +330,7 @@ module Fog
                  "tools_state"      => "toolsOk",
                  "name"             => "jefftest",
                  "operatingsystem"  => "Red Hat Enterprise Linux 6 (64-bit)",
-                 "path"             => "/",
+                 "path"             => "/Solutions/wibble",
                  "tools_version"    => "guestToolsUnmanaged",
                  "ipaddress"        => "192.168.100.187",
                  "uuid"             => "42329da7-e8ab-29ec-1892-d6a4a964912a",
@@ -318,8 +340,30 @@ module Fog
                 }
               },
               :datacenters => {
-                "Solutions" => {:name => "Solutions", :status => "grey"}
+                "Solutions" => {:name => "Solutions", :status => "grey", :path => ['Solutions']}
+              },
+              :folders => {
+                'wibble' => {
+                  'name' => 'wibble',
+                  'datacenter' => 'Solutions',
+                  'path' => '/Solutions/wibble',
+                  'type' => 'vm'
+                },
+                'empty' => {
+                  'name' => 'empty',
+                  'datacenter' => 'Solutions',
+                  'path' => '/Solutions/empty',
+                  'type' => 'vm'
+                }
               },
+              :storage_pods =>
+                [{:id => "group-p123456",
+                  :name => "Datastore Cluster 1",
+                  :freespace => "4856891834368",
+                  :capacity => "7132061630464",
+                  :datacenter => "Solutions",
+                 },
+                ],
               :clusters =>
                 [{:id => "1d4d9a3f-e4e8-4c40-b7fc-263850068fa4",
                   :name => "Solutionscluster",
@@ -417,7 +461,7 @@ module Fog
           # Negotiate the API revision
           if not revision
             rev = @connection.serviceContent.about.apiVersion
-            @connection.rev = [ rev, ENV['FOG_VSPHERE_REV'] || '4.1' ].min
+            @connection.rev = [ rev, ENV['FOG_VSPHERE_REV'] || '4.1' ].max
           end
 
           @vsphere_is_vcenter = @connection.serviceContent.about.apiType == "VirtualCenter"

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

@@ -0,0 +1,65 @@
+module Fog
+  module Compute
+    class Vsphere
+      class Cdrom < Fog::Model
+        identity :key
+
+        attribute :filename
+        attribute :name, :default => "CD-/DVD-ROM Drive"
+        attribute :controller_key
+        attribute :unit_number
+        attribute :start_connected
+        attribute :allow_guest_control
+        attribute :connected
+
+        has_one_identity :server, :servers, :aliases => :instance_uuid
+
+        def to_s
+          name
+        end
+
+        def destroy
+          requires :instance_uuid, :key, :unit_number
+
+          service.destroy_vm_cdrom(self)
+          true
+        end
+
+        def save
+          requires :instance_uuid
+
+          if unit_number.nil?
+            used_unit_numbers = server.cdroms.map { |cdrom| cdrom.unit_number }
+            max_unit_number = used_unit_numbers.max
+
+            if max_unit_number > server.cdroms.size
+              # If the max ID exceeds the number of cdroms, 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.cdroms.any? { |cdrom| cdrom.unit_number == self.unit_number && cdrom.id != self.id }
+              raise "A cdrom already exists with that unit_number, so we can't save the new cdrom"
+            end
+          end
+
+          data = service.add_vm_cdrom(self)
+
+          if data['task_state'] == 'success'
+            # We have to query vSphere to get the cdrom attributes since the task handle doesn't include that info.
+            created = server.cdroms.get(unit_number)
+
+            self.key = created.key
+            self.filename = created.filename
+            self.unit_number = created.unit_number
+
+            true
+          else
+            false
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Fog
+  module Compute
+    class Vsphere
+      class Cdroms < Fog::Collection
+        attribute :instance_uuid, :alias => :server_id
+        model Fog::Compute::Vsphere::Cdrom
+
+        def all(filters = {})
+          load service.list_vm_cdroms(instance_uuid)
+        end
+
+        def get(unit_number)
+          all.find { |cdrom| cdrom.unit_number == unit_number }
+        end
+      end
+    end
+  end
+end

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

@@ -19,6 +19,10 @@ module Fog
           service.datastores({ :datacenter => path.join("/") }.merge(filters))
         end
 
+        def storage_pods filters = { }
+          service.storage_pods({ :datacenter => path.join("/") }.merge(filters))
+        end
+
         def vm_folders filters = { }
           service.folders({ :datacenter => path.join("/"), :type => :vm }.merge(filters))
         end

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

@@ -18,6 +18,10 @@ module Fog
         def to_s
           name
         end
+        
+        def destroy
+          service.folder_destroy(path, datacenter)
+        end
       end
     end
   end

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

@@ -237,6 +237,14 @@ module Fog
           end
         end
 
+        def cdroms(opts = {})
+          service.cdroms(:instance_uuid => self.id).all(opts)
+        end
+
+        def cdrom(key)
+          cdroms.get(key)
+        end
+
         def guest_processes(opts = {})
           fail 'VM tools must be running' unless tools_running?
           service.list_processes(self.id, opts)

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

@@ -0,0 +1,19 @@
+module Fog
+  module Compute
+    class Vsphere
+      class StoragePod < Fog::Model
+        identity :id
+
+        attribute :name
+        attribute :datacenter
+        attribute :type
+        attribute :freespace
+        attribute :capacity
+
+        def to_s
+          name
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require 'fog/core/collection'
+require 'fog/vsphere/models/compute/storage_pod'
+
+module Fog
+  module Compute
+    class Vsphere
+      class StoragePods < Fog::Collection
+        model Fog::Compute::Vsphere::StoragePod
+        attribute :datacenter
+
+        def all(filters = {})
+          load service.list_storage_pods(filters.merge(datacenter: datacenter))
+        end
+
+        def get(id)
+          requires :datacenter
+          new service.get_storage_pod(id, datacenter)
+        end
+      end
+    end
+  end
+end

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

@@ -6,6 +6,7 @@ module Fog
         identity :id
 
         attribute :datastore
+        attribute :storage_pod
         attribute :mode
         attribute :size
         attribute :thin

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

@@ -17,6 +17,16 @@ module Fog
           end
         end
       end
+      class Mock
+        def create_folder(datacenter, path, name)
+          self.data[:folders][name] = {
+            'name'       => name,
+            'datacenter' => datacenter,
+            'path'       => "#{path}/#{name}",
+            'type'       => 'vm'
+          }
+        end
+      end
     end
   end
 end

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

@@ -19,13 +19,20 @@ 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)
           resource_pool = if attributes[:resource_pool]
                             get_raw_resource_pool(attributes[:resource_pool], attributes[:cluster], attributes[:datacenter])
                           else
                             get_raw_cluster(attributes[:cluster], attributes[:datacenter]).resourcePool
                           end
           vmFolder      = get_raw_vmfolder(attributes[:path], attributes[:datacenter])
-          vm            = vmFolder.CreateVM_Task(:config => vm_cfg, :pool => resource_pool).wait_for_completion
+          # if any volume has a storage_pod set, we deploy the vm on a storage pod instead of the defined datastores
+          pod = get_storage_pod(attributes)
+          if pod
+            vm = create_vm_on_storage_pod(pod, vm_cfg, vmFolder, resource_pool, attributes[:datacenter])
+          else
+            vm = create_vm_on_datastore(vm_cfg, vmFolder, resource_pool)
+          end
           vm.config.instanceUuid
         rescue => e
           raise e, "failed to create vm: #{e}"
@@ -33,9 +40,47 @@ module Fog
 
         private
 
+        def create_vm_on_datastore(vm_cfg, vmFolder, resource_pool)
+          vm = vmFolder.CreateVM_Task(:config => vm_cfg, :pool => resource_pool).wait_for_completion
+        end
+
+        def create_vm_on_storage_pod(storage_pod, vm_cfg, vmFolder, resource_pool, datacenter)
+          pod_spec     = RbVmomi::VIM::StorageDrsPodSelectionSpec.new(
+            :storagePod => get_raw_storage_pod(storage_pod, datacenter),
+          )
+          storage_spec = RbVmomi::VIM::StoragePlacementSpec.new(
+            :type => 'create',
+            :folder => vmFolder,
+            :resourcePool => resource_pool,
+            :podSelectionSpec => pod_spec,
+            :configSpec => vm_cfg,
+          )
+          srm = @connection.serviceContent.storageResourceManager
+          result = srm.RecommendDatastores(:storageSpec => storage_spec)
+
+          # if result array contains recommendation, we can apply it
+          if key = result.recommendations.first.key
+            result = srm.ApplyStorageDrsRecommendation_Task(:key => [key]).wait_for_completion
+            vm = result.vm
+          else
+            raise "Could not create vm on storage pod, did not get a storage recommendation"
+          end
+          vm
+        end
+
+        # check if a storage pool is set on any of the volumes and return the first result found or nil
+        # return early if vsphere revision is lower than 5 as this is not supported
+        def get_storage_pod attributes
+          return unless @vsphere_rev.to_f >= 5
+          volume = attributes[:volumes].detect {|volume| !( volume.storage_pod.nil? || volume.storage_pod.empty? ) }
+          volume.storage_pod if volume
+        end
+
         # this methods defines where the vm config files would be located,
         # by default we prefer to keep it at the same place the (first) vmdk is located
+        # if we deploy the vm on a storage pool, we have to return an empty string
         def vm_path_name attributes
+          return '' if get_storage_pod(attributes)
           datastore = attributes[:volumes].first.datastore unless attributes[:volumes].empty?
           datastore ||= 'datastore1'
           "[#{datastore}]"
@@ -49,11 +94,73 @@ module Fog
 
           if (disks = attributes[:volumes])
             devices << create_controller(attributes[:scsi_controller]||attributes["scsi_controller"]||{})
-            devices << disks.map { |disk| create_disk(disk, disks.index(disk)) }
+            devices << disks.map { |disk| create_disk(disk, disks.index(disk), :add, 1000, get_storage_pod(attributes)) }
+          end
+
+          if (cdroms = attributes[:cdroms])
+            devices << cdroms.map { |cdrom| create_cdrom(cdrom, cdroms.index(cdrom)) }
           end
           devices.flatten
         end
 
+        def boot_options attributes
+          # 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)
+          return unless @vsphere_rev.to_f >= 5
+          RbVmomi::VIM::VirtualMachineBootOptions.new(
+            :bootOrder => boot_order(attributes)
+          )
+        end
+
+        def boot_order attributes
+          # attributes[:boot_order] may be an array like this ['network', 'disk']
+          # stating, that we want to prefer network boots over disk boots
+          boot_order = []
+          attributes[:boot_order].each do |boot_device|
+            case boot_device
+            when 'network'
+              if nics = attributes[:interfaces]
+                # key is based on 4000 + the interface index
+                # we allow booting from all network interfaces, the first interface has the highest priority
+                nics.each do |nic|
+                  boot_order << RbVmomi::VIM::VirtualMachineBootOptionsBootableEthernetDevice.new(
+                    :deviceKey => 4000 + nics.index(nic),
+                  )
+                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
+              end
+            when 'cdrom'
+              boot_order << RbVmomi::VIM::VirtualMachineBootOptionsBootableCdromDevice.new()
+            when 'floppy'
+              boot_order << RbVmomi::VIM::VirtualMachineBootOptionsBootableFloppyDevice.new()
+            else
+              raise "failed to create boot device because \"#{boot_device}\" is unknown"
+            end
+          end
+          boot_order
+        end
+
+        def get_disk_device_key(index)
+          # 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
+        end
+
         def create_nic_backing nic, attributes
           raw_network = get_raw_network(nic.network, attributes[:datacenter], if nic.virtualswitch then nic.virtualswitch end)
 
@@ -121,19 +228,25 @@ module Fog
           end
         end
 
-        def create_disk disk, index = 0, operation = :add, controller_key = 1000
+        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
+          # 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
           payload = {
             :operation     => operation,
             :fileOperation => operation == :add ? :create : :destroy,
             :device        => RbVmomi::VIM.VirtualDisk(
               :key           => disk.key || _index,
               :backing       => RbVmomi::VIM.VirtualDiskFlatVer2BackingInfo(
-                :fileName        => "[#{disk.datastore}]",
+                :fileName        => datastore,
                 :diskMode        => disk.mode.to_sym,
                 :thinProvisioned => disk.thin
               ),
@@ -150,6 +263,22 @@ module Fog
           payload
         end
 
+        def create_cdrom cdrom, index = 0, operation = :add, controller_key = 200
+          {
+            :operation     => operation,
+            :device        => RbVmomi::VIM.VirtualCdrom(
+              :key           => cdrom.key || index,
+              :backing       => RbVmomi::VIM::VirtualCdromRemoteAtapiBackingInfo(deviceName: ''),
+              :controllerKey => controller_key,
+              connectable: RbVmomi::VIM::VirtualDeviceConnectInfo(
+                startConnected: false,
+                connected: false,
+                allowGuestControl: true,
+              ),
+            )
+          }
+        end
+
         def extra_config attributes
           [
             {
@@ -162,6 +291,36 @@ module Fog
 
       class Mock
         def create_vm attributes = { }
+          id = SecureRandom.uuid
+          vm = {
+            'id'                => id,
+            'uuid'              => id,
+            'instance_uuid'     => id,
+            'mo_ref'            => "vm-#{rand 99999}",
+            'datacenter'        => attributes[:datacenter],
+            'name'              => attributes[:name],
+            'interfaces'        => attributes[:interfaces].map {{
+              'mac' => 'f2:b5:46:b5:d8:d7'
+            }}
+          }
+          self.data[:servers][id] = vm
+          id
+        end
+
+        def create_cdrom cdrom, index = 0, operation = :add, controller_key = 200
+          {
+            :operation     => operation,
+            :device        => {
+              :key           => cdrom.key || index,
+              :backing       => { deviceName: '' },
+              :controllerKey => controller_key,
+              connectable: {
+                startConnected: false,
+                connected: false,
+                allowGuestControl: true,
+              },
+            }
+          }
         end
       end
     end