vmpooler 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 277212a5ca26187ed46a4e6d0ef0716511a3b63097deab1485908c95bb437c5e
-  data.tar.gz: 36272bc0744f943d88ca3eb0a33a070268f2a0fa45e130a7ee8abb04d4d0243e
+  metadata.gz: da4a010ab09d34f4fbfa9993526ad18dec205dfbc72f427a250304b2147bdf31
+  data.tar.gz: 61193bec61a1385754487f107e601c1fc76959ae81fc27a47d4f11a881553e91
 SHA512:
-  metadata.gz: 8bb11603444163deb47713be137b1da3234096c60c59cbedda58b35d5dafeef80a2f6f733ccd1c1d0eb4db39959f189183937a712139346ccd673a8d1ea7f8d0
-  data.tar.gz: 4502d6509ac75fc693ca24c9defdb401fc00aff14f3cba2d39143786efe3b0aef6eed0bc3ab6a1adb9cdd925684aa39f8e84c999dbbdd88d121efc052ba6fd84
+  metadata.gz: 13399e493bcaaf5c18541c2125366bb88325936746b715550c6e438d31de77eed9b0f42d9e6140c7529eb0dbd27e4335529f368e6b190c1d047f0cd2710f801e
+  data.tar.gz: 0f8551abcbb4cfbaf7bbf60d52f6630ce8334fff620ef1e05bad35e53fb7448c69da074494f8df5efa97053ad6b1e3dd2e55c942e97b359156b0ec07b26de912

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

@@ -210,6 +210,7 @@ module Vmpooler
             account_for_starting_vm(vmpool, vmname)
             vms << [vmpool, vmname, vmtemplate]
             metrics.increment("checkout.success.#{vmpool}")
+            update_user_metrics('allocate', vmname) if Vmpooler::API.settings.config[:config]['usage_stats']
           else
             failed = true
             metrics.increment("checkout.empty.#{requested}")
@@ -235,6 +236,59 @@ 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('.', '_')
+      else
+        user = 'unauthenticated'
+      end
+      metrics.increment("user.#{user}.#{operation}.#{poolname}")
+
+      if jenkins_build_url
+        if jenkins_build_url.include? 'litmus'
+          # Very simple filter for Litmus jobs - just count them coming through for the moment.
+          metrics.increment("usage_litmus.#{user}.#{operation}.#{poolname}")
+          return
+        end
+
+        url_parts = jenkins_build_url.split('/')[2..-1]
+        jenkins_instance = url_parts[0].gsub('.', '_')
+        value_stream_parts = url_parts[2].split('_')
+        value_stream_parts = value_stream_parts.map { |s| s.gsub('.', '_') }
+        value_stream = value_stream_parts.shift
+        branch = value_stream_parts.pop
+        project = value_stream_parts.shift
+        job_name = value_stream_parts.join('_')
+        build_metadata_parts = url_parts[3]
+        component_to_test = component_to_test('RMM_COMPONENT_TO_TEST_NAME', build_metadata_parts)
+
+        metrics.increment("usage_jenkins_instance.#{jenkins_instance}.#{value_stream}.#{operation}.#{poolname}")
+        metrics.increment("usage_branch_project.#{branch}.#{project}.#{operation}.#{poolname}")
+        metrics.increment("usage_job_component.#{job_name}.#{component_to_test}.#{operation}.#{poolname}")
+      end
+    rescue StandardError => e
+      puts 'd', "[!] [#{poolname}] failed while evaluating usage labels on '#{vmname}' with an error: #{e}"
+    end
+
     def update_pool_size(payload)
       result = { 'ok' => false }
 
@@ -1169,6 +1223,7 @@ module Vmpooler
           status 200
           result['ok'] = true
           metrics.increment('delete.success')
+          update_user_metrics('destroy', params[:hostname]) if Vmpooler::API.settings.config[:config]['usage_stats']
         else
           metrics.increment('delete.failed')
         end

data/lib/vmpooler/metrics/promstats.rb

