Class: Vmpooler::PoolManager

Inherits:
Object
  • Object
show all
Defined in:
lib/vmpooler/pool_manager.rb,
lib/vmpooler/providers/base.rb,
lib/vmpooler/providers/dummy.rb,
lib/vmpooler/providers/vsphere.rb,
lib/vmpooler/generic_connection_pool.rb

Defined Under Namespace

Classes: GenericConnectionPool, Provider

Constant Summary collapse

CHECK_LOOP_DELAY_MIN_DEFAULT = 
5
CHECK_LOOP_DELAY_MAX_DEFAULT = 
60
CHECK_LOOP_DELAY_DECAY_DEFAULT = 
2.0

Instance Method Summary collapse

Constructor Details

#initialize(config, logger, redis, metrics) ⇒ PoolManager

Returns a new instance of PoolManager.



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/vmpooler/pool_manager.rb', line 12

def initialize(config, logger, redis, metrics)
  $config = config

  # Load logger library
  $logger = logger

  # metrics logging handle
  $metrics = metrics

  # Connect to Redis
  $redis = redis

  # VM Provider objects
  $providers = {}

  # Our thread-tracker object
  $threads = {}

  # Pool mutex
  @reconfigure_pool = {}

  @vm_mutex = {}

  # Name generator for generating host names
  @name_generator = Spicy::Proton.new

  # load specified providers from config file
  load_used_providers
end

Instance Method Details

#_check_disk_queue ⇒ Object 



630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'lib/vmpooler/pool_manager.rb', line 630

def _check_disk_queue
  task_detail = $redis.spop('vmpooler__tasks__disk')
  unless task_detail.nil?
    begin
      vm_name, disk_size = task_detail.split(':')
      pool_name = get_pool_name_for_vm(vm_name)
      raise("Unable to determine which pool #{vm_name} is a member of") if pool_name.nil?

      provider = get_provider_for_pool(pool_name)
      raise("Missing Provider for vm #{vm_name} in pool #{pool_name}") if provider.nil?

      create_vm_disk(pool_name, vm_name, disk_size, provider)
    rescue StandardError => e
      $logger.log('s', "[!] [disk_manager] disk creation appears to have failed: #{e}")
    end
  end
end

#_check_pending_vm(vm, pool, timeout, provider) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/vmpooler/pool_manager.rb', line 84

def _check_pending_vm(vm, pool, timeout, provider)
  mutex = vm_mutex(vm)
  return if mutex.locked?

  mutex.synchronize do
    if provider.vm_ready?(pool, vm)
      move_pending_vm_to_ready(vm, pool)
    else
      fail_pending_vm(vm, pool, timeout)
    end
  end
end

#_check_pool(pool, provider) ⇒ Object 



1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
 
# File 'lib/vmpooler/pool_manager.rb', line 1144

def _check_pool(pool, provider)
  pool_check_response = {
    discovered_vms: 0,
    checked_running_vms: 0,
    checked_ready_vms: 0,
    checked_pending_vms: 0,
    destroyed_vms: 0,
    migrated_vms: 0,
    cloned_vms: 0
  }

  begin
    inventory = create_inventory(pool, provider, pool_check_response)
  rescue StandardError
    return(pool_check_response)
  end

  check_running_pool_vms(pool['name'], provider, pool_check_response, inventory)

  check_ready_pool_vms(pool['name'], provider, pool_check_response, inventory, pool['ready_ttl'])

  check_pending_pool_vms(pool['name'], provider, pool_check_response, inventory, pool['timeout'])

  check_completed_pool_vms(pool['name'], provider, pool_check_response, inventory)

  check_discovered_pool_vms(pool['name'])

  check_migrating_pool_vms(pool['name'], provider, pool_check_response, inventory)

  # UPDATE TEMPLATE
  # Evaluates a pool template to ensure templates are prepared adequately for the configured provider
  # If a pool template configuration change is detected then template preparation is repeated for the new template
  # Additionally, a pool will drain ready and pending instances
  evaluate_template(pool, provider)

  # Check to see if a pool size change has been made via the configuration API
  # Since check_pool runs in a loop it does not
  # otherwise identify this change when running
  update_pool_size(pool)

  # Check to see if a pool size change has been made via the configuration API
  # Additionally, a pool will drain ready and pending instances
  update_clone_target(pool)

  repopulate_pool_vms(pool['name'], provider, pool_check_response, pool['size'])

  # Remove VMs in excess of the configured pool size
  remove_excess_vms(pool)

  # Reset a pool when poolreset is requested from the API
  reset_pool(pool)

  pool_check_response
end

#_check_ready_vm(vm, pool_name, ttl, provider) ⇒ Object 



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/vmpooler/pool_manager.rb', line 157

def _check_ready_vm(vm, pool_name, ttl, provider)
  # Periodically check that the VM is available
  mutex = vm_mutex(vm)
  return if mutex.locked?

  mutex.synchronize do
    check_stamp = $redis.hget('vmpooler__vm__' + vm, 'check')
    return if check_stamp && (((Time.now - Time.parse(check_stamp)) / 60) <= $config[:config]['vm_checktime'])

    $redis.hset('vmpooler__vm__' + vm, 'check', Time.now)
    # Check if the hosts TTL has expired
    if ttl > 0
      # if 'boottime' is nil, set bootime to beginning of unix epoch, forces TTL to be assumed expired
      boottime = $redis.hget("vmpooler__vm__#{vm}", 'ready')
      if boottime
        boottime = Time.parse(boottime)
      else
        boottime = Time.at(0)
      end
      if ((Time.now - boottime) / 60).to_s[/^\d+\.\d{1}/].to_f > ttl
        $redis.smove('vmpooler__ready__' + pool_name, 'vmpooler__completed__' + pool_name, vm)

        $logger.log('d', "[!] [#{pool_name}] '#{vm}' reached end of TTL after #{ttl} minutes, removed from 'ready' queue")
        return
      end
    end

    return if mismatched_hostname?(vm, pool_name, provider)

    vm_still_ready?(pool_name, vm, provider)
  end
end

#_check_running_vm(vm, pool, ttl, provider) ⇒ Object 



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/vmpooler/pool_manager.rb', line 232

def _check_running_vm(vm, pool, ttl, provider)
  mutex = vm_mutex(vm)
  return if mutex.locked?

  mutex.synchronize do
    # Check that VM is within defined lifetime
    checkouttime = $redis.hget('vmpooler__active__' + pool, vm)
    if checkouttime
      running = (Time.now - Time.parse(checkouttime)) / 60 / 60

      if (ttl.to_i > 0) && (running.to_i >= ttl.to_i)
        move_vm_queue(pool, vm, 'running', 'completed', "reached end of TTL after #{ttl} hours")
        return
      end
    end

    if provider.vm_ready?(pool, vm)
      return
    else
      host = provider.get_vm(pool, vm)

      if host
        return
      else
        move_vm_queue(pool, vm, 'running', 'completed', 'is no longer in inventory, removing from running')
      end
    end
  end
end

#_check_snapshot_queue ⇒ Object 



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
 
# File 'lib/vmpooler/pool_manager.rb', line 666

