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 



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

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 



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

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

#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

#extract_templates_from_query_params(params) ⇒ Object 



711
712
713
714
715
716
717
718
719
720
 
# File 'lib/vmpooler/api/v1.rb', line 711

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 



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/vmpooler/api/v1.rb', line 45

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
          backend.smove("vmpooler__ready__#{template_backend}", "vmpooler__running__#{template_backend}", vm)
          return [vm, template_backend, template]
        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

#invalid_pool(payload) ⇒ Object 



754
755
756
757
758
759
760
 
# File 'lib/vmpooler/api/v1.rb', line 754

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 



743
744
745
746
747
748
749
750
751
752
 
# File 'lib/vmpooler/api/v1.rb', line 743

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 



730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/vmpooler/api/v1.rb', line 730

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 



722
723
724
725
726
727
728
 
# File 'lib/vmpooler/api/v1.rb', line 722

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 



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

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 



98
99
100
 
# File 'lib/vmpooler/api/v1.rb', line 98

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

#sync_clone_targets ⇒ Object 



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

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|
      if pool_index.include? poolname
        unless pools[pool_index[poolname]]['clone_target'] == clone_target
          pools[pool_index[poolname]]['clone_target'] == clone_target
        end
      end
  end
end

#sync_pool_sizes ⇒ Object 



251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/vmpooler/api/v1.rb', line 251

def sync_pool_sizes
  pool_index = pool_index(pools)
  poolsize_configs = backend.hgetall('vmpooler__config__poolsize')
  poolsize_configs&.each do |poolname, size|
      if pool_index.include? poolname
        unless pools[pool_index[poolname]]['size'] == size.to_i
          pools[pool_index[poolname]]['size'] == size.to_i
        end
      end
  end
end

#sync_pool_templates ⇒ Object 



239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/vmpooler/api/v1.rb', line 239

def sync_pool_templates
  pool_index = pool_index(pools)
  template_configs = backend.hgetall('vmpooler__config__template')
  template_configs&.each do |poolname, template|
      if pool_index.include? poolname
        unless pools[pool_index[poolname]]['template'] == template
          pools[pool_index[poolname]]['template'] = template
        end
      end
  end
end

#update_clone_target(payload) ⇒ Object 



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/vmpooler/api/v1.rb', line 219

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 



168
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 168

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 



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

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 



121
122
123
124
125
126
127
128
129
 
# File 'lib/vmpooler/api/v1.rb', line 121

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