summaryrefslogtreecommitdiffstats
path: root/snaps/openstack/create_flavor.py
blob: b428621692c30c960df616c26dbda72e8cb511f6 (plain)
1
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
34
35
36
37
38
39
40
41
42
43
44
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
97
98
99
100
101
102
103
104
105
106
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# Copyright (c) 2016 Cable Television Laboratories, Inc. ("CableLabs")
#                    and others.  All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import logging

from novaclient.exceptions import NotFound

from snaps.openstack.openstack_creator import OpenStackComputeObject
from snaps.openstack.utils import nova_utils

__author__ = 'spisarski'

logger = logging.getLogger('create_flavor')

MEM_PAGE_SIZE_ANY = {'hw:mem_page_size': 'any'}
MEM_PAGE_SIZE_LARGE = {'hw:mem_page_size': 'large'}


class OpenStackFlavor(OpenStackComputeObject):
    """
    Class responsible for creating a user in OpenStack
    """

    def __init__(self, os_creds, flavor_settings):
        """
        Constructor
        :param os_creds: The OpenStack connection credentials
        :param flavor_settings: The flavor settings
        :return:
        """
        super(self.__class__, self).__init__(os_creds)

        self.flavor_settings = flavor_settings
        self.__flavor = None

    def initialize(self):
        """
        Loads the existing OpenStack flavor
        :return: The Flavor domain object or None
        """
        super(self.__class__, self).initialize()

        self.__flavor = nova_utils.get_flavor_by_name(
            self._nova, self.flavor_settings.name)
        if self.__flavor:
            logger.info('Found flavor with name - %s',
                        self.flavor_settings.name)
        return self.__flavor

    def create(self):
        """
        Creates the image in OpenStack if it does not already exist
        :return: The OpenStack flavor object
        """
        self.initialize()
        if not self.__flavor:
            self.__flavor = nova_utils.create_flavor(
                self._nova, self.flavor_settings)
            if self.flavor_settings.metadata:
                nova_utils.set_flavor_keys(self._nova, self.__flavor,
                                           self.flavor_settings.metadata)
        else:
            logger.info('Did not create flavor due to cleanup mode')

        return self.__flavor

    def clean(self):
        """
        Cleanse environment of all artifacts
        :return: void
        """
        if self.__flavor:
            try:
                nova_utils.delete_flavor(self._nova, self.__flavor)
            except NotFound:
                pass

            self.__flavor = None

    def get_flavor(self):
        """
        Returns the OpenStack flavor object
        :return:
        """
        return self.__flavor


class FlavorSettings:
    """
    Configuration settings for OpenStack flavor creation
    """

    def __init__(self, **kwargs):
        """
        Constructor
        :param name: the flavor's name (required)
        :param flavor_id: the string ID (default 'auto')
        :param ram: the required RAM in MB (required)
        :param disk: the size of the root disk in GB (required)
        :param vcpus: the number of virtual CPUs (required)
        :param ephemeral: the size of the ephemeral disk in GB (default 0)
        :param swap: the size of the dedicated swap disk in GB (default 0)
        :param rxtx_factor: the receive/transmit factor to be set on ports if
                            backend supports QoS extension (default 1.0)
        :param is_public: denotes whether or not the flavor is public
                          (default True)
        :param metadata: freeform dict() for special metadata
        """
        self.name = kwargs.get('name')

        if kwargs.get('flavor_id'):
            self.flavor_id = kwargs['flavor_id']
        else:
            self.flavor_id = 'auto'

        self.ram = kwargs.get('ram')
        self.disk = kwargs.get('disk')
        self.vcpus = kwargs.get('vcpus')

        if kwargs.get('ephemeral'):
            self.ephemeral = kwargs['ephemeral']
        else:
            self.ephemeral = 0

        if kwargs.get('swap'):
            self.swap = kwargs['swap']
        else:
            self.swap = 0

        if kwargs.get('rxtx_factor'):
            self.rxtx_factor = kwargs['rxtx_factor']
        else:
            self.rxtx_factor = 1.0

        if kwargs.get('is_public') is not None:
            self.is_public = kwargs['is_public']
        else:
            self.is_public = True

        if kwargs.get('metadata'):
            self.metadata = kwargs['metadata']
        else:
            self.metadata = None

        if not self.name or not self.ram or not self.disk or not self.vcpus:
            raise FlavorSettingsError(
                'The attributes name, ram, disk, and vcpus are required for'
                'FlavorSettings')

        if not isinstance(self.ram, int):
            raise FlavorSettingsError('The ram attribute must be a integer')

        if not isinstance(self.disk, int):
            raise FlavorSettingsError('The ram attribute must be a integer')

        if not isinstance(self.vcpus, int):
            raise FlavorSettingsError('The vcpus attribute must be a integer')

        if self.ephemeral and not isinstance(self.ephemeral, int):
            raise FlavorSettingsError(
                'The ephemeral attribute must be an integer')

        if self.swap and not isinstance(self.swap, int):
            raise FlavorSettingsError('The swap attribute must be an integer')

        if self.rxtx_factor and not isinstance(self.rxtx_factor, (int, float)):
            raise FlavorSettingsError(
                'The is_public attribute must be an integer or float')

        if self.is_public and not isinstance(self.is_public, bool):
            raise FlavorSettingsError(
                'The is_public attribute must be a boolean')


class FlavorSettingsError(Exception):
    """
    Exception to be thrown when an flavor settings are incorrect
    """