chef-provisioning-vsphere 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1250ea80100fd698d506ffd6f006dc479c66d1e1
-  data.tar.gz: a5fcb5cea33734d3ade4eff3ed7cd0fe4baa80af
+  metadata.gz: 2b059db41619a80c83fc1e3a397054aa706a40f9
+  data.tar.gz: f5231f61cf89c339da4140b10641bcb02c79c538
 SHA512:
-  metadata.gz: cbee2f3e9c9bf33d412b7fc247ee1c08d755570f6f07bbbdf10dd0cd34dd720f126eef620a2366bb0964e04e4d67e42d27106fb721757012177fbe5db3ac026e
-  data.tar.gz: a41a2f406b599ccd0500b69ade08d223e329007722e583ad95842704a06ae63b872ed8f7e1ec323921816f2095981879ad2824f603df00f642505835e07ce8e7
+  metadata.gz: 66bcd56de9e4a17cd2de6431b982228c19d6dea451b1d915f36d98f2dc7fa0dfa9d43d87e9893e4b945b629683b3d13ab60690fe063d08c3ced7db4f8a2d3e95
+  data.tar.gz: a261f68210ebfed783e07d82085e0d7b86cc4633f83ebe15566db79cab5d2b3c635d93f3bce36b5c5e5cf5f71242cac94dd7caa7968035d085002b1f68e44bbc

data/CHANGELOG.md

@@ -1,7 +1,16 @@
 # Change Log
 
-## [v2.1.0](https://github.com/chef-partners/chef-provisioning-vsphere/tree/v2.1.0)
+## [v2.2.0](https://github.com/chef-partners/chef-provisioning-vsphere/tree/v2.2.0)
 
