__init__.py 16 KB
Newer Older
1
# Copyright 2011-2013 GRNET S.A. All rights reserved.
Giorgos Verigakis's avatar
Giorgos Verigakis committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
#   1. Redistributions of source code must retain the above
#      copyright notice, this list of conditions and the following
#      disclaimer.
#
#   2. Redistributions in binary form must reproduce the above
#      copyright notice, this list of conditions and the following
#      disclaimer in the documentation and/or other materials
#      provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# The views and conclusions contained in the software and
# documentation are those of the authors and should not be
# interpreted as representing official policies, either expressed
# or implied, of GRNET S.A.

34
35
from time import sleep

36
from kamaki.clients.cyclades.rest_api import CycladesRestClient
37
from kamaki.clients import ClientError
Giorgos Verigakis's avatar
Giorgos Verigakis committed
38

39

40
class CycladesClient(CycladesRestClient):
41
    """Synnefo Cyclades Compute API client"""
42

43
44
45
46
47
48
49
50
51
    def create_server(
            self, name, flavor_id, image_id,
            metadata=None, personality=None):
        """Submit request to create a new server

        :param name: (str)

        :param flavor_id: integer id denoting a preset hardware configuration

52
        :param image_id: (str) id denoting the OS image to run on virt. server
53
54
55
56

        :param metadata: (dict) vm metadata updated by os/users image metadata

        :param personality: a list of (file path, file contents) tuples,
57
            describing files to be injected into virtual server upon creation
58

59
        :returns: a dict with the new virtual server details
60
61
62
63
64
65
66
67
68
69
70

        :raises ClientError: wraps request errors
        """
        image = self.get_image_details(image_id)
        metadata = metadata or dict()
        for key in ('os', 'users'):
            try:
                metadata[key] = image['metadata'][key]
            except KeyError:
                pass

71
72
73
        return super(CycladesClient, self).create_server(
            name, flavor_id, image_id,
            metadata=metadata, personality=personality)
74

Giorgos Verigakis's avatar
Giorgos Verigakis committed
75
    def start_server(self, server_id):
76
77
78
        """Submit a startup request

        :param server_id: integer (str or int)
79
80

        :returns: (dict) response headers
81
        """
Giorgos Verigakis's avatar
Giorgos Verigakis committed
82
        req = {'start': {}}
83
        r = self.servers_action_post(server_id, json_data=req, success=202)
84
        return r.headers
85

Giorgos Verigakis's avatar
Giorgos Verigakis committed
86
    def shutdown_server(self, server_id):
87
88
89
        """Submit a shutdown request

        :param server_id: integer (str or int)
90
91

        :returns: (dict) response headers
92
        """
Giorgos Verigakis's avatar
Giorgos Verigakis committed
93
        req = {'shutdown': {}}
94
        r = self.servers_action_post(server_id, json_data=req, success=202)
95
        return r.headers
96

Giorgos Verigakis's avatar
Giorgos Verigakis committed
97
    def get_server_console(self, server_id):
98
99
100
        """
        :param server_id: integer (str or int)

101
        :returns: (dict) info to set a VNC connection to virtual server
102
        """
Giorgos Verigakis's avatar
Giorgos Verigakis committed
103
        req = {'console': {'type': 'vnc'}}
104
        r = self.servers_action_post(server_id, json_data=req, success=200)
Giorgos Verigakis's avatar
Giorgos Verigakis committed
105
        return r.json['console']
106
107

    def get_firewall_profile(self, server_id):
108
109
110
111
112
113
114
        """
        :param server_id: integer (str or int)

        :returns: (str) ENABLED | DISABLED | PROTECTED

        :raises ClientError: 520 No Firewall Profile
        """
115
116
        r = self.get_server_details(server_id)
        try:
117
            return r['attachments'][0]['firewallProfile']
118
        except KeyError:
119
            raise ClientError(
120
                'No Firewall Profile',
121
                details='Server %s is missing a firewall profile' % server_id)
122

Giorgos Verigakis's avatar
Giorgos Verigakis committed
123
124
    def set_firewall_profile(self, server_id, profile):
        """Set the firewall profile for the public interface of a server
125
126
127
128

        :param server_id: integer (str or int)

        :param profile: (str) ENABLED | DISABLED | PROTECTED
129
130

        :returns: (dict) response headers
Giorgos Verigakis's avatar
Giorgos Verigakis committed
131
        """
