vmpooler-provider-vsphere 3.3.4 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89055d5655c089933c5e57db2fc1208fe6e52c0ab6b7a28001056fabac1d6be0
-  data.tar.gz: f319d467743e1ff8a570f07d6f019542bdc9b860c515728ffb3935fbcfd7a67c
+  metadata.gz: 70ae81e3cc10136212e98b959de197cd6fd9f77aad9a52374e4b0716020c52f8
+  data.tar.gz: beca8a851c0df498f726e7441bf3bc9cafc01cc703004832212af3eeadab2e14
 SHA512:
-  metadata.gz: 3ab52b86c880df03c88934336d99a6ab0314eb758fe6e623cd88269e61a1214e64db692c60d72adfa4b9b8230caa02aecb025d527127792f8efcde3708a73ea3
-  data.tar.gz: 50205ce2612b97551072c2fbdc6383e0e49e27f12ae8c6264a80b7b69a5b3a7a8d32d2c53382ce12d0a70bcdaf8dda00adbfc7ea3e5f3524de4e5ccec2d366aa
+  metadata.gz: c6844c6c213111ba9c4a5b7f29c4fc5805e0cc9bc5e0da5201c7e4b0a54813d738542ad2ba4704c705e6f471aa20dbeffd9d4faf8d5d111477a22bdd052c8bf3
+  data.tar.gz: 2bb2b9d136a389e528eaa0f6af3160d269462a676a0431f78f7e066862c053e83c7cf2a5828dd6605ca3a7add47e113fae1a9b1e0bf84876d2e417bcd45f3f83

data/lib/vmpooler/providers/vsphere.rb

@@ -3,6 +3,7 @@
 require 'bigdecimal'
 require 'bigdecimal/util'
 require 'rbvmomi'
+require 'timeout'
 require 'vmpooler/providers/base'
 
 module Vmpooler
@@ -74,7 +75,7 @@ module Vmpooler
               transaction.hset("vmpooler__vm__#{vm_name}", 'destroy', Time.now.to_s)
 
               # Auto-expire metadata key
-              transaction.expire("vmpooler__vm__#{vm_name}", (data_ttl * 60 * 60))
+              transaction.expire("vmpooler__vm__#{vm_name}", data_ttl * 60 * 60)
             end
           end
 
@@ -186,14 +187,18 @@ module Vmpooler
 
         def vms_in_pool(pool_name)
           vms = []
-          @connection_pool.with_metrics do |pool_object|
-            connection = ensured_vsphere_connection(pool_object)
-            folder_object = find_vm_folder(pool_name, connection)
+          with_circuit_breaker do
+            Timeout.timeout(vsphere_connection_timeout) do
+              @connection_pool.with_metrics do |pool_object|
+                connection = ensured_vsphere_connection(pool_object)
+                folder_object = find_vm_folder(pool_name, connection)
 
-            return vms if folder_object.nil?
+                next if folder_object.nil?
 
-            folder_object.childEntity.each do |vm|
-              vms << { 'name' => vm.name } if vm.is_a? RbVmomi::VIM::VirtualMachine
+                folder_object.childEntity.each do |vm|
+                  vms << { 'name' => vm.name } if vm.is_a? RbVmomi::VIM::VirtualMachine
+                end
+              end
             end
           end
           vms
@@ -305,12 +310,16 @@ module Vmpooler
 
         def get_vm(pool_name, vm_name)
           vm_hash = nil
-          @connection_pool.with_metrics do |pool_object|
-            connection = ensured_vsphere_connection(pool_object)
-            vm_object = find_vm(pool_name, vm_name, connection)
-            return vm_hash if vm_object.nil?
-
-            vm_hash = generate_vm_hash(vm_object, pool_name)
+          with_circuit_breaker do
+            Timeout.timeout(vsphere_connection_timeout) do
+              @connection_pool.with_metrics do |pool_object|
+                connection = ensured_vsphere_connection(pool_object)
+                vm_object = find_vm(pool_name, vm_name, connection)
+                next if vm_object.nil?
+
+                vm_hash = generate_vm_hash(vm_object, pool_name)
+              end
+            end
           end
           vm_hash
         end
@@ -320,86 +329,94 @@ module Vmpooler
           raise("Pool #{pool_name} does not exist for the provider #{name}") if pool.nil?
 
           vm_hash = nil
