Class: Vmpooler::API::V3

Inherits:
Sinatra::Base
  • Object
show all
Defined in:
lib/vmpooler/api/v3.rb

Instance Method Summary collapse

Instance Method Details

#account_for_starting_vm(template, vm) ⇒ Object 



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/vmpooler/api/v3.rb', line 186

def (template, vm)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do |span|
    user = backend.hget("vmpooler__token__#{request.env['HTTP_X_AUTH_TOKEN']}", 'user')
    span.set_attribute('enduser.id', user)
    has_token_result = has_token?
    backend.sadd("vmpooler__migrating__#{template}", vm)
    backend.hset("vmpooler__active__#{template}", vm, Time.now.to_s)
    backend.hset("vmpooler__vm__#{vm}", 'checkout', Time.now.to_s)

    if Vmpooler::API.settings.config[:auth] and has_token_result
      backend.hset("vmpooler__vm__#{vm}", 'token:token', request.env['HTTP_X_AUTH_TOKEN'])
      backend.hset("vmpooler__vm__#{vm}", 'token:user', user)

      if config['vm_lifetime_auth'].to_i > 0
        backend.hset("vmpooler__vm__#{vm}", 'lifetime', config['vm_lifetime_auth'].to_i)
      end
    end
  end
end

#atomically_allocate_vms(payload) ⇒ Object 



218
219
220
221
222
223
224
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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/vmpooler/api/v3.rb', line 218

def atomically_allocate_vms(payload)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do |span|
    result = { 'ok' => false }
    failed = false
    vms = [] # vmpool, vmname, vmtemplate

    validate_token(backend) if Vmpooler::API.settings.config[:auth] and has_token?

    payload.each do |requested, count|
      count.to_i.times do |_i|
        vmname, vmpool, vmtemplate = fetch_single_vm(requested)
        if vmname
          (vmpool, vmname)
          vms << [vmpool, vmname, vmtemplate]
          metrics.increment("checkout.success.#{vmpool}")
          update_user_metrics('allocate', vmname) if Vmpooler::API.settings.config[:config]['usage_stats']
        else
          failed = true
          metrics.increment("checkout.empty.#{requested}")
          break
        end
      end
    end

    if failed
      vms.each do |(vmpool, vmname, _vmtemplate)|
        return_vm_to_ready_state(vmpool, vmname)
      end
      span.add_event('error', attributes: {
        'error.type' => 'Vmpooler::API::V3.atomically_allocate_vms',
        'error.message' => '503 due to failing to allocate one or more vms'
      })
      status 503
    else
      vm_names = []
      vms.each do |(vmpool, vmname, vmtemplate)|
        vmdomain = Dns.get_domain_for_pool(full_config, vmpool)
        vmfqdn = "#{vmname}.#{vmdomain}"
        update_result_hosts(result, vmtemplate, vmfqdn)
        vm_names.append(vmfqdn)
      end

      span.set_attribute('vmpooler.vm_names', vm_names.join(',')) unless vm_names.empty?

      result['ok'] = true
    end

    result
  end
end

#backend ⇒ Object 



16
17
18
 
# File 'lib/vmpooler/api/v3.rb', line 16

def backend
  Vmpooler::API.settings.redis
end

#check_ondemand_request(request_id) ⇒ Object 



1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
 
# File 'lib/vmpooler/api/v3.rb', line 1305