+[Full Changelog](https://github.com/chef-partners/chef-provisioning-vsphere/compare/v2.1.0...v2.2.0)
+
+**Merged pull requests:**
+
+- Save VM properties to kitchen state file after cloning [\#83](https://github.com/chef-partners/chef-provisioning-vsphere/pull/83) ([josh-barker](https://github.com/josh-barker))
+- allow chef14 [\#82](https://github.com/chef-partners/chef-provisioning-vsphere/pull/82) ([jjlimepoint](https://github.com/jjlimepoint))
+- Main disk size and rework of ip\_to\_bootstrap\(\) [\#72](https://github.com/chef-partners/chef-provisioning-vsphere/pull/72) ([algaut](https://github.com/algaut))
+
+## [v2.1.0](https://github.com/chef-partners/chef-provisioning-vsphere/tree/v2.1.0) (2018-03-02)
 [Full Changelog](https://github.com/chef-partners/chef-provisioning-vsphere/compare/v2.0.10...v2.1.0)
 
 **Closed issues:**

data/README.md

@@ -7,7 +7,7 @@
 
 This is a [chef-provisioning](https://github.com/chef/chef-provisioning) provisioner for [VMware vSphere](http://www.vmware.com/products/vsphere).
 
-chef-provisioning-vsphere supports provisioning Unix/ssh and Windows/WinRMrm guest VMs.
+chef-provisioning-vsphere supports provisioning Unix/ssh and Windows/WinRM guest VMs.
 
 ## Prerequisites
 
@@ -87,12 +87,14 @@ This will use chef-zero and needs no chef server (only works for ssh). Note that
 - `[:network_name]` - array of network names to use. A NIC will be added for each
 - `[:memory_mb]` - number of megabytes to allocate for machine
 - `[:host]` - `{cluster}`/`{host}` to use during provisioning
-- `[:resource_pool]` - `{cluster}`/`{resource pool}` to use during provisioning 
+- `[:resource_pool]` - `{cluster}`/`{resource pool}` to use during provisioning
 (for single-host setups, use `{vsphere_ip / vsphere_hostname}`/`{resource pool}`)
 - `[:additional_disk_size_gb]` - an array of numbers, each signifying the number of gigabytes to assign to an additional disk (*this requires a datastore to be specified*)
+- `[:main_disk_size_gb]` - the desired size of the VM's main virtual disk in gigabytes. (*Will be ignored if lower than the template's main disk size*)
 - `[:initial_iso_file]` - an iso file to mount at boot.  This is useful for custom OS installations.  In the format of `[datastore] filename.iso`
 - `[:bootstrap_ipv4]` - `true` / `false`, set to `true` to wait for an IPv4 address to become available before bootstrapping.
 - `[:ipv4_timeout]` - use with `[:bootstrap_ipv4]`, set the time in seconds to wait before an IPv4 address is received (defaults to 30)
+- `[:ip_ready_timeout]` - set the time in seconds to wait before the machine IP is ready and connectable (defaults to 300)
 - `[:ssh][:user]` user to use for ssh/winrm (defaults to root on linux/administrator on windows)
 - `[:ssh][:password]` - password to use for ssh/winrm
 - `[:ssh][:paranoid]` - specifies the strictness of the host key verification checking

data/chef-provisioning-vsphere.gemspec

@@ -21,9 +21,9 @@ Gem::Specification.new do |s|
   s.files        = `git ls-files -z`.split("\x0")
   s.test_files   = s.files.grep(%r{^(test|spec|features)/})
 
-  s.add_dependency 'chef', '>= 12.0', '< 14.0'
+  s.add_dependency 'chef', '>= 12.0'
   s.add_dependency 'chef-provisioning', '~> 2.0'
-  s.add_dependency 'cheffish', '>= 4.0', '< 14.0'
+  s.add_dependency 'cheffish', '>= 4.0'
   s.add_dependency 'rbvmomi', '~> 1.10'
 
   s.add_development_dependency 'chefstyle'

data/lib/chef/provisioning/vsphere_driver/driver.rb

@@ -224,7 +224,7 @@ module ChefProvisioningVsphere
         vm = clone_vm(
           action_handler,
           bootstrap_options,
-          machine_spec.name
+          machine_spec
         )
       end
       vm
@@ -587,7 +587,7 @@ module ChefProvisioningVsphere
 
     # Ubuntu requires some...hacking to get DNS to work.
     #
-    # @param [Object] bootstrap_options The bootstarp options required to start the VM.
+    # @param [Object] bootstrap_options The bootstrap options required to start the VM.
     # @param [Object] _machine_spec The machine spec required to start the VM.
     # @param [Object] machine Machine object to connect to.
     def setup_ubuntu_dns(machine, bootstrap_options, _machine_spec)
@@ -616,7 +616,7 @@ module ChefProvisioningVsphere
 
     # Verify static IP.
     #
-    # @param [Object] bootstrap_options The bootstarp options required to start the VM.
+    # @param [Object] bootstrap_options The bootstrap options required to start the VM.
     def has_static_ip(bootstrap_options)
       if bootstrap_options.key?(:customization_spec)
         bootstrap_options = bootstrap_options[:customization_spec]
@@ -662,7 +662,8 @@ module ChefProvisioningVsphere
       end
     end
 
-    def clone_vm(action_handler, bootstrap_options, machine_name)
+    def clone_vm(action_handler, bootstrap_options, machine_spec)
+      machine_name = machine_spec.name
       vm_template = vm_template_for(bootstrap_options)
 
       spec_builder = CloneSpecBuilder.new(vsphere_helper, action_handler)
@@ -684,18 +685,20 @@ module ChefProvisioningVsphere
       print "\n#{machine_name} done!"
 
       vm = vsphere_helper.find_vm(vm_folder, machine_name)
+      add_machine_spec_location(vm, machine_spec)
+
+      additional_disk_size_gb = Array(bootstrap_options[:additional_disk_size_gb])
 
-      additional_disk_size_gb = bootstrap_options[:additional_disk_size_gb]
-      unless additional_disk_size_gb.is_a?(Array)
-        additional_disk_size_gb = [additional_disk_size_gb]
+
+      vsphere_helper.update_main_disk_size_for(vm, bootstrap_options[:main_disk_size_gb])
+      vsphere_helper.set_additional_disks_for(vm, bootstrap_options[:datastore], bootstrap_options[:additional_disk_size_gb])
+      if !additional_disk_size_gb.empty? && bootstrap_options[:datastore].to_s.empty?
+        raise ':datastore must be specified when adding a disk to a cloned vm'
       end
 
       additional_disk_size_gb.each do |size|
         size = size.to_i
         next if size == 0
-        if bootstrap_options[:datastore].to_s.empty?
-          raise ':datastore must be specified when adding a disk to a cloned vm'
-        end
         task = vm.ReconfigVM_Task(
           spec: RbVmomi::VIM.VirtualMachineConfigSpec(
             deviceChange: [
@@ -710,6 +713,7 @@ module ChefProvisioningVsphere
         task.wait_for_completion
       end
 
+
       if bootstrap_options[:initial_iso_image]
         d_obj = vm.config.hardware.device.select {|hw| hw.class == RbVmomi::VIM::VirtualCdrom}.first
         backing = RbVmomi::VIM::VirtualCdromIsoBackingInfo(fileName: bootstrap_options[:initial_iso_image])
@@ -724,12 +728,15 @@ module ChefProvisioningVsphere
                 connectable: RbVmomi::VIM::VirtualDeviceConnectInfo(
                   startConnected: true,
                   connected: true,
-                  allowGuestControl: true)
+
+                  allowGuestControl: true
                 )
-              ]
-            )
+
+              )
+            ]
           )
-          task.wait_for_completion
+        )
+        task.wait_for_completion
       end
 
       vm
@@ -885,7 +892,7 @@ module ChefProvisioningVsphere
       )
     end
 
