Module: Vmpooler

Defined in:
lib/vmpooler/util/parsing.rb,
lib/vmpooler.rb,
lib/vmpooler/api.rb,
lib/vmpooler/api/v1.rb,
lib/vmpooler/api/v2.rb,
lib/vmpooler/logger.rb,
lib/vmpooler/metrics.rb,
lib/vmpooler/version.rb,
lib/vmpooler/dashboard.rb,
lib/vmpooler/providers.rb,
lib/vmpooler/api/helpers.rb,
lib/vmpooler/api/reroute.rb,
lib/vmpooler/pool_manager.rb,
lib/vmpooler/api/dashboard.rb,
lib/vmpooler/metrics/statsd.rb,
lib/vmpooler/providers/base.rb,
lib/vmpooler/api/healthcheck.rb,
lib/vmpooler/providers/dummy.rb,
lib/vmpooler/metrics/graphite.rb,
lib/vmpooler/metrics/promstats.rb,
lib/vmpooler/api/request_logger.rb,
lib/vmpooler/metrics/dummy_statsd.rb,
lib/vmpooler/generic_connection_pool.rb,
lib/vmpooler/metrics/promstats/collector_middleware.rb

Overview

utility class shared between apps api and pool_manager

Defined Under Namespace

Classes: API, Dashboard, Logger, Metrics, Parsing, PoolManager, Providers

Constant Summary collapse

VERSION = 
'2.3.0'

Class Method Summary collapse

Class Method Details

.config(filepath = 'vmpooler.yaml') ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/vmpooler.rb', line 31