def check_ondemand_request(request_id)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do |span|
    span.set_attribute('vmpooler.request_id', request_id)
    result = { 'ok' => false }
    request_hash = backend.hgetall("vmpooler__odrequest__#{request_id}")
    if request_hash.empty?
      e_message = "no request found for request_id '#{request_id}'"
      result['message'] = e_message
      span.add_event('error', attributes: {
        'error.type' => 'Vmpooler::API::V3.check_ondemand_request',
        'error.message' => e_message
      })
      return result
    end

    result['request_id'] = request_id
    result['ready'] = false
    result['ok'] = true
    status 202

    case request_hash['status']
    when 'ready'
      result['ready'] = true
      Parsing.get_platform_pool_count(request_hash['requested']) do |platform_alias, pool, _count|
        instances = backend.smembers("vmpooler__#{request_id}__#{platform_alias}__#{pool}")
        domain = Dns.get_domain_for_pool(full_config, pool)
        instances.map! { |instance| instance.concat(".#{domain}") }

        if result.key?(platform_alias)
          result[platform_alias][:hostname] = result[platform_alias][:hostname] + instances
        else
          result[platform_alias] = { 'hostname': instances }
        end
      end
      status 200
    when 'failed'
      result['message'] = "The request failed to provision instances within the configured ondemand_request_ttl '#{config['ondemand_request_ttl']}'"
      status 200
    when 'deleted'
      result['message'] = 'The request has been deleted'
      status 200
    else
      Parsing.get_platform_pool_count(request_hash['requested']) do |platform_alias, pool, count|
        instance_count = backend.scard("vmpooler__#{request_id}__#{platform_alias}__#{pool}")
        instances_pending = count.to_i - instance_count.to_i

        if result.key?(platform_alias) && result[platform_alias].key?(:ready)
          result[platform_alias][:ready] = (result[platform_alias][:ready].to_i + instance_count).to_s
          result[platform_alias][:pending] = (result[platform_alias][:pending].to_i + instances_pending).to_s
        else
          result[platform_alias] = {
            'ready': instance_count.to_s,
            'pending': instances_pending.to_s
          }
        end
      end
    end

    result
  end
end

#checkoutlock ⇒ Object 



52
53
54
 
# File 'lib/vmpooler/api/v3.rb', line 52

def checkoutlock
  Vmpooler::API.settings.checkoutlock
end

#component_to_test(match, labels_string) ⇒ Object 



269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/vmpooler/api/v3.rb', line 269

def component_to_test(match, labels_string)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    return if labels_string.nil?

    labels_string_parts = labels_string.split(',')
    labels_string_parts.each do |part|
      key, value = part.split('=')
      next if value.nil?
      return value if key == match
    end
    'none'
  end
end

#config ⇒ Object 



24
25
26
 
# File 'lib/vmpooler/api/v3.rb', line 24

def config
  Vmpooler::API.settings.config[:config]
end

#count_selection(selection) ⇒ Object 



86
87
88
89
90
91
92
 
# File 'lib/vmpooler/api/v3.rb', line 86

def count_selection(selection)
  result = {}
  selection.uniq.each do |poolname|
    result[poolname] = selection.count(poolname)
  end
  result
end

#delete_ondemand_request(request_id) ⇒ Object 



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
1198
1199
1200
1201
1202
 
# File 'lib/vmpooler/api/v3.rb', line 1169

def delete_ondemand_request(request_id)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do |span|
    span.set_attribute('vmpooler.request_id', request_id)
    result = { 'ok' => false }

    platforms = backend.hget("vmpooler__odrequest__#{request_id}", 'requested')
    unless platforms
      e_message = "no request found for request_id '#{request_id}'"
      result['message'] = e_message
      span.add_event('error', attributes: {
        'error.type' => 'Vmpooler::API::V3.delete_ondemand_request',
        'error.message' => e_message
      })
      return result
    end

    if backend.hget("vmpooler__odrequest__#{request_id}", 'status') == 'deleted'
      result['message'] = 'the request has already been deleted'
    else
      backend.hset("vmpooler__odrequest__#{request_id}", 'status', 'deleted')

      Parsing.get_platform_pool_count(platforms) do |platform_alias, pool, _count|
        backend.smembers("vmpooler__#{request_id}__#{platform_alias}__#{pool}")&.each do |vm|
          backend.smove("vmpooler__running__#{pool}", "vmpooler__completed__#{pool}", vm)
        end
        backend.del("vmpooler__#{request_id}__#{platform_alias}__#{pool}")
      end
      backend.expire("vmpooler__odrequest__#{request_id}", 129_600_0)
    end
    status 200
    result['ok'] = true
    result
  end
end

#evaluate_template_aliases(template, count) ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/vmpooler/api/v3.rb', line 94

def evaluate_template_aliases(template, count)
  template_backends = []
  template_backends << template if backend.sismember('vmpooler__pools', template)
  selection = []
  aliases = get_template_aliases(template)
  if aliases
    template_backends += aliases
    weighted_pools = get_pool_weights(template_backends)

    if weighted_pools.count > 1 && weighted_pools.count == template_backends.count
      pickup = Pickup.new(weighted_pools)
      count.to_i.times do
        selection << pickup.pick
      end
    else
      count.to_i.times do
        selection << template_backends.sample
      end
    end
  end

  count_selection(selection)
end

#extract_templates_from_query_params(params) ⇒ Object 