@@ -165,33 +165,33 @@ module Vmpooler
           },
           user: {
             mtype: M_COUNTER,
-            torun: %i[manager],
-            docstring: 'Number of pool instances this user created created',
-            param_labels: %i[user poolname]
+            torun: %i[api],
+            docstring: 'Number of pool instances and the operation performed by a user',
+            param_labels: %i[user operation poolname]
           },
           usage_litmus: {
             mtype: M_COUNTER,
-            torun: %i[manager],
-            docstring: 'Pools by Litmus job usage',
-            param_labels: %i[user poolname]
+            torun: %i[api],
+            docstring: 'Number of pool instances and the operation performed by Litmus jobs',
+            param_labels: %i[user operation poolname]
           },
           usage_jenkins_instance: {
             mtype: M_COUNTER,
-            torun: %i[manager],
-            docstring: 'Pools by Jenkins instance usage',
-            param_labels: %i[jenkins_instance value_stream poolname]
+            torun: %i[api],
+            docstring: 'Number of pool instances and the operation performed by Jenkins instances',
+            param_labels: %i[jenkins_instance value_stream operation poolname]
           },
           usage_branch_project: {
             mtype: M_COUNTER,
-            torun: %i[manager],
-            docstring: 'Pools by branch/project usage',
-            param_labels: %i[branch project poolname]
+            torun: %i[api],
+            docstring: 'Number of pool instances and the operation performed by Jenkins branch/project',
+            param_labels: %i[branch project operation poolname]
           },
           usage_job_component: {
             mtype: M_COUNTER,
-            torun: %i[manager],
-            docstring: 'Pools by job/component usage',
-            param_labels: %i[job_name component_to_test poolname]
+            torun: %i[api],
+            docstring: 'Number of pool instances and the operation performed by Jenkins job/component',
+            param_labels: %i[job_name component_to_test operation poolname]
           },
           checkout: {
             mtype: M_COUNTER,

data/lib/vmpooler/pool_manager.rb

@@ -473,66 +473,11 @@ module Vmpooler
           finish = format('%<time>.2f', time: Time.now - start)
           $logger.log('s', "[-] [#{pool}] '#{vm}' destroyed in #{finish} seconds")
           $metrics.timing("destroy.#{pool}", finish)
-          get_vm_usage_labels(vm, redis)
         end
       end
       dereference_mutex(vm)
     end
 
-    def get_vm_usage_labels(vm, redis)
-      return unless $config[:config]['usage_stats']
-
-      redis.multi
-      redis.hget("vmpooler__vm__#{vm}", 'checkout')
-      redis.hget("vmpooler__vm__#{vm}", 'tag:jenkins_build_url')
-      redis.hget("vmpooler__vm__#{vm}", 'token:user')
-      redis.hget("vmpooler__vm__#{vm}", 'template')
-      checkout, jenkins_build_url, user, poolname = redis.exec
-      return if checkout.nil?
-
-      user ||= 'unauthenticated'
-      user = user.gsub('.', '_')
-      $metrics.increment("user.#{user}.#{poolname}")
-
-      return unless jenkins_build_url
-
-      if jenkins_build_url.include? 'litmus'
-        # Very simple filter for Litmus jobs - just count them coming through for the moment.
-        $metrics.increment("usage_litmus.#{user}.#{poolname}")
-        return
-      end
-
-      url_parts = jenkins_build_url.split('/')[2..-1]
-      jenkins_instance = url_parts[0].gsub('.', '_')
-      value_stream_parts = url_parts[2].split('_')
-      value_stream_parts = value_stream_parts.map { |s| s.gsub('.', '_') }
-      value_stream = value_stream_parts.shift
-      branch = value_stream_parts.pop
-      project = value_stream_parts.shift
-      job_name = value_stream_parts.join('_')
-      build_metadata_parts = url_parts[3]
-      component_to_test = component_to_test('RMM_COMPONENT_TO_TEST_NAME', build_metadata_parts)
-
-      $metrics.increment("usage_jenkins_instance.#{jenkins_instance}.#{value_stream}.#{poolname}")
-      $metrics.increment("usage_branch_project.#{branch}.#{project}.#{poolname}")
-      $metrics.increment("usage_job_component.#{job_name}.#{component_to_test}.#{poolname}")
-    rescue StandardError => e
-      $logger.log('d', "[!] [#{poolname}] failed while evaluating usage labels on '#{vm}' with an error: #{e}")
-      raise
-    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

data/lib/vmpooler/version.rb

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

data/lib/vmpooler.rb

@@ -119,6 +119,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
@@ -236,12 +241,12 @@ module Vmpooler
     if tracing_enabled.eql?('false')
       puts "Exporting of traces has been disabled so the span processor has been se to a 'NoopSpanExporter'"
       span_processor = OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
-        exporter: OpenTelemetry::SDK::Trace::Export::NoopSpanExporter.new
+        OpenTelemetry::SDK::Trace::Export::NoopSpanExporter.new
       )
     else
       puts "Exporting of traces will be done over HTTP in binary Thrift format to #{tracing_jaeger_host}"
       span_processor = OpenTelemetry::SDK::Trace::Export::BatchSpanProcessor.new(
-        exporter: OpenTelemetry::Exporter::Jaeger::CollectorExporter.new(endpoint: tracing_jaeger_host)
+        OpenTelemetry::Exporter::Jaeger::CollectorExporter.new(endpoint: tracing_jaeger_host)
       )
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vmpooler
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-02 00:00:00.000000000 Z
+date: 2021-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -72,84 +72,84 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-concurrent_ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-resource_detectors
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: pickup
   requirement: !ruby/object:Gem::Requirement