Heat Orchestration Template reference

Transcription

1 docs.openstack.org

2 Heat Orchestration Template reference ( ) Copyright 2014 OpenStack Foundation Some rights reserved. This guide documents the Heat Orchestration Template syntax. Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. ii

3 Table of Contents HOT reference overview. vi Conventions vi 1. OpenStack Resource Types 1 OS::Ceilometer::Alarm 2 OS::Ceilometer::CombinationAlarm.. 6 OS::Cinder::Volume. 8 OS::Cinder::VolumeAttachment.. 11 OS::Glance::Image. 12 OS::Heat::AccessPolicy.. 15 OS::Heat::AutoScalingGroup. 16 OS::Heat::CWLiteAlarm 18 OS::Heat::CloudConfig. 21 OS::Heat::HARestarter. 23 OS::Heat::InstanceGroup. 24 OS::Heat::MultipartMime 25 OS::Heat::RandomString. 27 OS::Heat::ResourceGroup 30 OS::Heat::ScalingPolicy. 34 OS::Heat::SoftwareComponent 35 OS::Heat::SoftwareConfig.. 39 OS::Heat::SoftwareDeployment.. 43 OS::Heat::SoftwareDeployments. 45 OS::Heat::StructuredConfig 48 OS::Heat::StructuredDeployment 51 OS::Heat::StructuredDeployments.. 53 OS::Heat::SwiftSignal 55 OS::Heat::SwiftSignalHandle. 57 OS::Heat::UpdateWaitConditionHandle 58 OS::Heat::WaitCondition. 59 OS::Heat::WaitConditionHandle.. 60 OS::Neutron::Firewall 61 OS::Neutron::FirewallPolicy 63 OS::Neutron::FirewallRule.. 64 OS::Neutron::FloatingIP.. 68 OS::Neutron::FloatingIPAssociation 69 OS::Neutron::HealthMonitor. 71 OS::Neutron::IKEPolicy. 73 OS::Neutron::IPsecPolicy. 76 OS::Neutron::IPsecSiteConnection.. 79 OS::Neutron::LoadBalancer 83 OS::Neutron::MeteringLabel. 84 OS::Neutron::MeteringRule 85 OS::Neutron::Net 87 OS::Neutron::NetworkGateway 89 OS::Neutron::Pool.. 92 OS::Neutron::PoolMember. 96 OS::Neutron::Port.. 98 OS::Neutron::ProviderNet 102 iii

4 OS::Neutron::Router OS::Neutron::RouterGateway. 107 OS::Neutron::RouterInterface. 108 OS::Neutron::SecurityGroup 109 OS::Neutron::Subnet OS::Neutron::VPNService OS::Nova::FloatingIP OS::Nova::FloatingIPAssociation 119 OS::Nova::KeyPair 120 OS::Nova::Server OS::Nova::ServerGroup. 130 OS::Sahara::Cluster. 131 OS::Sahara::ClusterTemplate OS::Sahara::NodeGroupTemplate. 136 OS::Swift::Container 139 OS::Trove::Instance CloudFormation Compatible Resource Types 146 AWS::AutoScaling::AutoScalingGroup 146 AWS::AutoScaling::LaunchConfiguration AWS::AutoScaling::ScalingPolicy 154 AWS::CloudFormation::Stack AWS::CloudFormation::WaitCondition AWS::CloudFormation::WaitConditionHandle. 158 AWS::CloudWatch::Alarm 159 AWS::EC2::EIP 161 AWS::EC2::EIPAssociation. 162 AWS::EC2::Instance. 164 AWS::EC2::InternetGateway 171 AWS::EC2::NetworkInterface. 172 AWS::EC2::RouteTable AWS::EC2::SecurityGroup. 175 AWS::EC2::Subnet 178 AWS::EC2::SubnetRouteTableAssociation. 180 AWS::EC2::VPC. 181 AWS::EC2::VPCGatewayAttachment 182 AWS::EC2::Volume AWS::EC2::VolumeAttachment AWS::ElasticLoadBalancing::LoadBalancer 187 AWS::IAM::AccessKey 190 AWS::IAM::User 191 AWS::RDS::DBInstance AWS::S3::Bucket CloudFormation Compatible Functions 198 Ref. 198 Fn::Base Fn::FindInMap Fn::GetAtt Fn::GetAZs Fn::Join. 200 Fn::Select. 200 Fn::Split 200 iv

5 Fn::Replace. 201 Fn::ResourceFacade 201 Fn::MemberListToMap A. Community support 203 Documentation 203 ask.openstack.org 204 OpenStack mailing lists. 204 The OpenStack wiki 205 The Launchpad Bugs area The OpenStack IRC channel 206 Documentation feedback 206 OpenStack distribution packages. 206 v

6 HOT reference overview Conventions.. vi Heat Orchestration Template (HOT) is a new template format meant to replace the Heat CloudFormation-compatible format (CFN) as the native format supported by the Orchestration module over time. This reference documents the syntax of: OpenStack native resources CloudFormation-compatible resources CloudFormation-compatible functions Conventions Notices The OpenStack documentation uses several typesetting conventions. Notices take these forms: Note A handy tip or reminder. Important Something you must be aware of before proceeding. Warning Command prompts Critical information about the risk of data loss or security issues. $ prompt Any user, including the root user, can run commands that are prefixed with the $ prompt. # prompt The root user must run commands that are prefixed with the # prompt. You can also prefix these commands with the sudo command, if available, to run them. vi