1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
 
# File 'lib/vmpooler/api/v3.rb', line 1108

def extract_templates_from_query_params(params)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    payload = {}

    params.split('+').each do |template|
      payload[template] ||= 0
      payload[template] += 1
    end

    payload
  end
end

#fetch_single_vm(template) ⇒ Tuple

Fetch a single vm from a pool

Parameters:

  • template (String) —

    The template that the vm should be created from

Returns:

  • (Tuple) —

    vmname, vmpool, vmtemplate Returns a tuple containing the vm’s name, the pool it came from, and what template was used, if successful. Otherwise the tuple contains. nil values.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/vmpooler/api/v3.rb', line 127

def fetch_single_vm(template)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    template_backends = [template]
    aliases = Vmpooler::API.settings.config[:alias]
    if aliases
      template_backends += aliases[template] if aliases[template].is_a?(Array)
      template_backends << aliases[template] if aliases[template].is_a?(String)
      pool_index = pool_index(pools)
      weighted_pools = {}
      template_backends.each do |t|
        next unless pool_index.key? t

        index = pool_index[t]
        clone_target = pools[index]['clone_target'] || config['clone_target']
        next unless config.key?('backend_weight')

        weight = config['backend_weight'][clone_target]
        if weight
          weighted_pools[t] = weight
        end
      end

      if weighted_pools.count == template_backends.count
        pickup = Pickup.new(weighted_pools)
        selection = pickup.pick
        template_backends.delete(selection)
        template_backends.unshift(selection)
      else
        first = template_backends.sample
        template_backends.delete(first)
        template_backends.unshift(first)
      end
    end

    checkoutlock.synchronize do
      template_backends.each do |template_backend|
        vms = backend.smembers("vmpooler__ready__#{template_backend}")
        next if vms.empty?

        vm = vms.pop
        smoved = backend.smove("vmpooler__ready__#{template_backend}", "vmpooler__running__#{template_backend}", vm)
        if smoved
          return [vm, template_backend, template]
        end
      end
      [nil, nil, nil]
    end
  end
end

#full_config ⇒ Object 



28
29
30
 
# File 'lib/vmpooler/api/v3.rb', line 28

def full_config
  Vmpooler::API.settings.config
end

#generate_ondemand_request(payload) ⇒ Object 



515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
 
# File 'lib/vmpooler/api/v3.rb', line 515

def generate_ondemand_request(payload)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do |span|
    result = { 'ok': false }

    requested_instances = payload.reject { |k, _v| k == 'request_id' }
    if too_many_requested?(requested_instances)
      e_message = "requested amount of instances exceeds the maximum #{config['max_ondemand_instances_per_request']}"
      result['message'] = e_message
      status 403
      span.add_event('error', attributes: {
        'error.type' => 'Vmpooler::API::V3.generate_ondemand_request',
        'error.message' => "403 due to #{e_message}"
      })
      return result
    end

    score = Time.now.to_i
    request_id = payload['request_id']
    request_id ||= generate_request_id
    result['request_id'] = request_id
    span.set_attribute('vmpooler.request_id', request_id)

    if backend.exists?("vmpooler__odrequest__#{request_id}")
      e_message = "request_id '#{request_id}' has already been created"
      result['message'] = e_message
      status 409
      span.add_event('error', attributes: {
        'error.type' => 'Vmpooler::API::V3.generate_ondemand_request',
        'error.message' => "409 due to #{e_message}"
      })
      metrics.increment('ondemandrequest_generate.duplicaterequests')
      return result
    end

    status 201

    platforms_with_aliases = []
    requested_instances.each do |poolname, count|
      selection = evaluate_template_aliases(poolname, count)
      selection.map { |selected_pool, selected_pool_count| platforms_with_aliases << "#{poolname}:#{selected_pool}:#{selected_pool_count}" }
    end
    platforms_string = platforms_with_aliases.join(',')

    return result unless backend.zadd('vmpooler__provisioning__request', score, request_id)

    backend.hset("vmpooler__odrequest__#{request_id}", 'requested', platforms_string)
    if Vmpooler::API.settings.config[:auth] and has_token?
      token_token = request.env['HTTP_X_AUTH_TOKEN']
      token_user = backend.hget("vmpooler__token__#{token_token}", 'user')
      backend.hset("vmpooler__odrequest__#{request_id}", 'token:token', token_token)
      backend.hset("vmpooler__odrequest__#{request_id}", 'token:user', token_user)
      span.set_attribute('enduser.id', token_user)
    end

    result[:ok] = true
    metrics.increment('ondemandrequest_generate.success')
    result
  end