def _check_snapshot_queue
  task_detail = $redis.spop('vmpooler__tasks__snapshot')

  unless task_detail.nil?
    begin
      vm_name, snapshot_name = task_detail.split(':')
      pool_name = get_pool_name_for_vm(vm_name)
      raise("Unable to determine which pool #{vm_name} is a member of") if pool_name.nil?

      provider = get_provider_for_pool(pool_name)
      raise("Missing Provider for vm #{vm_name} in pool #{pool_name}") if provider.nil?

      create_vm_snapshot(pool_name, vm_name, snapshot_name, provider)
    rescue StandardError => e
      $logger.log('s', "[!] [snapshot_manager] snapshot create appears to have failed: #{e}")
    end
  end

  task_detail = $redis.spop('vmpooler__tasks__snapshot-revert')

  unless task_detail.nil?
    begin
      vm_name, snapshot_name = task_detail.split(':')
      pool_name = get_pool_name_for_vm(vm_name)
      raise("Unable to determine which pool #{vm_name} is a member of") if pool_name.nil?

      provider = get_provider_for_pool(pool_name)
      raise("Missing Provider for vm #{vm_name} in pool #{pool_name}") if provider.nil?

      revert_vm_snapshot(pool_name, vm_name, snapshot_name, provider)
    rescue StandardError => e
      $logger.log('s', "[!] [snapshot_manager] snapshot revert appears to have failed: #{e}")
    end
  end
end

#_clone_vm(pool_name, provider) ⇒ Object 



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/vmpooler/pool_manager.rb', line 314

def _clone_vm(pool_name, provider)
  new_vmname = find_unique_hostname(pool_name)

  # Add VM to Redis inventory ('pending' pool)
  $redis.sadd('vmpooler__pending__' + pool_name, new_vmname)
  $redis.hset('vmpooler__vm__' + new_vmname, 'clone', Time.now)
  $redis.hset('vmpooler__vm__' + new_vmname, 'template', pool_name)

  begin
    $logger.log('d', "[ ] [#{pool_name}] Starting to clone '#{new_vmname}'")
    start = Time.now
    provider.create_vm(pool_name, new_vmname)
    finish = format('%<time>.2f', time: Time.now - start)

    $redis.hset('vmpooler__clone__' + Date.today.to_s, pool_name + ':' + new_vmname, finish)
    $redis.hset('vmpooler__vm__' + new_vmname, 'clone_time', finish)
    $logger.log('s', "[+] [#{pool_name}] '#{new_vmname}' cloned in #{finish} seconds")

    $metrics.timing("clone.#{pool_name}", finish)
  rescue StandardError
    $redis.srem("vmpooler__pending__#{pool_name}", new_vmname)
    expiration_ttl = $config[:redis]['data_ttl'].to_i * 60 * 60
    $redis.expire("vmpooler__vm__#{new_vmname}", expiration_ttl)
    raise
  ensure
    $redis.decr('vmpooler__tasks__clone')
  end
end

#_create_vm_disk(pool_name, vm_name, disk_size, provider) ⇒ Object 



496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/vmpooler/pool_manager.rb', line 496

def _create_vm_disk(pool_name, vm_name, disk_size, provider)
  raise("Invalid disk size of '#{disk_size}' passed") if disk_size.nil? || disk_size.empty? || disk_size.to_i <= 0

  $logger.log('s', "[ ] [disk_manager] '#{vm_name}' is attaching a #{disk_size}gb disk")

  start = Time.now

  result = provider.create_disk(pool_name, vm_name, disk_size.to_i)

  finish = format('%<time>.2f', time: Time.now - start)

  if result
    rdisks = $redis.hget('vmpooler__vm__' + vm_name, 'disk')
    disks = rdisks ? rdisks.split(':') : []
    disks.push("+#{disk_size}gb")
    $redis.hset('vmpooler__vm__' + vm_name, 'disk', disks.join(':'))

    $logger.log('s', "[+] [disk_manager] '#{vm_name}' attached #{disk_size}gb disk in #{finish} seconds")
  else
    $logger.log('s', "[+] [disk_manager] '#{vm_name}' failed to attach disk")
  end

  result
end

#_create_vm_snapshot(pool_name, vm_name, snapshot_name, provider) ⇒ Object 



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/vmpooler/pool_manager.rb', line 532

def _create_vm_snapshot(pool_name, vm_name, snapshot_name, provider)
  $logger.log('s', "[ ] [snapshot_manager] 'Attempting to snapshot #{vm_name} in pool #{pool_name}")
  start = Time.now

  result = provider.create_snapshot(pool_name, vm_name, snapshot_name)

  finish = format('%<time>.2f', time: Time.now - start)

  if result
    $redis.hset('vmpooler__vm__' + vm_name, 'snapshot:' + snapshot_name, Time.now.to_s)
    $logger.log('s', "[+] [snapshot_manager] '#{vm_name}' snapshot created in #{finish} seconds")
  else
    $logger.log('s', "[+] [snapshot_manager] Failed to snapshot '#{vm_name}'")
  end

  result
end

#_destroy_vm(vm, pool, provider) ⇒ Object 



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/vmpooler/pool_manager.rb', line 355

def _destroy_vm(vm, pool, provider)
  mutex = vm_mutex(vm)
  return if mutex.locked?

  mutex.synchronize do
    $redis.hdel('vmpooler__active__' + pool, vm)
    $redis.hset('vmpooler__vm__' + vm, 'destroy', Time.now)

    # Auto-expire metadata key
    $redis.expire('vmpooler__vm__' + vm, ($config[:redis]['data_ttl'].to_i * 60 * 60))

    start = Time.now

    provider.destroy_vm(pool, vm)

    $redis.srem('vmpooler__completed__' + pool, vm)

    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)
  end
  dereference_mutex(vm)
end

#_revert_vm_snapshot(pool_name, vm_name, snapshot_name, provider) ⇒ Object 



561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'lib/vmpooler/pool_manager.rb', line 561

def _revert_vm_snapshot(pool_name, vm_name, snapshot_name, provider)
  $logger.log('s', "[ ] [snapshot_manager] 'Attempting to revert #{vm_name}' in pool #{pool_name} to snapshot '#{snapshot_name}'")
  start = Time.now

  result = provider.revert_snapshot(pool_name, vm_name, snapshot_name)

  finish = format('%<time>.2f', time: Time.now - start)

  if result
    $logger.log('s', "[+] [snapshot_manager] '#{vm_name}' reverted to snapshot '#{snapshot_name}' in #{finish} seconds")
  else
    $logger.log('s', "[+] [snapshot_manager] Failed to revert #{vm_name}' in pool #{pool_name} to snapshot '#{snapshot_name}'")
  end

  result
end

#check_completed_pool_vms(pool_name, provider, pool_check_response, inventory) ⇒ Object 



1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
 
# File 'lib/vmpooler/pool_manager.rb', line 1064

def check_completed_pool_vms(pool_name, provider, pool_check_response, inventory)
  $redis.smembers("vmpooler__completed__#{pool_name}").each do |vm|
    if inventory[vm]
      begin
        pool_check_response[:destroyed_vms] += 1
        destroy_vm(vm, pool_name, provider)
      rescue StandardError => e
        $redis.srem("vmpooler__completed__#{pool_name}", vm)
        $redis.hdel("vmpooler__active__#{pool_name}", vm)
        $redis.del("vmpooler__vm__#{vm}")
        $logger.log('d', "[!] [#{pool_name}] _check_pool failed with an error while evaluating completed VMs: #{e}")
      end
    else
      $logger.log('s', "[!] [#{pool_name}] '#{vm}' not found in inventory, removed from 'completed' queue")
      $redis.srem("vmpooler__completed__#{pool_name}", vm)
      $redis.hdel("vmpooler__active__#{pool_name}", vm)
      $redis.del("vmpooler__vm__#{vm}")
    end
  end