-          @connection_pool.with_metrics do |pool_object|
-            connection = ensured_vsphere_connection(pool_object)
-            # Assume all pool config is valid i.e. not missing
-            template_path = pool['template']
-            target_folder_path = pool['folder']
-            target_datastore = pool['datastore']
-            target_datacenter_name = get_target_datacenter_from_config(pool_name)
-
-            # Get the template VM object
-            raise("Pool #{pool_name} did not specify a full path for the template for the provider #{name}") unless valid_template_path? template_path
-
-            template_vm_object = find_template_vm(pool, connection)
-
-            extra_config = [
-              { key: 'guestinfo.hostname', value: new_vmname }
-            ]
-
-            if pool.key?('snapshot_mainMem_ioBlockPages')
-              ioblockpages = pool['snapshot_mainMem_ioBlockPages']
-              extra_config.push(
-                { key: 'mainMem.ioBlockPages', value: ioblockpages }
-              )
-            end
-            if pool.key?('snapshot_mainMem_iowait')
-              iowait = pool['snapshot_mainMem_iowait']
-              extra_config.push(
-                { key: 'mainMem.iowait', value: iowait }
-              )
-            end
+          with_circuit_breaker do
+            @connection_pool.with_metrics do |pool_object|
+              connection = ensured_vsphere_connection(pool_object)
+              # Assume all pool config is valid i.e. not missing
+              template_path = pool['template']
+              target_folder_path = pool['folder']
+              target_datastore = pool['datastore']
+              target_datacenter_name = get_target_datacenter_from_config(pool_name)
+
+              # Get the template VM object
+              raise("Pool #{pool_name} did not specify a full path for the template for the provider #{name}") unless valid_template_path? template_path
+
+              template_vm_object = find_template_vm(pool, connection)
+
+              extra_config = [
+                { key: 'guestinfo.hostname', value: new_vmname }
+              ]
+
+              if pool.key?('snapshot_mainMem_ioBlockPages')
+                ioblockpages = pool['snapshot_mainMem_ioBlockPages']
+                extra_config.push(
+                  { key: 'mainMem.ioBlockPages', value: ioblockpages }
+                )
+              end
+              if pool.key?('snapshot_mainMem_iowait')
+                iowait = pool['snapshot_mainMem_iowait']
+                extra_config.push(
+                  { key: 'mainMem.iowait', value: iowait }
+                )
+              end
 
-            # Annotate with creation time, origin template, etc.
-            # Add extraconfig options that can be queried by vmtools
-            config_spec = create_config_spec(new_vmname, template_path, extra_config)
+              # Annotate with creation time, origin template, etc.
+              # Add extraconfig options that can be queried by vmtools
+              config_spec = create_config_spec(new_vmname, template_path, extra_config)
 
-            # Check if alternate network configuration is specified and add configuration
-            if pool.key?('network')
-              template_vm_network_device = template_vm_object.config.hardware.device.grep(RbVmomi::VIM::VirtualEthernetCard).first
-              network_name = pool['network']
-              network_device = set_network_device(target_datacenter_name, template_vm_network_device, network_name, connection)
-              config_spec.deviceChange = [{ operation: 'edit', device: network_device }]
-            end
+              # Check if alternate network configuration is specified and add configuration
+              if pool.key?('network')
+                template_vm_network_device = template_vm_object.config.hardware.device.grep(RbVmomi::VIM::VirtualEthernetCard).first
+                network_name = pool['network']
+                network_device = set_network_device(target_datacenter_name, template_vm_network_device, network_name, connection)
+                config_spec.deviceChange = [{ operation: 'edit', device: network_device }]
+              end
 
-            # Put the VM in the specified folder and resource pool
-            relocate_spec = create_relocate_spec(target_datastore, target_datacenter_name, pool_name, connection)
+              # Put the VM in the specified folder and resource pool
+              relocate_spec = create_relocate_spec(target_datastore, target_datacenter_name, pool_name, connection)
 
-            # Create a clone spec
-            clone_spec = create_clone_spec(relocate_spec, config_spec)
+              # Create a clone spec
+              clone_spec = create_clone_spec(relocate_spec, config_spec)
 
