Source code for heat.engine.hot.template

#    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.

from heat.engine import template
from heat.engine.cfn import template as cfn_template
from heat.engine.hot import parameters
from heat.openstack.common.gettextutils import _
from heat.openstack.common import log as logging


logger = logging.getLogger(__name__)


[docs]class HOTemplate(template.Template): """ A Heat Orchestration Template format stack template. """ SECTIONS = (VERSION, DESCRIPTION, PARAMETER_GROUPS, PARAMETERS, RESOURCES, OUTPUTS, MAPPINGS) = \ ('heat_template_version', 'description', 'parameter_groups', 'parameters', 'resources', 'outputs', '__undefined__') SECTIONS_NO_DIRECT_ACCESS = set([PARAMETERS, VERSION]) VERSIONS = ('2013-05-23',) _CFN_TO_HOT_SECTIONS = {cfn_template.CfnTemplate.VERSION: VERSION, cfn_template.CfnTemplate.DESCRIPTION: DESCRIPTION, cfn_template.CfnTemplate.PARAMETERS: PARAMETERS, cfn_template.CfnTemplate.MAPPINGS: MAPPINGS, cfn_template.CfnTemplate.RESOURCES: RESOURCES, cfn_template.CfnTemplate.OUTPUTS: OUTPUTS} def __getitem__(self, section): """"Get the relevant section in the template.""" #first translate from CFN into HOT terminology if necessary if section not in self.SECTIONS: section = HOTemplate._translate(section, self._CFN_TO_HOT_SECTIONS, _('"%s" is not a valid template ' 'section')) 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.MAPPINGS: return {} if section == self.DESCRIPTION: default = 'No description' else: default = {} the_section = self.t.get(section, default) # In some cases (e.g. parameters), also translate each entry of # a section into CFN format (case, naming, etc) so the rest of the # engine can cope with it. # This is a shortcut for now and might be changed in the future. if section == self.RESOURCES: return self._translate_resources(the_section) if section == self.OUTPUTS: return self._translate_outputs(the_section) return the_section @staticmethod def _translate(value, mapping, err_msg=None): try: return mapping[value] except KeyError as ke: if err_msg: raise KeyError(err_msg % value) else: raise ke def _translate_resources(self, resources): """Get the resources of the template translated into CFN format.""" HOT_TO_CFN_ATTRS = {'type': 'Type', 'properties': 'Properties', 'metadata': 'Metadata', 'depends_on': 'DependsOn', 'deletion_policy': 'DeletionPolicy', 'update_policy': 'UpdatePolicy'} cfn_resources = {} for resource_name, attrs in resources.iteritems(): cfn_resource = {} for attr, attr_value in attrs.iteritems(): cfn_attr = self._translate(attr, HOT_TO_CFN_ATTRS, _('"%s" is not a valid keyword ' 'inside a resource definition')) cfn_resource[cfn_attr] = attr_value cfn_resources[resource_name] = cfn_resource return cfn_resources def _translate_outputs(self, outputs): """Get the outputs of the template translated into CFN format.""" HOT_TO_CFN_ATTRS = {'description': 'Description', 'value': 'Value'} cfn_outputs = {} for output_name, attrs in outputs.iteritems(): cfn_output = {} for attr, attr_value in attrs.iteritems(): cfn_attr = self._translate(attr, HOT_TO_CFN_ATTRS, _('"%s" is not a valid keyword ' 'inside an output definition')) cfn_output[cfn_attr] = attr_value cfn_outputs[output_name] = cfn_output return cfn_outputs
[docs] def param_schemata(self): params = self.t.get(self.PARAMETERS, {}).iteritems() return dict((name, parameters.HOTParamSchema.from_dict(schema)) for name, schema in params)
[docs] def parameters(self, stack_identifier, user_params): return parameters.HOTParameters(stack_identifier, self, user_params=user_params)
[docs]def template_mapping(): return { ('heat_template_version', '2013-05-23'): HOTemplate, }