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 



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/vmpooler/api/v1.rb', line 169

def (template, vm)
  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?
    validate_token(backend)

    backend.hset('vmpooler__vm__' + vm, 'token:token', request.env['HTTP_X_AUTH_TOKEN'])
    backend.hset('vmpooler__vm__' + vm, 'token:user',
                 backend.hget('vmpooler__token__' + request.env['HTTP_X_AUTH_TOKEN'], 'user')
    )

    if config['vm_lifetime_auth'].to_i > 0
      backend.hset('vmpooler__vm__' + vm, 'lifetime', config['vm_lifetime_auth'].to_i)
    end
  end
end

#atomically_allocate_vms(payload) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/vmpooler/api/v1.rb', line 198

def atomically_allocate_vms(payload)
  result = { 'ok' => false }
  failed = false
  vms = []

  payload.each do |requested, count|
    count.to_i.times do |_i|
      vmname, vmpool, vmtemplate = fetch_single_vm(requested)
      if !vmname
        failed = true
        metrics.increment('checkout.empty.' + requested)
        break
      else
        vms << [vmpool, vmname, vmtemplate]
        metrics.increment('checkout.success.' + vmtemplate)
      end
    end
  end

  if failed
    vms.each do |(vmpool, vmname, _vmtemplate)|
      return_vm_to_ready_state(vmpool, vmname)
    end
    status 503
  else
    vms.each do |(vmpool, vmname, vmtemplate)|
      (vmpool, vmname)
      update_result_hosts(result, vmtemplate, vmname)
    end

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

  result
end

#backend ⇒ Object 



13
14
15
 
# File 'lib/vmpooler/api/v1.rb', line 13

def backend
  Vmpooler::API.settings.redis
end

#check_ondemand_request(request_id) ⇒ Object 



962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/vmpooler/api/v1.rb', line 962

def check_ondemand_request(request_id)
  result = { 'ok' => false }
  request_hash = backend.hgetall("vmpooler__odrequest__#{request_id}")
  if request_hash.empty?
    result['message'] = "no request found for request_id '#{request_id}'"
    return result
  end

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

  if request_hash['status'] == 'ready'
    result['ready'] = true
    platform_parts = request_hash['requested'].split(',')
    platform_parts.each do |platform|
      pool_alias, pool, _count = platform.split(':')
      instances = backend.smembers("vmpooler__#{request_id}__#{pool_alias}__#{pool}")
      result[pool_alias] = { 'hostname': instances }
    end
    result['domain'] = config['domain'] if config['domain']
    status 200
  elsif request_hash['status'] == 'failed'
    result['message'] = "The request failed to provision instances within the configured ondemand_request_ttl '#{config['ondemand_request_ttl']}'"
    status 200
  elsif request_hash['status'] == 'deleted'
    result['message'] = 'The request has been deleted'
    status 200
  else
    platform_parts = request_hash['requested'].split(',')
    platform_parts.each do |platform|
      pool_alias, pool, count = platform.split(':')
      instance_count = backend.scard("vmpooler__#{request_id}__#{pool_alias}__#{pool}")
      result[pool_alias] = {
        'ready': instance_count.to_s,
        'pending': (count.to_i - instance_count.to_i).to_s
      }
    end
  end

  result
end

#checkoutlock ⇒ Object 



41
42
43
 
# File 'lib/vmpooler/api/v1.rb', line 41

def checkoutlock
  Vmpooler::API.settings.checkoutlock
end

#config ⇒ Object 



21
22
23
 
# File 'lib/vmpooler/api/v1.rb', line 21

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

#count_selection(selection) ⇒ Object 



73
74
75
76
77
78
79
 
# File 'lib/vmpooler/api/v1.rb', line 73

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

#delete_ondemand_request(request_id) ⇒ Object 



1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
 
# File 'lib/vmpooler/api/v1.rb', line 1006

def delete_ondemand_request(request_id)
  result = { 'ok' => false }

  platforms = backend.hget("vmpooler__odrequest__#{request_id}", 'requested')
  unless platforms
    result['message'] = "no request found for request_id '#{request_id}'"
    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')

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

#evaluate_template_aliases(template, count) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/vmpooler/api/v1.rb', line 81

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)

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

  count_selection(selection)
end

#extract_templates_from_query_params(params) ⇒ Object 



911
912
913
914
915
916
917
918
919
920
 
# File 'lib/vmpooler/api/v1.rb', line 911

def extract_templates_from_query_params(params)
  payload = {}

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

  payload
end

#fetch_single_vm(template) ⇒ Object 



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

def fetch_single_vm(template)
  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

#generate_ondemand_request(payload) ⇒ Object 



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
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
 
# File 'lib/vmpooler/api/v1.rb', line 345