def self.config(filepath = 'vmpooler.yaml')
  # Take the config either from an ENV config variable or from a config file
  if ENV['VMPOOLER_CONFIG']
    config_string = ENV['VMPOOLER_CONFIG']
    # Parse the YAML config into a Hash
    # Allow the Symbol class
    parsed_config = YAML.safe_load(config_string, [Symbol])
  else
    # Take the name of the config file either from an ENV variable or from the filepath argument
    config_file = ENV['VMPOOLER_CONFIG_FILE'] || filepath
    parsed_config = YAML.load_file(config_file) if File.exist? config_file
    parsed_config[:config]['extra_config'] = ENV['EXTRA_CONFIG'] if ENV['EXTRA_CONFIG']
    if parsed_config[:config]['extra_config']
      extra_configs = parsed_config[:config]['extra_config'].split(',')
      extra_configs.each do |config|
        puts "loading extra_config file #{config}"
        extra_config = YAML.load_file(config)
        parsed_config.deep_merge(extra_config)
      end
    end
  end

  parsed_config ||= { config: {} }

  # Bail out if someone attempts to start vmpooler with dummy authentication
  # without enbaling debug mode.
  if parsed_config.key?(:auth) && parsed_config[:auth]['provider'] == 'dummy' && !ENV['VMPOOLER_DEBUG']
    warning = [
      'Dummy authentication should not be used outside of debug mode',
      'please set environment variable VMPOOLER_DEBUG to \'true\' if you want to use dummy authentication'
    ]

    raise warning.join(";\s")
  end

  # Set some configuration defaults
  parsed_config[:config]['task_limit']                         = string_to_int(ENV['TASK_LIMIT']) || parsed_config[:config]['task_limit'] || 10
  parsed_config[:config]['ondemand_clone_limit']               = string_to_int(ENV['ONDEMAND_CLONE_LIMIT']) || parsed_config[:config]['ondemand_clone_limit'] || 10
  parsed_config[:config]['max_ondemand_instances_per_request'] = string_to_int(ENV['MAX_ONDEMAND_INSTANCES_PER_REQUEST']) || parsed_config[:config]['max_ondemand_instances_per_request'] || 10
  parsed_config[:config]['migration_limit']                    = string_to_int(ENV['MIGRATION_LIMIT']) if ENV['MIGRATION_LIMIT']
  parsed_config[:config]['vm_checktime']                       = string_to_int(ENV['VM_CHECKTIME']) || parsed_config[:config]['vm_checktime'] || 1
  parsed_config[:config]['vm_lifetime']                        = string_to_int(ENV['VM_LIFETIME']) || parsed_config[:config]['vm_lifetime'] || 24
  parsed_config[:config]['max_lifetime_upper_limit']           = string_to_int(ENV['MAX_LIFETIME_UPPER_LIMIT']) || parsed_config[:config]['max_lifetime_upper_limit']
  parsed_config[:config]['ready_ttl']                          = string_to_int(ENV['READY_TTL']) || parsed_config[:config]['ready_ttl'] || 60
  parsed_config[:config]['ondemand_request_ttl']               = string_to_int(ENV['ONDEMAND_REQUEST_TTL']) || parsed_config[:config]['ondemand_request_ttl'] || 5
  parsed_config[:config]['prefix']                             = ENV['PREFIX'] || parsed_config[:config]['prefix'] || ''
  parsed_config[:config]['logfile']                            = ENV['LOGFILE'] if ENV['LOGFILE']
  parsed_config[:config]['site_name']                          = ENV['SITE_NAME'] if ENV['SITE_NAME']
  parsed_config[:config]['domain']                             = ENV['DOMAIN'] if ENV['DOMAIN']
  parsed_config[:config]['clone_target']                       = ENV['CLONE_TARGET'] if ENV['CLONE_TARGET']
  parsed_config[:config]['timeout']                            = string_to_int(ENV['TIMEOUT']) if ENV['TIMEOUT']
  parsed_config[:config]['vm_lifetime_auth']                   = string_to_int(ENV['VM_LIFETIME_AUTH']) if ENV['VM_LIFETIME_AUTH']
  parsed_config[:config]['max_tries']                          = string_to_int(ENV['MAX_TRIES']) if ENV['MAX_TRIES']
  parsed_config[:config]['retry_factor']                       = string_to_int(ENV['RETRY_FACTOR']) if ENV['RETRY_FACTOR']
  parsed_config[:config]['create_folders']                     = true?(ENV['CREATE_FOLDERS']) if ENV['CREATE_FOLDERS']
  parsed_config[:config]['experimental_features']              = ENV['EXPERIMENTAL_FEATURES'] if ENV['EXPERIMENTAL_FEATURES']
  parsed_config[:config]['usage_stats']                        = ENV['USAGE_STATS'] if ENV['USAGE_STATS']
  parsed_config[:config]['request_logger']                     = ENV['REQUEST_LOGGER'] if ENV['REQUEST_LOGGER']
  parsed_config[:config]['create_template_delta_disks']        = ENV['CREATE_TEMPLATE_DELTA_DISKS'] if ENV['CREATE_TEMPLATE_DELTA_DISKS']
  parsed_config[:config]['purge_unconfigured_resources']       = ENV['PURGE_UNCONFIGURED_RESOURCES'] if ENV['PURGE_UNCONFIGURED_RESOURCES']
  parsed_config[:config]['purge_unconfigured_resources']       = ENV['PURGE_UNCONFIGURED_FOLDERS'] if ENV['PURGE_UNCONFIGURED_FOLDERS']
  # ENV PURGE_UNCONFIGURED_FOLDERS deprecated, will be removed in version 3
  puts '[!] [deprecation] rename ENV var \'PURGE_UNCONFIGURED_FOLDERS\' to \'PURGE_UNCONFIGURED_RESOURCES\'' if ENV['PURGE_UNCONFIGURED_FOLDERS']
  set_linked_clone(parsed_config)

  parsed_config[:redis]                            = parsed_config[:redis] || {}
  parsed_config[:redis]['server']                  = ENV['REDIS_SERVER'] || parsed_config[:redis]['server'] || 'localhost'
  parsed_config[:redis]['port']                    = string_to_int(ENV['REDIS_PORT']) if ENV['REDIS_PORT']
  parsed_config[:redis]['password']                = ENV['REDIS_PASSWORD'] if ENV['REDIS_PASSWORD']
  parsed_config[:redis]['data_ttl']                = string_to_int(ENV['REDIS_DATA_TTL']) || parsed_config[:redis]['data_ttl'] || 168
  parsed_config[:redis]['connection_pool_size']    = string_to_int(ENV['REDIS_CONNECTION_POOL_SIZE']) || parsed_config[:redis]['connection_pool_size'] || 10
  parsed_config[:redis]['connection_pool_timeout'] = string_to_int(ENV['REDIS_CONNECTION_POOL_TIMEOUT']) || parsed_config[:redis]['connection_pool_timeout'] || 5
  parsed_config[:redis]['reconnect_attempts']      = string_to_int(ENV['REDIS_RECONNECT_ATTEMPTS']) || parsed_config[:redis]['reconnect_attempts'] || 10

  parsed_config[:statsd]           = parsed_config[:statsd] || {} if ENV['STATSD_SERVER']
  parsed_config[:statsd]['server'] = ENV['STATSD_SERVER'] if ENV['STATSD_SERVER']
  parsed_config[:statsd]['prefix'] = ENV['STATSD_PREFIX'] if ENV['STATSD_PREFIX']
  parsed_config[:statsd]['port']   = string_to_int(ENV['STATSD_PORT']) if ENV['STATSD_PORT']

  parsed_config[:graphite]           = parsed_config[:graphite] || {} if ENV['GRAPHITE_SERVER']
  parsed_config[:graphite]['server'] = ENV['GRAPHITE_SERVER'] if ENV['GRAPHITE_SERVER']
  parsed_config[:graphite]['prefix'] = ENV['GRAPHITE_PREFIX'] if ENV['GRAPHITE_PREFIX']
  parsed_config[:graphite]['port']   = string_to_int(ENV['GRAPHITE_PORT']) if ENV['GRAPHITE_PORT']

  parsed_config[:tracing]                = parsed_config[:tracing] || {}
  parsed_config[:tracing]['enabled']     = ENV['VMPOOLER_TRACING_ENABLED'] || parsed_config[:tracing]['enabled'] || 'false'
  parsed_config[:tracing]['jaeger_host'] = ENV['VMPOOLER_TRACING_JAEGER_HOST'] || parsed_config[:tracing]['jaeger_host'] || 'http://localhost:14268/api/traces'

  parsed_config[:auth] = parsed_config[:auth] || {} if ENV['AUTH_PROVIDER']
  if parsed_config.key? :auth
    parsed_config[:auth]['provider']           = ENV['AUTH_PROVIDER'] if ENV['AUTH_PROVIDER']
    parsed_config[:auth][:ldap]                = parsed_config[:auth][:ldap] || {} if parsed_config[:auth]['provider'] == 'ldap'
    parsed_config[:auth][:ldap]['host']        = ENV['LDAP_HOST'] if ENV['LDAP_HOST']
    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
  parsed_config[:pool_names] = Set.new
  unless parsed_config[:pools]
    puts 'loading pools configuration from redis, since the config[:pools] is empty'
    redis = new_redis(parsed_config[:redis]['server'], parsed_config[:redis]['port'], parsed_config[:redis]['password'])
    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']
    pool['ready_ttl'] ||= parsed_config[:config]['ready_ttl']
    if pool['alias']
      if pool['alias'].instance_of?(Array)
        pool['alias'].each do |pool_alias|
          parsed_config[:alias] ||= {}
          parsed_config[:alias][pool_alias] = [pool['name']] unless parsed_config[:alias].key? pool_alias
          parsed_config[:alias][pool_alias] << pool['name'] unless parsed_config[:alias][pool_alias].include? pool['name']
          parsed_config[:pool_names] << pool_alias
        end
      elsif pool['alias'].instance_of?(String)
        parsed_config[:alias][pool['alias']] = pool['name']
        parsed_config[:pool_names] << pool['alias']
      end
    end
  end

  parsed_config[:tagfilter]&.keys&.each do |tag|
    parsed_config[:tagfilter][tag] = Regexp.new(parsed_config[:tagfilter][tag])
  end

  parsed_config[:uptime] = Time.now

  parsed_config