-            begin
-              vm_target_folder = find_vm_folder(pool_name, connection)
-              vm_target_folder ||= create_folder(connection, target_folder_path, target_datacenter_name) if @config[:config].key?('create_folders') && (@config[:config]['create_folders'] == true)
-            rescue StandardError
-              if @config[:config].key?('create_folders') && (@config[:config]['create_folders'] == true)
-                vm_target_folder = create_folder(connection, target_folder_path, target_datacenter_name)
-              else
-                raise
+              begin
+                vm_target_folder = find_vm_folder(pool_name, connection)
+                vm_target_folder ||= create_folder(connection, target_folder_path, target_datacenter_name) if @config[:config].key?('create_folders') && (@config[:config]['create_folders'] == true)
+              rescue StandardError
+                if @config[:config].key?('create_folders') && (@config[:config]['create_folders'] == true)
+                  vm_target_folder = create_folder(connection, target_folder_path, target_datacenter_name)
+                else
+                  raise
+                end
               end
-            end
-            raise ArgumentError, "Cannot find the configured folder for #{pool_name} #{target_folder_path}" unless vm_target_folder
+              raise ArgumentError, "Cannot find the configured folder for #{pool_name} #{target_folder_path}" unless vm_target_folder
 
-            # Create the new VM
-            new_vm_object = template_vm_object.CloneVM_Task(
-              folder: vm_target_folder,
-              name: new_vmname,
-              spec: clone_spec
-            ).wait_for_completion
+              # Create the new VM
+              new_vm_object = template_vm_object.CloneVM_Task(
+                folder: vm_target_folder,
+                name: new_vmname,
+                spec: clone_spec
+              ).wait_for_completion
 
-            vm_hash = generate_vm_hash(new_vm_object, pool_name)
+              vm_hash = generate_vm_hash(new_vm_object, pool_name)
+            end
           end
           vm_hash
         end
 
         # The inner method requires vmware tools running in the guest os
         def get_vm_ip_address(vm_name, pool_name)
-          @connection_pool.with_metrics do |pool_object|
-            connection = ensured_vsphere_connection(pool_object)
-            vm_object = find_vm(pool_name, vm_name, connection)
-            vm_hash = generate_vm_hash(vm_object, pool_name)
-            return vm_hash['ip']
+          ip = nil
+          with_circuit_breaker do
+            Timeout.timeout(vsphere_connection_timeout) do
+              @connection_pool.with_metrics do |pool_object|
+                connection = ensured_vsphere_connection(pool_object)
+                vm_object = find_vm(pool_name, vm_name, connection)
+                vm_hash = generate_vm_hash(vm_object, pool_name)
+                ip = vm_hash['ip']
+              end
+            end
           end
+          ip
         end
 
         def create_config_spec(vm_name, template_name, extra_config)
@@ -540,17 +557,19 @@ module Vmpooler
         end
 
         def destroy_vm(pool_name, vm_name)
-          @connection_pool.with_metrics do |pool_object|
-            connection = ensured_vsphere_connection(pool_object)
-            vm_object = find_vm(pool_name, vm_name, connection)
-            # If a VM doesn't exist then it is effectively deleted
-            return true if vm_object.nil?
+          with_circuit_breaker do
+            @connection_pool.with_metrics do |pool_object|
+              connection = ensured_vsphere_connection(pool_object)
+              vm_object = find_vm(pool_name, vm_name, connection)
+              # If a VM doesn't exist then it is effectively deleted
+              next if vm_object.nil?
 
-            # Poweroff the VM if it's running
-            vm_object.PowerOffVM_Task.wait_for_completion if vm_object.runtime&.powerState && vm_object.runtime.powerState == 'poweredOn'
+              # Poweroff the VM if it's running
+              vm_object.PowerOffVM_Task.wait_for_completion if vm_object.runtime&.powerState && vm_object.runtime.powerState == 'poweredOn'
 
-            # Kill it with fire
-            vm_object.Destroy_Task.wait_for_completion
+              # Kill it with fire
+              vm_object.Destroy_Task.wait_for_completion
+            end
           end
           true
         end
@@ -595,7 +614,7 @@ module Vmpooler
           pool_configuration = pool_config(pool_name)
           return nil if pool_configuration.nil?
 
-          hostname = vm_object.summary.guest.hostName if vm_object.summary&.guest && vm_object.summary.guest.hostName
+          hostname = vm_object.summary.guest.hostName if vm_object.summary&.guest&.hostName
           boottime = vm_object.runtime.bootTime if vm_object.runtime&.bootTime
           powerstate = vm_object.runtime.powerState if vm_object.runtime&.powerState
 
@@ -631,6 +650,14 @@ module Vmpooler
         DISK_TYPE = 'thin'
         DISK_MODE = 'persistent'
 