Giorgos Verigakis's avatar
Giorgos Verigakis committed
132
        req = {'firewallProfile': {'profile': profile}}
133
        r = self.servers_action_post(server_id, json_data=req, success=202)
134
        return r.headers
135

136
    def list_server_nics(self, server_id):
137
138
139
140
141
        """
        :param server_id: integer (str or int)

        :returns: (dict) network interface connections
        """
142
        r = self.servers_ips_get(server_id)
143
        return r.json['attachments']
144

Giorgos Verigakis's avatar
Giorgos Verigakis committed
145
    def get_server_stats(self, server_id):
146
147
148
149
150
        """
        :param server_id: integer (str or int)

        :returns: (dict) auto-generated graphs of statistics (urls)
        """
151
        r = self.servers_stats_get(server_id)
Giorgos Verigakis's avatar
Giorgos Verigakis committed
152
        return r.json['stats']
153

Giorgos Verigakis's avatar
Giorgos Verigakis committed
154
    def list_networks(self, detail=False):
155
156
157
158
159
        """
        :param detail: (bool)

        :returns: (list) id,name if not detail else full info per network
        """
160
161
        detail = 'detail' if detail else ''
        r = self.networks_get(command=detail)
162
        return r.json['networks']
Giorgos Verigakis's avatar
Giorgos Verigakis committed
163

164
    def list_network_nics(self, network_id):
165
166
167
168
169
        """
        :param network_id: integer (str or int)

        :returns: (list)
        """
170
        r = self.networks_get(network_id=network_id)
171
        return r.json['network']['attachments']
172

173
174
    def create_network(
            self, name,
175
            cidr=None, gateway=None, type=None, dhcp=False):
176
177
178
179
180
181
182
        """
        :param name: (str)

        :param cidr: (str)

        :param geteway: (str)

183
184
        :param type: (str) if None, will use MAC_FILTERED as default
            Valid values: CUSTOM, IP_LESS_ROUTED, MAC_FILTERED, PHYSICAL_VLAN
185

186
        :param dhcp: (bool)
187
188

        :returns: (dict) network detailed info
189
190
191
        """
        net = dict(name=name)
        if cidr:
192
            net['cidr'] = cidr
193
        if gateway:
194
            net['gateway'] = gateway
195
        net['type'] = type or 'MAC_FILTERED'
196
        net['dhcp'] = True if dhcp else False
197
        req = dict(network=net)
198
        r = self.networks_post(json_data=req, success=202)
Giorgos Verigakis's avatar
Giorgos Verigakis committed
199
        return r.json['network']
Giorgos Verigakis's avatar
Giorgos Verigakis committed
200
201

    def get_network_details(self, network_id):
202
203
204
205
206
        """
        :param network_id: integer (str or int)

        :returns: (dict)
        """
207
        r = self.networks_get(network_id=network_id)
Giorgos Verigakis's avatar
Giorgos Verigakis committed
208
        return r.json['network']
Giorgos Verigakis's avatar
Giorgos Verigakis committed
209
210

    def update_network_name(self, network_id, new_name):
211
212
213
214
        """
        :param network_id: integer (str or int)

        :param new_name: (str)
215
216

        :returns: (dict) response headers
217
        """
Giorgos Verigakis's avatar
Giorgos Verigakis committed
218
        req = {'network': {'name': new_name}}
219
220
        r = self.networks_put(network_id=network_id, json_data=req)
        return r.headers
Giorgos Verigakis's avatar
Giorgos Verigakis committed
221
222

    def delete_network(self, network_id):
223
224
225
        """
        :param network_id: integer (str or int)

226
227
        :returns: (dict) response headers

228
229
        :raises ClientError: 421 Network in use
        """
230
        try:
231
232
            r = self.networks_delete(network_id)
            return r.headers
233
234
        except ClientError as err:
            if err.status == 421:
235
                err.details = [
236
                    'Network may be still connected to at least one server']
237
            raise
Giorgos Verigakis's avatar
Giorgos Verigakis committed
238
239

    def connect_server(self, server_id, network_id):
