root / snf-app / synnefo / api / servers.py @ 483c9197
History | View | Annotate | Download (18.9 kB)
1 |
# Copyright 2011 GRNET S.A. All rights reserved.
|
---|---|
2 |
#
|
3 |
# Redistribution and use in source and binary forms, with or
|
4 |
# without modification, are permitted provided that the following
|
5 |
# conditions are met:
|
6 |
#
|
7 |
# 1. Redistributions of source code must retain the above
|
8 |
# copyright notice, this list of conditions and the following
|
9 |
# disclaimer.
|
10 |
#
|
11 |
# 2. Redistributions in binary form must reproduce the above
|
12 |
# copyright notice, this list of conditions and the following
|
13 |
# disclaimer in the documentation and/or other materials
|
14 |
# provided with the distribution.
|
15 |
#
|
16 |
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
|
17 |
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
18 |
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
19 |
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
|
20 |
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
21 |
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
22 |
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
23 |
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
24 |
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
25 |
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
26 |
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
27 |
# POSSIBILITY OF SUCH DAMAGE.
|
28 |
#
|
29 |
# The views and conclusions contained in the software and
|
30 |
# documentation are those of the authors and should not be
|
31 |
# interpreted as representing official policies, either expressed
|
32 |
# or implied, of GRNET S.A.
|
33 |
|
34 |
from base64 import b64decode |
35 |
|
36 |
from django.conf import settings |
37 |
from django.conf.urls.defaults import patterns |
38 |
from django.http import HttpResponse |
39 |
from django.template.loader import render_to_string |
40 |
from django.utils import simplejson as json |
41 |
|
42 |
from synnefo.api import faults, util |
43 |
from synnefo.api.actions import server_actions |
44 |
from synnefo.api.common import method_not_allowed |
45 |
from synnefo.db.models import VirtualMachine, VirtualMachineMetadata |
46 |
from synnefo.logic.backend import create_instance, delete_instance |
47 |
from synnefo.logic.utils import get_rsapi_state |
48 |
from synnefo.util.rapi import GanetiApiError |
49 |
from synnefo.util.log import getLogger |
50 |
|
51 |
|
52 |
log = getLogger('synnefo.api')
|
53 |
|
54 |
urlpatterns = patterns('synnefo.api.servers',
|
55 |
(r'^(?:/|.json|.xml)?$', 'demux'), |
56 |
(r'^/detail(?:.json|.xml)?$', 'list_servers', {'detail': True}), |
57 |
(r'^/(\d+)(?:.json|.xml)?$', 'server_demux'), |
58 |
(r'^/(\d+)/action(?:.json|.xml)?$', 'server_action'), |
59 |
(r'^/(\d+)/ips(?:.json|.xml)?$', 'list_addresses'), |
60 |
(r'^/(\d+)/ips/(.+?)(?:.json|.xml)?$', 'list_addresses_by_network'), |
61 |
(r'^/(\d+)/meta(?:.json|.xml)?$', 'metadata_demux'), |
62 |
(r'^/(\d+)/meta/(.+?)(?:.json|.xml)?$', 'metadata_item_demux'), |
63 |
(r'^/(\d+)/stats(?:.json|.xml)?$', 'server_stats'), |
64 |
) |
65 |
|
66 |
|
67 |
def demux(request): |
68 |
if request.method == 'GET': |
69 |
return list_servers(request)
|
70 |
elif request.method == 'POST': |
71 |
return create_server(request)
|
72 |
else:
|
73 |
return method_not_allowed(request)
|
74 |
|
75 |
|
76 |
def server_demux(request, server_id): |
77 |
if request.method == 'GET': |
78 |
return get_server_details(request, server_id)
|
79 |
elif request.method == 'PUT': |
80 |
return update_server_name(request, server_id)
|
81 |
elif request.method == 'DELETE': |
82 |
return delete_server(request, server_id)
|
83 |
else:
|
84 |
return method_not_allowed(request)
|
85 |
|
86 |
|
87 |
def metadata_demux(request, server_id): |
88 |
if request.method == 'GET': |
89 |
return list_metadata(request, server_id)
|
90 |
elif request.method == 'POST': |
91 |
return update_metadata(request, server_id)
|
92 |
else:
|
93 |
return method_not_allowed(request)
|
94 |
|
95 |
|
96 |
def metadata_item_demux(request, server_id, key): |
97 |
if request.method == 'GET': |
98 |
return get_metadata_item(request, server_id, key)
|
99 |
elif request.method == 'PUT': |
100 |
return create_metadata_item(request, server_id, key)
|
101 |
elif request.method == 'DELETE': |
102 |
return delete_metadata_item(request, server_id, key)
|
103 |
else:
|
104 |
return method_not_allowed(request)
|
105 |
|
106 |
|
107 |
def nic_to_dict(nic): |
108 |
network = nic.network |
109 |
network_id = str(network.id) if not network.public else 'public' |
110 |
d = {'id': network_id, 'name': network.name, 'mac': nic.mac} |
111 |
if nic.firewall_profile:
|
112 |
d['firewallProfile'] = nic.firewall_profile
|
113 |
if nic.ipv4 or nic.ipv6: |
114 |
d['values'] = []
|
115 |
if nic.ipv4:
|
116 |
d['values'].append({'version': 4, 'addr': nic.ipv4}) |
117 |
if nic.ipv6:
|
118 |
d['values'].append({'version': 6, 'addr': nic.ipv6}) |
119 |
return d
|
120 |
|
121 |
|
122 |
def vm_to_dict(vm, detail=False): |
123 |
d = dict(id=vm.id, name=vm.name)
|
124 |
if detail:
|
125 |
d['status'] = get_rsapi_state(vm)
|
126 |
d['progress'] = 100 if get_rsapi_state(vm) == 'ACTIVE' \ |
127 |
else vm.buildpercentage
|
128 |
d['hostId'] = vm.hostid
|
129 |
d['updated'] = util.isoformat(vm.updated)
|
130 |
d['created'] = util.isoformat(vm.created)
|
131 |
d['flavorRef'] = vm.flavor.id
|
132 |
d['imageRef'] = vm.sourceimage.id
|
133 |
|
134 |
metadata = dict((m.meta_key, m.meta_value) for m in vm.metadata.all()) |
135 |
if metadata:
|
136 |
d['metadata'] = {'values': metadata} |
137 |
|
138 |
addresses = [nic_to_dict(nic) for nic in vm.nics.all()] |
139 |
if addresses:
|
140 |
d['addresses'] = {'values': addresses} |
141 |
return d
|
142 |
|
143 |
|
144 |
def render_server(request, server, status=200): |
145 |
if request.serialization == 'xml': |
146 |
data = render_to_string('server.xml', {
|
147 |
'server': server,
|
148 |
'is_root': True}) |
149 |
else:
|
150 |
data = json.dumps({'server': server})
|
151 |
return HttpResponse(data, status=status)
|
152 |
|
153 |
|
154 |
@util.api_method('GET') |
155 |
def list_servers(request, detail=False): |
156 |
# Normal Response Codes: 200, 203
|
157 |
# Error Response Codes: computeFault (400, 500),
|
158 |
# serviceUnavailable (503),
|
159 |
# unauthorized (401),
|
160 |
# badRequest (400),
|
161 |
# overLimit (413)
|
162 |
|
163 |
log.debug('list_servers detail=%s', detail)
|
164 |
user_vms = VirtualMachine.objects.filter(owner=request.user) |
165 |
since = util.isoparse(request.GET.get('changes-since'))
|
166 |
|
167 |
if since:
|
168 |
user_vms = user_vms.filter(updated__gte=since) |
169 |
if not user_vms: |
170 |
return HttpResponse(status=304) |
171 |
else:
|
172 |
user_vms = user_vms.filter(deleted=False)
|
173 |
|
174 |
servers = [vm_to_dict(server, detail) for server in user_vms] |
175 |
|
176 |
if request.serialization == 'xml': |
177 |
data = render_to_string('list_servers.xml', {
|
178 |
'servers': servers,
|
179 |
'detail': detail})
|
180 |
else:
|
181 |
data = json.dumps({'servers': {'values': servers}}) |
182 |
|
183 |
return HttpResponse(data, status=200) |
184 |
|
185 |
|
186 |
@util.api_method('POST') |
187 |
def create_server(request): |
188 |
# Normal Response Code: 202
|
189 |
# Error Response Codes: computeFault (400, 500),
|
190 |
# serviceUnavailable (503),
|
191 |
# unauthorized (401),
|
192 |
# badMediaType(415),
|
193 |
# itemNotFound (404),
|
194 |
# badRequest (400),
|
195 |
# serverCapacityUnavailable (503),
|
196 |
# overLimit (413)
|
197 |
|
198 |
req = util.get_request_dict(request) |
199 |
log.debug('create_server %s', req)
|
200 |
owner = request.user |
201 |
|
202 |
try:
|
203 |
server = req['server']
|
204 |
name = server['name']
|
205 |
metadata = server.get('metadata', {})
|
206 |
assert isinstance(metadata, dict) |
207 |
image_id = server['imageRef']
|
208 |
flavor_id = server['flavorRef']
|
209 |
personality = server.get('personality', [])
|
210 |
assert isinstance(personality, list) |
211 |
except (KeyError, AssertionError): |
212 |
raise faults.BadRequest("Malformed request") |
213 |
|
214 |
if len(personality) > settings.MAX_PERSONALITY: |
215 |
raise faults.OverLimit("Maximum number of personalities exceeded") |
216 |
|
217 |
for p in personality: |
218 |
# Verify that personalities are well-formed
|
219 |
try:
|
220 |
assert isinstance(p, dict) |
221 |
keys = set(p.keys())
|
222 |
allowed = set(['contents', 'group', 'mode', 'owner', 'path']) |
223 |
assert keys.issubset(allowed)
|
224 |
contents = p['contents']
|
225 |
if len(contents) > settings.MAX_PERSONALITY_SIZE: |
226 |
# No need to decode if contents already exceed limit
|
227 |
raise faults.OverLimit("Maximum size of personality exceeded") |
228 |
if len(b64decode(contents)) > settings.MAX_PERSONALITY_SIZE: |
229 |
raise faults.OverLimit("Maximum size of personality exceeded") |
230 |
except AssertionError: |
231 |
raise faults.BadRequest("Malformed personality in request") |
232 |
|
233 |
image = util.get_image(image_id, owner) |
234 |
flavor = util.get_flavor(flavor_id) |
235 |
password = util.random_password() |
236 |
|
237 |
count = VirtualMachine.objects.filter(owner=owner, deleted=False).count()
|
238 |
if count >= settings.MAX_VMS_PER_USER:
|
239 |
raise faults.OverLimit("Server count limit exceeded for your account.") |
240 |
|
241 |
# We must save the VM instance now, so that it gets a valid vm.backend_id.
|
242 |
vm = VirtualMachine.objects.create( |
243 |
name=name, |
244 |
owner=owner, |
245 |
sourceimage=image, |
246 |
flavor=flavor) |
247 |
|
248 |
try:
|
249 |
create_instance(vm, flavor, image, password, personality) |
250 |
except GanetiApiError:
|
251 |
vm.delete() |
252 |
raise
|
253 |
|
254 |
for key, val in metadata.items(): |
255 |
VirtualMachineMetadata.objects.create( |
256 |
meta_key=key, |
257 |
meta_value=val, |
258 |
vm=vm) |
259 |
|
260 |
log.info('User %d created vm with %s cpus, %s ram and %s storage',
|
261 |
owner.id, flavor.cpu, flavor.ram, flavor.disk) |
262 |
|
263 |
server = vm_to_dict(vm, detail=True)
|
264 |
server['status'] = 'BUILD' |
265 |
server['adminPass'] = password
|
266 |
return render_server(request, server, status=202) |
267 |
|
268 |
|
269 |
@util.api_method('GET') |
270 |
def get_server_details(request, server_id): |
271 |
# Normal Response Codes: 200, 203
|
272 |
# Error Response Codes: computeFault (400, 500),
|
273 |
# serviceUnavailable (503),
|
274 |
# unauthorized (401),
|
275 |
# badRequest (400),
|
276 |
# itemNotFound (404),
|
277 |
# overLimit (413)
|
278 |
|
279 |
log.debug('get_server_details %s', server_id)
|
280 |
vm = util.get_vm(server_id, request.user) |
281 |
server = vm_to_dict(vm, detail=True)
|
282 |
return render_server(request, server)
|
283 |
|
284 |
|
285 |
@util.api_method('PUT') |
286 |
def update_server_name(request, server_id): |
287 |
# Normal Response Code: 204
|
288 |
# Error Response Codes: computeFault (400, 500),
|
289 |
# serviceUnavailable (503),
|
290 |
# unauthorized (401),
|
291 |
# badRequest (400),
|
292 |
# badMediaType(415),
|
293 |
# itemNotFound (404),
|
294 |
# buildInProgress (409),
|
295 |
# overLimit (413)
|
296 |
|
297 |
req = util.get_request_dict(request) |
298 |
log.debug('update_server_name %s %s', server_id, req)
|
299 |
|
300 |
try:
|
301 |
name = req['server']['name'] |
302 |
except (TypeError, KeyError): |
303 |
raise faults.BadRequest("Malformed request") |
304 |
|
305 |
vm = util.get_vm(server_id, request.user) |
306 |
vm.name = name |
307 |
vm.save() |
308 |
|
309 |
return HttpResponse(status=204) |
310 |
|
311 |
|
312 |
@util.api_method('DELETE') |
313 |
def delete_server(request, server_id): |
314 |
# Normal Response Codes: 204
|
315 |
# Error Response Codes: computeFault (400, 500),
|
316 |
# serviceUnavailable (503),
|
317 |
# unauthorized (401),
|
318 |
# itemNotFound (404),
|
319 |
# unauthorized (401),
|
320 |
# buildInProgress (409),
|
321 |
# overLimit (413)
|
322 |
|
323 |
log.debug('delete_server %s', server_id)
|
324 |
vm = util.get_vm(server_id, request.user) |
325 |
delete_instance(vm) |
326 |
return HttpResponse(status=204) |
327 |
|
328 |
|
329 |
@util.api_method('POST') |
330 |
def server_action(request, server_id): |
331 |
req = util.get_request_dict(request) |
332 |
log.debug('server_action %s %s', server_id, req)
|
333 |
vm = util.get_vm(server_id, request.user) |
334 |
if len(req) != 1: |
335 |
raise faults.BadRequest("Malformed request") |
336 |
|
337 |
key = req.keys()[0]
|
338 |
val = req[key] |
339 |
|
340 |
try:
|
341 |
assert isinstance(val, dict) |
342 |
return server_actions[key](request, vm, req[key])
|
343 |
except KeyError: |
344 |
raise faults.BadRequest("Unknown action") |
345 |
except AssertionError: |
346 |
raise faults.BadRequest("Invalid argument") |
347 |
|
348 |
|
349 |
@util.api_method('GET') |
350 |
def list_addresses(request, server_id): |
351 |
# Normal Response Codes: 200, 203
|
352 |
# Error Response Codes: computeFault (400, 500),
|
353 |
# serviceUnavailable (503),
|
354 |
# unauthorized (401),
|
355 |
# badRequest (400),
|
356 |
# overLimit (413)
|
357 |
|
358 |
log.debug('list_addresses %s', server_id)
|
359 |
vm = util.get_vm(server_id, request.user) |
360 |
addresses = [nic_to_dict(nic) for nic in vm.nics.all()] |
361 |
|
362 |
if request.serialization == 'xml': |
363 |
data = render_to_string('list_addresses.xml', {'addresses': addresses}) |
364 |
else:
|
365 |
data = json.dumps({'addresses': {'values': addresses}}) |
366 |
|
367 |
return HttpResponse(data, status=200) |
368 |
|
369 |
|
370 |
@util.api_method('GET') |
371 |
def list_addresses_by_network(request, server_id, network_id): |
372 |
# Normal Response Codes: 200, 203
|
373 |
# Error Response Codes: computeFault (400, 500),
|
374 |
# serviceUnavailable (503),
|
375 |
# unauthorized (401),
|
376 |
# badRequest (400),
|
377 |
# itemNotFound (404),
|
378 |
# overLimit (413)
|
379 |
|
380 |
log.debug('list_addresses_by_network %s %s', server_id, network_id)
|
381 |
owner = request.user |
382 |
machine = util.get_vm(server_id, owner) |
383 |
network = util.get_network(network_id, owner) |
384 |
nic = util.get_nic(machine, network) |
385 |
address = nic_to_dict(nic) |
386 |
|
387 |
if request.serialization == 'xml': |
388 |
data = render_to_string('address.xml', {'address': address}) |
389 |
else:
|
390 |
data = json.dumps({'network': address})
|
391 |
|
392 |
return HttpResponse(data, status=200) |
393 |
|
394 |
|
395 |
@util.api_method('GET') |
396 |
def list_metadata(request, server_id): |
397 |
# Normal Response Codes: 200, 203
|
398 |
# Error Response Codes: computeFault (400, 500),
|
399 |
# serviceUnavailable (503),
|
400 |
# unauthorized (401),
|
401 |
# badRequest (400),
|
402 |
# overLimit (413)
|
403 |
|
404 |
log.debug('list_server_metadata %s', server_id)
|
405 |
vm = util.get_vm(server_id, request.user) |
406 |
metadata = dict((m.meta_key, m.meta_value) for m in vm.metadata.all()) |
407 |
return util.render_metadata(request, metadata, use_values=True, status=200) |
408 |
|
409 |
|
410 |
@util.api_method('POST') |
411 |
def update_metadata(request, server_id): |
412 |
# Normal Response Code: 201
|
413 |
# Error Response Codes: computeFault (400, 500),
|
414 |
# serviceUnavailable (503),
|
415 |
# unauthorized (401),
|
416 |
# badRequest (400),
|
417 |
# buildInProgress (409),
|
418 |
# badMediaType(415),
|
419 |
# overLimit (413)
|
420 |
|
421 |
req = util.get_request_dict(request) |
422 |
log.debug('update_server_metadata %s %s', server_id, req)
|
423 |
vm = util.get_vm(server_id, request.user) |
424 |
try:
|
425 |
metadata = req['metadata']
|
426 |
assert isinstance(metadata, dict) |
427 |
except (KeyError, AssertionError): |
428 |
raise faults.BadRequest("Malformed request") |
429 |
|
430 |
for key, val in metadata.items(): |
431 |
meta, created = vm.metadata.get_or_create(meta_key=key) |
432 |
meta.meta_value = val |
433 |
meta.save() |
434 |
|
435 |
vm.save() |
436 |
vm_meta = dict((m.meta_key, m.meta_value) for m in vm.metadata.all()) |
437 |
return util.render_metadata(request, vm_meta, status=201) |
438 |
|
439 |
|
440 |
@util.api_method('GET') |
441 |
def get_metadata_item(request, server_id, key): |
442 |
# Normal Response Codes: 200, 203
|
443 |
# Error Response Codes: computeFault (400, 500),
|
444 |
# serviceUnavailable (503),
|
445 |
# unauthorized (401),
|
446 |
# itemNotFound (404),
|
447 |
# badRequest (400),
|
448 |
# overLimit (413)
|
449 |
|
450 |
log.debug('get_server_metadata_item %s %s', server_id, key)
|
451 |
vm = util.get_vm(server_id, request.user) |
452 |
meta = util.get_vm_meta(vm, key) |
453 |
return util.render_meta(request, meta, status=200) |
454 |
|
455 |
|
456 |
@util.api_method('PUT') |
457 |
def create_metadata_item(request, server_id, key): |
458 |
# Normal Response Code: 201
|
459 |
# Error Response Codes: computeFault (400, 500),
|
460 |
# serviceUnavailable (503),
|
461 |
# unauthorized (401),
|
462 |
# itemNotFound (404),
|
463 |
# badRequest (400),
|
464 |
# buildInProgress (409),
|
465 |
# badMediaType(415),
|
466 |
# overLimit (413)
|
467 |
|
468 |
req = util.get_request_dict(request) |
469 |
log.debug('create_server_metadata_item %s %s %s', server_id, key, req)
|
470 |
vm = util.get_vm(server_id, request.user) |
471 |
try:
|
472 |
metadict = req['meta']
|
473 |
assert isinstance(metadict, dict) |
474 |
assert len(metadict) == 1 |
475 |
assert key in metadict |
476 |
except (KeyError, AssertionError): |
477 |
raise faults.BadRequest("Malformed request") |
478 |
|
479 |
meta, created = VirtualMachineMetadata.objects.get_or_create( |
480 |
meta_key=key, |
481 |
vm=vm) |
482 |
|
483 |
meta.meta_value = metadict[key] |
484 |
meta.save() |
485 |
vm.save() |
486 |
return util.render_meta(request, meta, status=201) |
487 |
|
488 |
|
489 |
@util.api_method('DELETE') |
490 |
def delete_metadata_item(request, server_id, key): |
491 |
# Normal Response Code: 204
|
492 |
# Error Response Codes: computeFault (400, 500),
|
493 |
# serviceUnavailable (503),
|
494 |
# unauthorized (401),
|
495 |
# itemNotFound (404),
|
496 |
# badRequest (400),
|
497 |
# buildInProgress (409),
|
498 |
# badMediaType(415),
|
499 |
# overLimit (413),
|
500 |
|
501 |
log.debug('delete_server_metadata_item %s %s', server_id, key)
|
502 |
vm = util.get_vm(server_id, request.user) |
503 |
meta = util.get_vm_meta(vm, key) |
504 |
meta.delete() |
505 |
vm.save() |
506 |
return HttpResponse(status=204) |
507 |
|
508 |
|
509 |
@util.api_method('GET') |
510 |
def server_stats(request, server_id): |
511 |
# Normal Response Codes: 200
|
512 |
# Error Response Codes: computeFault (400, 500),
|
513 |
# serviceUnavailable (503),
|
514 |
# unauthorized (401),
|
515 |
# badRequest (400),
|
516 |
# itemNotFound (404),
|
517 |
# overLimit (413)
|
518 |
|
519 |
log.debug('server_stats %s', server_id)
|
520 |
vm = util.get_vm(server_id, request.user) |
521 |
#secret = util.encrypt(vm.backend_id)
|
522 |
secret = vm.backend_id # XXX disable backend id encryption
|
523 |
|
524 |
stats = { |
525 |
'serverRef': vm.id,
|
526 |
'refresh': settings.STATS_REFRESH_PERIOD,
|
527 |
'cpuBar': settings.CPU_BAR_GRAPH_URL % secret,
|
528 |
'cpuTimeSeries': settings.CPU_TIMESERIES_GRAPH_URL % secret,
|
529 |
'netBar': settings.NET_BAR_GRAPH_URL % secret,
|
530 |
'netTimeSeries': settings.NET_TIMESERIES_GRAPH_URL % secret}
|
531 |
|
532 |
if request.serialization == 'xml': |
533 |
data = render_to_string('server_stats.xml', stats)
|
534 |
else:
|
535 |
data = json.dumps({'stats': stats})
|
536 |
|
537 |
return HttpResponse(data, status=200) |