Template Structure

The Heat Orchestration Template (HOT) is defined in YAML format.

Below is an outline of the template structure.

heat_template_version: 2013-05-23

description: <description>

parameters:
  <parameters>

resources:
  <resources>

outputs:
  <outputs>
Section Required Description
heat_template_version Yes

The HOT version.

Specified as 2013-05-23.

description No Defines a description of the template.
parameters No

Defines the input parameters.

This is used when instantiating the template.

resources No Defines the resources.
outputs No

Defines the output parameters.

This can be used by users after instantiation of the template has been completed.

Note: Heat templates use indenting to represent hierarchical structures. However, tab characters cannot be used for these indents.

parameters, resources, and outputs have the following relationships.

parameters Defines the input parameters used when using a Heat template.
resources Refers to parameters and can be used in resource creation
outputs Refers to parameters and resources, and can be used as output information
parameters:
  Defines the input parameters used when using a Heat template
resources:
  Refers to parameters and can be used in resource creation
outputs:
  Refers to parameters and resources, and can be used as output information