+        def with_circuit_breaker(&block)
+          if circuit_breaker
+            circuit_breaker.call(&block)
+          else
+            yield
+          end
+        end
+
         def ensured_vsphere_connection(connection_pool_object)
           connection_pool_object[:connection] = connect_to_vsphere unless vsphere_connection_ok?(connection_pool_object[:connection])
           connection_pool_object[:connection]
@@ -651,7 +678,9 @@ module Vmpooler
             connection = RbVmomi::VIM.connect host: provider_config['server'],
                                               user: provider_config['username'],
                                               password: provider_config['password'],
-                                              insecure: provider_config['insecure'] || false
+                                              insecure: provider_config['insecure'] || false,
+                                              read_timeout: vsphere_connection_timeout,
+                                              open_timeout: vsphere_connection_timeout
             metrics.increment('connect.open')
             connection
           rescue StandardError => e
@@ -664,6 +693,12 @@ module Vmpooler
           end
         end
 
+        def vsphere_connection_timeout
+          timeout = provider_config['vsphere_timeout'] ||
+                    global_config&.dig(:config, 'vsphere_timeout') || 60
+          timeout.to_i
+        end
+
         # This should supercede the open_socket method in the Pool Manager
         def open_socket(host, domain = nil, timeout = 5, port = 22, &_block)
           target_host = host
@@ -697,7 +732,7 @@ module Vmpooler
 
           # Reverse the array back to normal and
           # then convert the array of paths into a '/' seperated string
-          (full_path.reverse.map { |p| p[1] }).join('/')
+          full_path.reverse.map { |p| p[1] }.join('/')
         end
 
         def add_disk(vm, size, datastore, connection, datacentername)
@@ -1078,7 +1113,7 @@ module Vmpooler
           vm_object = find_vm(pool_name, vm_name, connection)
           return nil if vm_object.nil?
 
-          parent_host_object = vm_object.summary.runtime.host if vm_object.summary&.runtime && vm_object.summary.runtime.host
+          parent_host_object = vm_object.summary.runtime.host if vm_object.summary&.runtime&.host
           raise('Unable to determine which host the VM is running on') if parent_host_object.nil?
 
           parent_host = parent_host_object.name
@@ -1103,6 +1138,9 @@ module Vmpooler
             begin
               connection = ensured_vsphere_connection(pool_object)
               vm_hash = get_vm_details(pool_name, vm_name, connection)
+
+              raise StandardError, 'failed to get vm details. vm is unreachable or no longer exists' if vm_hash.nil?
+
               @redis.with_metrics do |redis|
                 redis.hset("vmpooler__vm__#{vm_name}", 'host', vm_hash['host_name'])
                 migration_count = redis.scard('vmpooler__migration')
@@ -1220,7 +1258,8 @@ module Vmpooler
         def linked_clone?(pool)
           return if pool['create_linked_clone'] == false
           return true if pool['create_linked_clone']
-          return true if @config[:config]['create_linked_clones']
+
+          true if @config[:config]['create_linked_clones']
         end
       end
     end

data/lib/vmpooler-provider-vsphere/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VmpoolerProviderVsphere
-  VERSION = '3.3.4'
+  VERSION = '3.4.0'
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: vmpooler-provider-vsphere
 version: !ruby/object:Gem::Version
-  version: 3.3.4
+  version: 3.4.0
 platform: ruby
 authors:
 - Puppet
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-30 00:00:00.000000000 Z
+date: 2026-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: rbvmomi2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -19,9 +19,8 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
-  name: rbvmomi2
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -31,118 +30,119 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
+  name: vmpooler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-  name: vmpooler
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
+  name: climate_control
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.0
-  name: climate_control
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.0
 - !ruby/object:Gem::Dependency
+  name: mock_redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.17.0
-  name: mock_redis
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.17.0
 - !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  name: pry
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
-  name: rack-test
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-  name: rspec
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.28.2
-  name: rubocop
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.28.2
 - !ruby/object:Gem::Dependency
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.11.2
-  name: simplecov
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.11.2
 - !ruby/object:Gem::Dependency
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -151,9 +151,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.1
-  name: thor
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -163,20 +162,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.1
 - !ruby/object:Gem::Dependency
+  name: yarjuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
-  name: yarjuf
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
-description:
 email:
 - support@puppet.com
 executables: []
@@ -189,7 +187,6 @@ homepage: https://github.com/puppetlabs/vmpooler-provider-vsphere
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -204,8 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: VMware provider for VMPooler
 test_files: []