end

#generate_request_id ⇒ Object 



575
576
577
 
# File 'lib/vmpooler/api/v3.rb', line 575

def generate_request_id
  SecureRandom.uuid
end

#get_pool_weights(template_backends) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/vmpooler/api/v3.rb', line 68

def get_pool_weights(template_backends)
  pool_index = pool_index(pools)
  weighted_pools = {}
  template_backends.each do |t|
    next unless pool_index.key? t

    index = pool_index[t]
    clone_target = pools[index]['clone_target'] || config['clone_target']
    next unless config.key?('backend_weight')

    weight = config['backend_weight'][clone_target]
    if weight
      weighted_pools[t] = weight
    end
  end
  weighted_pools
end

#get_template_aliases(template) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/vmpooler/api/v3.rb', line 56

def get_template_aliases(template)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    result = []
    aliases = Vmpooler::API.settings.config[:alias]
    if aliases
      result += aliases[template] if aliases[template].is_a?(Array)
      template_backends << aliases[template] if aliases[template].is_a?(String)
    end
    result
  end
end

#invalid_pool(payload) ⇒ Object 



1159
1160
1161
1162
1163
1164
1165
1166
1167
 
# File 'lib/vmpooler/api/v3.rb', line 1159

def invalid_pool(payload)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    invalid = []
    payload.each do |pool, _clone_target|
      invalid << pool unless pool_exists?(pool)
    end
    invalid
  end
end

#invalid_template_or_path(payload) ⇒ Object 



1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
 
# File 'lib/vmpooler/api/v3.rb', line 1146

def invalid_template_or_path(payload)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    invalid = []
    payload.each do |pool, template|
      invalid << pool unless pool_exists?(pool)
      invalid << pool unless template.include? '/'
      invalid << pool if template[0] == '/'
      invalid << pool if template[-1] == '/'
    end
    invalid
  end
end

#invalid_template_or_size(payload) ⇒ Object 



1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
 
# File 'lib/vmpooler/api/v3.rb', line 1131

def invalid_template_or_size(payload)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    invalid = []
    payload.each do |pool, size|
      invalid << pool unless pool_exists?(pool)
      unless is_integer?(size)
        invalid << pool
        next
      end
      invalid << pool unless Integer(size) >= 0
    end
    invalid
  end
end

#invalid_templates(payload) ⇒ Object 



1121
1122
1123
1124
1125
1126
1127
1128
1129
 
# File 'lib/vmpooler/api/v3.rb', line 1121

def invalid_templates(payload)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    invalid = []
    payload.keys.each do |template|
      invalid << template unless pool_exists?(template)
    end
    invalid
  end
end

#metrics ⇒ Object 



20
21
22
 
# File 'lib/vmpooler/api/v3.rb', line 20

def metrics
  Vmpooler::API.settings.metrics
end

#need_auth! ⇒ Object 



44
45
46
 
# File 'lib/vmpooler/api/v3.rb', line 44

def need_auth!
  validate_auth(backend)
end

#need_token! ⇒ Object 



48
49
50
 
# File 'lib/vmpooler/api/v3.rb', line 48

def need_token!
  validate_token(backend)
end

#pool_exists?(template) ⇒ Boolean

Returns:

  • (Boolean) 


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

def pool_exists?(template)
  Vmpooler::API.settings.config[:pool_names].include?(template)
end

#pools ⇒ Object 



32
33
34
 
# File 'lib/vmpooler/api/v3.rb', line 32

def pools
  Vmpooler::API.settings.config[:pools]
end

#pools_at_startup ⇒ Object 



36
37
38
 
# File 'lib/vmpooler/api/v3.rb', line 36

def pools_at_startup
  Vmpooler::API.settings.config[:pools_at_startup]
end

#reset_pool(payload) ⇒ Object 



432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/vmpooler/api/v3.rb', line 432

def reset_pool(payload)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    result = { 'ok' => false }

    payload.each do |poolname, _count|
      backend.sadd('vmpooler__poolreset', poolname)
    end
    status 201
    result['ok'] = true
    result
  end
end

#reset_pool_size(poolname) ⇒ Object 



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/vmpooler/api/v3.rb', line 331