end

.configure_tracing(startup_args, prefix, tracing_enabled, tracing_jaeger_host, version) ⇒ Object 



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/vmpooler.rb', line 245

def self.configure_tracing(startup_args, prefix, tracing_enabled, tracing_jaeger_host, version)
  if startup_args.length == 1 && startup_args.include?('api')
    service_name = 'vmpooler-api'
  elsif startup_args.length == 1 && startup_args.include?('manager')
    service_name = 'vmpooler-manager'
  else
    service_name = 'vmpooler'
  end

  service_name += "-#{prefix}" unless prefix.empty?

  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(
      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(
      OpenTelemetry::Exporter::Jaeger::CollectorExporter.new(endpoint: tracing_jaeger_host)
    )
  end

  OpenTelemetry::SDK.configure do |c|
    c.use 'OpenTelemetry::Instrumentation::Sinatra'
    c.use 'OpenTelemetry::Instrumentation::ConcurrentRuby'
    c.use 'OpenTelemetry::Instrumentation::HttpClient'
    c.use 'OpenTelemetry::Instrumentation::Redis'

    c.add_span_processor(span_processor)

    c.service_name = service_name
    c.service_version = version

    c.resource = OpenTelemetry::Resource::Detectors::AutoDetector.detect
  end
end

.load_pools_from_redis(redis) ⇒ Object 



181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/vmpooler.rb', line 181

def self.load_pools_from_redis(redis)
  pools = []
  redis.smembers('vmpooler__pools').each do |pool|
    pool_hash = {}
    redis.hgetall("vmpooler__pool__#{pool}").each do |k, v|
      pool_hash[k] = v
    end
    pool_hash['alias'] = pool_hash['alias'].split(',')
    pools << pool_hash
  end
  pools
end

.new_redis(host = 'localhost', port = nil, password = nil, redis_reconnect_attempts = 10) ⇒ Object 



208
209
210
211
 
# File 'lib/vmpooler.rb', line 208

def self.new_redis(host = 'localhost', port = nil, password = nil, redis_reconnect_attempts = 10)
  Redis.new(host: host, port: port, password: password, reconnect_attempts: redis_reconnect_attempts, reconnect_delay: 1.5,
            reconnect_delay_max: 10.0)
end

.pool_index(pools) ⇒ Object 



217
218
219
220
221
222
223
224
225
 
# File 'lib/vmpooler.rb', line 217

def self.pool_index(pools)
  pools_hash = {}
  index = 0
  pools.each do |pool|
    pools_hash[pool['name']] = index
    index += 1
  end
  pools_hash
end

.pools(conf) ⇒ Object 



213
214
215
 
# File 'lib/vmpooler.rb', line 213

def self.pools(conf)
  conf[:pools]
end

.redis_connection_pool(host, port, password, size, timeout, metrics, redis_reconnect_attempts = 0) ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/vmpooler.rb', line 194

def self.redis_connection_pool(host, port, password, size, timeout, metrics, redis_reconnect_attempts = 0)
  Vmpooler::PoolManager::GenericConnectionPool.new(
    metrics: metrics,
    connpool_type: 'redis_connection_pool',
    connpool_provider: 'manager',
    size: size,
    timeout: timeout
  ) do
    connection = Concurrent::Hash.new
    redis = new_redis(host, port, password, redis_reconnect_attempts)
    connection['connection'] = redis
  end
end

.set_linked_clone(parsed_config) ⇒ Object

rubocop:disable Naming/AccessorMethodName



239
240
241
242
243
 
# File 'lib/vmpooler.rb', line 239

def self.set_linked_clone(parsed_config) # rubocop:disable Naming/AccessorMethodName
  parsed_config[:config]['create_linked_clones'] = parsed_config[:config]['create_linked_clones'] || true
  parsed_config[:config]['create_linked_clones'] = ENV['CREATE_LINKED_CLONES'] if ENV['CREATE_LINKED_CLONES'] =~ /true|false/
  parsed_config[:config]['create_linked_clones'] = true?(parsed_config[:config]['create_linked_clones']) if parsed_config[:config]['create_linked_clones']
end

.string_to_int(s) ⇒ Object 



227
228
229
230
231
232
233
 
# File 'lib/vmpooler.rb', line 227

def self.string_to_int(s)
  # Returns a integer if input is a string
  return if s.nil?
  return unless s =~ /\d/

  Integer(s)
end

.true?(obj) ⇒ Boolean

Returns:

  • (Boolean) 


235
236
237
 
# File 'lib/vmpooler.rb', line 235

def self.true?(obj)
  obj.to_s.downcase == 'true'
end