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.



10
11
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
 
# File 'lib/vmpooler/pool_manager.rb', line 10

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 



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

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 => err
      $logger.log('s', "[!] [disk_manager] disk creation appears to have failed: #{err}")
    end
  end
end

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



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

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 



1104
1105
1106
1107
1108
1109
1110
1111
1112
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
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
 
# File 'lib/vmpooler/pool_manager.rb', line 1104

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 => err
    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)

  pool_check_response
end

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



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
180
181
182
183
 
# File 'lib/vmpooler/pool_manager.rb', line 153

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 has_mismatched_hostname?(vm, pool_name, provider)

    vm_still_ready?(pool_name, vm, provider)
  end
end

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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/vmpooler/pool_manager.rb', line 225

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 



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
 
# File 'lib/vmpooler/pool_manager.rb', line 644

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 => err
      $logger.log('s', "[!] [snapshot_manager] snapshot create appears to have failed: #{err}")
    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 => err
      $logger.log('s', "[!] [snapshot_manager] snapshot revert appears to have failed: #{err}")
    end
  end
end

#_clone_vm(pool_name, provider) ⇒ Object 



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/vmpooler/pool_manager.rb', line 297

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('%.2f', 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 => _err
    $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 _err
  ensure
    $redis.decr('vmpooler__tasks__clone')
  end
end

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



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/vmpooler/pool_manager.rb', line 477

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('%.2f', 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 



513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/vmpooler/pool_manager.rb', line 513

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('%.2f', 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 



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/vmpooler/pool_manager.rb', line 338

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('%.2f', 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 



542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/vmpooler/pool_manager.rb', line 542

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('%.2f', 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 



1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
 
# File 'lib/vmpooler/pool_manager.rb', line 1021

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 => err
        $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: #{err}")
      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 



1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
 
# File 'lib/vmpooler/pool_manager.rb', line 1042

def check_discovered_pool_vms(pool_name)
  begin
    $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

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

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



592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
 
# File 'lib/vmpooler/pool_manager.rb', line 592

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.zero?
        break if loop_count >= maxloop
        loop_count += 1
      end
    end
  end
end

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



1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
 
# File 'lib/vmpooler/pool_manager.rb', line 1061

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 => err
        $logger.log('s', "[x] [#{pool_name}] '#{vm}' failed to migrate: #{err}")
      end
    end
  end
end

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



1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/vmpooler/pool_manager.rb', line 1005

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 => err
        $logger.log('d', "[!] [#{pool_name}] _check_pool failed with an error while evaluating pending VMs: #{err}")
      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



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

def check_pending_vm(vm, pool, timeout, provider)
  Thread.new do
    begin
      _check_pending_vm(vm, pool, timeout, provider)
    rescue => err
      $logger.log('s', "[!] [#{pool}] '#{vm}' #{timeout} #{provider} errored while checking a pending vm : #{err}")
      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 



760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/vmpooler/pool_manager.rb', line 760

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)

        unless maxloop.zero?
          break if loop_count >= maxloop
          loop_count += 1
        end
      end
    rescue => err
      $logger.log('s', "[!] [#{pool['name']}] Error while checking the pool: #{err}")
      raise
    end
  end
end

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



990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
 
# File 'lib/vmpooler/pool_manager.rb', line 990

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 => err
        $logger.log('d', "[!] [#{pool_name}] _check_pool failed with an error while evaluating ready VMs: #{err}")
      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 



142
143
144
145
146
147
148
149
150
151
 
# File 'lib/vmpooler/pool_manager.rb', line 142

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

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



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

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 => err
        $logger.log('d', "[!] [#{pool_name}] _check_pool with an error while evaluating running VMs: #{err}")
      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 



214
215
216
217
218
219
220
221
222
223
 
# File 'lib/vmpooler/pool_manager.rb', line 214

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

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



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
 
# File 'lib/vmpooler/pool_manager.rb', line 627

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.zero?
        break if loop_count >= maxloop
        loop_count += 1
      end
    end
  end
end

#clone_vm(pool_name, provider) ⇒ Object

Clone a VM



260
261
262
263
264
265
266
267
268
269
 
# File 'lib/vmpooler/pool_manager.rb', line 260

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

#component_to_test(match, labels_string) ⇒ Object 



406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/vmpooler/pool_manager.rb', line 406

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?
    if key == match
      return value
    end
  end
  return
end

#config ⇒ Object 



40
41
42
 
# File 'lib/vmpooler/pool_manager.rb', line 40

def config
  $config
end

#create_inventory(pool, provider, pool_check_response) ⇒ Object 



945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
 
# File 'lib/vmpooler/pool_manager.rb', line 945

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 => err
    $logger.log('s', "[!] [#{pool['name']}] _check_pool failed with an error while running create_inventory: #{err}")
    raise(err)
  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



1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'lib/vmpooler/pool_manager.rb', line 1163

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 



466
467
468
469
470
471
472
473
474
475
 
# File 'lib/vmpooler/pool_manager.rb', line 466

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

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



502
503
504
505
506
507
508
509
510
511
 
# File 'lib/vmpooler/pool_manager.rb', line 502

def create_vm_snapshot(pool_name, vm, snapshot_name, provider)
  Thread.new do
    begin
      _create_vm_snapshot(pool_name, vm, snapshot_name, provider)
    rescue => err
      $logger.log('d', "[!] [#{pool_name}] '#{vm}' failed while creating snapshot: #{err}")
      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



574
575
576
 
# File 'lib/vmpooler/pool_manager.rb', line 574

def default_providers
  @default_providers ||= %w( vsphere dummy )
end

#dereference_mutex(vmname) ⇒ Object 



813
814
815
816
817
818
819
 
# File 'lib/vmpooler/pool_manager.rb', line 813

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

#destroy_vm(vm, pool, provider) ⇒ Object

Destroy a VM



327
328
329
330
331
332
333
334
335
336
 
# File 'lib/vmpooler/pool_manager.rb', line 327

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

#drain_pool(poolname) ⇒ Object 



869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
 
# File 'lib/vmpooler/pool_manager.rb', line 869

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 



844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
 
# File 'lib/vmpooler/pool_manager.rb', line 844

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 



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
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
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
 
# File 'lib/vmpooler/pool_manager.rb', line 1172

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 => err
      $logger.log('s', "Error while creating provider for pool #{pool['name']}: #{err}")
      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.zero?
      break if loop_count >= maxloop
      loop_count += 1
    end
  end
end

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



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

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 => err
  $logger.log('d', "Fail pending VM failed with an error: #{err}")
  false
end

#find_unique_hostname(pool_name) ⇒ Object 



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

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 



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

def generate_and_check_hostname(pool_name)
  # Generate a randomized hostname
  random_name = [@name_generator.adjective(max: 7), @name_generator.noun(max: 7)].join('-')
  hostname = $config[:config]['prefix'] + random_name
  available = $redis.hlen('vmpooler__vm__' + hostname) == 0

  return hostname, available
end

#get_base_folders(folders) ⇒ Object 



451
452
453
454
455
456
457
 
# File 'lib/vmpooler/pool_manager.rb', line 451

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 



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

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



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

def get_provider_for_pool(pool_name)
  pool = $config[:pools].find { |pool| pool['name'] == pool_name }
  return nil unless pool
  provider_name = pool.fetch('provider', nil)
  $providers[provider_name]
end

#get_vm_usage_labels(vm) ⇒ Object 



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
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
 
# File 'lib/vmpooler/pool_manager.rb', line 362

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 { |s| s.nil? }
  metric_parts = metric_parts.map { |s| s.gsub('.', '_') }

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

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

Returns:

  • (Boolean) 


185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/vmpooler/pool_manager.rb', line 185

def has_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")
  return true
end

#load_pools_to_redis ⇒ Object

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



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

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.has_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
  return
end

#load_used_providers ⇒ Object

load only providers used in config file



560
561
562
 
# File 'lib/vmpooler/pool_manager.rb', line 560

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

#migrate_vm(vm_name, pool_name, provider) ⇒ Object 



680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/vmpooler/pool_manager.rb', line 680

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 => err
      $logger.log('s', "[x] [#{pool_name}] '#{vm_name}' migration failed with an error: #{err}")
    end
  end
end

#move_pending_vm_to_ready(vm, pool) ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/vmpooler/pool_manager.rb', line 119

def move_pending_vm_to_ready(vm, pool)
  clone_time = $redis.hget('vmpooler__vm__' + vm, 'clone')
  finish = format('%.2f', 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 



254
255
256
257
 
# File 'lib/vmpooler/pool_manager.rb', line 254

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) ⇒ Object

Return a list of pool folders



439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/vmpooler/pool_manager.rb', line 439

def pool_folders(provider)
  provider_name = provider.name
  folders = {}
  $config[:pools].each do |pool|
    next unless pool['provider'] == provider_name
    folder_parts = pool['folder'].split('/')
    datacenter = provider.get_target_datacenter_from_config(pool['name'])
    folders[folder_parts.pop] = "#{datacenter}/vm/#{folder_parts.join('/')}"
  end
  folders
end

#pool_mutex(poolname) ⇒ Object 



805
806
807
 
# File 'lib/vmpooler/pool_manager.rb', line 805

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

#prepare_template(pool, provider) ⇒ Object 



830
831
832
833
834
835
836
837
838
839
840
841
842
 
# File 'lib/vmpooler/pool_manager.rb', line 830

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 => err
        $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: #{err}")
      end
    end
  end
  $redis.hset('vmpooler__template__prepared', pool['name'], pool['template'])
end

#purge_unused_vms_and_folders ⇒ Object 



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/vmpooler/pool_manager.rb', line 419

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($providers[provider.to_s])
        rescue => err
          $logger.log('s', "[!] failed while purging provider #{provider.to_s} VMs and folders with an error: #{err}")
        end
      end
    end
  end
  return
end

#purge_vms_and_folders(provider) ⇒ Object 



459
460
461
462
463
464
 
# File 'lib/vmpooler/pool_manager.rb', line 459

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

#remove_excess_vms(pool) ⇒ Object 



911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
 
# File 'lib/vmpooler/pool_manager.rb', line 911

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 



94
95
96
97
 
# File 'lib/vmpooler/pool_manager.rb', line 94

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 



1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
 
# File 'lib/vmpooler/pool_manager.rb', line 1074

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.zero?
  elsif ready.zero?
    $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 => err
        $logger.log('s', "[!] [#{pool_name}] clone failed during check_pool with an error: #{err}")
        $redis.decr('vmpooler__tasks__clone')
        raise
      end
    end
  end
end

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



531
532
533
534
535
536
537
538
539
540
 
# File 'lib/vmpooler/pool_manager.rb', line 531

def revert_vm_snapshot(pool_name, vm, snapshot_name, provider)
  Thread.new do
    begin
      _revert_vm_snapshot(pool_name, vm, snapshot_name, provider)
    rescue => err
      $logger.log('d', "[!] [#{pool_name}] '#{vm}' failed while reverting snapshot: #{err}")
      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



709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
 
# File 'lib/vmpooler/pool_manager.rb', line 709

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)

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

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

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

  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

    end

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

#sync_pool_template(pool) ⇒ Object 



821
822
823
824
825
826
827
828
 
# File 'lib/vmpooler/pool_manager.rb', line 821

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

#time_passed?(_event, time) ⇒ Boolean

Helper method mainly used for unit testing

Returns:

  • (Boolean) 


695
696
697
 
# File 'lib/vmpooler/pool_manager.rb', line 695

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

#update_clone_target(pool) ⇒ Object 



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

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 



933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/vmpooler/pool_manager.rb', line 933

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 



885
886
887
888
889
890
891
892
893
894
 
# File 'lib/vmpooler/pool_manager.rb', line 885

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



566
567
568
569
 
# File 'lib/vmpooler/pool_manager.rb', line 566

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

#vm_mutex(vmname) ⇒ Object 



809
810
811
 
# File 'lib/vmpooler/pool_manager.rb', line 809

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

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

Returns:

  • (Boolean) 


134
135
136
137
138
139
140
 
# File 'lib/vmpooler/pool_manager.rb', line 134

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
  move_vm_queue(pool_name, vm_name, 'ready', 'completed', "is unreachable, removed from 'ready' queue")
end