end

#check_discovered_pool_vms(pool_name) ⇒ Object 



1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
 
# File 'lib/vmpooler/pool_manager.rb', line 1085

def check_discovered_pool_vms(pool_name)
  $redis.smembers("vmpooler__discovered__#{pool_name}").reverse.each do |vm|
    %w[pending ready running completed].each do |queue|
      if $redis.sismember("vmpooler__#{queue}__#{pool_name}", vm)
        $logger.log('d', "[!] [#{pool_name}] '#{vm}' found in '#{queue}', removed from 'discovered' queue")
        $redis.srem("vmpooler__discovered__#{pool_name}", vm)
      end
    end

    $redis.smove("vmpooler__discovered__#{pool_name}", "vmpooler__completed__#{pool_name}", vm) if $redis.sismember("vmpooler__discovered__#{pool_name}", vm)
  end
rescue StandardError => e
  $logger.log('d', "[!] [#{pool_name}] _check_pool failed with an error while evaluating discovered VMs: #{e}")
end

#check_disk_queue(maxloop = 0, loop_delay = 5) ⇒ Object 



612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
 
# File 'lib/vmpooler/pool_manager.rb', line 612

def check_disk_queue(maxloop = 0, loop_delay = 5)
  $logger.log('d', '[*] [disk_manager] starting worker thread')

  $threads['disk_manager'] = Thread.new do
    loop_count = 1
    loop do
      _check_disk_queue
      sleep(loop_delay)

      unless maxloop == 0
        break if loop_count >= maxloop

        loop_count += 1
      end
    end
  end
end

#check_migrating_pool_vms(pool_name, provider, pool_check_response, inventory) ⇒ Object 



1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
 
# File 'lib/vmpooler/pool_manager.rb', line 1100

def check_migrating_pool_vms(pool_name, provider, pool_check_response, inventory)
  $redis.smembers("vmpooler__migrating__#{pool_name}").reverse.each do |vm|
    if inventory[vm]
      begin
        pool_check_response[:migrated_vms] += 1
        migrate_vm(vm, pool_name, provider)
      rescue StandardError => e
        $logger.log('s', "[x] [#{pool_name}] '#{vm}' failed to migrate: #{e}")
      end
    end
  end
end

#check_pending_pool_vms(pool_name, provider, pool_check_response, inventory, pool_timeout = nil) ⇒ Object 



1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
 
# File 'lib/vmpooler/pool_manager.rb', line 1048

def check_pending_pool_vms(pool_name, provider, pool_check_response, inventory, pool_timeout = nil)
  pool_timeout ||= $config[:config]['timeout'] || 15
  $redis.smembers("vmpooler__pending__#{pool_name}").reverse.each do |vm|
    if inventory[vm]
      begin
        pool_check_response[:checked_pending_vms] += 1
        check_pending_vm(vm, pool_name, pool_timeout, provider)
      rescue StandardError => e
        $logger.log('d', "[!] [#{pool_name}] _check_pool failed with an error while evaluating pending VMs: #{e}")
      end
    else
      fail_pending_vm(vm, pool_name, pool_timeout, false)
    end
  end
end

#check_pending_vm(vm, pool, timeout, provider) ⇒ Object

Check the state of a VM



72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/vmpooler/pool_manager.rb', line 72

def check_pending_vm(vm, pool, timeout, provider)
  Thread.new do
    begin
      _check_pending_vm(vm, pool, timeout, provider)
    rescue StandardError => e
      $logger.log('s', "[!] [#{pool}] '#{vm}' #{timeout} #{provider} errored while checking a pending vm : #{e}")
      fail_pending_vm(vm, pool, timeout)
      raise
    end
  end
end

#check_pool(pool, maxloop = 0, loop_delay_min = CHECK_LOOP_DELAY_MIN_DEFAULT, loop_delay_max = CHECK_LOOP_DELAY_MAX_DEFAULT, loop_delay_decay = CHECK_LOOP_DELAY_DECAY_DEFAULT) ⇒ Object 



784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/vmpooler/pool_manager.rb', line 784

def check_pool(pool,
               maxloop = 0,
               loop_delay_min = CHECK_LOOP_DELAY_MIN_DEFAULT,
               loop_delay_max = CHECK_LOOP_DELAY_MAX_DEFAULT,
               loop_delay_decay = CHECK_LOOP_DELAY_DECAY_DEFAULT)
  $logger.log('d', "[*] [#{pool['name']}] starting worker thread")

  # Use the pool setings if they exist
  loop_delay_min = pool['check_loop_delay_min'] unless pool['check_loop_delay_min'].nil?
  loop_delay_max = pool['check_loop_delay_max'] unless pool['check_loop_delay_max'].nil?
  loop_delay_decay = pool['check_loop_delay_decay'] unless pool['check_loop_delay_decay'].nil?

  loop_delay_decay = 2.0 if loop_delay_decay <= 1.0
  loop_delay_max = loop_delay_min if loop_delay_max.nil? || loop_delay_max < loop_delay_min

  $threads[pool['name']] = Thread.new do
    begin
      loop_count = 1
      loop_delay = loop_delay_min
      provider = get_provider_for_pool(pool['name'])
      raise("Could not find provider '#{pool['provider']}") if provider.nil?

      sync_pool_template(pool)
      loop do
        result = _check_pool(pool, provider)

        if result[:cloned_vms] > 0 || result[:checked_pending_vms] > 0 || result[:discovered_vms] > 0
          loop_delay = loop_delay_min
        else
          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, pool_reset: true)

        unless maxloop == 0
          break if loop_count >= maxloop

          loop_count += 1
        end
      end
    rescue Redis::CannotConnectError
      raise
    rescue StandardError => e
      $logger.log('s', "[!] [#{pool['name']}] Error while checking the pool: #{e}")
      raise
    end
  end
end

#check_ready_pool_vms(pool_name, provider, pool_check_response, inventory, pool_ttl = 0) ⇒ Object 



1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'lib/vmpooler/pool_manager.rb', line 1033

def check_ready_pool_vms(pool_name, provider, pool_check_response, inventory, pool_ttl = 0)
  $redis.smembers("vmpooler__ready__#{pool_name}").each do |vm|
    if inventory[vm]
      begin
        pool_check_response[:checked_ready_vms] += 1
        check_ready_vm(vm, pool_name, pool_ttl || 0, provider)
      rescue StandardError => e
        $logger.log('d', "[!] [#{pool_name}] _check_pool failed with an error while evaluating ready VMs: #{e}")
      end
    else
      move_vm_queue(pool_name, vm, 'ready', 'completed', 'is a ready VM but is missing from inventory.  Marking as completed.')
    end
  end
end

#check_ready_vm(vm, pool_name, ttl, provider) ⇒ Object 



146
147
148
149
150
151
152
153
154
155
 