240
241
242
243
244
        """ Connect a server to a network

        :param server_id: integer (str or int)

        :param network_id: integer (str or int)
245
246

        :returns: (dict) response headers
247
        """
Giorgos Verigakis's avatar
Giorgos Verigakis committed
248
        req = {'add': {'serverRef': server_id}}
249
250
        r = self.networks_post(network_id, 'action', json_data=req)
        return r.headers
Giorgos Verigakis's avatar
Giorgos Verigakis committed
251

252
    def disconnect_server(self, server_id, nic_id):
253
254
255
256
        """
        :param server_id: integer (str or int)

        :param nic_id: (str)
257
258

        :returns: (int) the number of nics disconnected
259
        """
260
        vm_nets = self.list_server_nics(server_id)
261
        num_of_disconnections = 0
262
        for (nic_id, network_id) in [(
263
264
                net['id'],
                net['network_id']) for net in vm_nets if nic_id == net['id']]:
265
            req = {'remove': {'attachment': '%s' % nic_id}}
266
            self.networks_post(network_id, 'action', json_data=req)
267
268
            num_of_disconnections += 1
        return num_of_disconnections
269
270

    def disconnect_network_nics(self, netid):
271
272
273
274
        """
        :param netid: integer (str or int)
        """
        for nic in self.list_network_nics(netid):
275
            req = dict(remove=dict(attachment=nic))
276
            self.networks_post(netid, 'action', json_data=req)
277

278
279
280
281
    def _wait(
            self, item_id, current_status, get_status,
            delay=1, max_wait=100, wait_cb=None):
        """Wait for item while its status is current_status
282
283
284

        :param server_id: integer (str or int)

285
286
287
288
        :param current_status: (str)

        :param get_status: (method(self, item_id)) if called, returns
            (status, progress %) If no way to tell progress, return None
289
290
291

        :param delay: time interval between retries

292
        :param wait_cb: if set a progress bar is used to show progress
293

294
        :returns: (str) the new mode if successful, (bool) False if timed out
295
        """
296
        status, progress = get_status(self, item_id)
297

298
        if wait_cb:
299
            wait_gen = wait_cb(max_wait // delay)
300
            wait_gen.next()
301

302
303
304
305
306
307
308
309
310
        if status != current_status:
            if wait_cb:
                try:
                    wait_gen.next()
                except Exception:
                    pass
            return status
        old_wait = total_wait = 0

311
312
313
314
        while status == current_status and total_wait <= max_wait:
            if wait_cb:
                try:
                    for i in range(total_wait - old_wait):
315
                        wait_gen.next()
316
317
318
                except Exception:
                    break
            old_wait = total_wait
319
            total_wait = progress or total_wait + 1
320
            sleep(delay)
321
            status, progress = get_status(self, item_id)
322

323
        if total_wait < max_wait:
324
325
            if wait_cb:
                try:
326
                    for i in range(max_wait):
327
328
329
                        wait_gen.next()
                except:
                    pass
330
331
332
333
334
335
336
337
338
339
340
341
342
343
        return status if status != current_status else False

    def wait_server(
            self, server_id,
            current_status='BUILD',
            delay=1, max_wait=100, wait_cb=None):
        """Wait for server while its status is current_status

        :param server_id: integer (str or int)

        :param current_status: (str) BUILD|ACTIVE|STOPPED|DELETED|REBOOT

        :param delay: time interval between retries

344
345
        :max_wait: (int) timeout in secconds

346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
        :param wait_cb: if set a progressbar is used to show progress

        :returns: (str) the new mode if succesfull, (bool) False if timed out
        """

        def get_status(self, server_id):
            r = self.get_server_details(server_id)
            return r['status'], (r.get('progress', None) if (
                            current_status in ('BUILD', )) else None)

        return self._wait(
            server_id, current_status, get_status, delay, max_wait, wait_cb)

    def wait_network(
            self, net_id,
361
            current_status='PENDING', delay=1, max_wait=100, wait_cb=None):
362
363
364
365
366
367
368
369
        """Wait for network while its status is current_status

        :param net_id: integer (str or int)

        :param current_status: (str) PENDING | ACTIVE | DELETED

        :param delay: time interval between retries

370
371
        :max_wait: (int) timeout in secconds

372
373
374
375
376
377
378
379
380
381
382
        :param wait_cb: if set a progressbar is used to show progress

        :returns: (str) the new mode if succesfull, (bool) False if timed out
        """

        def get_status(self, net_id):
            r = self.get_network_details(net_id)
            return r['status'], None

        return self._wait(
            net_id, current_status, get_status, delay, max_wait, wait_cb)
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
    def wait_firewall(
            self, server_id,
            current_status='DISABLED', delay=1, max_wait=100, wait_cb=None):
        """Wait while the public network firewall status is current_status

        :param server_id: integer (str or int)

        :param current_status: (str) DISABLED | ENABLED | PROTECTED

        :param delay: time interval between retries

        :max_wait: (int) timeout in secconds

        :param wait_cb: if set a progressbar is used to show progress

        :returns: (str) the new mode if succesfull, (bool) False if timed out
        """

        def get_status(self, server_id):
            return self.get_firewall_profile(server_id), None

        return self._wait(
            server_id, current_status, get_status, delay, max_wait, wait_cb)

408
409
410
411
412
413
414
415
416
    def get_floating_ip_pools(self):
        """
        :returns: (dict) {floating_ip_pools:[{name: ...}, ...]}
        """
        r = self.floating_ip_pools_get()
        return r.json

    def get_floating_ips(self):
        """
Stavros Sachtouris's avatar
Stavros Sachtouris committed
417
        :returns: (dict) {floating_ips: [fixed_ip: , id: , ip: , pool: ]}
418
419
420
421
422
423
424
425
426
427
428
        """
        r = self.floating_ips_get()
        return r.json

    def alloc_floating_ip(self, pool=None, address=None):
        """
        :param pool: (str) pool of ips to allocate from

        :param address: (str) ip address to request

        :returns: (dict) {
429
            fixed_ip: ..., id: ..., instance_id: ..., ip: ..., pool: ...}
430
431
432
433
        """
        json_data = dict()
        if pool:
            json_data['pool'] = pool
434
435
        if address:
            json_data['address'] = address
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
        r = self.floating_ips_post(json_data)
        return r.json['floating_ip']

    def get_floating_ip(self, fip_id):
        """
        :param fip_id: (str) floating ip id

        :returns: (dict)
            {fixed_ip: ..., id: ..., instance_id: ..., ip: ..., pool: ...},

        :raises AssertionError: if fip_id is emtpy
        """
        assert fip_id, 'floating ip id is needed for get_floating_ip'
        r = self.floating_ips_get(fip_id)
        return r.json['floating_ip']

    def delete_floating_ip(self, fip_id=None):
        """
        :param fip_id: (str) floating ip id (if None, all ips are deleted)

        :returns: (dict) request headers

        :raises AssertionError: if fip_id is emtpy
        """
        assert fip_id, 'floating ip id is needed for delete_floating_ip'
        r = self.floating_ips_delete(fip_id)
        return r.headers

464
    def attach_floating_ip(self, server_id, address):
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
        """Associate the address ip to server with server_id

        :param server_id: (int)

        :param address: (str) the ip address to assign to server (vm)

        :returns: (dict) request headers

        :raises ValueError: if server_id cannot be converted to int

        :raises ValueError: if server_id is not of a int-convertable type

        :raises AssertionError: if address is emtpy
        """
        server_id = int(server_id)
480
        assert address, 'address is needed for attach_floating_ip'
481
482
        req = dict(addFloatingIp=dict(address=address))
        r = self.servers_action_post(server_id, json_data=req)
483
484
        return r.headers

485
    def detach_floating_ip(self, server_id, address):
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
        """Disassociate an address ip from the server with server_id

        :param server_id: (int)

        :param address: (str) the ip address to assign to server (vm)

        :returns: (dict) request headers

        :raises ValueError: if server_id cannot be converted to int

        :raises ValueError: if server_id is not of a int-convertable type

        :raises AssertionError: if address is emtpy
        """
        server_id = int(server_id)
501
        assert address, 'address is needed for detach_floating_ip'
502
503
        req = dict(removeFloatingIp=dict(address=address))
        r = self.servers_action_post(server_id, json_data=req)
504
        return r.headers