08431c7c06
This give the user a way to set defaults recursively down nested stacks without having to create the parameter in every template (it's ignored if the template does not have the parameter). blueprint env-nested-usability Change-Id: Ie6b4481417204a527d322fd532c341b9acbce473
192 lines
7.3 KiB
Python
192 lines
7.3 KiB
Python
#
|
|
# 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 collections
|
|
import six
|
|
|
|
from heat.common.i18n import _
|
|
from heat.engine.cfn import functions as cfn_funcs
|
|
from heat.engine import function
|
|
from heat.engine import parameters
|
|
from heat.engine import rsrc_defn
|
|
from heat.engine import template
|
|
|
|
|
|
_RESOURCE_KEYS = (
|
|
RES_TYPE, RES_PROPERTIES, RES_METADATA, RES_DEPENDS_ON,
|
|
RES_DELETION_POLICY, RES_UPDATE_POLICY, RES_DESCRIPTION,
|
|
) = (
|
|
'Type', 'Properties', 'Metadata', 'DependsOn',
|
|
'DeletionPolicy', 'UpdatePolicy', 'Description',
|
|
)
|
|
|
|
|
|
class CfnTemplate(template.Template):
|
|
'''A stack template.'''
|
|
|
|
SECTIONS = (VERSION, ALTERNATE_VERSION, DESCRIPTION, MAPPINGS,
|
|
PARAMETERS, RESOURCES, OUTPUTS) = \
|
|
('AWSTemplateFormatVersion', 'HeatTemplateFormatVersion',
|
|
'Description', 'Mappings', 'Parameters', 'Resources', 'Outputs'
|
|
)
|
|
|
|
SECTIONS_NO_DIRECT_ACCESS = set([PARAMETERS, VERSION, ALTERNATE_VERSION])
|
|
|
|
functions = {
|
|
'Fn::FindInMap': cfn_funcs.FindInMap,
|
|
'Fn::GetAZs': cfn_funcs.GetAZs,
|
|
'Ref': cfn_funcs.Ref,
|
|
'Fn::GetAtt': cfn_funcs.GetAtt,
|
|
'Fn::Select': cfn_funcs.Select,
|
|
'Fn::Join': cfn_funcs.Join,
|
|
'Fn::Base64': cfn_funcs.Base64,
|
|
}
|
|
|
|
def __getitem__(self, section):
|
|
'''Get the relevant section in the template.'''
|
|
if section not in self.SECTIONS:
|
|
raise KeyError(_('"%s" is not a valid template section') % section)
|
|
if section in self.SECTIONS_NO_DIRECT_ACCESS:
|
|
raise KeyError(
|
|
_('Section %s can not be accessed directly.') % section)
|
|
|
|
if section == self.DESCRIPTION:
|
|
default = 'No description'
|
|
else:
|
|
default = {}
|
|
|
|
# if a section is None (empty yaml section) return {}
|
|
# to be consistent with an empty json section.
|
|
return self.t.get(section) or default
|
|
|
|
def param_schemata(self, param_defaults=None):
|
|
params = self.t.get(self.PARAMETERS) or {}
|
|
pdefaults = param_defaults or {}
|
|
for name, schema in six.iteritems(params):
|
|
if name in pdefaults:
|
|
params[name][parameters.DEFAULT] = pdefaults[name]
|
|
|
|
return dict((name, parameters.Schema.from_dict(name, schema))
|
|
for name, schema in six.iteritems(params))
|
|
|
|
def parameters(self, stack_identifier, user_params, param_defaults=None):
|
|
return parameters.Parameters(stack_identifier, self,
|
|
user_params=user_params,
|
|
param_defaults=param_defaults)
|
|
|
|
def resource_definitions(self, stack):
|
|
def rsrc_defn_item(name, snippet):
|
|
data = self.parse(stack, snippet)
|
|
|
|
def get_check_type(key, valid_types, typename, default=None):
|
|
if key in data:
|
|
field = data[key]
|
|
if not isinstance(field, valid_types):
|
|
args = {'name': name, 'key': key, 'typename': typename}
|
|
msg = _('Resource %(name)s %(key)s type '
|
|
'must be %(typename)s') % args
|
|
raise TypeError(msg)
|
|
return field
|
|
else:
|
|
return default
|
|
|
|
resource_type = get_check_type(RES_TYPE,
|
|
six.string_types,
|
|
'string')
|
|
if resource_type is None:
|
|
args = {'name': name, 'type_key': RES_TYPE}
|
|
msg = _('Resource %(name)s is missing "%(type_key)s"') % args
|
|
raise KeyError(msg)
|
|
|
|
properties = get_check_type(RES_PROPERTIES,
|
|
(collections.Mapping,
|
|
function.Function),
|
|
'object')
|
|
|
|
metadata = get_check_type(RES_METADATA,
|
|
(collections.Mapping,
|
|
function.Function),
|
|
'object')
|
|
|
|
depends = get_check_type(RES_DEPENDS_ON,
|
|
collections.Sequence,
|
|
'list or string',
|
|
default=[])
|
|
if isinstance(depends, six.string_types):
|
|
depends = [depends]
|
|
|
|
deletion_policy = get_check_type(RES_DELETION_POLICY,
|
|
six.string_types,
|
|
'string')
|
|
|
|
update_policy = get_check_type(RES_UPDATE_POLICY,
|
|
(collections.Mapping,
|
|
function.Function),
|
|
'object')
|
|
|
|
description = get_check_type(RES_DESCRIPTION,
|
|
six.string_types,
|
|
'string',
|
|
default='')
|
|
|
|
defn = rsrc_defn.ResourceDefinition(
|
|
name, resource_type,
|
|
properties=properties,
|
|
metadata=metadata,
|
|
depends=depends,
|
|
deletion_policy=deletion_policy,
|
|
update_policy=update_policy,
|
|
description=description)
|
|
return name, defn
|
|
|
|
resources = self.t.get(self.RESOURCES) or {}
|
|
return dict(rsrc_defn_item(name, data)
|
|
for name, data in resources.items())
|
|
|
|
def add_resource(self, definition, name=None):
|
|
if name is None:
|
|
name = definition.name
|
|
hot_tmpl = definition.render_hot()
|
|
|
|
HOT_TO_CFN_ATTRS = {'type': RES_TYPE,
|
|
'properties': RES_PROPERTIES,
|
|
'metadata': RES_METADATA,
|
|
'depends_on': RES_DEPENDS_ON,
|
|
'deletion_policy': RES_DELETION_POLICY,
|
|
'update_policy': RES_UPDATE_POLICY}
|
|
|
|
cfn_tmpl = dict((HOT_TO_CFN_ATTRS[k], v) for k, v in hot_tmpl.items())
|
|
|
|
if len(cfn_tmpl.get(RES_DEPENDS_ON, [])) == 1:
|
|
cfn_tmpl[RES_DEPENDS_ON] = cfn_tmpl[RES_DEPENDS_ON][0]
|
|
|
|
if self.t.get(self.RESOURCES) is None:
|
|
self.t[self.RESOURCES] = {}
|
|
self.t[self.RESOURCES][name] = cfn_tmpl
|
|
|
|
|
|
class HeatTemplate(CfnTemplate):
|
|
functions = {
|
|
'Fn::FindInMap': cfn_funcs.FindInMap,
|
|
'Fn::GetAZs': cfn_funcs.GetAZs,
|
|
'Ref': cfn_funcs.Ref,
|
|
'Fn::GetAtt': cfn_funcs.GetAtt,
|
|
'Fn::Select': cfn_funcs.Select,
|
|
'Fn::Join': cfn_funcs.Join,
|
|
'Fn::Split': cfn_funcs.Split,
|
|
'Fn::Replace': cfn_funcs.Replace,
|
|
'Fn::Base64': cfn_funcs.Base64,
|
|
'Fn::MemberListToMap': cfn_funcs.MemberListToMap,
|
|
'Fn::ResourceFacade': cfn_funcs.ResourceFacade,
|
|
}
|