-    # Find the IP to bootstrap against
+    # Return a SSH transport for the machine
     #
     # @param [String] host The host the VM is connecting to
     # @param [Object] options Options that are required to connect to the host from Chef-Provisioning
@@ -907,12 +914,14 @@ module ChefProvisioningVsphere
     # @param [Object] bootstrap_options The bootstrap options from Chef-Provisioning
     # @param [Object] vm The VM object from Chef-Provisioning
     def ip_to_bootstrap(bootstrap_options, vm)
+      start_time = Time.now.utc
+      timeout = bootstrap_ip_ready_timeout(bootstrap_options)
       @vm_helper.find_port?(vm, bootstrap_options) unless vm_helper.port?
-      vm_ip = nil
+      # First get the IP to be tested
       if has_static_ip(bootstrap_options)
         if bootstrap_options[:customization_spec].is_a?(String)
           spec = vsphere_helper.find_customization_spec(bootstrap_options[:customization_spec])
-          vm_ip = spec.nicSettingMap[0].adapter.ip.ipAddress
+          vm_ip = spec.nicSettingMap[0].adapter.ip.ipAddress # Use a direct return here?
         else
           ## Check if true available
           vm_ip = bootstrap_options[:customization_spec][:ipsettings][:ip] unless vm_helper.ip?
@@ -922,63 +931,70 @@ module ChefProvisioningVsphere
             nb_attempts += 1
           end
         end
+      elsif use_ipv4_during_bootstrap?(bootstrap_options)
+        vm_ip = wait_for_ipv4(bootstrap_ipv4_timeout(bootstrap_options), vm)
       else
-        if use_ipv4_during_bootstrap?(bootstrap_options)
-          until @vm_helper.open_port?(vm_ip, @vm_helper.port, 1)
-            wait_for_ipv4(bootstrap_ip_timeout(bootstrap_options), vm)
-          end
-        end
-        vm_ip = vm.guest.ipAddress until vm_guest_ip?(vm) && @vm_helper.open_port?(vm_ip, @vm_helper.port, 1) # Don't set empty ip
+        vm_ip = vm.guest.ipAddress until vm_guest_ip?(vm) || Time.now.utc - start_time > timeout
       end
-      vm_ip.to_s
+      # Then check that it is reachable
+      until Time.now.utc - start_time > timeout
+        print '.'
+        return vm_ip.to_s if @vm_helper.open_port?(vm_ip, @vm_helper.port, 1)
+        sleep 1
+      end
+      raise "Timed out (#{timeout}s) waiting for ip #{vm_ip} to be connectable"
     end
 
     # Force IPv4 a bootstrap, default: false
     #
     # @param [Object] bootstrap_options The bootstrap options from Chef-Provisioning
     def use_ipv4_during_bootstrap?(bootstrap_options)
-      if bootstrap_options.key?(:bootstrap_ipv4)
-        return bootstrap_options[:bootstrap_ipv4] == true
-      end
-      false
+      bootstrap_options.key?(:bootstrap_ipv4) && bootstrap_options[:bootstrap_ipv4] == true
     end
 
-    # Setting a bootstrap ip timeout, default: 30
+    # Setting a bootstrap ipv4 timeout, default: 30
     #
     # @param [Object] bootstrap_options The bootstrap options from Chef-Provisioning
