__init__.py 9.31 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
from kamaki.clients.cyclades.rest_api import CycladesRestClient
35
from kamaki.clients.network import NetworkClient
36
from kamaki.clients.utils import path4url
Stavros Sachtouris's avatar
Stavros Sachtouris committed
37
from kamaki.clients import ClientError, Waiter
Giorgos Verigakis's avatar
Giorgos Verigakis committed
38

39

Stavros Sachtouris's avatar
Stavros Sachtouris committed
40
class CycladesClient(CycladesRestClient, Waiter):
41
    """Synnefo Cyclades Compute API client"""
42

43
44
    def create_server(
            self, name, flavor_id, image_id,
45
            metadata=None, personality=None, networks=None):
46
47
48
49
50
51
        """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
60
61
62
63
        :param networks: (list of dicts) Networks to connect to, list this:
            "networks": [
                {"network": <network_uuid>},
                {"network": <network_uuid>, "fixed_ip": address},
                {"port": <port_id>}, ...]
64
65
            ATTENTION: Empty list is different to None. None means ' do not
            mention it', empty list means 'automatically get an ip'
66

67
        :returns: a dict with the new virtual server details
68
69
70
71
72
73
74
75
76
77
78

        :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

79
80
        return super(CycladesClient, self).create_server(
            name, flavor_id, image_id,
81
            metadata=metadata, personality=personality, networks=networks)
82

Giorgos Verigakis's avatar
Giorgos Verigakis committed
83
    def start_server(self, server_id):
84
85
86
        """Submit a startup request

        :param server_id: integer (str or int)
87
88

        :returns: (dict) response headers
89
        """
Giorgos Verigakis's avatar
Giorgos Verigakis committed
90
        req = {'start': {}}
91
        r = self.servers_action_post(server_id, json_data=req, success=202)
92
        return r.headers
93

Giorgos Verigakis's avatar
Giorgos Verigakis committed
94
    def shutdown_server(self, server_id):
95
96
97
        """Submit a shutdown request

        :param server_id: integer (str or int)
98
99

        :returns: (dict) response headers
100
        """
Giorgos Verigakis's avatar
Giorgos Verigakis committed
101
        req = {'shutdown': {}}
102
        r = self.servers_action_post(server_id, json_data=req, success=202)
103
        return r.headers
104

Giorgos Verigakis's avatar
Giorgos Verigakis committed
105
    def get_server_console(self, server_id):
106
107
108
        """
        :param server_id: integer (str or int)

109
        :returns: (dict) info to set a VNC connection to virtual server
110
        """
Giorgos Verigakis's avatar
Giorgos Verigakis committed
111
        req = {'console': {'type': 'vnc'}}
112
        r = self.servers_action_post(server_id, json_data=req, success=200)
Giorgos Verigakis's avatar
Giorgos Verigakis committed
113
        return r.json['console']
114
115

    def get_firewall_profile(self, server_id):
116
117
118
119
120
121
122
        """
        :param server_id: integer (str or int)

        :returns: (str) ENABLED | DISABLED | PROTECTED

        :raises ClientError: 520 No Firewall Profile
        """
123
124
        r = self.get_server_details(server_id)
        try:
125
            return r['attachments'][0]['firewallProfile']
126
        except KeyError:
127
            raise ClientError(
128
                'No Firewall Profile',
129
                details='Server %s is missing a firewall profile' % server_id)
130

Giorgos Verigakis's avatar
Giorgos Verigakis committed
131
132
    def set_firewall_profile(self, server_id, profile):
        """Set the firewall profile for the public interface of a server
133
134
135
136

        :param server_id: integer (str or int)

        :param profile: (str) ENABLED | DISABLED | PROTECTED
137
138

        :returns: (dict) response headers
Giorgos Verigakis's avatar
Giorgos Verigakis committed
139
        """
Giorgos Verigakis's avatar
Giorgos Verigakis committed
140
        req = {'firewallProfile': {'profile': profile}}
141
        r = self.servers_action_post(server_id, json_data=req, success=202)
142
        return r.headers
143

144
    def list_server_nics(self, server_id):
145
146
147
148
149
        """
        :param server_id: integer (str or int)

        :returns: (dict) network interface connections
        """
150
        r = self.servers_ips_get(server_id)
151
        return r.json['attachments']
152

Giorgos Verigakis's avatar
Giorgos Verigakis committed
153
    def get_server_stats(self, server_id):
154
155
156
157
158
        """
        :param server_id: integer (str or int)

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

162
163
164
165
166
167
168
169
170
171
172
173
    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

174
175
        :max_wait: (int) timeout in secconds

176
177
178
179
180
181
182
183
184
185
186
187
188
        :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)

189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
    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)

213

214
class CycladesNetworkClient(NetworkClient):
215
216
217
218
219
    """Cyclades Network API extentions"""

    network_types = (
        'CUSTOM', 'MAC_FILTERED', 'IP_LESS_ROUTED', 'PHYSICAL_VLAN')

220
221
222
223
224
    def list_networks(self, detail=None):
        path = path4url('networks', 'detail' if detail else '')
        r = self.get(path, success=200)
        return r.json['networks']

225
226
227
228
229
230
231
232
    def create_network(self, type, name=None, shared=None):
        req = dict(network=dict(type=type, admin_state_up=True))
        if name:
            req['network']['name'] = name
        if shared not in (None, ):
            req['network']['shared'] = bool(shared)
        r = self.networks_post(json_data=req, success=201)
        return r.json['network']
233

Stavros Sachtouris's avatar
Stavros Sachtouris committed
234
    def create_port(
235
236
237
238
239
            self, network_id,
            device_id=None, security_groups=None, name=None, fixed_ips=None):
        port = dict(network_id=network_id)
        if device_id:
            port['device_id'] = device_id
240
241
        if security_groups:
            port['security_groups'] = security_groups
Stavros Sachtouris's avatar
Stavros Sachtouris committed
242
243
        if name:
            port['name'] = name
244
        for fixed_ip in fixed_ips or []:
245
            diff = set(['subnet_id', 'ip_address']).difference(fixed_ip)
246
247
248
            if diff:
                raise ValueError(
                    'Invalid format for "fixed_ips", %s missing' % diff)
249
        if fixed_ips:
250
            port['fixed_ips'] = fixed_ips
251
252
        r = self.ports_post(json_data=dict(port=port), success=201)
        return r.json['port']
Stavros Sachtouris's avatar
Stavros Sachtouris committed
253

254
255
256
    def create_floatingip(self, floating_network_id, floating_ip_address=''):
        return super(CycladesNetworkClient, self).create_floatingip(
            floating_network_id, floating_ip_address=floating_ip_address)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
257

258
259
260
261
    def update_floatingip(self, floating_network_id, floating_ip_address=''):
        """To nullify something optional, use None"""
        return super(CycladesNetworkClient, self).update_floatingip(
            floating_network_id, floating_ip_address=floating_ip_address)