# File 'lib/vmpooler/pool_manager.rb', line 146

def check_ready_vm(vm, pool_name, ttl, provider)
  Thread.new do
    begin
      _check_ready_vm(vm, pool_name, ttl, provider)
    rescue StandardError => e
      $logger.log('s', "[!] [#{pool_name}] '#{vm}' failed while checking a ready vm : #{e}")
      raise
    end
  end
end

#check_running_pool_vms(pool_name, provider, pool_check_response, inventory) ⇒ Object 



1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
 
# File 'lib/vmpooler/pool_manager.rb', line 1017

def check_running_pool_vms(pool_name, provider, pool_check_response, inventory)
  $redis.smembers("vmpooler__running__#{pool_name}").each do |vm|
    if inventory[vm]
      begin
        vm_lifetime = $redis.hget('vmpooler__vm__' + vm, 'lifetime') || $config[:config]['vm_lifetime'] || 12
        pool_check_response[:checked_running_vms] += 1
        check_running_vm(vm, pool_name, vm_lifetime, provider)
      rescue StandardError => e
        $logger.log('d', "[!] [#{pool_name}] _check_pool with an error while evaluating running VMs: #{e}")
      end
    else
      move_vm_queue(pool_name, vm, 'running', 'completed', 'is a running VM but is missing from inventory.  Marking as completed.')
    end
  end
end

#check_running_vm(vm, pool, ttl, provider) ⇒ Object 



221
222
223
224
225
226
227
228
229
230
 
# File 'lib/vmpooler/pool_manager.rb', line 221

def check_running_vm(vm, pool, ttl, provider)
  Thread.new do
    begin
      _check_running_vm(vm, pool, ttl, provider)
    rescue StandardError => e
      $logger.log('s', "[!] [#{pool}] '#{vm}' failed while checking VM with an error: #{e}")
      raise
    end
  end
end

#check_snapshot_queue(maxloop = 0, loop_delay = 5) ⇒ Object 



648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'lib/vmpooler/pool_manager.rb', line 648

def check_snapshot_queue(maxloop = 0, loop_delay = 5)
  $logger.log('d', '[*] [snapshot_manager] starting worker thread')

  $threads['snapshot_manager'] = Thread.new do
    loop_count = 1
    loop do
      _check_snapshot_queue
      sleep(loop_delay)

      unless maxloop == 0
        break if loop_count >= maxloop

        loop_count += 1
      end
    end
  end
end

#clone_vm(pool_name, provider) ⇒ Object

Clone a VM



268
269
270
271
272
273
274
275
276
277
 
# File 'lib/vmpooler/pool_manager.rb', line 268

def clone_vm(pool_name, provider)
  Thread.new do
    begin
      _clone_vm(pool_name, provider)
    rescue StandardError => e
      $logger.log('s', "[!] [#{pool_name}] failed while cloning VM with an error: #{e}")
      raise
    end
  end
end

#component_to_test(match, labels_string) ⇒ Object 



426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/vmpooler/pool_manager.rb', line 426

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
  nil
end

#config ⇒ Object 



42
43
44
 
# File 'lib/vmpooler/pool_manager.rb', line 42

def config
  $config
end

#create_inventory(pool, provider, pool_check_response) ⇒ Object 



988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'lib/vmpooler/pool_manager.rb', line 988

def create_inventory(pool, provider, pool_check_response)
  inventory = {}
  begin
    mutex = pool_mutex(pool['name'])
    mutex.synchronize do
      provider.vms_in_pool(pool['name']).each do |vm|
        if !$redis.sismember('vmpooler__running__' + pool['name'], vm['name']) &&
           !$redis.sismember('vmpooler__ready__' + pool['name'], vm['name']) &&
           !$redis.sismember('vmpooler__pending__' + pool['name'], vm['name']) &&
           !$redis.sismember('vmpooler__completed__' + pool['name'], vm['name']) &&
           !$redis.sismember('vmpooler__discovered__' + pool['name'], vm['name']) &&
           !$redis.sismember('vmpooler__migrating__' + pool['name'], vm['name'])

          pool_check_response[:discovered_vms] += 1
          $redis.sadd('vmpooler__discovered__' + pool['name'], vm['name'])

          $logger.log('s', "[?] [#{pool['name']}] '#{vm['name']}' added to 'discovered' queue")
        end

        inventory[vm['name']] = 1
      end
    end
  rescue StandardError => e
    $logger.log('s', "[!] [#{pool['name']}] _check_pool failed with an error while running create_inventory: #{e}")
    raise(e)
  end
  inventory
end

#create_provider_object(config, logger, metrics, provider_class, provider_name, options) ⇒ Object