7 1. OpenStack Resource Types OS::Ceilometer::Alarm.. 2 OS::Ceilometer::CombinationAlarm. 6 OS::Cinder::Volume 8 OS::Cinder::VolumeAttachment. 11 OS::Glance::Image 12 OS::Heat::AccessPolicy. 15 OS::Heat::AutoScalingGroup 16 OS::Heat::CWLiteAlarm.. 18 OS::Heat::CloudConfig 21 OS::Heat::HARestarter 23 OS::Heat::InstanceGroup 24 OS::Heat::MultipartMime.. 25 OS::Heat::RandomString 27 OS::Heat::ResourceGroup.. 30 OS::Heat::ScalingPolicy 34 OS::Heat::SoftwareComponent.. 35 OS::Heat::SoftwareConfig. 39 OS::Heat::SoftwareDeployment. 43 OS::Heat::SoftwareDeployments 45 OS::Heat::StructuredConfig.. 48 OS::Heat::StructuredDeployment.. 51 OS::Heat::StructuredDeployments. 53 OS::Heat::SwiftSignal.. 55 OS::Heat::SwiftSignalHandle 57 OS::Heat::UpdateWaitConditionHandle.. 58 OS::Heat::WaitCondition 59 OS::Heat::WaitConditionHandle. 60 OS::Neutron::Firewall.. 61 OS::Neutron::FirewallPolicy.. 63 OS::Neutron::FirewallRule. 64 OS::Neutron::FloatingIP. 68 OS::Neutron::FloatingIPAssociation.. 69 OS::Neutron::HealthMonitor 71 OS::Neutron::IKEPolicy 73 OS::Neutron::IPsecPolicy 76 OS::Neutron::IPsecSiteConnection. 79 OS::Neutron::LoadBalancer.. 83 OS::Neutron::MeteringLabel 84 OS::Neutron::MeteringRule.. 85 OS::Neutron::Net.. 87 OS::Neutron::NetworkGateway.. 89 OS::Neutron::Pool. 92 OS::Neutron::PoolMember 96 OS::Neutron::Port. 98 OS::Neutron::ProviderNet OS::Neutron::Router. 104 OS::Neutron::RouterGateway 107 OS::Neutron::RouterInterface 108 1

8 OS::Neutron::SecurityGroup OS::Neutron::Subnet. 113 OS::Neutron::VPNService. 116 OS::Nova::FloatingIP. 118 OS::Nova::FloatingIPAssociation OS::Nova::KeyPair OS::Nova::Server. 122 OS::Nova::ServerGroup 130 OS::Sahara::Cluster 131 OS::Sahara::ClusterTemplate. 133 OS::Sahara::NodeGroupTemplate 136 OS::Swift::Container OS::Trove::Instance 141 OS::Ceilometer::Alarm Properties alarm_actions A list of URLs (webhooks) to invoke when state transitions to alarm. comparison_operator Operator used to compare specified statistic with threshold. Allowed values: ge, gt, eq, ne, lt, le description Description for the alarm. enabled True if alarm evaluation/actioning is enabled. Optional property, defaults to "true". evaluation_periods Number of periods to evaluate over. insufficient_data_actions A list of URLs (webhooks) to invoke when state transitions to insufficient-data. 2

9 matching_metadata Meter should match this resource metadata (key=value) additionally to the meter_name. Optional property, defaults to "{". meter_name Meter name watched by the alarm. ok_actions A list of URLs (webhooks) to invoke when state transitions to ok. period Period (seconds) to evaluate over. query A list of query factors, each comparing a Sample attribute with a value. Implicitly combined with matching_metadata, if any. List contents: * Map properties: field Name of attribute to compare. Names of the form metadata.user_metadata.x or metadata.metering.x are equivalent to what you can address through matching_metadata; the former for Nova meters, the latter for all others. To see the attributes of your Samples, use `ceilometer --debug sample-list`. 3

10 op Comparison operator Allowed values: le, ge, eq, lt, gt, ne value String value with which to compare repeat_actions False to trigger actions when the threshold is reached AND the alarm's state has changed. By default, actions are called each time the threshold is reached. Optional property, defaults to "true". statistic Meter statistic to evaluate. Allowed values: count, avg, sum, min, max threshold Threshold to evaluate against. HOT Syntax heat_template_version: resources: the_resource: type: OS::Ceilometer::Alarm properties: alarm_actions: [Value, Value, ] comparison_operator: String description: String enabled: Boolean evaluation_periods: Integer insufficient_data_actions: [Value, Value, ] 4