-    def bootstrap_ip_timeout(bootstrap_options)
-      if bootstrap_options.key?(:ipv4_timeout)
-        return bootstrap_options[:ipv4_timeout].to_i
-      end
-      30
+    def bootstrap_ipv4_timeout(bootstrap_options)
+      bootstrap_options.key?(:ipv4_timeout) ? bootstrap_options[:ipv4_timeout].to_i : 30
+    end
+
+    # Setting a bootstrap ip timeout, default: 300
+    #
+    # @param [Object] bootstrap_options The bootstrap options from Chef-Provisioning
+    def bootstrap_ip_ready_timeout(bootstrap_options)
+      bootstrap_options.key?(:ip_ready_timeout) ? bootstrap_options[:ip_ready_timeout].to_i : 300
     end
 
-    # What for IPv4 address
+    # Wait for IPv4 address
     #
-    # @param [String] timeout Declared a timeout
+    # @param [String] timeout_seconds A timeout in seconds, an error will be raised if it is reached
     # @param [Object] vm The VM object from Chef-Provisioning
-    def wait_for_ipv4(timeout, vm)
-      sleep_time = 5
-      print 'Waiting for ipv4 address.'
-      tries = 0
-      start_search_ip = true
-      max_tries = timeout > sleep_time ? timeout / sleep_time : 1
-      while start_search_ip && (tries += 1) <= max_tries
-        print '.'
-        sleep sleep_time
-        vm_ip = vm.guest.ipAddress if vm_guest_ip?(vm)
-        start_search_ip = false if @vm_helper.open_port?(vm_ip, @vm_helper.port, 1)
+    def wait_for_ipv4(timeout_seconds, vm)
+      Chef::Log.info("Waiting #{timeout_seconds}s for ipv4 address.")
+
+      start_time = Time.now.utc
+      while (Time.now.utc - start_time) <= timeout_seconds
+        # print '.'
+        sleep 5
+        vm_ips = all_ips_for(vm)
+        Chef::Log.info("Found IP address(es): #{vm_ips}")
+        next unless vm_guest_ip?(vm)
+        vm_ips.each do |vm_ip|
+          if IPAddr.new(vm_ip).ipv4?
+            Chef::Log.info("Found ipv4 address: #{vm_ip}")
+            return vm_ip
+          end
+        end
       end
-      raise 'Timed out waiting for ipv4 address!' if tries > max_tries
-      puts 'Found ipv4 address!'
-      true
+      raise 'Timed out waiting for ipv4 address!'
     end
 
     # What is the VM guest IP
     #
     # @param [Object] vm The VM object from Chef-Provisioning
     def vm_guest_ip?(vm)
-      vm.guest.guestState == 'running' && vm.guest.toolsRunningStatus == 'guestToolsRunning' && !vm.guest.ipAddress.nil? && IPAddr.new(vm.guest.ipAddress).ipv4?
+      vm.guest.guestState == 'running' && vm.guest.toolsRunningStatus == 'guestToolsRunning' && !vm.guest.ipAddress.nil?
     end
   end
 end

data/lib/chef/provisioning/vsphere_driver/version.rb

@@ -3,5 +3,5 @@
 # Provisions machines in vSphere.
 module ChefProvisioningVsphere
   # The version of this awesome Gem. BOOM.
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.2.0'.freeze
 end

data/lib/chef/provisioning/vsphere_driver/vsphere_helpers.rb

@@ -253,6 +253,62 @@ module ChefProvisioningVsphere
       )
     end
 
