vmpooler 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ae03cde5adef86e2f5b52928b1b241e6e300993f5ab9bca3c76fbba49b5f29a
-  data.tar.gz: 3f04c605b3a255baf73ea7a5e985ab5d241411a43763b47e2b8739574b48178b
+  metadata.gz: 69a8b533d59906b740d63c48c2f237bac2d42c3bbc770ed178e41f9981c7f955
+  data.tar.gz: '0609a290e75b7deb1f167a059b6342c43ce7942e600c7f67ba29b3389f411b59'
 SHA512:
-  metadata.gz: 4ec28d2335628c1fe8bf079940db915233c45100e885eb387ffa86bfdcb384078f9fb5aa7fb2985ead5e0b9c8e8f619037a66b0927a9325db8bc8a2cfc63e1ae
-  data.tar.gz: dff5b02ccab6c7eab949dab4df8ea2c1d530d6c672278dd9fe7c485e9234b19045f6e65f28870dbe3fe1cbbb8d53aac4fea45cfe008b548e619307b04ba56f25
+  metadata.gz: bd7da108e63619bb0f7a80d1567ee38e6c05c3d87d77982fa81d117612577eb7480940f39c910c8d7fb0ec373972233a304f7bc63e80dae35c7d1f0ba9edddf4
+  data.tar.gz: d7023cc35609431f37f55a74fd07312afaefab627558ad55f9d03eaa320dce8929ffdb36fc4ca2ab6d0a299a1d93820a2767714680813e3f7f2fbb78fac01b27

data/lib/vmpooler/api/helpers.rb

@@ -56,14 +56,11 @@ module Vmpooler
         return false
       end
 
