heat.engine.template 模块

class heat.engine.template.Template(template, *args, **kwargs)

基类: Mapping

模板格式插件的抽象基类。

所有模板格式（内部和第三方）都应从 Template 派生，并实现抽象函数以提供资源定义和其他数据。

这是一个稳定的第三方 API。不要添加特定于内部模板格式的实现。不要添加新的抽象方法。

add_output(definition)

将输出添加到模板。

输出作为 OutputDefinition 对象传递。

abstract add_resource(definition, name=None)

将资源添加到模板。

资源作为 ResourceDefinition 对象传递。如果未指定名称，则应使用 ResourceDefinition 中的名称。

all_param_schemata(files)

condition_functions = {}

conditions(stack)

返回已解析条件的字典。

classmethod create_empty_template(version=('heat_template_version', '2015-04-30'), from_template=None)

创建一个空模板。

使用给定的版本创建一个新的空模板。如果未提供版本，则返回一个版本为“2015-04-30”的新空 HOT 模板。

参数：

version – 包含模板版本头和值的元组，例如 ('heat_template_version', '2015-04-30')

返回值:

一个新的空模板。

property files

functions = {}

abstract get_section_name(section)

获取资源或输出定义中的字段名称。

返回模板格式中给定字段（由 heat.engine.rsrc_defn 和 heat.engine.output 给定的常量指定）的名称。这用于错误报告，以帮助用户找到模板中错误的所在位置。

请注意，这里的“section”与模板的其他地方（如参数、资源等）不同，它不指模板的顶级部分。

classmethod load(context, template_id, t=None)

从数据库中检索具有给定 ID 的 Template。

merge_snippets(other)

abstract outputs(stack)

返回 OutputDefinition 对象的字典。

abstract param_schemata(param_defaults=None)

返回参数的 Schema 对象的字典。

abstract parameters(stack_identifier, user_params, param_defaults=None)

返回堆栈的 parameters.Parameters 对象。

parse(stack, snippet, path='')

parse_condition(stack, snippet, path='')

remove_all_resources()

删除模板中的所有资源。

remove_resource(name)

从模板中删除资源。

abstract resource_definitions(stack)

返回 ResourceDefinition 对象的字典。

store(context)

将 Template 存储在数据库中并返回其 ID。

validate()

验证模板。

验证模板的顶级部分以及 select 部分内的语法。某些部分在这里未检查，但在负责使用各自部分的各个代码部分中进行检查（例如，参数由参数模式类检查）。