def generate_ondemand_request(payload)
  result = { 'ok': false }

  requested_instances = payload.reject { |k, _v| k == 'request_id' }
  if too_many_requested?(requested_instances)
    result['message'] = "requested amount of instances exceeds the maximum #{config['max_ondemand_instances_per_request']}"
    status 403
    return result
  end

  score = Time.now.to_i
  request_id = payload['request_id']
  request_id ||= generate_request_id
  result['request_id'] = request_id

  if backend.exists("vmpooler__odrequest__#{request_id}")
    result['message'] = "request_id '#{request_id}' has already been created"
    status 409
    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?
    backend.hset("vmpooler__odrequest__#{request_id}", 'token:token', request.env['HTTP_X_AUTH_TOKEN'])
    backend.hset("vmpooler__odrequest__#{request_id}", 'token:user',
                 backend.hget('vmpooler__token__' + request.env['HTTP_X_AUTH_TOKEN'], 'user'))
  end

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

#generate_request_id ⇒ Object 



389
390
391
 
# File 'lib/vmpooler/api/v1.rb', line 389

def generate_request_id
  SecureRandom.uuid
end

#get_pool_weights(template_backends) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/vmpooler/api/v1.rb', line 55

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 



45
46
47
48
49
50
51
52
53
 
# File 'lib/vmpooler/api/v1.rb', line 45

def get_template_aliases(template)
  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

#invalid_pool(payload) ⇒ Object 



954
955
956
957
958
959
960
 
# File 'lib/vmpooler/api/v1.rb', line 954

def invalid_pool(payload)
  invalid = []
  payload.each do |pool, _clone_target|
    invalid << pool unless pool_exists?(pool)
  end
  invalid
end

#invalid_template_or_path(payload) ⇒ Object 



943
944
945
946
947
948
949
950
951
952
 
# File 'lib/vmpooler/api/v1.rb', line 943

def invalid_template_or_path(payload)
  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

#invalid_template_or_size(payload) ⇒ Object 



930
931
932
933
934
935
936
937
938
939
940
941
 
# File 'lib/vmpooler/api/v1.rb', line 930

def invalid_template_or_size(payload)
  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

#invalid_templates(payload) ⇒ Object 



922
923
924
925
926
927
928
 
# File 'lib/vmpooler/api/v1.rb', line 922

def invalid_templates(payload)
  invalid = []
  payload.keys.each do |template|
    invalid << template unless pool_exists?(template)
  end
  invalid
end

#metrics ⇒ Object 



17
18
19
 
# File 'lib/vmpooler/api/v1.rb', line 17

def metrics
  Vmpooler::API.settings.metrics
end

#need_auth! ⇒ Object 



33
34
35
 
# File 'lib/vmpooler/api/v1.rb', line 33

def need_auth!
  validate_auth(backend)
end

#need_token! ⇒ Object 



37
38
39
 
# File 'lib/vmpooler/api/v1.rb', line 37

def need_token!
  validate_token(backend)
end

#pool_exists?(template) ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/vmpooler/api/v1.rb', line 29

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

#pools ⇒ Object 



25
26
27
 
# File 'lib/vmpooler/api/v1.rb', line 25

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

#reset_pool(payload) ⇒ Object 



275
276
277
278
279
280
281
282
283
284
 
# File 'lib/vmpooler/api/v1.rb', line 275

def reset_pool(payload)
  result = { 'ok' => false }

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

#return_vm_to_ready_state(template, vm) ⇒ Object 



165
166
167
 
# File 'lib/vmpooler/api/v1.rb', line 165

def return_vm_to_ready_state(template, vm)
  backend.smove("vmpooler__running__#{template}", "vmpooler__ready__#{template}", vm)
end

#sync_clone_targets ⇒ Object 



326
327
328
329
330
331
332
333
334
 
# File 'lib/vmpooler/api/v1.rb', line 326

def sync_clone_targets
  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

#sync_pool_sizes ⇒ Object 



316
317
318
319
320
321
322
323
324
 
# File 'lib/vmpooler/api/v1.rb', line 316

def sync_pool_sizes
  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

#sync_pool_templates ⇒ Object 



306
307
308
309
310
311
312
313
314
 
# File 'lib/vmpooler/api/v1.rb', line 306

def sync_pool_templates
  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

#too_many_requested?(payload) ⇒ Boolean

Returns:

  • (Boolean) 


336
337
338
339
340
341
342
343
 
# File 'lib/vmpooler/api/v1.rb', line 336

def too_many_requested?(payload)
  payload&.each do |_poolname, count|
    next unless count.to_i > config['max_ondemand_instances_per_request']

    return true
  end
  false
end

#update_clone_target(payload) ⇒ Object 



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/vmpooler/api/v1.rb', line 286

def update_clone_target(payload)
  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

#update_pool_size(payload) ⇒ Object 



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/vmpooler/api/v1.rb', line 235

def update_pool_size(payload)
  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

#update_pool_template(payload) ⇒ Object 



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/vmpooler/api/v1.rb', line 255

def update_pool_template(payload)
  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

#update_result_hosts(result, template, vm) ⇒ Object 



188
189
190
191
192
193
194
195
196
 
# File 'lib/vmpooler/api/v1.rb', line 188

def update_result_hosts(result, template, vm)
  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