def reset_pool_size(poolname)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    result = { 'ok' => false }

    pool_index = pool_index(pools)

    pools_updated = 0
    sync_pool_sizes

    pool_size_now = pools[pool_index[poolname]]['size'].to_i
    pool_size_original = pools_at_startup[pool_index[poolname]]['size'].to_i
    result['pool_size_before_reset'] = pool_size_now
    result['pool_size_before_overrides'] = pool_size_original

    unless pool_size_now == pool_size_original
      pools[pool_index[poolname]]['size'] = pool_size_original
      backend.hdel('vmpooler__config__poolsize', poolname)
      backend.sadd('vmpooler__pool__undo_size_override', poolname)
      pools_updated += 1
      status 201
    end

    status 200 unless pools_updated > 0
    result['ok'] = true
    result
  end
end

#reset_pool_template(poolname) ⇒ Object 



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
 
# File 'lib/vmpooler/api/v3.rb', line 381

def reset_pool_template(poolname)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    result = { 'ok' => false }

    pool_index_live = pool_index(pools)
    pool_index_original = pool_index(pools_at_startup)

    pools_updated = 0
    sync_pool_templates

    template_now = pools[pool_index_live[poolname]]['template']
    template_original = pools_at_startup[pool_index_original[poolname]]['template']
    result['template_before_reset'] = template_now
    result['template_before_overrides'] = template_original

    unless template_now == template_original
      pools[pool_index_live[poolname]]['template'] = template_original
      backend.hdel('vmpooler__config__template', poolname)
      backend.sadd('vmpooler__pool__undo_template_override', poolname)
      pools_updated += 1
      status 201
    end

    status 200 unless pools_updated > 0
    result['ok'] = true
    result
  end
end

#return_vm_to_ready_state(template, vm) ⇒ Object 



177
178
179
180
181
182
183
184
 
# File 'lib/vmpooler/api/v3.rb', line 177

def return_vm_to_ready_state(template, vm)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    backend.srem("vmpooler__migrating__#{template}", vm)
    backend.hdel("vmpooler__active__#{template}", vm)
    backend.hdel("vmpooler__vm__#{vm}", 'checkout', 'token:token', 'token:user')
    backend.smove("vmpooler__running__#{template}", "vmpooler__ready__#{template}", vm)
  end
end

#sync_clone_targets ⇒ Object 



491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/vmpooler/api/v3.rb', line 491

def sync_clone_targets
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    pool_index = pool_index(pools)
    clone_target_configs = backend.hgetall('vmpooler__config__clone_target')
    clone_target_configs&.each do |poolname, clone_target|
      next unless pool_index.include? poolname

      pools[pool_index[poolname]]['clone_target'] = clone_target
    end
  end
end

#sync_pool_sizes ⇒ Object 



479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/vmpooler/api/v3.rb', line 479

def sync_pool_sizes
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    pool_index = pool_index(pools)
    poolsize_configs = backend.hgetall('vmpooler__config__poolsize')
    poolsize_configs&.each do |poolname, size|
      next unless pool_index.include? poolname

      pools[pool_index[poolname]]['size'] = size.to_i
    end
  end
end

#sync_pool_templates ⇒ Object 



467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/vmpooler/api/v3.rb', line 467

def sync_pool_templates
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    pool_index = pool_index(pools)
    template_configs = backend.hgetall('vmpooler__config__template')
    template_configs&.each do |poolname, template|
      next unless pool_index.include? poolname

      pools[pool_index[poolname]]['template'] = template
    end
  end
end

#too_many_requested?(payload) ⇒ Boolean

Returns:

  • (Boolean) 


503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/vmpooler/api/v3.rb', line 503

def too_many_requested?(payload)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    payload&.each do |poolname, count|
      next unless count.to_i > config['max_ondemand_instances_per_request']

      metrics.increment("ondemandrequest_fail.toomanyrequests.#{poolname}")
      return true
    end
    false
  end
end

#update_clone_target(payload) ⇒ Object 



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/vmpooler/api/v3.rb', line 445

def update_clone_target(payload)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    result = { 'ok' => false }

    pool_index = pool_index(pools)
    pools_updated = 0
    sync_clone_targets

    payload.each do |poolname, clone_target|
      unless pools[pool_index[poolname]]['clone_target'] == clone_target
        pools[pool_index[poolname]]['clone_target'] = clone_target
        backend.hset('vmpooler__config__clone_target', poolname, clone_target)
        pools_updated += 1
        status 201
      end
    end
    status 200 unless pools_updated > 0
    result['ok'] = true
    result
  end
