Class: Vmpooler::API::V1

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

Instance Method Summary collapse

Instance Method Details

#account_for_starting_vm(template, vm) ⇒ Object 



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/vmpooler/api/v1.rb', line 182

def (template, vm)
  tracer.in_span("Vmpooler::API::V1.#{__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)
    backend.hset("vmpooler__vm__#{vm}", 'checkout', Time.now)

    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 



214
215
216
217
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
 
# File 'lib/vmpooler/api/v1.rb', line 214

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

    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::V1.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)|
        update_result_hosts(result, vmtemplate, vmname)
        vm_names.append(vmname)
      end

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

      result['ok'] = true
      result['domain'] = config['domain'] if config['domain']
    end

    result
  end
end

#backend ⇒ Object 



15
16
17
 
# File 'lib/vmpooler/api/v1.rb', line 15

def backend
  Vmpooler::API.settings.redis
end

#check_ondemand_request(request_id) ⇒ Object 



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

def check_ondemand_request(request_id)
  tracer.in_span("Vmpooler::API::V1.#{__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::V1.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}")

        if result.key?(platform_alias)
          result[platform_alias][:hostname] = result[platform_alias][:hostname] + instances
        else
          result[platform_alias] = { 'hostname': instances }
        end
      end
      result['domain'] = config['domain'] if config['domain']
      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 



47
48
49
 
# File 'lib/vmpooler/api/v1.rb', line 47

def checkoutlock
  Vmpooler::API.settings.checkoutlock
end

#component_to_test(match, labels_string) ⇒ Object 



264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/vmpooler/api/v1.rb', line 264