-      def authenticate_ldap(port, host, user_object, base, username_str, password_str)
+      def authenticate_ldap(port, host, encryption_hash, user_object, base, username_str, password_str)
         ldap = Net::LDAP.new(
           :host => host,
           :port => port,
-          :encryption => {
-            :method => :start_tls,
-            :tls_options => { :ssl_version => 'TLSv1' }
-          },
+          :encryption => encryption_hash,
           :base => base,
           :auth => {
             :method => :simple,
@@ -86,6 +83,10 @@ module Vmpooler
           ldap_port = auth[:ldap]['port'] || 389
           ldap_user_obj = auth[:ldap]['user_object']
           ldap_host = auth[:ldap]['host']
+          ldap_encryption_hash = auth[:ldap]['encryption'] || {
+            :method => :start_tls,
+            :tls_options => { :ssl_version => 'TLSv1' }
+          }
 
           unless ldap_base.is_a? Array
             ldap_base = ldap_base.split
@@ -100,6 +101,7 @@ module Vmpooler
               result = authenticate_ldap(
                 ldap_port,
                 ldap_host,
+                ldap_encryption_hash,
                 search_user_obj,
                 search_base,
                 username_str,

data/lib/vmpooler/api/v1.rb

@@ -28,6 +28,10 @@ module Vmpooler
       Vmpooler::API.settings.config[:pools]
     end
 
+    def pools_at_startup
+      Vmpooler::API.settings.config[:pools_at_startup]
+    end
+
     def pool_exists?(template)
       Vmpooler::API.settings.config[:pool_names].include?(template)
     end
@@ -236,12 +240,25 @@ module Vmpooler
       result
     end
 
+    def component_to_test(match, labels_string)
+      return if labels_string.nil?
+
+      labels_string_parts = labels_string.split(',')
+      labels_string_parts.each do |part|
+        key, value = part.split('=')
+        next if value.nil?
+        return value if key == match
+      end
+      'none'
+    end
+
     def update_user_metrics(operation, vmname)
       backend.multi
       backend.hget("vmpooler__vm__#{vmname}", 'tag:jenkins_build_url')
       backend.hget("vmpooler__vm__#{vmname}", 'token:user')
       backend.hget("vmpooler__vm__#{vmname}", 'template')
       jenkins_build_url, user, poolname = backend.exec
+      poolname = poolname.gsub('.', '_')
 
       if user
         user = user.gsub('.', '_')
@@ -276,6 +293,32 @@ module Vmpooler
       puts 'd', "[!] [#{poolname}] failed while evaluating usage labels on '#{vmname}' with an error: #{e}"
     end
 
+    def reset_pool_size(poolname)
+      result = { 'ok' => false }
+
+      pool_index = pool_index(pools)
+
+      pools_updated = 0
+      sync_pool_sizes
+
+      pool_size_now = pools[pool_index[poolname]]['size'].to_i
+      pool_size_original = pools_at_startup[pool_index[poolname]]['size'].to_i
+      result['pool_size_before_reset'] = pool_size_now
+      result['pool_size_before_overrides'] = pool_size_original
+
+      unless pool_size_now == pool_size_original
+        pools[pool_index[poolname]]['size'] = pool_size_original
+        backend.hdel('vmpooler__config__poolsize', poolname)
+        backend.sadd('vmpooler__pool__undo_size_override', poolname)
+        pools_updated += 1
+        status 201
+      end
+
+      status 200 unless pools_updated > 0
+      result['ok'] = true
+      result
+    end
+
     def update_pool_size(payload)
       result = { 'ok' => false }
 
@@ -296,6 +339,33 @@ module Vmpooler
       result
     end
 
+    def reset_pool_template(poolname)
+      result = { 'ok' => false }
+
+      pool_index_live = pool_index(pools)
+      pool_index_original = pool_index(pools_at_startup)
+
+      pools_updated = 0
+      sync_pool_templates
+
+      template_now = pools[pool_index_live[poolname]]['template']
+      template_original = pools_at_startup[pool_index_original[poolname]]['template']
+      result['template_before_reset'] = template_now
+      result['template_before_overrides'] = template_original
+
+      unless template_now == template_original
+        pools[pool_index_live[poolname]]['template'] = template_original
+        backend.hdel('vmpooler__config__template', poolname)
+        backend.sadd('vmpooler__pool__undo_template_override', poolname)
+        pools_updated += 1
+        status 201
+      end
+
+      status 200 unless pools_updated > 0
+      result['ok'] = true
+      result
+    end
+
     def update_pool_template(payload)
       result = { 'ok' => false }
 
@@ -1362,6 +1432,26 @@ module Vmpooler
       JSON.pretty_generate(result)
     end
 
+    delete "#{api_prefix}/config/poolsize/:pool/?" do
+      content_type :json
+      result = { 'ok' => false }
+
+      if config['experimental_features']
+        need_token! if Vmpooler::API.settings.config[:auth]
+
+        if pool_exists?(params[:pool])
+          result = reset_pool_size(params[:pool])
+        else
+          metrics.increment('config.invalid.unknown')
+          status 404
+        end
+      else
+        status 405
+      end
+
+      JSON.pretty_generate(result)
+    end
+
     post "#{api_prefix}/config/poolsize/?" do
       content_type :json
       result = { 'ok' => false }
@@ -1393,6 +1483,26 @@ module Vmpooler
       JSON.pretty_generate(result)
     end
 
+    delete "#{api_prefix}/config/pooltemplate/:pool/?" do
+      content_type :json
+      result = { 'ok' => false }
+
+      if config['experimental_features']
+        need_token! if Vmpooler::API.settings.config[:auth]
+
+        if pool_exists?(params[:pool])
+          result = reset_pool_template(params[:pool])
+        else
+          metrics.increment('config.invalid.unknown')
+          status 404
+        end
+      else
+        status 405
+      end
+
+      JSON.pretty_generate(result)
+    end
+
     post "#{api_prefix}/config/pooltemplate/?" do
       content_type :json
       result = { 'ok' => false }

data/lib/vmpooler/pool_manager.rb

@@ -478,18 +478,6 @@ module Vmpooler
       dereference_mutex(vm)
     end
 
-    def component_to_test(match, labels_string)
-      return if labels_string.nil?
-
-      labels_string_parts = labels_string.split(',')
-      labels_string_parts.each do |part|
-        key, value = part.split('=')
-        next if value.nil?
-        return value if key == match
-      end
-      'none'
-    end
-
     def purge_unused_vms_and_folders
       global_purge = $config[:config]['purge_unconfigured_folders']
       providers = $config[:providers].keys
@@ -640,7 +628,7 @@ module Vmpooler
     end
 
     # @return [Array] - a list of used providers from the config file, defaults to the default providers
-    # ie. ["vsphere", "dummy"]
+    # ie. ["dummy"]
     def used_providers
       pools = config[:pools] || []
       @used_providers ||= (pools.map { |pool| pool[:provider] || pool['provider'] }.compact + default_providers).uniq
@@ -650,7 +638,7 @@ module Vmpooler
     # note: vsphere is the default if user does not specify although this should not be
     # if vsphere is to no longer be loaded by default please remove
     def default_providers
-      @default_providers ||= %w[vsphere dummy]
+      @default_providers ||= %w[dummy]
     end
 
     def get_pool_name_for_vm(vm_name, redis)
@@ -796,6 +784,10 @@ module Vmpooler
     #   - Fires when a pool reset is requested
     #   - Additional options
     #       :poolname
+    # :undo_override
+    #   - Fires when a pool override removal is requested
+    #   - Additional options
+    #       :poolname
     #
     def sleep_with_wakeup_events(loop_delay, wakeup_period = 5, options = {})
       exit_by = Time.now + loop_delay
@@ -838,6 +830,11 @@ module Vmpooler
               break if pending
             end
 
+            if options[:undo_override]
+              break if redis.sismember('vmpooler__pool__undo_template_override', options[:poolname])
+              break if redis.sismember('vmpooler__pool__undo_size_override', options[:poolname])
+            end
+
             if options[:pending_vm]
               pending_vm_count = redis.scard("vmpooler__pending__#{options[:poolname]}")
               break unless pending_vm_count == 0
@@ -892,7 +889,7 @@ module Vmpooler
               loop_delay = (loop_delay * loop_delay_decay).to_i
               loop_delay = loop_delay_max if loop_delay > loop_delay_max
             end
-            sleep_with_wakeup_events(loop_delay, loop_delay_min, pool_size_change: true, poolname: pool['name'], pool_template_change: true, clone_target_change: true, pending_vm: true, pool_reset: true)
+            sleep_with_wakeup_events(loop_delay, loop_delay_min, pool_size_change: true, poolname: pool['name'], pool_template_change: true, clone_target_change: true, pending_vm: true, pool_reset: true, undo_override: true)
 
             unless maxloop == 0
               break if loop_count >= maxloop
@@ -1052,15 +1049,18 @@ module Vmpooler
       return if mutex.locked?
 
       @redis.with_metrics do |redis|
-        poolsize = redis.hget('vmpooler__config__poolsize', pool['name'])
-        break if poolsize.nil?
+        pool_size_requested = redis.hget('vmpooler__config__poolsize', pool['name'])
+        break if pool_size_requested.nil?
 
-        poolsize = Integer(poolsize)
-        break if poolsize == pool['size']
+        pool_size_requested = Integer(pool_size_requested)
+        pool_size_currently = pool['size']
+        break if pool_size_requested == pool_size_currently
 
         mutex.synchronize do
-          pool['size'] = poolsize
+          pool['size'] = pool_size_requested
         end
+
+        $logger.log('s', "[*] [#{pool['name']}] size updated from #{pool_size_currently} to #{pool_size_requested}")
       end
     end
 
@@ -1078,6 +1078,38 @@ module Vmpooler
       end
     end
 
+    def undo_override(pool, provider)
+      poolname = pool['name']
+      mutex = pool_mutex(poolname)
+      return if mutex.locked?
+
+      @redis.with_metrics do |redis|
+        break unless redis.sismember('vmpooler__pool__undo_template_override', poolname)
+
+        redis.srem('vmpooler__pool__undo_template_override', poolname)
+        template_now = pool['template']
+        template_original = $config[:pools_at_startup][$config[:pool_index][poolname]]['template']
+
+        mutex.synchronize do
+          update_pool_template(pool, provider, template_original, template_now, redis)
+        end
+      end
+
+      @redis.with_metrics do |redis|
+        break unless redis.sismember('vmpooler__pool__undo_size_override', poolname)
+
+        redis.srem('vmpooler__pool__undo_size_override', poolname)
+        pool_size_now = pool['size']
+        pool_size_original = $config[:pools_at_startup][$config[:pool_index][poolname]]['size']
+
+        mutex.synchronize do
+          pool['size'] = pool_size_original
+        end
+
+        $logger.log('s', "[*] [#{poolname}] size updated from #{pool_size_now} to #{pool_size_original}")
+      end
+    end
+
     def create_inventory(pool, provider, pool_check_response)
       inventory = {}
       begin
@@ -1312,6 +1344,9 @@ module Vmpooler
       # Reset a pool when poolreset is requested from the API
       reset_pool(pool)
 
+      # Undo overrides submitted via the api
+      undo_override(pool, provider)
+
       pool_check_response
     end
 
@@ -1526,8 +1561,8 @@ module Vmpooler
       # Set default provider for all pools that do not have one defined
       $config[:pools].each do |pool|
         if pool['provider'].nil?
-          $logger.log('d', "[!] Setting provider for pool '#{pool['name']}' to 'vsphere' as default")
-          pool['provider'] = 'vsphere'
+          $logger.log('d', "[!] Setting provider for pool '#{pool['name']}' to 'dummy' as default")
+          pool['provider'] = 'dummy'
         end
       end
 

data/lib/vmpooler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Vmpooler
-  VERSION = '1.1.1'
+  VERSION = '2.0.0'
 end

data/lib/vmpooler.rb

@@ -7,7 +7,6 @@ module Vmpooler
   require 'net/ldap'
   require 'open-uri'
   require 'pickup'
-  require 'rbvmomi'
   require 'redis'
   require 'set'
   require 'sinatra/base'
@@ -119,6 +118,11 @@ module Vmpooler
       parsed_config[:auth][:ldap]['port']        = string_to_int(ENV['LDAP_PORT']) if ENV['LDAP_PORT']
       parsed_config[:auth][:ldap]['base']        = ENV['LDAP_BASE'] if ENV['LDAP_BASE']
       parsed_config[:auth][:ldap]['user_object'] = ENV['LDAP_USER_OBJECT'] if ENV['LDAP_USER_OBJECT']
+      if parsed_config[:auth]['provider'] == 'ldap' && parsed_config[:auth][:ldap].key?('encryption')
+        parsed_config[:auth][:ldap]['encryption'] = parsed_config[:auth][:ldap]['encryption']
+      elsif parsed_config[:auth]['provider'] == 'ldap'
+        parsed_config[:auth][:ldap]['encryption'] = {}
+      end
     end
 
     # Create an index of pool aliases
@@ -128,8 +132,17 @@ module Vmpooler
       parsed_config[:pools] = load_pools_from_redis(redis)
     end
 
+    # Marshal.dump is paired with Marshal.load to create a copy that has its own memory space
+    # so that each can be edited independently
+    # rubocop:disable Security/MarshalLoad
+
+    # retain a copy of the pools that were observed at startup
+    serialized_pools = Marshal.dump(parsed_config[:pools])
+    parsed_config[:pools_at_startup] = Marshal.load(serialized_pools)
+
     # Create an index of pools by title
     parsed_config[:pool_index] = pool_index(parsed_config[:pools])
+    # rubocop:enable Security/MarshalLoad
 
     parsed_config[:pools].each do |pool|
       parsed_config[:pool_names] << pool['name']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vmpooler
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-24 00:00:00.000000000 Z
+date: 2021-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -226,26 +226,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rbvmomi
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -400,6 +380,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.11.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: yarjuf
   requirement: !ruby/object:Gem::Requirement
@@ -444,10 +444,10 @@ files:
 - lib/vmpooler/providers.rb
 - lib/vmpooler/providers/base.rb
 - lib/vmpooler/providers/dummy.rb
-- lib/vmpooler/providers/vsphere.rb
 - lib/vmpooler/public/bootstrap.min.css
 - lib/vmpooler/public/img/bg.png
 - lib/vmpooler/public/img/logo.gif
+- lib/vmpooler/public/img/logo.png
 - lib/vmpooler/public/img/spinner.svg
 - lib/vmpooler/public/img/subtle_dots.png
 - lib/vmpooler/public/img/textured_paper.png
@@ -479,7 +479,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: vmpooler provides configurable pools of instantly-available (running) virtual