end

#update_pool_size(payload) ⇒ Object 



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/vmpooler/api/v3.rb', line 359

def update_pool_size(payload)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    result = { 'ok' => false }

    pool_index = pool_index(pools)
    pools_updated = 0
    sync_pool_sizes

    payload.each do |poolname, size|
      unless pools[pool_index[poolname]]['size'] == size.to_i
        pools[pool_index[poolname]]['size'] = size.to_i
        backend.hset('vmpooler__config__poolsize', poolname, size)
        pools_updated += 1
        status 201
      end
    end
    status 200 unless pools_updated > 0
    result['ok'] = true
    result
  end
end

#update_pool_template(payload) ⇒ Object 



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/vmpooler/api/v3.rb', line 410

def update_pool_template(payload)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    result = { 'ok' => false }

    pool_index = pool_index(pools)
    pools_updated = 0
    sync_pool_templates

    payload.each do |poolname, template|
      unless pools[pool_index[poolname]]['template'] == template
        pools[pool_index[poolname]]['template'] = template
        backend.hset('vmpooler__config__template', poolname, template)
        pools_updated += 1
        status 201
      end
    end
    status 200 unless pools_updated > 0
    result['ok'] = true
    result
  end
end

#update_result_hosts(result, template, vm) ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/vmpooler/api/v3.rb', line 206

def update_result_hosts(result, template, vm)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do
    result[template] ||= {}
    if result[template]['hostname']
      result[template]['hostname'] = Array(result[template]['hostname'])
      result[template]['hostname'].push(vm)
    else
      result[template]['hostname'] = vm
    end
  end
end

#update_user_metrics(operation, vmname) ⇒ Object 



283
284
285
286
287
288
289
290
291
292
293
294
295
296
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
325
326
327
328
329
 
# File 'lib/vmpooler/api/v3.rb', line 283

def update_user_metrics(operation, vmname)
  tracer.in_span("Vmpooler::API::V3.#{__method__}") do |span|
    begin
      jenkins_build_url = backend.hget("vmpooler__vm__#{vmname}", 'tag:jenkins_build_url')
      user = backend.hget("vmpooler__vm__#{vmname}", 'token:user')
      poolname = backend.hget("vmpooler__vm__#{vmname}", 'template')
      poolname = poolname.gsub('.', '_')

      if user
        user = user.gsub('.', '_')
      else
        user = 'unauthenticated'
      end
      metrics.increment("user.#{user}.#{operation}.#{poolname}")

      if jenkins_build_url
        if jenkins_build_url.include? 'litmus'
          # Very simple filter for Litmus jobs - just count them coming through for the moment.
          metrics.increment("usage_litmus.#{user}.#{operation}.#{poolname}")
        else
          url_parts = jenkins_build_url.split('/')[2..]
          jenkins_instance = url_parts[0].gsub('.', '_')
          value_stream_parts = url_parts[2].split('_')
          value_stream_parts = value_stream_parts.map { |s| s.gsub('.', '_') }
          value_stream = value_stream_parts.shift
          branch = value_stream_parts.pop
          project = value_stream_parts.shift
          job_name = value_stream_parts.join('_')
          build_metadata_parts = url_parts[3]
          component_to_test = component_to_test('RMM_COMPONENT_TO_TEST_NAME', build_metadata_parts)

          metrics.increment("usage_jenkins_instance.#{jenkins_instance}.#{value_stream}.#{operation}.#{poolname}")
          metrics.increment("usage_branch_project.#{branch}.#{project}.#{operation}.#{poolname}")
          metrics.increment("usage_job_component.#{job_name}.#{component_to_test}.#{operation}.#{poolname}")
        end
      end
    rescue StandardError => e
      puts 'd', "[!] [#{poolname}] failed while evaluating usage labels on '#{vmname}' with an error: #{e}"
      span.record_exception(e)
      span.status = OpenTelemetry::Trace::Status.error(e.to_s)
      span.add_event('log', attributes: {
        'log.severity' => 'debug',
        'log.message' => "[#{poolname}] failed while evaluating usage labels on '#{vmname}' with an error: #{e}"
      })
    end
  end
end