def component_to_test(match, labels_string)
  tracer.in_span("Vmpooler::API::V1.#{__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 



23
24
25
 
# File 'lib/vmpooler/api/v1.rb', line 23

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

#count_selection(selection) ⇒ Object 



81
82
83
84
85
86
87
 
# File 'lib/vmpooler/api/v1.rb', line 81

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

#delete_ondemand_request(request_id) ⇒ Object 



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

def delete_ondemand_request(request_id)
  tracer.in_span("Vmpooler::API::V1.#{__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::V1.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 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/vmpooler/api/v1.rb', line 89

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 



1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
 
# File 'lib/vmpooler/api/v1.rb', line 1106

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

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

    payload
  end
end

#fetch_single_vm(template) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/vmpooler/api/v1.rb', line 113

def fetch_single_vm(template)
  tracer.in_span("Vmpooler::API::V1.#{__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?

        vms.reverse.each do |vm|
          ready = vm_ready?(vm, config['domain'])
          if ready
            smoved = backend.smove("vmpooler__ready__#{template_backend}", "vmpooler__running__#{template_backend}", vm)
            if smoved
              return [vm, template_backend, template]
            else
              metrics.increment("checkout.smove.failed.#{template_backend}")
              return [nil, nil, nil]
            end
          else
            backend.smove("vmpooler__ready__#{template_backend}", "vmpooler__completed__#{template_backend}", vm)
            metrics.increment("checkout.nonresponsive.#{template_backend}")
          end
        end
      end
      [nil, nil, nil]
    end
  end
end

#generate_ondemand_request(payload) ⇒ Object 



512
513
514
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
 
# File 'lib/vmpooler/api/v1.rb', line 512

def generate_ondemand_request(payload)
  tracer.in_span("Vmpooler::API::V1.#{__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::V1.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::V1.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['domain'] = config['domain'] if config['domain']
    result[:ok] = true
    metrics.increment('ondemandrequest_generate.success')
    result
  end
end

#generate_request_id ⇒ Object 



573
574
575
 
# File 'lib/vmpooler/api/v1.rb', line 573

def generate_request_id
  SecureRandom.uuid
end

#get_pool_weights(template_backends) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/vmpooler/api/v1.rb', line 63

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 



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/vmpooler/api/v1.rb', line 51

def get_template_aliases(template)
  tracer.in_span("Vmpooler::API::V1.#{__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 



1157
1158
1159
1160
1161
1162
1163
1164
1165
 
# File 'lib/vmpooler/api/v1.rb', line 1157

def invalid_pool(payload)
  tracer.in_span("Vmpooler::API::V1.#{__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 



1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
 
# File 'lib/vmpooler/api/v1.rb', line 1144

def invalid_template_or_path(payload)
  tracer.in_span("Vmpooler::API::V1.#{__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 



1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
 
# File 'lib/vmpooler/api/v1.rb', line 1129

def invalid_template_or_size(payload)
  tracer.in_span("Vmpooler::API::V1.#{__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 



1119
1120
1121
1122
1123
1124
1125
1126
1127
 
# File 'lib/vmpooler/api/v1.rb', line 1119

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

#metrics ⇒ Object 



19
20
21
 
# File 'lib/vmpooler/api/v1.rb', line 19

def metrics
  Vmpooler::API.settings.metrics
end

#need_auth! ⇒ Object 



39
40
41
 
# File 'lib/vmpooler/api/v1.rb', line 39

def need_auth!
  validate_auth(backend)
end

#need_token! ⇒ Object 



43
44
45
 
# File 'lib/vmpooler/api/v1.rb', line 43

def need_token!
  validate_token(backend)
end

#pool_exists?(template) ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/vmpooler/api/v1.rb', line 35

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

#pools ⇒ Object 



27
28
29
 
# File 'lib/vmpooler/api/v1.rb', line 27

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

#pools_at_startup ⇒ Object 



31
32
33
 
# File 'lib/vmpooler/api/v1.rb', line 31

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

#reset_pool(payload) ⇒ Object 



429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/vmpooler/api/v1.rb', line 429

def reset_pool(payload)
  tracer.in_span("Vmpooler::API::V1.#{__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 



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

def reset_pool_size(poolname)
  tracer.in_span("Vmpooler::API::V1.#{__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 



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
405
 
# File 'lib/vmpooler/api/v1.rb', line 378

def reset_pool_template(poolname)
  tracer.in_span("Vmpooler::API::V1.#{__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 



173
174
175
176
177
178
179
180
 
# File 'lib/vmpooler/api/v1.rb', line 173

def return_vm_to_ready_state(template, vm)
  tracer.in_span("Vmpooler::API::V1.#{__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 



488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/vmpooler/api/v1.rb', line 488

def sync_clone_targets
  tracer.in_span("Vmpooler::API::V1.#{__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 



476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/vmpooler/api/v1.rb', line 476

def sync_pool_sizes
  tracer.in_span("Vmpooler::API::V1.#{__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 



464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/vmpooler/api/v1.rb', line 464

def sync_pool_templates
  tracer.in_span("Vmpooler::API::V1.#{__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) 


500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/vmpooler/api/v1.rb', line 500

def too_many_requested?(payload)
  tracer.in_span("Vmpooler::API::V1.#{__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 



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/vmpooler/api/v1.rb', line 442

def update_clone_target(payload)
  tracer.in_span("Vmpooler::API::V1.#{__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 



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

def update_pool_size(payload)
  tracer.in_span("Vmpooler::API::V1.#{__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 



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/vmpooler/api/v1.rb', line 407

def update_pool_template(payload)
  tracer.in_span("Vmpooler::API::V1.#{__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 



202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/vmpooler/api/v1.rb', line 202

def update_result_hosts(result, template, vm)
  tracer.in_span("Vmpooler::API::V1.#{__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 



278
279
280
281
282
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
 
# File 'lib/vmpooler/api/v1.rb', line 278

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

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

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

          metrics.increment("usage_jenkins_instance.#{jenkins_instance}.#{value_stream}.#{operation}.#{poolname}")
          metrics.increment("usage_branch_project.#{branch}.#{project}.#{operation}.#{poolname}")
          metrics.increment("usage_job_component.#{job_name}.#{component_to_test}.#{operation}.#{poolname}")
        end
      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