+    # Creates the additional virtual disk for the VM
+    #
+    # @param [Object] vm the VM object.
+    # @param [Subject] datastore the datastore the disk will be created on.
+    # @param [Subject] size_gb the size of the disk.
+    def set_additional_disks_for(vm, datastore, additional_disk_size_gb)
+      (additional_disk_size_gb.is_a?(Array) ? additional_disk_size_gb : [additional_disk_size_gb]).each do |size|
+        size = size.to_i
+        next if size.zero?
+        if datastore.to_s.empty?
+          raise ':datastore must be specified when adding a disk to a cloned vm'
+        end
+        task = vm.ReconfigVM_Task(
+          spec: RbVmomi::VIM.VirtualMachineConfigSpec(
+            deviceChange: [
+              virtual_disk_for(
+                vm,
+                datastore,
+                size
+              )
+            ]
+          )
+        )
+        task.wait_for_completion
+      end
+    end
+
+    # Updates the main virtual disk for the VM
+    # This can only add capacity to the main disk, it is not possible to reduce the capacity.
+    #
+    # @param [Object] vm the VM object.
+    # @param [Subject] size_gb the final size of the disk.
+    def update_main_disk_size_for(vm, size_gb)
+      disk = vm.disks.first
+      size_kb = size_gb.to_i * 1024 * 1024
+      if disk.capacityInKB > size_kb
+        if size_gb.to_i > 0
+          msg = "Specified disk size #{size_gb}GB is inferior to the template's disk size (#{disk.capacityInKB / 1024**2}GB)."
+          msg += "\nThe VM disk size will remain the same."
+          Chef::Log.warn(msg)
+        end
+        return false
+      end
+      disk.capacityInKB = size_kb
+      vm.ReconfigVM_Task(
+        spec: RbVmomi::VIM.VirtualMachineConfigSpec(
+          deviceChange: [
+            {
+              operation: :edit,
+              device: disk
+            }
+          ]
+        )
+      ).wait_for_completion
+    end
+
     # Add a new network card via the boot_options
     #
     # @param [Object] action_handler TODO
@@ -417,6 +473,7 @@ module ChefProvisioningVsphere
           res = traverse_folders_for_network(child, item)
           return res unless res.nil?
         end
+        nil
       when RbVmomi::VIM::VmwareDistributedVirtualSwitch
         idx = base.summary.portgroupName.find_index(item)
         idx.nil? ? nil : base.portgroup[idx]

data/lib/kitchen/driver/vsphere.rb

@@ -23,12 +23,12 @@ module Kitchen
                        ssh: {
                          user: 'root',
                          paranoid: false,
-                         port: 22
+                         port: 22,
                        },
                        convergence_options: {},
                        customization_spec: {
-                         domain: 'local'
-                       }
+                         domain: 'local',
+                       },
                      }
 
       default_config(:vsphere_name) do |driver|
@@ -39,17 +39,26 @@ module Kitchen
       #
       # @param [Object] state Uses state of the machine from Chef provisioning.
       def create(state)
-        state[:vsphere_name] = config[:vsphere_name]
+        state[:vsphere_name] ||= config[:vsphere_name]
         state[:username] = config[:machine_options][:bootstrap_options][:ssh][:user]
         state[:password] = config[:machine_options][:bootstrap_options][:ssh][:password]
         config[:server_name] = state[:vsphere_name]
 
-        machine = with_provisioning_driver(state) do |action_handler, driver, machine_spec|
-          driver.allocate_machine(action_handler, machine_spec, config[:machine_options])
-          driver.ready_machine(action_handler, machine_spec, config[:machine_options])
-          state[:server_id] = machine_spec.location['server_id']
-          state[:hostname] = machine_spec.location['ipaddress']
-          machine_spec.save(action_handler)
+        with_provisioning_driver(state) do |action_handler, driver, machine_spec|
+          begin
+            driver.allocate_machine(action_handler, machine_spec, config[:machine_options])
+            driver.ready_machine(action_handler, machine_spec, config[:machine_options])
+          rescue
+            raise
+          ensure
+            if machine_spec
+              if machine_spec.location
+                state[:server_id] = machine_spec.location['server_id']
+                state[:hostname] = machine_spec.location['ipaddress']
+              end
+              machine_spec.save(action_handler)
+            end
+          end
         end
       end
 

data/spec/integration_tests/vsphere_driver_spec.rb

@@ -36,6 +36,8 @@ require 'chef/provisioning/machine_spec'
 
 describe 'vsphere_driver' do
   before :all do
+    skip("driver options do not exist") unless File.exist?(File.expand_path('../config.rb', __FILE__))
+
     @vm_name = "cmvd-test-#{SecureRandom.hex}"
     @metal_config = eval File.read(File.expand_path('../config.rb', __FILE__))
     Cheffish.honor_local_mode do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chef-provisioning-vsphere
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - CenturyLink Cloud
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-02 00:00:00.000000000 Z
+date: 2018-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -18,9 +18,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '12.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '14.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,9 +25,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '12.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '14.0'
 - !ruby/object:Gem::Dependency
   name: chef-provisioning
   requirement: !ruby/object:Gem::Requirement
@@ -52,9 +46,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '14.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -62,9 +53,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '14.0'
 - !ruby/object:Gem::Dependency
   name: rbvmomi
   requirement: !ruby/object:Gem::Requirement