1 # Copyright (c) 2016 Cable Television Laboratories, Inc. ("CableLabs")
2 # and others. All rights reserved.
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at:
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
17 from novaclient.exceptions import NotFound
19 from snaps.openstack.utils import nova_utils
21 __author__ = 'spisarski'
23 logger = logging.getLogger('create_image')
25 MEM_PAGE_SIZE_ANY = {'hw:mem_page_size': 'any'}
26 MEM_PAGE_SIZE_LARGE = {'hw:mem_page_size': 'large'}
29 class OpenStackFlavor:
31 Class responsible for creating a user in OpenStack
34 def __init__(self, os_creds, flavor_settings):
37 :param os_creds: The OpenStack connection credentials
38 :param flavor_settings: The flavor settings
41 self.__os_creds = os_creds
42 self.flavor_settings = flavor_settings
46 def create(self, cleanup=False):
48 Creates the image in OpenStack if it does not already exist
49 :param cleanup: Denotes whether or not this is being called for cleanup or not
50 :return: The OpenStack flavor object
52 self.__nova = nova_utils.nova_client(self.__os_creds)
53 self.__flavor = nova_utils.get_flavor_by_name(self.__nova, self.flavor_settings.name)
55 logger.info('Found flavor with name - ' + self.flavor_settings.name)
57 self.__flavor = nova_utils.create_flavor(self.__nova, self.flavor_settings)
58 if self.flavor_settings.metadata:
59 self.__flavor.set_keys(self.flavor_settings.metadata)
60 self.__flavor = nova_utils.get_flavor_by_name(self.__nova, self.flavor_settings.name)
62 logger.info('Did not create flavor due to cleanup mode')
68 Cleanse environment of all artifacts
73 nova_utils.delete_flavor(self.__nova, self.__flavor)
81 Returns the OpenStack flavor object
89 Configuration settings for OpenStack flavor creation
92 def __init__(self, config=None, name=None, flavor_id='auto', ram=None, disk=None, vcpus=None, ephemeral=0, swap=0,
93 rxtx_factor=1.0, is_public=True, metadata=None):
96 :param config: dict() object containing the configuration settings using the attribute names below as each
97 member's the key and overrides any of the other parameters.
98 :param name: the flavor's name (required)
99 :param flavor_id: the string ID (default 'auto')
100 :param ram: the required RAM in MB (required)
101 :param disk: the size of the root disk in GB (required)
102 :param vcpus: the number of virtual CPUs (required)
103 :param ephemeral: the size of the ephemeral disk in GB (default 0)
104 :param swap: the size of the dedicated swap disk in GB (default 0)
105 :param rxtx_factor: the receive/transmit factor to be set on ports if backend supports
106 QoS extension (default 1.0)
107 :param is_public: denotes whether or not the flavor is public (default True)
108 :param metadata: freeform dict() for special metadata (default hw:mem_page_size=any)
112 self.name = config.get('name')
114 if config.get('flavor_id'):
115 self.flavor_id = config['flavor_id']
117 self.flavor_id = flavor_id
119 self.ram = config.get('ram')
120 self.disk = config.get('disk')
121 self.vcpus = config.get('vcpus')
123 if config.get('ephemeral'):
124 self.ephemeral = config['ephemeral']
126 self.ephemeral = ephemeral
128 if config.get('swap'):
129 self.swap = config['swap']
133 if config.get('rxtx_factor'):
134 self.rxtx_factor = config['rxtx_factor']
136 self.rxtx_factor = rxtx_factor
138 if config.get('is_public') is not None:
139 self.is_public = config['is_public']
141 self.is_public = is_public
143 if config.get('metadata'):
144 self.metadata = config['metadata']
146 self.metadata = metadata
149 self.flavor_id = flavor_id
153 self.ephemeral = ephemeral
155 self.rxtx_factor = rxtx_factor
156 self.is_public = is_public
157 self.metadata = metadata
159 if not self.name or not self.ram or not self.disk or not self.vcpus:
160 raise Exception('The attributes name, ram, disk, and vcpus are required for FlavorSettings')
162 if not isinstance(self.ram, int):
163 raise Exception('The ram attribute must be a integer')
165 if not isinstance(self.disk, int):
166 raise Exception('The ram attribute must be a integer')
168 if not isinstance(self.vcpus, int):
169 raise Exception('The vcpus attribute must be a integer')
171 if self.ephemeral and not isinstance(self.ephemeral, int):
172 raise Exception('The ephemeral attribute must be an integer')
174 if self.swap and not isinstance(self.swap, int):
175 raise Exception('The swap attribute must be an integer')
177 if self.rxtx_factor and not isinstance(self.rxtx_factor, (int, float)):
178 raise Exception('The is_public attribute must be an integer or float')
180 if self.is_public and not isinstance(self.is_public, bool):
181 raise Exception('The is_public attribute must be a boolean')