11 matching_metadata: { meter_name: String ok_actions: [Value, Value, ] period: Integer query: [{"field": String, "value": String, "op": String, {"field": String, "value": String, "op": String, ] repeat_actions: Boolean statistic: String threshold: Number YAML Syntax HeatTemplateFormatVersion: ' ' Resources: TheResource: Type: OS::Ceilometer::Alarm Properties: alarm_actions: [Value, Value, ] comparison_operator: String description: String enabled: Boolean evaluation_periods: Integer insufficient_data_actions: [Value, Value, ] matching_metadata: { meter_name: String ok_actions: [Value, Value, ] period: Integer query: [{"field": String, "value": String, "op": String, {"field": String, "value": String, "op": String, ] repeat_actions: Boolean statistic: String threshold: Number JSON Syntax { "AWSTemplateFormatVersion" : " ", "Resources" : { "TheResource": { "Type": "OS::Ceilometer::Alarm", "Properties": { "alarm_actions": [Value, Value, ], "comparison_operator": String, "description": String, "enabled": Boolean, "evaluation_periods": Integer, "insufficient_data_actions": [Value, Value, ], "matching_metadata": {, "meter_name": String, "ok_actions": [Value, Value, ], "period": Integer, "query": [{"field": String, "value": String, "op": String, {"field": String, "value": String, "op": String, ], "repeat_actions": Boolean, "statistic": String, "threshold": Number 5

12 OS::Ceilometer::CombinationAlarm Properties Available since (Icehouse). alarm_actions A list of URLs (webhooks) to invoke when state transitions to alarm. alarm_ids List of alarm identifiers to combine. The length must be at least 1. description Description for the alarm. enabled True if alarm evaluation/actioning is enabled. Optional property, defaults to "true". insufficient_data_actions A list of URLs (webhooks) to invoke when state transitions to insufficient-data. ok_actions A list of URLs (webhooks) to invoke when state transitions to ok. operator Operator used to combine the alarms. 6

13 Allowed values: and, or repeat_actions False to trigger actions when the threshold is reached AND the alarm's state has changed. By default, actions are called each time the threshold is reached. Optional property, defaults to "true". HOT Syntax heat_template_version: resources: the_resource: type: OS::Ceilometer::CombinationAlarm properties: alarm_actions: [Value, Value, ] alarm_ids: [Value, Value, ] description: String enabled: Boolean insufficient_data_actions: [Value, Value, ] ok_actions: [Value, Value, ] operator: String repeat_actions: Boolean YAML Syntax HeatTemplateFormatVersion: ' ' Resources: TheResource: Type: OS::Ceilometer::CombinationAlarm Properties: alarm_actions: [Value, Value, ] alarm_ids: [Value, Value, ] description: String enabled: Boolean insufficient_data_actions: [Value, Value, ] ok_actions: [Value, Value, ] operator: String repeat_actions: Boolean JSON Syntax { "AWSTemplateFormatVersion" : " ", "Resources" : { 7

14 "TheResource": { "Type": "OS::Ceilometer::CombinationAlarm", "Properties": { "alarm_actions": [Value, Value, ], "alarm_ids": [Value, Value, ], "description": String, "enabled": Boolean, "insufficient_data_actions": [Value, Value, ], "ok_actions": [Value, Value, ], "operator": String, "repeat_actions": Boolean OS::Cinder::Volume Properties availability_zone The availability zone in which the volume will be created. backup_id If specified, the backup to create the volume from. description A description of the volume. image If specified, the name or ID of the image to create the volume from. Value must be of type glance.image metadata Key/value pairs to associate with the volume. name A name used to distinguish the volume. 8

15 scheduler_hints Arbitrary key-value pairs specified by the client to help the Cinder scheduler creating a volume. size The size of the volume in GB. On update only increase in size is supported. The value must be at least 1. snapshot_id If specified, the snapshot to create the volume from. source_volid If specified, the volume to use as source. volume_type If specified, the type of volume to use, mapping to a specific backend. imageref Note DEPRECATED - Use property image. The ID of the image to create the volume from. Attributes attachments availability_zone bootable The list of attachments of the volume. The availability zone in which the volume is located. Boolean indicating if the volume can be booted or not. 9

16 created_at display_description display_name encrypted metadata The timestamp indicating volume creation. Description of the volume. Name of the volume. Boolean indicating if the volume is encrypted or not. Key/value pairs associated with the volume. metadata_values size snapshot_id source_volid status volume_type Key/value pairs associated with the volume in raw dict form. The size of the volume in GB. The snapshot the volume was created from, if any. The volume used as source, if any. The status of the volume. The type of the volume mapping to a backend, if any. HOT Syntax heat_template_version: resources: the_resource: type: OS::Cinder::Volume properties: availability_zone: String backup_id: String description: String image: String metadata: { name: String scheduler_hints: { size: Integer snapshot_id: String source_volid: String volume_type: String YAML Syntax HeatTemplateFormatVersion: ' ' Resources: TheResource: Type: OS::Cinder::Volume Properties: availability_zone: String backup_id: String description: String image: String 10

17 JSON Syntax { metadata: { name: String scheduler_hints: { size: Integer snapshot_id: String source_volid: String volume_type: String "AWSTemplateFormatVersion" : " ", "Resources" : { "TheResource": { "Type": "OS::Cinder::Volume", "Properties": { "availability_zone": String, "backup_id": String, "description": String, "image": String, "metadata": {, "name": String, "scheduler_hints": {, "size": Integer, "snapshot_id": String, "source_volid": String, "volume_type": String OS::Cinder::VolumeAttachment Properties instance_uuid The ID of the server to which the volume attaches. mountpoint The location where the volume is exposed on the instance. This assignment may not be honored and it is advised that the path /dev/disk/byid/virtio-<volumeid> be used instead. volume_id The ID of the volume to be attached. 11

18 HOT Syntax heat_template_version: resources: the_resource: type: OS::Cinder::VolumeAttachment properties: instance_uuid: String mountpoint: String volume_id: String YAML Syntax HeatTemplateFormatVersion: ' ' Resources: TheResource: Type: OS::Cinder::VolumeAttachment Properties: instance_uuid: String mountpoint: String volume_id: String JSON Syntax { "AWSTemplateFormatVersion" : " ", "Resources" : { "TheResource": { "Type": "OS::Cinder::VolumeAttachment", "Properties": { "instance_uuid": String, "mountpoint": String, "volume_id": String OS::Glance::Image Properties A resource managing for image in Glance. Available since (Juno). container_format Container format of image. 12

19 disk_format Allowed values: ami, ari, aki, bare, ova, ovf Disk format of image. Allowed values: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso id The image ID. Glance will generate a UUID if not specified. is_public Scope of image accessibility. Public or private. Default value is False means private. Optional property, defaults to "False". location URL where the data for this image already resides. For example, if the image data is stored in swift, you could specify "swift:// example.com/container/obj". min_disk Amount of disk space (in GB) required to boot image. Default value is 0 if not specified and means no limit on the disk size. The value must be at least 0. min_ram Amount of ram (in MB) required to boot image. Default value is 0 if not specified and means no limit on the ram size. The value must be at least 0. name Name for the image. The name of an image is not unique to a Image Service node. 13

20 protected Whether the image can be deleted. If the value is True, the image is protected and cannot be deleted. HOT Syntax heat_template_version: resources: the_resource: type: OS::Glance::Image properties: container_format: String disk_format: String id: String is_public: Boolean location: String min_disk: Integer min_ram: Integer name: String protected: Boolean YAML Syntax HeatTemplateFormatVersion: ' ' Resources: TheResource: Type: OS::Glance::Image Properties: container_format: String disk_format: String id: String is_public: Boolean location: String min_disk: Integer min_ram: Integer name: String protected: Boolean JSON Syntax { "AWSTemplateFormatVersion" : " ", "Resources" : { "TheResource": { "Type": "OS::Glance::Image", "Properties": { "container_format": String, "disk_format": String, "id": String, "is_public": Boolean, 14

21 "location": String, "min_disk": Integer, "min_ram": Integer, "name": String, "protected": Boolean OS::Heat::AccessPolicy Properties AllowedResources Resources that users are allowed to access by the DescribeStackResource API. HOT Syntax heat_template_version: resources: the_resource: type: OS::Heat::AccessPolicy properties: AllowedResources: [Value, Value, ] YAML Syntax HeatTemplateFormatVersion: ' ' Resources: TheResource: Type: OS::Heat::AccessPolicy Properties: AllowedResources: [Value, Value, ] JSON Syntax { "AWSTemplateFormatVersion" : " ", "Resources" : { "TheResource": { "Type": "OS::Heat::AccessPolicy", "Properties": { "AllowedResources": [Value, Value, ] 15

22 OS::Heat::AutoScalingGroup Properties An autoscaling group that can scale arbitrary resources. Available since (Icehouse). cooldown Cooldown period, in seconds. desired_capacity Desired initial number of resources. max_size Maximum number of resources in the group. The value must be at least 0. min_size Minimum number of resources in the group. The value must be at least 0. resource Resource definition for the resources in the group, in HOT format. The value of this property is the definition of a resource just as if it had been declared in the template itself. rolling_updates Policy for rolling updates for this scaling group. Map properties: max_batch_size The maximum number of resources to replace at once. 16

23 Optional property, defaults to "1". The value must be at least 0. min_in_service The minimum number of resources in service while rolling updates are being executed. Optional property, defaults to "0". The value must be at least 0. pause_time The number of seconds to wait between batches of updates. Optional property, defaults to "0". The value must be at least 0. Attributes _size outputs outputs_list The size of AutoscalingResourceGroup. A map of resource names to the specified attribute of each individual resource. A list of the specified attribute of each individual resource. HOT Syntax heat_template_version: resources: the_resource: type: OS::Heat::AutoScalingGroup properties: cooldown: Integer desired_capacity: Integer max_size: Integer min_size: Integer resource: { rolling_updates: {"min_in_service": Number, "pause_time": Number, "max_batch_size": Number 17

24 YAML Syntax HeatTemplateFormatVersion: ' ' Resources: TheResource: Type: OS::Heat::AutoScalingGroup Properties: cooldown: Integer desired_capacity: Integer max_size: Integer min_size: Integer resource: { rolling_updates: {"min_in_service": Number, "pause_time": Number, "max_batch_size": Number JSON Syntax { "AWSTemplateFormatVersion" : " ", "Resources" : { "TheResource": { "Type": "OS::Heat::AutoScalingGroup", "Properties": { "cooldown": Integer, "desired_capacity": Integer, "max_size": Integer, "min_size": Integer, "resource": {, "rolling_updates": {"min_in_service": Number, "pause_time": Number, "max_batch_size": Number OS::Heat::CWLiteAlarm Properties Note DEPRECATED - OS::Heat::CWLiteAlarm is deprecated, use OS::Ceilometer::Alarm instead. AlarmActions A list of actions to execute when state transitions to alarm. AlarmDescription Description for the alarm. 18

25 ComparisonOperator Operator used to compare the specified Statistic with Threshold. Allowed values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold Dimensions A list of dimensions (arbitrary name/value pairs) associated with the metric. EvaluationPeriods Number of periods to evaluate over. InsufficientDataActions A list of actions to execute when state transitions to insufficient-data. MetricName Metric name watched by the alarm. Namespace Namespace for the metric. OKActions A list of actions to execute when state transitions to ok. Period Period (seconds) to evaluate over. 19

26 Statistic Metric statistic to evaluate. Allowed values: SampleCount, Average, Sum, Minimum, Maximum Threshold Threshold to evaluate against. Units Unit for the metric. Allowed values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None HOT Syntax heat_template_version: resources: the_resource: type: OS::Heat::CWLiteAlarm properties: AlarmActions: [Value, Value, ] AlarmDescription: String ComparisonOperator: String Dimensions: [Value, Value, ] EvaluationPeriods: String InsufficientDataActions: [Value, Value, ] MetricName: String Namespace: String OKActions: [Value, Value, ] Period: String Statistic: String Threshold: String Units: String 20

27 YAML Syntax HeatTemplateFormatVersion: ' ' Resources: TheResource: Type: OS::Heat::CWLiteAlarm Properties: AlarmActions: [Value, Value, ] AlarmDescription: String ComparisonOperator: String Dimensions: [Value, Value, ] EvaluationPeriods: String InsufficientDataActions: [Value, Value, ] MetricName: String Namespace: String OKActions: [Value, Value, ] Period: String Statistic: String Threshold: String Units: String JSON Syntax { "AWSTemplateFormatVersion" : " ", "Resources" : { "TheResource": { "Type": "OS::Heat::CWLiteAlarm", "Properties": { "AlarmActions": [Value, Value, ], "AlarmDescription": String, "ComparisonOperator": String, "Dimensions": [Value, Value, ], "EvaluationPeriods": String, "InsufficientDataActions": [Value, Value, ], "MetricName": String, "Namespace": String, "OKActions": [Value, Value, ], "Period": String, "Statistic": String, "Threshold": String, "Units": String OS::Heat::CloudConfig A configuration resource for representing cloud-init cloud-config. This resource allows cloud-config YAML to be defined and stored by the config API. Any intrinsic functions called in the config will be resolved before storing the result. 21

28 Properties This resource will generally be referenced by OS::Nova::Server user_data, or OS::Heat::MultipartMime parts config. Since cloud-config is boot-only configuration, any changes to the definition will result in the replacement of all servers which reference it. Available since (Icehouse). cloud_config Map representing the cloud-config data structure which will be formatted as YAML. Attributes config HOT Syntax The config value of the software config. heat_template_version: resources: the_resource: type: OS::Heat::CloudConfig properties: cloud_config: { YAML Syntax HeatTemplateFormatVersion: ' ' Resources: TheResource: Type: OS::Heat::CloudConfig Properties: cloud_config: { JSON Syntax { "AWSTemplateFormatVersion" : " ", "Resources" : { "TheResource": { "Type": "OS::Heat::CloudConfig", "Properties": { "cloud_config": { 22

29 OS::Heat::HARestarter Properties InstanceId Instance ID to be restarted. Attributes AlarmUrl A signed url to handle the alarm (Heat extension). HOT Syntax heat_template_version: resources: the_resource: type: OS::Heat::HARestarter properties: InstanceId: String YAML Syntax HeatTemplateFormatVersion: ' ' Resources: TheResource: Type: OS::Heat::HARestarter Properties: InstanceId: String JSON Syntax { "AWSTemplateFormatVersion" : " ", "Resources" : { "TheResource": { "Type": "OS::Heat::HARestarter", "Properties": { "InstanceId": String 23

30 OS::Heat::InstanceGroup Properties AvailabilityZones Not Implemented. LaunchConfigurationName The reference to a LaunchConfiguration resource. LoadBalancerNames List of LoadBalancer resources. Size Desired number of instances. Tags Tags to attach to this group. List contents: * Map properties: Key Value Attributes InstanceList A comma-delimited list of server ip addresses. (Heat extension). 24

31 HOT Syntax heat_template_version: resources: the_resource: type: OS::Heat::InstanceGroup properties: AvailabilityZones: [Value, Value, ] LaunchConfigurationName: String LoadBalancerNames: [Value, Value, ] Size: Integer Tags: [{"Value": String, "Key": String, {"Value": String, "Key": String, ] YAML Syntax HeatTemplateFormatVersion: ' ' Resources: TheResource: Type: OS::Heat::InstanceGroup Properties: AvailabilityZones: [Value, Value, ] LaunchConfigurationName: String LoadBalancerNames: [Value, Value, ] Size: Integer Tags: [{"Value": String, "Key": String, {"Value": String, "Key": String, ] JSON Syntax { "AWSTemplateFormatVersion" : " ", "Resources" : { "TheResource": { "Type": "OS::Heat::InstanceGroup", "Properties": { "AvailabilityZones": [Value, Value, ], "LaunchConfigurationName": String, "LoadBalancerNames": [Value, Value, ], "Size": Integer, "Tags": [{"Value": String, "Key": String, {"Value": String, "Key": String, ] OS::Heat::MultipartMime A resource which assembles a collection of software configurations as a multi-part mime message. 25

32 Properties Parts in the message can be populated with inline configuration or references to other config resources. If the referenced resource is itself a valid multi-part mime message, that will be broken into parts and those parts appended to this message. The resulting multi-part mime message will be stored by the configs API and can be referenced in properties such as OS::Nova::Server user_data. This resource is generally used to build a list of cloud-init configuration elements including scripts and cloud-config. Since cloud-init is boot-only configuration, any changes to the definition will result in the replacement of all servers which reference it. Available since (Icehouse). parts Parts belonging to this message. Optional property, defaults to "[]". List contents: * Map properties: config Content of part to attach, either inline or by referencing the ID of another software config resource filename Optional filename to associate with part. subtype Optional subtype to specify with the type. type Whether the part content is text or multipart. Optional property, defaults to "text". Allowed values: text, multipart 26

33 Attributes config The config value of the software config. HOT Syntax heat_template_version: resources: the_resource: type: OS::Heat::MultipartMime properties: parts: [{"type": String, "subtype": String, "config": String, "filename": String, {"type": String, "subtype": String, "config": String, "filename": String, ] YAML Syntax HeatTemplateFormatVersion: ' ' Resources: TheResource: Type: OS::Heat::MultipartMime Properties: parts: [{"type": String, "subtype": String, "config": String, "filename": String, {"type": String, "subtype": String, "config": String, "filename": String, ] JSON Syntax { "AWSTemplateFormatVersion" : " ", "Resources" : { "TheResource": { "Type": "OS::Heat::MultipartMime", "Properties": { "parts": [{"type": String, "subtype": String, "config": String, "filename": String, {"type": String, "subtype": String, "config": String, "filename": String, ] OS::Heat::RandomString A resource which generates a random string. This is useful for configuring passwords and secrets on services. Available since (Icehouse). 27

34 Properties character_classes A list of character class and their constraints to generate the random string from. List contents: * Map properties: class A character class and its corresponding min constraint to generate the random string from. Optional property, defaults to "lettersdigits". Allowed values: lettersdigits, letters, lowercase, uppercase, digits, hexdigits, octdigits min The minimum number of characters from this character class that will be in the generated string. Optional property, defaults to "1". The value must be in the range 1 to 512. character_sequences A list of character sequences and their constraints to generate the random string from. List contents: * Map properties: min The minimum number of characters from this sequence that will be in the generated string. 28

35 Optional property, defaults to "1". The value must be in the range 1 to 512. sequence A character sequence and its corresponding min constraint to generate the random string from. length Length of the string to generate. Optional property, defaults to "32". The value must be in the range 1 to 512. salt Value which can be set or changed on stack update to trigger the resource for replacement with a new random string. The salt value itself is ignored by the random generator. sequence Note DEPRECATED - Use property character_classes. Sequence of characters to build the random string from. Allowed values: lettersdigits, letters, lowercase, uppercase, digits, hexdigits, octdigits Attributes value The random string generated by this resource. This value is also available by referencing the resource. 29

36 HOT Syntax heat_template_version: resources: the_resource: type: OS::Heat::RandomString properties: character_classes: [{"class": String, "min": Integer, {"class": String, "min": Integer, ] character_sequences: [{"min": Integer, "sequence": String, {"min": Integer, "sequence": String, ] length: Integer salt: String YAML Syntax HeatTemplateFormatVersion: ' ' Resources: TheResource: Type: OS::Heat::RandomString Properties: character_classes: [{"class": String, "min": Integer, {"class": String, "min": Integer, ] character_sequences: [{"min": Integer, "sequence": String, {"min": Integer, "sequence": String, ] length: Integer salt: String JSON Syntax { "AWSTemplateFormatVersion" : " ", "Resources" : { "TheResource": { "Type": "OS::Heat::RandomString", "Properties": { "character_classes": [{"class": String, "min": Integer, {"class": String, "min": Integer, ], "character_sequences": [{"min": Integer, "sequence": String, {"min": Integer, "sequence": String, ], "length": Integer, "salt": String OS::Heat::ResourceGroup A resource that creates one or more identically configured nested resources. 30

37 Properties In addition to the refs attribute, this resource implements synthetic attributes that mirror those of the resources in the group. When getting an attribute from this resource, however, a list of attribute values for each resource in the group is returned. To get attribute values for a single resource in the group, synthetic attributes of the form resource.{resource index.{attribute name can be used. The resource ID of a particular resource in the group can be obtained via the synthetic attribute resource.{resource index. While each resource in the group will be identically configured, this resource does allow for some index-based customization of the properties of the resources in the group. For example: resources: my_indexed_group: type: OS::Heat::ResourceGroup properties: count: 3 resource_def: type: OS::Nova::Server properties: # create a unique name for each server # using its index in the group name: my_server_%index% image: CentOS 6.5 flavor: 4GB Performance would result in a group of three servers having the same image and flavor, but names of my_server_0, my_server_1, and my_server_2. The variable used for substitution can be customized by using the index_var property. Available since (Icehouse). count The number of instances to create. Optional property, defaults to "1". The value must be at least 0. index_var A variable that this resource will use to replace with the index of a given resource in the group. Can be used, for example, to customize the name property of grouped servers in order to differentiate them when listed with nova client. Optional property, defaults to "%index%". The length must be at least 3. removal_policies Policies for removal of resources on update 31

38 Optional property, defaults to "[]". List contents: * Policy to be processed when doing an update which requires removal of specific resources. Map properties: resource_list List of resources to be removed when doing an update which requires removal of specific resources. The resource may be specified several ways: (1) The resource name, as in the nested stack, (2) The resource reference returned from get_resource in a template, as available via the 'refs' attribute Note this is destructive on update when specified; even if the count is not being reduced, and once a resource name is removed, it's name is never reused in subsequent updates Optional property, defaults to "[]". resource_def Resource definition for the resources in the group. The value of this property is the definition of a resource just as if it had been declared in the template itself. Map properties: properties Property values for the resources in the group type The type of the resources in the group 32

39 Attributes attributes refs A map of resource names to the specified attribute of each individual resource. A list of resource IDs for the resources in the group HOT Syntax heat_template_version: resources: the_resource: type: OS::Heat::ResourceGroup properties: count: Integer index_var: String removal_policies: [{"resource_list": [Value, Value, ], {"resource_list": [Value, Value, ], ] resource_def: {"type": String, "properties": { YAML Syntax HeatTemplateFormatVersion: ' ' Resources: TheResource: Type: OS::Heat::ResourceGroup Properties: count: Integer index_var: String removal_policies: [{"resource_list": [Value, Value, ], {"resource_list": [Value, Value, ], ] resource_def: {"type": String, "properties": { JSON Syntax { "AWSTemplateFormatVersion" : " ", "Resources" : { "TheResource": { "Type": "OS::Heat::ResourceGroup", "Properties": { "count": Integer, "index_var": String, "removal_policies": [{"resource_list": [Value, Value, ], {"resource_list": [Value, Value, ], ], "resource_def": {"type": String, "properties": { 33

40 OS::Heat::ScalingPolicy Properties A resource to manage scaling of OS::Heat::AutoScalingGroup. while it may incidentally support AWS::AutoScaling::AutoScalingGroup for now, please don't use it for that purpose and use AWS::AutoScaling::ScalingPolicy instead. adjustment_type Type of adjustment (absolute or percentage). Allowed values: change_in_capacity, exact_capacity, percent_change_in_capacity auto_scaling_group_id AutoScaling group ID to apply policy to. cooldown Cooldown period, in seconds. scaling_adjustment Size of adjustment. Attributes alarm_url A signed url to handle the alarm. HOT Syntax heat_template_version: resources: the_resource: type: OS::Heat::ScalingPolicy properties: adjustment_type: String auto_scaling_group_id: String cooldown: Number scaling_adjustment: Number 34

41 YAML Syntax HeatTemplateFormatVersion: ' ' Resources: TheResource: Type: OS::Heat::ScalingPolicy Properties: adjustment_type: String auto_scaling_group_id: String cooldown: Number scaling_adjustment: Number JSON Syntax { "AWSTemplateFormatVersion" : " ", "Resources" : { "TheResource": { "Type": "OS::Heat::ScalingPolicy", "Properties": { "adjustment_type": String, "auto_scaling_group_id": String, "cooldown": Number, "scaling_adjustment": Number OS::Heat::SoftwareComponent Properties A resource for describing and storing a software component. This resource is similar to OS::Heat::SoftwareConfig. In contrast to SoftwareConfig which allows for storing only one configuration (e.g. one script), SoftwareComponent allows for storing multiple configurations to address handling of all lifecycle hooks (CREATE, UPDATE, SUSPEND, RESUME, DELETE) for a software component in one place. This resource is backed by the persistence layer and the API of the SoftwareConfig resource, and only adds handling for the additional 'configs' property and attribute. Available since (Juno). configs The list of configurations for the different lifecycle actions of the represented software component. 35

42 The length must be at least 1. List contents: * Map properties: actions Lifecycle actions to which the configuration applies. The string values provided for this property can include the standard resource actions CREATE, DELETE, UPDATE, SUSPEND and RE- SUME supported by Heat. The length must be at least 1. List contents: * config Configuration script or manifest which specifies what actual configuration is performed. tool The configuration tool used to actually apply the configuration on a server. This string property has to be understood by in-instance tools running inside deployed servers. inputs Schema representing the inputs that this software config is expecting. List contents: * 36

43 Map properties: default Default value for the input if none is specified. description Description of the input. name Name of the input. type Type of the value of the input. Optional property, defaults to "String". Allowed values: String, Number, CommaDelimitedList, Json options Map containing options specific to the configuration management tool used by this resource. outputs Schema representing the outputs that this software config will produce. List contents: * Map properties: description Description of the output. 37

44 error_output Denotes that the deployment is in an error state if this output has a value. Optional property, defaults to "False". name Name of the output. type Type of the value of the output. Optional property, defaults to "String". Allowed values: String, Number, CommaDelimitedList, Json Attributes config The config value of the software config. HOT Syntax heat_template_version: resources: the_resource: type: OS::Heat::SoftwareComponent properties: configs: [{"tool": String, "config": String, "actions": [String, String, ], {"tool": String, "config": String, "actions": [String, String, ], ] inputs: [{"default": String, "type": String, "name": String, "description": String, {"default": String, "type": String, "name": String, "description": String, ] options: { outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String, {"type": String, "name": String, "error_output": Boolean, "description": String, ] 38

45 YAML Syntax HeatTemplateFormatVersion: ' ' Resources: TheResource: Type: OS::Heat::SoftwareComponent Properties: configs: [{"tool": String, "config": String, "actions": [String, String, ], {"tool": String, "config": String, "actions": [String, String, ], ] inputs: [{"default": String, "type": String, "name": String, "description": String, {"default": String, "type": String, "name": String, "description": String, ] options: { outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String, {"type": String, "name": String, "error_output": Boolean, "description": String, ] JSON Syntax { "AWSTemplateFormatVersion" : " ", "Resources" : { "TheResource": { "Type": "OS::Heat::SoftwareComponent", "Properties": { "configs": [{"tool": String, "config": String, "actions": [String, String, ], {"tool": String, "config": String, "actions": [String, String, ], ], "inputs": [{"default": String, "type": String, "name": String, "description": String, {"default": String, "type": String, "name": String, "description": String, ], "options": {, "outputs": [{"type": String, "name": String, "error_output": Boolean, "description": String, {"type": String, "name": String, "error_output": Boolean, "description": String, ] OS::Heat::SoftwareConfig A resource for describing and storing software configuration. The software_configs API which backs this resource creates immutable configs, so any change to the template resource definition will result in a new config being created, and the old one being deleted. Configs can be defined in the same template which uses them, or they can be created in one stack, and passed to another stack via a parameter. 39

46 Properties A config resource can be referenced in other resource properties which are config-aware. This includes the properties OS::Nova::Server user_data, OS::Heat::SoftwareDeployment config and OS::Heat::MultipartMime parts config. Along with the config script itself, this resource can define schemas for inputs and outputs which the config script is expected to consume and produce. Inputs and outputs are optional and will map to concepts which are specific to the configuration tool being used. Available since (Icehouse). config Configuration script or manifest which specifies what actual configuration is performed. group Namespace to group this software config by when delivered to a server. This may imply what configuration tool is going to perform the configuration. Optional property, defaults to "Heat::Ungrouped". inputs Schema representing the inputs that this software config is expecting. List contents: * Map properties: default Default value for the input if none is specified. description Description of the input. name Name of the input. 40

47 type Type of the value of the input. Optional property, defaults to "String". Allowed values: String, Number, CommaDelimitedList, Json options Map containing options specific to the configuration management tool used by this resource. outputs Schema representing the outputs that this software config will produce. List contents: * Map properties: description Description of the output. error_output Denotes that the deployment is in an error state if this output has a value. Optional property, defaults to "False". name Name of the output. type Type of the value of the output. Updates 41 cause replacement.

48 Optional property, defaults to "String". Allowed values: String, Number, CommaDelimitedList, Json Attributes config The config value of the software config. HOT Syntax heat_template_version: resources: the_resource: type: OS::Heat::SoftwareConfig properties: config: String group: String inputs: [{"default": String, "type": String, "name": String, "description": String, {"default": String, "type": String, "name": String, "description": String, ] options: { outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String, {"type": String, "name": String, "error_output": Boolean, "description": String, ] YAML Syntax HeatTemplateFormatVersion: ' ' Resources: TheResource: Type: OS::Heat::SoftwareConfig Properties: config: String group: String inputs: [{"default": String, "type": String, "name": String, "description": String, {"default": String, "type": String, "name": String, "description": String, ] options: { outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String, {"type": String, "name": String, "error_output": Boolean, "description": String, ] JSON Syntax { "AWSTemplateFormatVersion" : " ", "Resources" : { "TheResource": { "Type": "OS::Heat::SoftwareConfig", 42

49 "Properties": { "config": String, "group": String, "inputs": [{"default": String, "type": String, "name": String, "description": String, {"default": String, "type": String, "name": String, "description": String, ], "options": {, "outputs": [{"type": String, "name": String, "error_output": Boolean, "description": String, {"type": String, "name": String, "error_output": Boolean, "description": String, ] OS::Heat::SoftwareDeployment Properties This resource associates a server with some configuration which is to be deployed to that server. A deployment allows input values to be specified which map to the inputs schema defined in the config resource. These input values are interpreted by the configuration tool in a tool-specific manner. Whenever this resource goes to an IN_PROGRESS state, it creates an ephemeral config that includes the inputs values plus a number of extra inputs which have names prefixed with deploy_. The extra inputs relate to the state of the stack, along with the information and credentials required to signal back the deployment results. Unless signal_transport=no_signal, this resource will remain in an IN_PROGRESS state until the server signals it with the output values for that deployment. Those output values are then available as resource attributes, along with the default attributes deploy_stdout, deploy_stderr and deploy_status_code. Specifying actions other than the default CREATE and UPDATE will result in the deployment being triggered in those actions. For example this would allow cleanup configuration to be performed during actions SUSPEND and DELETE. A config could be designed to only work with some specific actions, or a config can read the value of the deploy_action input to allow conditional logic to perform different configuration for different actions. Available since (Icehouse). actions Which stack actions will result in this deployment being triggered. Optional property, defaults to "['CREATE', 'UPDATE']". Allowed values: CREATE, UPDATE, DELETE, SUSPEND, RESUME config ID of software configuration resource to execute when applying to the server. 43

50 input_values Input values to apply to the software configuration on this server. name Name of the derived config associated with this deployment. This is used to apply a sort order to the list of configurations ly deployed to a server. server ID of Nova server to apply configuration to. signal_transport How the server should signal to heat with the deployment output values. CFN_SIGNAL will allow an HTTP POST to a CFN keypair signed URL. HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal. Optional property, defaults to "CFN_SIGNAL". Allowed values: CFN_SIGNAL, HEAT_SIGNAL, NO_SIGNAL Attributes deploy_status_code deploy_stderr deploy_stdout Returned status code from the configuration execution Captured stderr from the configuration execution. Captured stdout from the configuration execution. 44

51 HOT Syntax heat_template_version: resources: the_resource: type: OS::Heat::SoftwareDeployment properties: actions: [Value, Value, ] config: String input_values: { name: String server: String signal_transport: String YAML Syntax HeatTemplateFormatVersion: ' ' Resources: TheResource: Type: OS::Heat::SoftwareDeployment Properties: actions: [Value, Value, ] config: String input_values: { name: String server: String signal_transport: String JSON Syntax { "AWSTemplateFormatVersion" : " ", "Resources" : { "TheResource": { "Type": "OS::Heat::SoftwareDeployment", "Properties": { "actions": [Value, Value, ], "config": String, "input_values": {, "name": String, "server": String, "signal_transport": String OS::Heat::SoftwareDeployments Available since (Juno). 45

52 Properties actions Which stack actions will result in this deployment being triggered. Optional property, defaults to "['CREATE', 'UPDATE']". Allowed values: CREATE, UPDATE, DELETE, SUSPEND, RESUME config ID of software configuration resource to execute when applying to the server. input_values Input values to apply to the software configuration on this server. name Name of the derived config associated with this deployment. This is used to apply a sort order to the list of configurations ly deployed to a server. servers A map of Nova names and IDs to apply configuration to. signal_transport How the server should signal to heat with the deployment output values. CFN_SIGNAL will allow an HTTP POST to a CFN keypair signed URL. HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal. Optional property, defaults to "CFN_SIGNAL". Allowed values: CFN_SIGNAL, HEAT_SIGNAL, NO_SIGNAL Attributes deploy_status_codes A map of Nova names and returned status code from the configuration execution 46

53 deploy_stderrs deploy_stdouts A map of Nova names and captured stderrs from the configuration execution to each server. A map of Nova names and captured stdouts from the configuration execution to each server. HOT Syntax heat_template_version: resources: the_resource: type: OS::Heat::SoftwareDeployments properties: actions: [Value, Value, ] config: String input_values: { name: String servers: { signal_transport: String YAML Syntax HeatTemplateFormatVersion: ' ' Resources: TheResource: Type: OS::Heat::SoftwareDeployments Properties: actions: [Value, Value, ] config: String input_values: { name: String servers: { signal_transport: String JSON Syntax { "AWSTemplateFormatVersion" : " ", "Resources" : { "TheResource": { "Type": "OS::Heat::SoftwareDeployments", "Properties": { "actions": [Value, Value, ], "config": String, "input_values": {, "name": String, "servers": {, "signal_transport": String 47

54 OS::Heat::StructuredConfig Properties This resource is like OS::Heat::SoftwareConfig except that the config property is represented by a Map rather than a String. This is useful for configuration tools which use YAML or JSON as their configuration syntax. The resulting configuration is transferred, stored and returned by the software_configs API as parsed JSON. Available since (Icehouse). config Map representing the configuration data structure which will be serialized to JSON format. group Namespace to group this software config by when delivered to a server. This may imply what configuration tool is going to perform the configuration. Optional property, defaults to "Heat::Ungrouped". inputs Schema representing the inputs that this software config is expecting. List contents: * Map properties: default Default value for the input if none is specified. description Description of the input. name Name of the input. 48