1 ##############################################################################
2 # Copyright (c) 2015 Ericsson AB and others.
4 # All rights reserved. This program and the accompanying materials
5 # are made available under the terms of the Apache License, Version 2.0
6 # which accompanies this distribution, and is available at
7 # http://www.apache.org/licenses/LICENSE-2.0
8 ##############################################################################
10 """ Heat template and stack management
21 import heatclient.client
24 from yardstick.common import template_format
27 log = logging.getLogger(__name__)
30 class HeatObject(object):
31 ''' base class for template and stack'''
33 self._keystone_client = None
34 self._heat_client = None
37 def _get_keystone_client(self):
38 '''returns a keystone client instance'''
40 if self._keystone_client is None:
41 self._keystone_client = keystoneclient.v2_0.client.Client(
42 auth_url=os.environ.get('OS_AUTH_URL'),
43 username=os.environ.get('OS_USERNAME'),
44 password=os.environ.get('OS_PASSWORD'),
45 tenant_name=os.environ.get('OS_TENANT_NAME'),
46 cacert=os.environ.get('OS_CACERT'))
48 return self._keystone_client
50 def _get_heat_client(self):
51 '''returns a heat client instance'''
53 if self._heat_client is None:
54 keystone = self._get_keystone_client()
55 heat_endpoint = keystone.service_catalog.url_for(
56 service_type='orchestration')
57 self._heat_client = heatclient.client.Client(
58 '1', endpoint=heat_endpoint, token=keystone.auth_token)
60 return self._heat_client
63 '''returns stack state as a string'''
64 heat = self._get_heat_client()
65 stack = heat.stacks.get(self.uuid)
66 return getattr(stack, 'stack_status')
69 class HeatStack(HeatObject):
70 ''' Represents a Heat stack (deployed template) '''
73 def __init__(self, name):
74 super(HeatStack, self).__init__()
78 HeatStack.stacks.append(self)
82 '''check if any stack has been deployed'''
83 return len(HeatStack.stacks) > 0
86 '''deletes a stack from the target cloud using heat'''
90 log.info("Deleting stack '%s', uuid:%s", self.name, self.uuid)
91 heat = self._get_heat_client()
92 template = heat.stacks.get(self.uuid)
93 start_time = time.time()
95 status = self.status()
97 while status != u'DELETE_COMPLETE':
98 log.debug("stack state %s", status)
99 if status == u'DELETE_FAILED':
101 heat.stacks.get(self.uuid).stack_status_reason)
104 status = self.status()
106 end_time = time.time()
107 log.info("Deleted stack '%s' in %d secs", self.name,
108 end_time - start_time)
111 def delete(self, block=True, retries=3):
112 '''deletes a stack in the target cloud using heat (with retry)
113 Sometimes delete fail with "InternalServerError" and the next attempt
114 succeeds. So it is worthwhile to test a couple of times.
116 if self.uuid is None:
128 except RuntimeError as err:
133 # if still not deleted try once more and let it fail everything
134 if self.uuid is not None:
137 HeatStack.stacks.remove(self)
141 for stack in HeatStack.stacks[:]:
146 raise RuntimeError("not implemented")
149 class HeatTemplate(HeatObject):
150 '''Describes a Heat template and a method to deploy template to a stack'''
152 def _init_template(self):
154 self._template['heat_template_version'] = '2013-05-23'
156 timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
157 self._template['description'] = \
158 '''Stack built by the yardstick framework for %s on host %s %s.
159 All referred generated resources are prefixed with the template
160 name (i.e. %s).''' % (getpass.getuser(), socket.gethostname(),
161 timestamp, self.name)
163 # short hand for resources part of template
164 self.resources = self._template['resources'] = {}
166 self._template['outputs'] = {}
168 def __init__(self, name, template_file=None, heat_parameters=None):
169 super(HeatTemplate, self).__init__()
171 self.state = "NOT_CREATED"
172 self.keystone_client = None
173 self.heat_client = None
174 self.heat_parameters = {}
176 # heat_parameters is passed to heat in stack create, empty dict when
177 # yardstick creates the template (no get_param in resources part)
179 self.heat_parameters = heat_parameters
182 with open(template_file) as stream:
183 print "Parsing external template:", template_file
184 template_str = stream.read()
185 self._template = template_format.parse(template_str)
186 self._parameters = heat_parameters
188 self._init_template()
190 # holds results of requested output after deployment
193 log.debug("template object '%s' created", name)
195 def add_network(self, name):
196 '''add to the template a Neutron Net'''
197 log.debug("adding Neutron::Net '%s'", name)
198 self.resources[name] = {
199 'type': 'OS::Neutron::Net',
200 'properties': {'name': name}
203 def add_subnet(self, name, network, cidr):
204 '''add to the template a Neutron Subnet'''
205 log.debug("adding Neutron::Subnet '%s' in network '%s', cidr '%s'",
207 self.resources[name] = {
208 'type': 'OS::Neutron::Subnet',
209 'depends_on': network,
213 'network_id': {'get_resource': network}
217 self._template['outputs'][name] = {
218 'description': 'subnet %s ID' % name,
219 'value': {'get_resource': name}
222 def add_router(self, name, ext_gw_net, subnet_name):
223 '''add to the template a Neutron Router and interface'''
224 log.debug("adding Neutron::Router:'%s', gw-net:'%s'", name, ext_gw_net)
226 self.resources[name] = {
227 'type': 'OS::Neutron::Router',
228 'depends_on': [subnet_name],
231 'external_gateway_info': {
232 'network': ext_gw_net
237 def add_router_interface(self, name, router_name, subnet_name):
238 '''add to the template a Neutron RouterInterface and interface'''
239 log.debug("adding Neutron::RouterInterface '%s' router:'%s', "
240 "subnet:'%s'", name, router_name, subnet_name)
242 self.resources[name] = {
243 'type': 'OS::Neutron::RouterInterface',
244 'depends_on': [router_name, subnet_name],
246 'router_id': {'get_resource': router_name},
247 'subnet_id': {'get_resource': subnet_name}
251 def add_port(self, name, network_name, subnet_name, sec_group_id=None):
252 '''add to the template a named Neutron Port'''
253 log.debug("adding Neutron::Port '%s', network:'%s', subnet:'%s', "
254 "secgroup:%s", name, network_name, subnet_name, sec_group_id)
255 self.resources[name] = {
256 'type': 'OS::Neutron::Port',
257 'depends_on': [subnet_name],
260 'fixed_ips': [{'subnet': {'get_resource': subnet_name}}],
261 'network_id': {'get_resource': network_name},
262 'replacement_policy': 'AUTO',
267 self.resources[name]['depends_on'].append(sec_group_id)
268 self.resources[name]['properties']['security_groups'] = \
271 self._template['outputs'][name] = {
272 'description': 'Address for interface %s' % name,
273 'value': {'get_attr': [name, 'fixed_ips', 0, 'ip_address']}
276 def add_floating_ip(self, name, network_name, port_name, router_if_name,
278 '''add to the template a Nova FloatingIP resource
279 see: https://bugs.launchpad.net/heat/+bug/1299259
281 log.debug("adding Nova::FloatingIP '%s', network '%s', port '%s', "
282 "rif '%s'", name, network_name, port_name, router_if_name)
284 self.resources[name] = {
285 'type': 'OS::Nova::FloatingIP',
286 'depends_on': [port_name, router_if_name],
293 self.resources[name]["depends_on"].append(secgroup_name)
295 self._template['outputs'][name] = {
296 'description': 'floating ip %s' % name,
297 'value': {'get_attr': [name, 'ip']}
300 def add_floating_ip_association(self, name, floating_ip_name, port_name):
301 '''add to the template a Nova FloatingIP Association resource
303 log.debug("adding Nova::FloatingIPAssociation '%s', server '%s', "
304 "floating_ip '%s'", name, port_name, floating_ip_name)
306 self.resources[name] = {
307 'type': 'OS::Neutron::FloatingIPAssociation',
308 'depends_on': [port_name],
310 'floatingip_id': {'get_resource': floating_ip_name},
311 'port_id': {'get_resource': port_name}
315 def add_keypair(self, name):
316 '''add to the template a Nova KeyPair'''
317 log.debug("adding Nova::KeyPair '%s'", name)
318 self.resources[name] = {
319 'type': 'OS::Nova::KeyPair',
322 'public_key': pkg_resources.resource_string(
323 'yardstick.resources', 'files/yardstick_key.pub')
327 def add_servergroup(self, name, policy):
328 '''add to the template a Nova ServerGroup'''
329 log.debug("adding Nova::ServerGroup '%s', policy '%s'", name, policy)
330 if policy not in ["anti-affinity", "affinity"]:
331 raise ValueError(policy)
333 self.resources[name] = {
334 'type': 'OS::Nova::ServerGroup',
341 self._template['outputs'][name] = {
342 'description': 'ID Server Group %s' % name,
343 'value': {'get_resource': name}
346 def add_security_group(self, name):
347 '''add to the template a Neutron SecurityGroup'''
348 log.debug("adding Neutron::SecurityGroup '%s'", name)
349 self.resources[name] = {
350 'type': 'OS::Neutron::SecurityGroup',
353 'description': "Group allowing icmp and upd/tcp on all ports",
355 {'remote_ip_prefix': '0.0.0.0/0',
357 'port_range_min': '1',
358 'port_range_max': '65535'},
359 {'remote_ip_prefix': '0.0.0.0/0',
361 'port_range_min': '1',
362 'port_range_max': '65535'},
363 {'remote_ip_prefix': '0.0.0.0/0',
369 self._template['outputs'][name] = {
370 'description': 'ID of Security Group',
371 'value': {'get_resource': name}
374 def add_server(self, name, image, flavor, ports=None, networks=None,
375 scheduler_hints=None, user=None, key_name=None,
376 user_data=None, metadata=None, additional_properties=None):
377 '''add to the template a Nova Server'''
378 log.debug("adding Nova::Server '%s', image '%s', flavor '%s', "
379 "ports %s", name, image, flavor, ports)
381 self.resources[name] = {
382 'type': 'OS::Nova::Server'
385 server_properties = {
389 'networks': [] # list of dictionaries
393 server_properties['admin_user'] = user
396 self.resources[name]['depends_on'] = [key_name]
397 server_properties['key_name'] = {'get_resource': key_name}
400 self.resources[name]['depends_on'] = ports
403 server_properties['networks'].append(
404 {'port': {'get_resource': port}}
408 for i in range(len(networks)):
409 server_properties['networks'].append({'network': networks[i]})
412 server_properties['scheduler_hints'] = scheduler_hints
415 server_properties['user_data'] = user_data
418 assert type(metadata) is dict
419 server_properties['metadata'] = metadata
421 if additional_properties:
422 assert type(additional_properties) is dict
423 for prop in additional_properties:
424 server_properties[prop] = additional_properties[prop]
426 server_properties['config_drive'] = True
428 self.resources[name]['properties'] = server_properties
430 self._template['outputs'][name] = {
431 'description': 'VM UUID',
432 'value': {'get_resource': name}
435 def create(self, block=True):
436 '''creates a template in the target cloud using heat
437 returns a dict with the requested output values from the template'''
438 log.info("Creating stack '%s'", self.name)
440 # create stack early to support cleanup, e.g. ctrl-c while waiting
441 stack = HeatStack(self.name)
443 heat = self._get_heat_client()
444 json_template = json.dumps(self._template)
445 start_time = time.time()
446 stack.uuid = self.uuid = heat.stacks.create(
447 stack_name=self.name, template=json_template,
448 parameters=self.heat_parameters)['stack']['id']
450 status = self.status()
453 while status != u'CREATE_COMPLETE':
454 log.debug("stack state %s", status)
455 if status == u'CREATE_FAILED':
456 raise RuntimeError(getattr(heat.stacks.get(self.uuid),
457 'stack_status_reason'))
460 status = self.status()
462 end_time = time.time()
463 outputs = getattr(heat.stacks.get(self.uuid), 'outputs')
465 for output in outputs:
466 self.outputs[output["output_key"].encode("ascii")] = \
467 output["output_value"].encode("ascii")
469 log.info("Created stack '%s' in %d secs",
470 self.name, end_time - start_time)
472 stack.outputs = self.outputs