Create a provider object, usually based on the providers/*.rb class, that implements providers/base.rb provider_class: Needs to match a class in the Vmpooler::PoolManager::Provider namespace. This is

either as a gem in the LOADPATH or in providers/*.rb ie Vmpooler::PoolManager::Provider::X

provider_name: Should be a unique provider name

returns an object Vmpooler::PoolManager::Provider::* or raises an error if the class does not exist



1206
1207
1208
1209
1210
1211
1212
1213
1214
 
# File 'lib/vmpooler/pool_manager.rb', line 1206

def create_provider_object(config, logger, metrics, provider_class, provider_name, options)
  provider_klass = Vmpooler::PoolManager::Provider
  provider_klass.constants.each do |classname|
    next unless classname.to_s.casecmp(provider_class) == 0

    return provider_klass.const_get(classname).new(config, logger, metrics, provider_name, options)
  end
  raise("Provider '#{provider_class}' is unknown for pool with provider name '#{provider_name}'") if provider.nil?
end

#create_vm_disk(pool_name, vm, disk_size, provider) ⇒ Object 



485
486
487
488
489
490
491
492
493
494
 
# File 'lib/vmpooler/pool_manager.rb', line 485

def create_vm_disk(pool_name, vm, disk_size, provider)
  Thread.new do
    begin
      _create_vm_disk(pool_name, vm, disk_size, provider)
    rescue StandardError => e
      $logger.log('d', "[!] [#{pool_name}] '#{vm}' failed while creating disk: #{e}")
      raise
    end
  end
end

#create_vm_snapshot(pool_name, vm, snapshot_name, provider) ⇒ Object 



521
522
523
524
525
526
527
528
529
530
 
# File 'lib/vmpooler/pool_manager.rb', line 521

def create_vm_snapshot(pool_name, vm, snapshot_name, provider)
  Thread.new do
    begin
      _create_vm_snapshot(pool_name, vm, snapshot_name, provider)
    rescue StandardError => e
      $logger.log('d', "[!] [#{pool_name}] '#{vm}' failed while creating snapshot: #{e}")
      raise
    end
  end
end

#default_providers ⇒ Array

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

Returns:

  • (Array) —

    • returns a list of providers that should always be loaded



593
594
595
 
# File 'lib/vmpooler/pool_manager.rb', line 593

def default_providers
  @default_providers ||= %w[vsphere dummy]
end

#dereference_mutex(vmname) ⇒ Object 



841
842
843
 
# File 'lib/vmpooler/pool_manager.rb', line 841

def dereference_mutex(vmname)
  true if @vm_mutex.delete(vmname)
end

#destroy_vm(vm, pool, provider) ⇒ Object

Destroy a VM



344
345
346
347
348
349
350
351
352
353
 
# File 'lib/vmpooler/pool_manager.rb', line 344

def destroy_vm(vm, pool, provider)
  Thread.new do
    begin
      _destroy_vm(vm, pool, provider)
    rescue StandardError => e
      $logger.log('d', "[!] [#{pool}] '#{vm}' failed while destroying the VM with an error: #{e}")
      raise
    end
  end
end

#drain_pool(poolname) ⇒ Object 



893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
 
# File 'lib/vmpooler/pool_manager.rb', line 893

def drain_pool(poolname)
  # Clear a pool of ready and pending instances
  if $redis.scard("vmpooler__ready__#{poolname}") > 0
    $logger.log('s', "[*] [#{poolname}] removing ready instances")
    $redis.smembers("vmpooler__ready__#{poolname}").each do |vm|
      move_vm_queue(poolname, vm, 'ready', 'completed')
    end
  end
  if $redis.scard("vmpooler__pending__#{poolname}") > 0
    $logger.log('s', "[*] [#{poolname}] removing pending instances")
    $redis.smembers("vmpooler__pending__#{poolname}").each do |vm|
      move_vm_queue(poolname, vm, 'pending', 'completed')
    end
  end
end

#evaluate_template(pool, provider) ⇒ Object 



866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/vmpooler/pool_manager.rb', line 866

def evaluate_template(pool, provider)
  mutex = pool_mutex(pool['name'])
  prepared_template = $redis.hget('vmpooler__template__prepared', pool['name'])
  configured_template = $redis.hget('vmpooler__config__template', pool['name'])
  return if mutex.locked?

  if prepared_template.nil?
    mutex.synchronize do
      prepare_template(pool, provider)
      prepared_template = $redis.hget('vmpooler__template__prepared', pool['name'])
    end
  elsif prepared_template != pool['template']
    if configured_template.nil?
      mutex.synchronize do
        prepare_template(pool, provider)
        prepared_template = $redis.hget('vmpooler__template__prepared', pool['name'])
      end
    end
  end
  return if configured_template.nil?
  return if configured_template == prepared_template

  mutex.synchronize do
    update_pool_template(pool, provider, configured_template, prepared_template)
  end
end

#execute!(maxloop = 0, loop_delay = 1) ⇒ Object 



1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'lib/vmpooler/pool_manager.rb', line 1216

def execute!(maxloop = 0, loop_delay = 1)
  $logger.log('d', 'starting vmpooler')

  # Clear out the tasks manager, as we don't know about any tasks at this point
  $redis.set('vmpooler__tasks__clone', 0)
  # Clear out vmpooler__migrations since stale entries may be left after a restart
  $redis.del('vmpooler__migration')

  # Copy vSphere settings to correct location.  This happens with older configuration files
  if !$config[:vsphere].nil? && ($config[:providers].nil? || $config[:providers][:vsphere].nil?)
    $logger.log('d', "[!] Detected an older configuration file. Copying the settings from ':vsphere:' to ':providers:/:vsphere:'")
    $config[:providers] = {} if $config[:providers].nil?
    $config[:providers][:vsphere] = $config[:vsphere]
  end

  # 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'
    end
  end

  # Load running pool configuration into redis so API server can retrieve it
  load_pools_to_redis

  # Get pool loop settings
  $config[:config] = {} if $config[:config].nil?
  check_loop_delay_min = $config[:config]['check_loop_delay_min'] || CHECK_LOOP_DELAY_MIN_DEFAULT
  check_loop_delay_max = $config[:config]['check_loop_delay_max'] || CHECK_LOOP_DELAY_MAX_DEFAULT
  check_loop_delay_decay = $config[:config]['check_loop_delay_decay'] || CHECK_LOOP_DELAY_DECAY_DEFAULT

  # Create the providers
  $config[:pools].each do |pool|
    provider_name = pool['provider']
    # The provider_class parameter can be defined in the provider's data eg
    #:providers:
    # :vsphere:
    #  provider_class: 'vsphere'
    # :another-vsphere:
    #  provider_class: 'vsphere'
    # the above would create two providers/vsphere.rb class objects named 'vsphere' and 'another-vsphere'
    # each pools would then define which provider definition to use: vsphere or another-vsphere
    #
    # if provider_class is not defined it will try to use the provider_name as the class, this is to be
    # backwards compatible for example when there is only one provider listed
    # :providers:
    #  :dummy:
    #   filename: 'db.txs'
    # the above example would create an object based on the class providers/dummy.rb
    if $config[:providers].nil? || $config[:providers][provider_name.to_sym].nil? || $config[:providers][provider_name.to_sym]['provider_class'].nil?
      provider_class = provider_name
    else
      provider_class = $config[:providers][provider_name.to_sym]['provider_class']
    end
    begin
      $providers[provider_name] = create_provider_object($config, $logger, $metrics, provider_class, provider_name, {}) if $providers[provider_name].nil?
    rescue StandardError => e
      $logger.log('s', "Error while creating provider for pool #{pool['name']}: #{e}")
      raise
    end
  end

  purge_unused_vms_and_folders

  loop_count = 1
  loop do
    if !$threads['disk_manager']
      check_disk_queue
    elsif !$threads['disk_manager'].alive?
      $logger.log('d', '[!] [disk_manager] worker thread died, restarting')
      check_disk_queue
    end

    if !$threads['snapshot_manager']
      check_snapshot_queue
    elsif !$threads['snapshot_manager'].alive?
      $logger.log('d', '[!] [snapshot_manager] worker thread died, restarting')
      check_snapshot_queue
    end

    $config[:pools].each do |pool|
      if !$threads[pool['name']]
        check_pool(pool)
      elsif !$threads[pool['name']].alive?
        $logger.log('d', "[!] [#{pool['name']}] worker thread died, restarting")
        check_pool(pool, check_loop_delay_min, check_loop_delay_max, check_loop_delay_decay)
      end
    end

    sleep(loop_delay)

    unless maxloop == 0
      break if loop_count >= maxloop

      loop_count += 1
    end
  end
rescue Redis::CannotConnectError => e
  $logger.log('s', "Cannot connect to the redis server: #{e}")
  raise
end

#fail_pending_vm(vm, pool, timeout, exists = true) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/vmpooler/pool_manager.rb', line 102

def fail_pending_vm(vm, pool, timeout, exists = true)
  clone_stamp = $redis.hget("vmpooler__vm__#{vm}", 'clone')
  return true unless clone_stamp

  time_since_clone = (Time.now - Time.parse(clone_stamp)) / 60
  if time_since_clone > timeout
    if exists
      $redis.smove('vmpooler__pending__' + pool, 'vmpooler__completed__' + pool, vm)
      $metrics.increment("errors.markedasfailed.#{pool}")
      $logger.log('d', "[!] [#{pool}] '#{vm}' marked as 'failed' after #{timeout} minutes")
    else
      remove_nonexistent_vm(vm, pool)
    end
  end
  true
rescue StandardError => e
  $logger.log('d', "Fail pending VM failed with an error: #{e}")
  false
end

#find_unique_hostname(pool_name) ⇒ Object 



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/vmpooler/pool_manager.rb', line 297

def find_unique_hostname(pool_name)
  hostname_retries = 0
  max_hostname_retries = 3
  while hostname_retries < max_hostname_retries
    hostname, available = generate_and_check_hostname(pool_name)
    break if available

    hostname_retries += 1
    $metrics.increment("errors.duplicatehostname.#{pool_name}")
    $logger.log('s', "[!] [#{pool_name}] Generated hostname #{hostname} was not unique (attempt \##{hostname_retries} of #{max_hostname_retries})")
  end

  raise "Unable to generate a unique hostname after #{hostname_retries} attempts. The last hostname checked was #{hostname}" unless available

  hostname
end

#generate_and_check_hostname(_pool_name) ⇒ Object 



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/vmpooler/pool_manager.rb', line 279

def generate_and_check_hostname(_pool_name)
  # Generate a randomized hostname. The total name must no longer than 15
  # character including the hyphen. The shortest adjective in the corpus is
  # three characters long. Therefore, we can technically select a noun up to 11
  # characters long and still be guaranteed to have an available adjective.
  # Because of the limited set of 11 letter nouns and corresponding 3
  # letter adjectives, we actually limit the noun to 10 letters to avoid
  # inviting more conflicts. We favor selecting a longer noun rather than a
  # longer adjective because longer adjectives tend to be less fun.
  noun = @name_generator.noun(max: 10)
  adjective = @name_generator.adjective(max: 14 - noun.length)
  random_name = [adjective, noun].join('-')
  hostname = $config[:config]['prefix'] + random_name
  available = $redis.hlen('vmpooler__vm__' + hostname) == 0

  [hostname, available]
end

#get_base_folders(folders) ⇒ Object 



470
471
472
473
474
475
476
 
# File 'lib/vmpooler/pool_manager.rb', line 470

def get_base_folders(folders)
  base = []
  folders.each do |_key, value|
    base << value
  end
  base.uniq
end

#get_pool_name_for_vm(vm_name) ⇒ Object 



597
598
599
600
 
# File 'lib/vmpooler/pool_manager.rb', line 597

def get_pool_name_for_vm(vm_name)
  # the 'template' is a bad name.  Should really be 'poolname'
  $redis.hget('vmpooler__vm__' + vm_name, 'template')
end

#get_provider_for_pool(pool_name) ⇒ Provider

Returns - returns the provider class Object.

Parameters:

  • pool_name (String) —

    • the name of the pool

Returns:

  • (Provider) —

    • returns the provider class Object



604
605
606
607
608
609
610
 
# File 'lib/vmpooler/pool_manager.rb', line 604

def get_provider_for_pool(pool_name)
  pool = $config[:pools].find { |p| p['name'] == pool_name }
  return nil unless pool

  provider_name = pool.fetch('provider', nil)
  $providers[provider_name]
end

#get_vm_usage_labels(vm) ⇒ Object 



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/vmpooler/pool_manager.rb', line 380

def get_vm_usage_labels(vm)
  return unless $config[:config]['usage_stats']

  checkout = $redis.hget("vmpooler__vm__#{vm}", 'checkout')
  return if checkout.nil?

  jenkins_build_url = $redis.hget("vmpooler__vm__#{vm}", 'tag:jenkins_build_url')
  user = $redis.hget("vmpooler__vm__#{vm}", 'token:user') || 'unauthenticated'
  poolname = $redis.hget("vmpooler__vm__#{vm}", 'template')

  unless jenkins_build_url
    user = user.gsub('.', '_')
    $metrics.increment("usage.#{user}.#{poolname}")
    return
  end

  url_parts = jenkins_build_url.split('/')[2..-1]
  instance = url_parts[0]
  value_stream_parts = url_parts[2].split('_')
  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)

  metric_parts = [
    'usage',
    user,
    instance,
    value_stream,
    branch,
    project,
    job_name,
    component_to_test,
    poolname
  ]

  metric_parts = metric_parts.reject(&:nil?)
  metric_parts = metric_parts.map { |s| s.gsub('.', '_') }

  $metrics.increment(metric_parts.join('.'))
rescue StandardError => e
  logger.log('d', "[!] [#{poolname}] failed while evaluating usage labels on '#{vm}' with an error: #{e}")
end

#load_pools_to_redis ⇒ Object

Place pool configuration in redis so an API instance can discover running pool configuration



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/vmpooler/pool_manager.rb', line 47

def load_pools_to_redis
  previously_configured_pools = $redis.smembers('vmpooler__pools')
  currently_configured_pools = []
  config[:pools].each do |pool|
    currently_configured_pools << pool['name']
    $redis.sadd('vmpooler__pools', pool['name'])
    pool_keys = pool.keys
    pool_keys.delete('alias')
    to_set = {}
    pool_keys.each do |k|
      to_set[k] = pool[k]
    end
    to_set['alias'] = pool['alias'].join(',') if to_set.key?('alias')
    $redis.hmset("vmpooler__pool__#{pool['name']}", to_set.to_a.flatten) unless to_set.empty?
  end
  previously_configured_pools.each do |pool|
    unless currently_configured_pools.include? pool
      $redis.srem('vmpooler__pools', pool)
      $redis.del("vmpooler__pool__#{pool}")
    end
  end
  nil
end

#load_used_providers ⇒ Object

load only providers used in config file



579
580
581
 
# File 'lib/vmpooler/pool_manager.rb', line 579

def load_used_providers
  Vmpooler::Providers.load_by_name(used_providers)
end

#migrate_vm(vm_name, pool_name, provider) ⇒ Object 



702
703
704
705
706
707
708
709
710
711
712
713
714
 
# File 'lib/vmpooler/pool_manager.rb', line 702

def migrate_vm(vm_name, pool_name, provider)
  Thread.new do
    begin
      mutex = vm_mutex(vm_name)
      mutex.synchronize do
        $redis.srem("vmpooler__migrating__#{pool_name}", vm_name)
        provider.migrate_vm(pool_name, vm_name)
      end
    rescue StandardError => e
      $logger.log('s', "[x] [#{pool_name}] '#{vm_name}' migration failed with an error: #{e}")
    end
  end
end

#mismatched_hostname?(vm, pool_name, provider) ⇒ Boolean

Returns:

  • (Boolean) 


190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/vmpooler/pool_manager.rb', line 190

def mismatched_hostname?(vm, pool_name, provider)
  pool_config = $config[:pools][$config[:pool_index][pool_name]]
  check_hostname = pool_config['check_hostname_for_mismatch']
  check_hostname = $config[:config]['check_ready_vm_hostname_for_mismatch'] if check_hostname.nil?
  return if check_hostname == false

  # Wait one minute before checking a VM for hostname mismatch
  # When checking as soon as the VM passes the ready test the instance
  # often doesn't report its hostname yet causing the VM to be removed immediately
  vm_ready_time = $redis.hget("vmpooler__vm__#{vm}", 'ready')
  if vm_ready_time
    wait_before_checking = 60
    time_since_ready = (Time.now - Time.parse(vm_ready_time)).to_i
    return unless time_since_ready > wait_before_checking
  end

  # Check if the hostname has magically changed from underneath Pooler
  vm_hash = provider.get_vm(pool_name, vm)
  return unless vm_hash.is_a? Hash

  hostname = vm_hash['hostname']

  return if hostname.nil?
  return if hostname.empty?
  return if hostname == vm

  $redis.smove('vmpooler__ready__' + pool_name, 'vmpooler__completed__' + pool_name, vm)
  $logger.log('d', "[!] [#{pool_name}] '#{vm}' has mismatched hostname #{hostname}, removed from 'ready' queue")
  true
end

#move_pending_vm_to_ready(vm, pool) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/vmpooler/pool_manager.rb', line 122

def move_pending_vm_to_ready(vm, pool)
  clone_time = $redis.hget('vmpooler__vm__' + vm, 'clone')
  finish = format('%<time>.2f', time: Time.now - Time.parse(clone_time)) if clone_time

  $redis.smove('vmpooler__pending__' + pool, 'vmpooler__ready__' + pool, vm)
  $redis.hset('vmpooler__boot__' + Date.today.to_s, pool + ':' + vm, finish) # maybe remove as this is never used by vmpooler itself?
  $redis.hset("vmpooler__vm__#{vm}", 'ready', Time.now)

  # last boot time is displayed in API, and used by alarming script
  $redis.hset('vmpooler__lastboot', pool, Time.now)

  $metrics.timing("time_to_ready_state.#{pool}", finish)
  $logger.log('s', "[>] [#{pool}] '#{vm}' moved from 'pending' to 'ready' queue")
end

#move_vm_queue(pool, vm, queue_from, queue_to, msg = nil) ⇒ Object 



262
263
264
265
 
# File 'lib/vmpooler/pool_manager.rb', line 262

def move_vm_queue(pool, vm, queue_from, queue_to, msg = nil)
  $redis.smove("vmpooler__#{queue_from}__#{pool}", "vmpooler__#{queue_to}__#{pool}", vm)
  $logger.log('d', "[!] [#{pool}] '#{vm}' #{msg}") if msg
end

#pool_folders(provider_name) ⇒ Object

Return a list of pool folders



458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/vmpooler/pool_manager.rb', line 458

def pool_folders(provider_name)
  folders = {}
  $config[:pools].each do |pool|
    next unless pool['provider'] == provider_name

    folder_parts = pool['folder'].split('/')
    datacenter = $providers[provider_name].get_target_datacenter_from_config(pool['name'])
    folders[folder_parts.pop] = "#{datacenter}/vm/#{folder_parts.join('/')}"
  end
  folders
end

#pool_mutex(poolname) ⇒ Object 



833
834
835
 
# File 'lib/vmpooler/pool_manager.rb', line 833

def pool_mutex(poolname)
  @reconfigure_pool[poolname] || @reconfigure_pool[poolname] = Mutex.new
end

#prepare_template(pool, provider) ⇒ Object 



852
853
854
855
856
857
858
859
860
861
862
863
864
 
# File 'lib/vmpooler/pool_manager.rb', line 852

def prepare_template(pool, provider)
  if $config[:config]['create_template_delta_disks']
    unless $redis.sismember('vmpooler__template__deltas', pool['template'])
      begin
        provider.create_template_delta_disks(pool)
        $redis.sadd('vmpooler__template__deltas', pool['template'])
      rescue StandardError => e
        $logger.log('s', "[!] [#{pool['name']}] failed while preparing a template with an error. As a result vmpooler could not create the template delta disks. Either a template delta disk already exists, or the template delta disk creation failed. The error is: #{e}")
      end
    end
  end
  $redis.hset('vmpooler__template__prepared', pool['name'], pool['template'])
end

#purge_unused_vms_and_folders ⇒ Object 



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/vmpooler/pool_manager.rb', line 438

def purge_unused_vms_and_folders
  global_purge = $config[:config]['purge_unconfigured_folders']
  providers = $config[:providers].keys
  providers.each do |provider|
    provider_purge = $config[:providers][provider]['purge_unconfigured_folders']
    provider_purge = global_purge if provider_purge.nil?
    if provider_purge
      Thread.new do
        begin
          purge_vms_and_folders(provider.to_s)
        rescue StandardError => e
          $logger.log('s', "[!] failed while purging provider #{provider} VMs and folders with an error: #{e}")
        end
      end
    end
  end
  nil
end

#purge_vms_and_folders(provider) ⇒ Object 



478
479
480
481
482
483
 
# File 'lib/vmpooler/pool_manager.rb', line 478

def purge_vms_and_folders(provider)
  configured_folders = pool_folders(provider)
  base_folders = get_base_folders(configured_folders)
  whitelist = $providers[provider].provider_config['folder_whitelist']
  $providers[provider].purge_unconfigured_folders(base_folders, configured_folders, whitelist)
end

#remove_excess_vms(pool) ⇒ Object 



937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
 
# File 'lib/vmpooler/pool_manager.rb', line 937

def remove_excess_vms(pool)
  ready = $redis.scard("vmpooler__ready__#{pool['name']}")
  total = $redis.scard("vmpooler__pending__#{pool['name']}") + ready
  return if total.nil?
  return if total == 0

  mutex = pool_mutex(pool['name'])
  return if mutex.locked?
  return unless ready > pool['size']

  mutex.synchronize do
    difference = ready - pool['size']
    difference.times do
      next_vm = $redis.spop("vmpooler__ready__#{pool['name']}")
      move_vm_queue(pool['name'], next_vm, 'ready', 'completed')
    end
    if total > ready
      $redis.smembers("vmpooler__pending__#{pool['name']}").each do |vm|
        move_vm_queue(pool['name'], vm, 'pending', 'completed')
      end
    end
  end
end

#remove_nonexistent_vm(vm, pool) ⇒ Object 



97
98
99
100
 
# File 'lib/vmpooler/pool_manager.rb', line 97

def remove_nonexistent_vm(vm, pool)
  $redis.srem("vmpooler__pending__#{pool}", vm)
  $logger.log('d', "[!] [#{pool}] '#{vm}' no longer exists. Removing from pending.")
end

#repopulate_pool_vms(pool_name, provider, pool_check_response, pool_size) ⇒ Object 



1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
 
# File 'lib/vmpooler/pool_manager.rb', line 1113

def repopulate_pool_vms(pool_name, provider, pool_check_response, pool_size)
  return if pool_mutex(pool_name).locked?

  ready = $redis.scard("vmpooler__ready__#{pool_name}")
  total = $redis.scard("vmpooler__pending__#{pool_name}") + ready

  $metrics.gauge("ready.#{pool_name}", $redis.scard("vmpooler__ready__#{pool_name}"))
  $metrics.gauge("running.#{pool_name}", $redis.scard("vmpooler__running__#{pool_name}"))

  if $redis.get("vmpooler__empty__#{pool_name}")
    $redis.del("vmpooler__empty__#{pool_name}") unless ready == 0
  elsif ready == 0
    $redis.set("vmpooler__empty__#{pool_name}", 'true')
    $logger.log('s', "[!] [#{pool_name}] is empty")
  end

  (pool_size - total).times do
    if $redis.get('vmpooler__tasks__clone').to_i < $config[:config]['task_limit'].to_i
      begin
        $redis.incr('vmpooler__tasks__clone')
        pool_check_response[:cloned_vms] += 1
        clone_vm(pool_name, provider)
      rescue StandardError => e
        $logger.log('s', "[!] [#{pool_name}] clone failed during check_pool with an error: #{e}")
        $redis.decr('vmpooler__tasks__clone')
        raise
      end
    end
  end
end

#reset_pool(pool) ⇒ Object 



976
977
978
979
980
981
982
983
984
985
986
 
# File 'lib/vmpooler/pool_manager.rb', line 976

def reset_pool(pool)
  poolname = pool['name']
  return unless $redis.sismember('vmpooler__poolreset', poolname)

  $redis.srem('vmpooler__poolreset', poolname)
  mutex = pool_mutex(poolname)
  mutex.synchronize do
    drain_pool(poolname)
    $logger.log('s', "[*] [#{poolname}] reset has cleared ready and pending instances")
  end
end

#revert_vm_snapshot(pool_name, vm, snapshot_name, provider) ⇒ Object 



550
551
552
553
554
555
556
557
558
559
 
# File 'lib/vmpooler/pool_manager.rb', line 550

def revert_vm_snapshot(pool_name, vm, snapshot_name, provider)
  Thread.new do
    begin
      _revert_vm_snapshot(pool_name, vm, snapshot_name, provider)
    rescue StandardError => e
      $logger.log('d', "[!] [#{pool_name}] '#{vm}' failed while reverting snapshot: #{e}")
      raise
    end
  end
end

#sleep_with_wakeup_events(loop_delay, wakeup_period = 5, options = {}) ⇒ Object

Possible wakeup events :pool_size_change

- Fires when the number of ready VMs changes due to being consumed.
- Additional options
    :poolname

:pool_template_change

- Fires when a template configuration update is requested
- Additional options
    :poolname

:pool_reset

- Fires when a pool reset is requested
- Additional options
    :poolname



735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
 
# File 'lib/vmpooler/pool_manager.rb', line 735

def sleep_with_wakeup_events(loop_delay, wakeup_period = 5, options = {})
  exit_by = Time.now + loop_delay
  wakeup_by = Time.now + wakeup_period
  return if time_passed?(:exit_by, exit_by)

  initial_ready_size = $redis.scard("vmpooler__ready__#{options[:poolname]}") if options[:pool_size_change]

  initial_clone_target = $redis.hget("vmpooler__pool__#{options[:poolname]}", options[:clone_target]) if options[:clone_target_change]

  initial_template = $redis.hget('vmpooler__template__prepared', options[:poolname]) if options[:pool_template_change]

  loop do
    sleep(1)
    break if time_passed?(:exit_by, exit_by)

    # Check for wakeup events
    if time_passed?(:wakeup_by, wakeup_by)
      wakeup_by = Time.now + wakeup_period

      # Wakeup if the number of ready VMs has changed
      if options[:pool_size_change]
        ready_size = $redis.scard("vmpooler__ready__#{options[:poolname]}")
        break unless ready_size == initial_ready_size
      end

      if options[:clone_target_change]
        clone_target = $redis.hget('vmpooler__config__clone_target}', options[:poolname])
        if clone_target
          break unless clone_target == initial_clone_target
        end
      end

      if options[:pool_template_change]
        configured_template = $redis.hget('vmpooler__config__template', options[:poolname])
        if configured_template
          break unless initial_template == configured_template
        end
      end

      if options[:pool_reset]
        break if $redis.sismember('vmpooler__poolreset', options[:poolname])
      end

    end

    break if time_passed?(:exit_by, exit_by)
  end
end

#sync_pool_template(pool) ⇒ Object 



845
846
847
848
849
850
 
# File 'lib/vmpooler/pool_manager.rb', line 845

def sync_pool_template(pool)
  pool_template = $redis.hget('vmpooler__config__template', pool['name'])
  if pool_template
    pool['template'] = pool_template unless pool['template'] == pool_template
  end
end

#time_passed?(_event, time) ⇒ Boolean

Helper method mainly used for unit testing

Returns:

  • (Boolean) 


717
718
719
 
# File 'lib/vmpooler/pool_manager.rb', line 717

def time_passed?(_event, time)
  Time.now > time
end

#update_clone_target(pool) ⇒ Object 



920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'lib/vmpooler/pool_manager.rb', line 920

def update_clone_target(pool)
  mutex = pool_mutex(pool['name'])
  return if mutex.locked?

  clone_target = $redis.hget('vmpooler__config__clone_target', pool['name'])
  return if clone_target.nil?
  return if clone_target == pool['clone_target']

  $logger.log('s', "[*] [#{pool['name']}] clone updated from #{pool['clone_target']} to #{clone_target}")
  mutex.synchronize do
    pool['clone_target'] = clone_target
    # Remove all ready and pending VMs so new instances are created for the new clone_target
    drain_pool(pool['name'])
  end
  $logger.log('s', "[*] [#{pool['name']}] is ready for use")
end

#update_pool_size(pool) ⇒ Object 



961
962
963
964
965
966
967
968
969
970
971
972
973
974
 
# File 'lib/vmpooler/pool_manager.rb', line 961

def update_pool_size(pool)
  mutex = pool_mutex(pool['name'])
  return if mutex.locked?

  poolsize = $redis.hget('vmpooler__config__poolsize', pool['name'])
  return if poolsize.nil?

  poolsize = Integer(poolsize)
  return if poolsize == pool['size']

  mutex.synchronize do
    pool['size'] = poolsize
  end
end

#update_pool_template(pool, provider, configured_template, prepared_template) ⇒ Object 



909
910
911
912
913
914
915
916
917
918
 
# File 'lib/vmpooler/pool_manager.rb', line 909

def update_pool_template(pool, provider, configured_template, prepared_template)
  pool['template'] = configured_template
  $logger.log('s', "[*] [#{pool['name']}] template updated from #{prepared_template} to #{configured_template}")
  # Remove all ready and pending VMs so new instances are created from the new template
  drain_pool(pool['name'])
  # Prepare template for deployment
  $logger.log('s', "[*] [#{pool['name']}] preparing pool template for deployment")
  prepare_template(pool, provider)
  $logger.log('s', "[*] [#{pool['name']}] is ready for use")
end

#used_providers ⇒ Array

ie. [“vsphere”, “dummy”]

Returns:

  • (Array) —

    • a list of used providers from the config file, defaults to the default providers



585
586
587
588
 
# File 'lib/vmpooler/pool_manager.rb', line 585

def used_providers
  pools = config[:pools] || []
  @used_providers ||= (pools.map { |pool| pool[:provider] || pool['provider'] }.compact + default_providers).uniq
end

#vm_mutex(vmname) ⇒ Object 



837
838
839
 
# File 'lib/vmpooler/pool_manager.rb', line 837

def vm_mutex(vmname)
  @vm_mutex[vmname] || @vm_mutex[vmname] = Mutex.new
end

#vm_still_ready?(pool_name, vm_name, provider) ⇒ Boolean

Returns:

  • (Boolean) 


137
138
139
140
141
142
143
144
 
# File 'lib/vmpooler/pool_manager.rb', line 137

def vm_still_ready?(pool_name, vm_name, provider)
  # Check if the VM is still ready/available
  return true if provider.vm_ready?(pool_name, vm_name)

  raise("VM #{vm_name} is not ready")
rescue StandardError
  move_vm_queue(pool_name, vm_name, 'ready', 'completed', "is unreachable, removed from 'ready' queue")
end