Note
Available since 2014.2 (Juno)
Note
Available since 5.0.0 (Liberty)
The type of the order.
String value expected.
Updates cause replacement.
Allowed values: key, asymmetric, certificate
The algorithm type used to generate the secret.
String value expected.
Updates cause replacement.
Note
Available since 5.0.0 (Liberty)
The identifier of the CA to use.
String value expected.
Updates cause replacement.
The expiration date for the secret in ISO-8601 format.
String value expected.
Updates cause replacement.
Value must be of type iso_8601
The type/mode of the algorithm associated with the secret information.
String value expected.
Updates cause replacement.
Note
Available since 5.0.0 (Liberty)
The passphrase the created key.
String value expected.
Updates cause replacement.
The type/format the secret data is provided in.
String value expected.
Updates cause replacement.
Note
Available since 5.0.0 (Liberty)
The profile of certificate to use.
String value expected.
Updates cause replacement.
Note
Available since 5.0.0 (Liberty)
The content of the CSR.
String value expected.
Updates cause replacement.
Note
Available since 5.0.0 (Liberty)
The type of the certificate request.
String value expected.
Updates cause replacement.
Note
Available since 5.0.0 (Liberty)
The source of certificate request.
String value expected.
Updates cause replacement.
Note
Available since 5.0.0 (Liberty)
The subject of the certificate request.
String value expected.
Updates cause replacement.
Note
Available since 5.0.0 (Liberty)
The payload of the created certificate, if available.
Note
Available since 5.0.0 (Liberty)
The payload of the created intermediates, if available.
The URI to the order.
Note
Available since 5.0.0 (Liberty)
The payload of the created private key, if available.
Note
Available since 5.0.0 (Liberty)
The payload of the created public key, if available.
The URI to the created secret.
Detailed information about resource.
The status of the order.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Barbican::Order
properties:
algorithm: String
bit_length: Integer
ca_id: String
expiration: String
mode: String
name: String
pass_phrase: String
payload_content_type: String
profile: String
request_data: String
request_type: String
source_container_ref: String
subject_dn: String
type: String
Note
Available since 2014.2 (Juno)
The algorithm type used to generate the secret.
String value expected.
Updates cause replacement.
The bit-length of the secret.
Integer value expected.
Updates cause replacement.
The value must be at least 0.
The expiration date for the secret in ISO-8601 format.
String value expected.
Updates cause replacement.
Value must be of type iso_8601
The type/mode of the algorithm associated with the secret information.
String value expected.
Updates cause replacement.
The unencrypted plain text of the secret.
String value expected.
Updates cause replacement.
The encoding format used to provide the payload data.
String value expected.
Updates cause replacement.
Allowed values: base64
The type/format the secret data is provided in.
String value expected.
Updates cause replacement.
Allowed values: text/plain, application/octet-stream
Note
Available since 5.0.0 (Liberty)
The type of the secret.
String value expected.
Updates cause replacement.
Allowed values: symmetric, public, private, certificate, passphrase, opaque
The decrypted secret payload.
Detailed information about resource.
The status of the secret.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Barbican::Secret
properties:
algorithm: String
bit_length: Integer
expiration: String
mode: String
name: String
payload: String
payload_content_encoding: String
payload_content_type: String
secret_type: String
Threshold to evaluate against.
Number value expected.
Can be updated without replacement.
A list of URLs (webhooks) to invoke when state transitions to alarm.
List value expected.
Can be updated without replacement.
Operator used to compare specified statistic with threshold.
String value expected.
Can be updated without replacement.
Allowed values: ge, gt, eq, ne, lt, le
True if alarm evaluation/actioning is enabled.
Boolean value expected.
Can be updated without replacement.
Defaults to “true”.
Number of periods to evaluate over.
Integer value expected.
Can be updated without replacement.
A list of URLs (webhooks) to invoke when state transitions to insufficient-data.
List value expected.
Can be updated without replacement.
Meter should match this resource metadata (key=value) additionally to the meter_name.
Map value expected.
Can be updated without replacement.
Defaults to “{}”.
A list of URLs (webhooks) to invoke when state transitions to ok.
List value expected.
Can be updated without replacement.
Period (seconds) to evaluate over.
Integer value expected.
Can be updated without replacement.
Note
Available since 2015.1 (Kilo)
A list of query factors, each comparing a Sample attribute with a value. Implicitly combined with matching_metadata, if any.
List value expected.
Can be updated without replacement.
List contents:
*¶
Map value expected.
Can be updated without replacement.
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`.
String value expected.
Can be updated without replacement.
op¶
Comparison operator
String value expected.
Can be updated without replacement.
Allowed values: le, ge, eq, lt, gt, ne
value¶
String value with which to compare
String value expected.
Can be updated without replacement.
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.
Boolean value expected.
Can be updated without replacement.
Defaults to “true”.
Note
Available since 5.0.0 (Liberty)
Severity of the alarm.
String value expected.
Can be updated without replacement.
Defaults to “low”.
Allowed values: low, moderate, critical
Meter statistic to evaluate.
String value expected.
Can be updated without replacement.
Allowed values: count, avg, sum, min, max
Note
Available since 5.0.0 (Liberty)
Describe time constraints for the alarm. Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression,whereas its duration is given in seconds.
List value expected.
Updates cause replacement.
Defaults to “[]”.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
duration¶
Duration for the time constraint.
Integer value expected.
Updates cause replacement.
The value must be at least 0.
start¶
Start time for the time constraint. A CRON expression property.
String value expected.
Updates cause replacement.
Value must be of type cron_expression
timezone¶
Timezone for the time constraint (eg. ‘Taiwan/Taipei’, ‘Europe/Amsterdam’)
String value expected.
Updates cause replacement.
Value must be of type timezone
heat_template_version: 2015-04-30
...
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, ...]
matching_metadata: {...}
meter_name: String
ok_actions: [Value, Value, ...]
period: Integer
query: [{"value": String, "op": String, "field": String}, {"value": String, "op": String, "field": String}, ...]
repeat_actions: Boolean
severity: String
statistic: String
threshold: Number
time_constraints: [{"duration": Integer, "name": String, "start": String, "description": String, "timezone": String}, {"duration": Integer, "name": String, "start": String, "description": String, "timezone": String}, ...]
Note
Available since 2014.1 (Icehouse)
List of alarm identifiers to combine.
List value expected.
Can be updated without replacement.
The length must be at least 1.
A list of URLs (webhooks) to invoke when state transitions to alarm.
List value expected.
Can be updated without replacement.
True if alarm evaluation/actioning is enabled.
Boolean value expected.
Can be updated without replacement.
Defaults to “true”.
A list of URLs (webhooks) to invoke when state transitions to insufficient-data.
List value expected.
Can be updated without replacement.
A list of URLs (webhooks) to invoke when state transitions to ok.
List value expected.
Can be updated without replacement.
Operator used to combine the alarms.
String value expected.
Can be updated without replacement.
Allowed values: and, or
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.
Boolean value expected.
Can be updated without replacement.
Defaults to “true”.
Note
Available since 5.0.0 (Liberty)
Severity of the alarm.
String value expected.
Can be updated without replacement.
Defaults to “low”.
Allowed values: low, moderate, critical
Note
Available since 5.0.0 (Liberty)
Describe time constraints for the alarm. Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression,whereas its duration is given in seconds.
List value expected.
Updates cause replacement.
Defaults to “[]”.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
duration¶
Duration for the time constraint.
Integer value expected.
Updates cause replacement.
The value must be at least 0.
start¶
Start time for the time constraint. A CRON expression property.
String value expected.
Updates cause replacement.
Value must be of type cron_expression
timezone¶
Timezone for the time constraint (eg. ‘Taiwan/Taipei’, ‘Europe/Amsterdam’)
String value expected.
Updates cause replacement.
Value must be of type timezone
heat_template_version: 2015-04-30
...
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
severity: String
time_constraints: [{"duration": Integer, "name": String, "start": String, "description": String, "timezone": String}, {"duration": Integer, "name": String, "start": String, "description": String, "timezone": String}, ...]
Note
Available since 2015.1 (Kilo)
Threshold to evaluate against.
Number value expected.
Can be updated without replacement.
The aggregation method to compare to the threshold
String value expected.
Can be updated without replacement.
Allowed values: mean, sum, last, max, min, std, median, first, count
A list of URLs (webhooks) to invoke when state transitions to alarm.
List value expected.
Can be updated without replacement.
Operator used to compare specified statistic with threshold.
String value expected.
Can be updated without replacement.
Allowed values: ge, gt, eq, ne, lt, le
True if alarm evaluation/actioning is enabled.
Boolean value expected.
Can be updated without replacement.
Defaults to “true”.
Number of periods to evaluate over.
Integer value expected.
Can be updated without replacement.
A list of URLs (webhooks) to invoke when state transitions to insufficient-data.
List value expected.
Can be updated without replacement.
A list of URLs (webhooks) to invoke when state transitions to ok.
List value expected.
Can be updated without replacement.
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.
Boolean value expected.
Can be updated without replacement.
Defaults to “true”.
Note
Available since 5.0.0 (Liberty)
Severity of the alarm.
String value expected.
Can be updated without replacement.
Defaults to “low”.
Allowed values: low, moderate, critical
Note
Available since 5.0.0 (Liberty)
Describe time constraints for the alarm. Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression,whereas its duration is given in seconds.
List value expected.
Updates cause replacement.
Defaults to “[]”.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
duration¶
Duration for the time constraint.
Integer value expected.
Updates cause replacement.
The value must be at least 0.
start¶
Start time for the time constraint. A CRON expression property.
String value expected.
Updates cause replacement.
Value must be of type cron_expression
timezone¶
Timezone for the time constraint (eg. ‘Taiwan/Taipei’, ‘Europe/Amsterdam’)
String value expected.
Updates cause replacement.
Value must be of type timezone
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Ceilometer::GnocchiAggregationByMetricsAlarm
properties:
aggregation_method: String
alarm_actions: [Value, Value, ...]
comparison_operator: String
description: String
enabled: Boolean
evaluation_periods: Integer
granularity: Integer
insufficient_data_actions: [Value, Value, ...]
metrics: [Value, Value, ...]
ok_actions: [Value, Value, ...]
repeat_actions: Boolean
severity: String
threshold: Number
time_constraints: [{"duration": Integer, "name": String, "start": String, "description": String, "timezone": String}, {"duration": Integer, "name": String, "start": String, "description": String, "timezone": String}, ...]
Note
Available since 2015.1 (Kilo)
Metric name watched by the alarm.
String value expected.
Can be updated without replacement.
Threshold to evaluate against.
Number value expected.
Can be updated without replacement.
The aggregation method to compare to the threshold
String value expected.
Can be updated without replacement.
Allowed values: mean, sum, last, max, min, std, median, first, count
A list of URLs (webhooks) to invoke when state transitions to alarm.
List value expected.
Can be updated without replacement.
Operator used to compare specified statistic with threshold.
String value expected.
Can be updated without replacement.
Allowed values: ge, gt, eq, ne, lt, le
True if alarm evaluation/actioning is enabled.
Boolean value expected.
Can be updated without replacement.
Defaults to “true”.
Number of periods to evaluate over.
Integer value expected.
Can be updated without replacement.
A list of URLs (webhooks) to invoke when state transitions to insufficient-data.
List value expected.
Can be updated without replacement.
A list of URLs (webhooks) to invoke when state transitions to ok.
List value expected.
Can be updated without replacement.
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.
Boolean value expected.
Can be updated without replacement.
Defaults to “true”.
Note
Available since 5.0.0 (Liberty)
Severity of the alarm.
String value expected.
Can be updated without replacement.
Defaults to “low”.
Allowed values: low, moderate, critical
Note
Available since 5.0.0 (Liberty)
Describe time constraints for the alarm. Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression,whereas its duration is given in seconds.
List value expected.
Updates cause replacement.
Defaults to “[]”.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
duration¶
Duration for the time constraint.
Integer value expected.
Updates cause replacement.
The value must be at least 0.
start¶
Start time for the time constraint. A CRON expression property.
String value expected.
Updates cause replacement.
Value must be of type cron_expression
timezone¶
Timezone for the time constraint (eg. ‘Taiwan/Taipei’, ‘Europe/Amsterdam’)
String value expected.
Updates cause replacement.
Value must be of type timezone
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Ceilometer::GnocchiAggregationByResourcesAlarm
properties:
aggregation_method: String
alarm_actions: [Value, Value, ...]
comparison_operator: String
description: String
enabled: Boolean
evaluation_periods: Integer
granularity: Integer
insufficient_data_actions: [Value, Value, ...]
metric: String
ok_actions: [Value, Value, ...]
query: String
repeat_actions: Boolean
resource_type: String
severity: String
threshold: Number
time_constraints: [{"duration": Integer, "name": String, "start": String, "description": String, "timezone": String}, {"duration": Integer, "name": String, "start": String, "description": String, "timezone": String}, ...]
Note
Available since 2015.1 (Kilo)
Metric name watched by the alarm.
String value expected.
Can be updated without replacement.
Threshold to evaluate against.
Number value expected.
Can be updated without replacement.
The aggregation method to compare to the threshold
String value expected.
Can be updated without replacement.
Allowed values: mean, sum, last, max, min, std, median, first, count
A list of URLs (webhooks) to invoke when state transitions to alarm.
List value expected.
Can be updated without replacement.
Operator used to compare specified statistic with threshold.
String value expected.
Can be updated without replacement.
Allowed values: ge, gt, eq, ne, lt, le
True if alarm evaluation/actioning is enabled.
Boolean value expected.
Can be updated without replacement.
Defaults to “true”.
Number of periods to evaluate over.
Integer value expected.
Can be updated without replacement.
A list of URLs (webhooks) to invoke when state transitions to insufficient-data.
List value expected.
Can be updated without replacement.
A list of URLs (webhooks) to invoke when state transitions to ok.
List value expected.
Can be updated without replacement.
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.
Boolean value expected.
Can be updated without replacement.
Defaults to “true”.
Note
Available since 5.0.0 (Liberty)
Severity of the alarm.
String value expected.
Can be updated without replacement.
Defaults to “low”.
Allowed values: low, moderate, critical
Note
Available since 5.0.0 (Liberty)
Describe time constraints for the alarm. Only evaluate the alarm if the time at evaluation is within this time constraint. Start point(s) of the constraint are specified with a cron expression,whereas its duration is given in seconds.
List value expected.
Updates cause replacement.
Defaults to “[]”.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
duration¶
Duration for the time constraint.
Integer value expected.
Updates cause replacement.
The value must be at least 0.
start¶
Start time for the time constraint. A CRON expression property.
String value expected.
Updates cause replacement.
Value must be of type cron_expression
timezone¶
Timezone for the time constraint (eg. ‘Taiwan/Taipei’, ‘Europe/Amsterdam’)
String value expected.
Updates cause replacement.
Value must be of type timezone
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Ceilometer::GnocchiResourcesAlarm
properties:
aggregation_method: String
alarm_actions: [Value, Value, ...]
comparison_operator: String
description: String
enabled: Boolean
evaluation_periods: Integer
granularity: Integer
insufficient_data_actions: [Value, Value, ...]
metric: String
ok_actions: [Value, Value, ...]
repeat_actions: Boolean
resource_id: String
resource_type: String
severity: String
threshold: Number
time_constraints: [{"duration": Integer, "name": String, "start": String, "description": String, "timezone": String}, {"duration": Integer, "name": String, "start": String, "description": String, "timezone": String}, ...]
Note
Available since 5.0.0 (Liberty)
A resource for encrypting a cinder volume type.
Note that default cinder security policy usage of this resource is limited to being used by administrators only.
The class that provides encryption support. For example, nova.volume.encryptors.luks.LuksEncryptor.
String value expected.
Can be updated without replacement.
Name or id of volume type (OS::Cinder::VolumeType).
String value expected.
Updates cause replacement.
Value must be of type cinder.vtype
The encryption algorithm or mode. For example, aes-xts-plain64.
String value expected.
Can be updated without replacement.
Allowed values: aes-xts-plain64, aes-cbc-essiv
Notional service where encryption is performed For example, front-end. For Nova.
String value expected.
Can be updated without replacement.
Defaults to “front-end”.
Allowed values: front-end, back-end
Size of encryption key, in bits. For example, 128 or 256.
Integer value expected.
Can be updated without replacement.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Cinder::EncryptedVolumeType
properties:
cipher: String
control_location: String
key_size: Integer
provider: String
volume_type: String
The availability zone in which the volume will be created.
String value expected.
Updates cause replacement.
If specified, the backup to create the volume from.
String value expected.
Can be updated without replacement.
Value must be of type cinder.backup
A description of the volume.
String value expected.
Can be updated without replacement.
If specified, the name or ID of the image to create the volume from.
String value expected.
Updates cause replacement.
Value must be of type glance.image
Key/value pairs to associate with the volume.
Map value expected.
Can be updated without replacement.
A name used to distinguish the volume.
String value expected.
Can be updated without replacement.
Note
Available since 5.0.0 (Liberty)
Enables or disables read-only access mode of volume.
Boolean value expected.
Can be updated without replacement.
Note
Available since 2015.1 (Kilo)
Arbitrary key-value pairs specified by the client to help the Cinder scheduler creating a volume.
Map value expected.
Updates cause replacement.
The size of the volume in GB. On update only increase in size is supported.
Integer value expected.
Can be updated without replacement.
The value must be at least 1.
If specified, the snapshot to create the volume from.
String value expected.
Updates cause replacement.
Value must be of type cinder.snapshot
If specified, the volume to use as source.
String value expected.
Updates cause replacement.
Value must be of type cinder.volume
If specified, the type of volume to use, mapping to a specific backend.
String value expected.
Can be updated without replacement.
Value must be of type cinder.vtype
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.
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.
Key/value pairs associated with the volume in raw dict form.
Detailed information about resource.
The size of the volume in GB.
The snapshot the volume was created from, if any.
The volume used as source, if any.
The current status of the volume.
The type of the volume mapping to a backend, if any.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Cinder::Volume
properties:
availability_zone: String
backup_id: String
description: String
image: String
metadata: {...}
name: String
read_only: Boolean
scheduler_hints: {...}
size: Integer
snapshot_id: String
source_volid: String
volume_type: String
The ID of the server to which the volume attaches.
String value expected.
Can be updated without replacement.
The ID of the volume to be attached.
String value expected.
Can be updated without replacement.
Value must be of type cinder.volume
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/by-id/virtio-<VolumeId> be used instead.
String value expected.
Can be updated without replacement.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Cinder::VolumeAttachment
properties:
instance_uuid: String
mountpoint: String
volume_id: String
Note
Available since 2015.1 (Kilo)
A resource for creating cinder volume types.
Note that default cinder security policy usage of this resource is limited to being used by administrators only.
Note
Available since 5.0.0 (Liberty)
Description of the volume type.
String value expected.
Can be updated without replacement.
Note
Available since 5.0.0 (Liberty)
Whether the volume type is accessible to the public.
Boolean value expected.
Updates cause replacement.
Defaults to “True”.
The extra specs key and value pairs of the volume type.
Map value expected.
Can be updated without replacement.
Note
Available since 5.0.0 (Liberty)
Projects to add volume type access to. NOTE: This property is only supported since Cinder API V2.
List value expected.
Can be updated without replacement.
Defaults to “[]”.
List contents:
*¶
String value expected.
Can be updated without replacement.
Value must be of type keystone.project
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Cinder::VolumeType
properties:
description: String
is_public: Boolean
metadata: {...}
name: String
projects: [String, String, ...]
Note
Available since 5.0.0 (Liberty)
Heat Template Resource for Designate Domain.
Domain name.
String value expected.
Updates cause replacement.
The length must be no greater than 255.
Description of domain.
String value expected.
Can be updated without replacement.
The length must be no greater than 160.
Time To Live (Seconds).
Integer value expected.
Can be updated without replacement.
The value must be in the range 1 to 2147483647.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Designate::Domain
properties:
description: String
email: String
name: String
ttl: Integer
Note
Available since 5.0.0 (Liberty)
Heat Template Resource for Designate Record.
DNS record data, varies based on the type of record. For more details, please refer rfc 1035.
String value expected.
Can be updated without replacement.
DNS Domain id or name.
String value expected.
Updates cause replacement.
Value must be of type designate.domain
Record name.
String value expected.
Updates cause replacement.
The length must be no greater than 255.
DNS Record type.
String value expected.
Can be updated without replacement.
Allowed values: A, AAAA, CNAME, MX, SRV, TXT, SPF, NS, PTR, SSHFP, SOA
Description of record.
String value expected.
Can be updated without replacement.
The length must be no greater than 160.
DNS record priority. It is considered only for MX and SRV types, otherwise, it is ignored.
Integer value expected.
Can be updated without replacement.
The value must be in the range 0 to 65536.
Time To Live (Seconds).
Integer value expected.
Can be updated without replacement.
The value must be in the range 0 to 2147483647.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Designate::Record
properties:
data: String
description: String
domain: String
name: String
priority: Integer
ttl: Integer
type: String
Note
Available since 2014.2 (Juno)
A resource managing for image in Glance.
Container format of image.
String value expected.
Updates cause replacement.
Allowed values: ami, ari, aki, bare, ova, ovf
Disk format of image.
String value expected.
Updates cause replacement.
Allowed values: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso
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”.
String value expected.
Updates cause replacement.
The image ID. Glance will generate a UUID if not specified.
String value expected.
Updates cause replacement.
Scope of image accessibility. Public or private. Default value is False means private.
Boolean value expected.
Updates cause replacement.
Defaults to “False”.
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.
Integer value expected.
Updates cause replacement.
The value must be at least 0.
Amount of ram (in MB) required to boot image. Default value is 0 if not specified and means no limit on the ram size.
Integer value expected.
Updates cause replacement.
The value must be at least 0.
Name for the image. The name of an image is not unique to a Image Service node.
String value expected.
Updates cause replacement.
Whether the image can be deleted. If the value is True, the image is protected and cannot be deleted.
Boolean value expected.
Updates cause replacement.
heat_template_version: 2015-04-30
...
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
Resources that users are allowed to access by the DescribeStackResource API.
List value expected.
Updates cause replacement.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::AccessPolicy
properties:
AllowedResources: [Value, Value, ...]
Note
Available since 2014.1 (Icehouse)
An autoscaling group that can scale arbitrary resources.
Maximum number of resources in the group.
Integer value expected.
Can be updated without replacement.
The value must be at least 0.
Minimum number of resources in the group.
Integer value expected.
Can be updated without replacement.
The value must be at least 0.
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.
Map value expected.
Can be updated without replacement.
Desired initial number of resources.
Integer value expected.
Can be updated without replacement.
Policy for rolling updates for this scaling group.
Map value expected.
Can be updated without replacement.
Defaults to “{‘min_in_service’: 0, ‘pause_time’: 0, ‘max_batch_size’: 1}”.
Map properties:
max_batch_size¶
The maximum number of resources to replace at once.
Integer value expected.
Can be updated without replacement.
Defaults to “1”.
The value must be at least 1.
min_in_service¶
The minimum number of resources in service while rolling updates are being executed.
Integer value expected.
Can be updated without replacement.
Defaults to “0”.
The value must be at least 0.
pause_time¶
The number of seconds to wait between batches of updates.
Number value expected.
Can be updated without replacement.
Defaults to “0”.
The value must be at least 0.
Note
Available since 2014.2 (Juno)
A map of resource names to the specified attribute of each individual resource. Requires heat_template_version: 2014-10-16 or higher.
Note
Available since 2014.2 (Juno)
A list of the specified attribute of each individual resource. Requires heat_template_version: 2014-10-16 or higher.
Detailed information about resource.
heat_template_version: 2015-04-30
...
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": Integer, "pause_time": Number, "max_batch_size": Integer}
Note
Available since 2014.1 (Icehouse)
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.
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.
Map representing the cloud-config data structure which will be formatted as YAML.
Map value expected.
Updates cause replacement.
The config value of the software config.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::CloudConfig
properties:
cloud_config: {...}
The reference to a LaunchConfiguration resource.
String value expected.
Can be updated without replacement.
A comma-delimited list of server ip addresses. (Heat extension).
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::InstanceGroup
properties:
AvailabilityZones: [Value, Value, ...]
LaunchConfigurationName: String
LoadBalancerNames: [Value, Value, ...]
Size: Integer
Tags: [{"Key": String, "Value": String}, {"Key": String, "Value": String}, ...]
Note
Available since 2014.1 (Icehouse)
A resource which assembles a collection of software configurations as a multi-part mime message.
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.
Parts belonging to this message.
List value expected.
Updates cause replacement.
Defaults to “[]”.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
config¶
Content of part to attach, either inline or by referencing the ID of another software config resource
String value expected.
Updates cause replacement.
filename¶
Optional filename to associate with part.
String value expected.
Updates cause replacement.
subtype¶
Optional subtype to specify with the type.
String value expected.
Updates cause replacement.
type¶
Whether the part content is text or multipart.
String value expected.
Updates cause replacement.
Defaults to “text”.
Allowed values: text, multipart
The config value of the software config.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::MultipartMime
properties:
parts: [{"config": String, "type": String, "subtype": String, "filename": String}, {"config": String, "type": String, "subtype": String, "filename": String}, ...]
Note
Available since 5.0.0 (Liberty)
A resource which enables easily disabling certain resources via the resource_registry. It does nothing, but can effectively stub out any other resource because it will accept any properties and return any attribute (as None). Note this resource always does nothing on update (e.g it is not replaced even if a change to the stubbed resource properties would cause replacement).
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::None
Note
Available since 2014.1 (Icehouse)
A resource which generates a random string.
This is useful for configuring passwords and secrets on services.
A list of character class and their constraints to generate the random string from.
List value expected.
Updates cause replacement.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
class¶
A character class and its corresponding min constraint to generate the random string from.
String value expected.
Updates cause replacement.
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.
Integer value expected.
Updates cause replacement.
Defaults to “1”.
The value must be in the range 1 to 512.
A list of character sequences and their constraints to generate the random string from.
List value expected.
Updates cause replacement.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
min¶
The minimum number of characters from this sequence that will be in the generated string.
Integer value expected.
Updates cause replacement.
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.
String value expected.
Updates cause replacement.
Length of the string to generate.
Integer value expected.
Updates cause replacement.
Defaults to “32”.
The value must be in the range 1 to 512.
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.
String value expected.
Updates cause replacement.
Detailed information about resource.
The random string generated by this resource. This value is also available by referencing the resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::RandomString
properties:
character_classes: [{"min": Integer, "class": String}, {"min": Integer, "class": String}, ...]
character_sequences: [{"min": Integer, "sequence": String}, {"min": Integer, "sequence": String}, ...]
length: Integer
salt: String
Note
Available since 2014.1 (Icehouse)
A resource that creates one or more identically configured nested resources.
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.
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 value expected.
Can be updated without replacement.
Map properties:
metadata¶
Note
Available since 5.0.0 (Liberty)
Supplied metadata for the resources in the group
Map value expected.
Can be updated without replacement.
properties¶
Property values for the resources in the group
Map value expected.
Can be updated without replacement.
type¶
The type of the resources in the group
String value expected.
Can be updated without replacement.
The number of resources to create.
Integer value expected.
Can be updated without replacement.
Defaults to “1”.
The value must be at least 0.
Note
Available since 2014.2 (Juno)
A variable that this resource will use to replace with the current 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.
String value expected.
Updates cause replacement.
Defaults to “%index%”.
The length must be at least 3.
Note
Available since 2015.1 (Kilo)
Policies for removal of resources on update
List value expected.
Can be updated without replacement.
Defaults to “[]”.
List contents:
*¶
Policy to be processed when doing an update which requires removal of specific resources.
Map value expected.
Can be updated without replacement.
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
List value expected.
Can be updated without replacement.
Defaults to “[]”.
Note
Available since 2014.2 (Juno)
A map of resource names to the specified attribute of each individual resource. Requires heat_template_version: 2014-10-16.
A list of resource IDs for the resources in the group
Detailed information about resource.
Note
Available since 5.0.0 (Liberty)
Map value expected.
Updates cause replacement.
Map properties:
max_batch_size¶
The maximum number of resources to create at once.
Integer value expected.
Updates cause replacement.
Defaults to “1”.
The value must be at least 1.
pause_time¶
The number of seconds to wait between batches.
Number value expected.
Updates cause replacement.
Defaults to “0”.
The value must be at least 0.
Note
Available since 5.0.0 (Liberty)
Map value expected.
Updates cause replacement.
Map properties:
max_batch_size¶
The maximum number of resources to replace at once.
Integer value expected.
Updates cause replacement.
Defaults to “1”.
The value must be at least 1.
min_in_service¶
The minimum number of resources in service while rolling updates are being executed.
Integer value expected.
Updates cause replacement.
Defaults to “0”.
The value must be at least 0.
pause_time¶
The number of seconds to wait between batches of updates.
Number value expected.
Updates cause replacement.
Defaults to “0”.
The value must be at least 0.
heat_template_version: 2015-04-30
...
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": {...}, "metadata": {...}}
A resource to manage scaling of OS::Heat::AutoScalingGroup.
Note while it may incidentally support AWS::AutoScaling::AutoScalingGroup for now, please don’t use it for that purpose and use AWS::AutoScaling::ScalingPolicy instead.
Type of adjustment (absolute or percentage).
String value expected.
Can be updated without replacement.
Allowed values: change_in_capacity, exact_capacity, percent_change_in_capacity
AutoScaling group ID to apply policy to.
String value expected.
Updates cause replacement.
Minimum number of resources that are added or removed when the AutoScaling group scales up or down. This can be used only when specifying percent_change_in_capacity for the adjustment_type property.
Integer value expected.
Can be updated without replacement.
The value must be at least 0.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::ScalingPolicy
properties:
adjustment_type: String
auto_scaling_group_id: String
cooldown: Number
min_adjustment_step: Integer
scaling_adjustment: Number
Note
Available since 2014.2 (Juno)
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.
The list of configurations for the different lifecycle actions of the represented software component.
List value expected.
Updates cause replacement.
The length must be at least 1.
List contents:
*¶
Map value expected.
Updates cause replacement.
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 RESUME supported by Heat.
List value expected.
Updates cause replacement.
Defaults to “[‘CREATE’, ‘UPDATE’]”.
The length must be at least 1.
List contents:
config¶
Configuration script or manifest which specifies what actual configuration is performed.
String value expected.
Updates cause replacement.
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.
String value expected.
Updates cause replacement.
Schema representing the inputs that this software config is expecting.
List value expected.
Updates cause replacement.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
default¶
Default value for the input if none is specified.
String value expected.
Updates cause replacement.
type¶
Type of the value of the input.
String value expected.
Updates cause replacement.
Defaults to “String”.
Allowed values: String, Number, CommaDelimitedList, Json, Boolean
Map containing options specific to the configuration management tool used by this resource.
Map value expected.
Updates cause replacement.
Schema representing the outputs that this software config will produce.
List value expected.
Updates cause replacement.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
error_output¶
Denotes that the deployment is in an error state if this output has a value.
Boolean value expected.
Updates cause replacement.
Defaults to “False”.
type¶
Type of the value of the output.
String value expected.
Updates cause replacement.
Defaults to “String”.
Allowed values: String, Number, CommaDelimitedList, Json, Boolean
The config value of the software config.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::SoftwareComponent
properties:
configs: [{"actions": [String, String, ...], "config": String, "tool": String}, {"actions": [String, String, ...], "config": String, "tool": String}, ...]
inputs: [{"type": String, "name": String, "description": String, "default": String}, {"type": String, "name": String, "description": String, "default": String}, ...]
options: {...}
outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]
Note
Available since 2014.1 (Icehouse)
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.
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.
Configuration script or manifest which specifies what actual configuration is performed.
String value expected.
Updates cause replacement.
Namespace to group this software config by when delivered to a server. This may imply what configuration tool is going to perform the configuration.
String value expected.
Updates cause replacement.
Defaults to “Heat::Ungrouped”.
Schema representing the inputs that this software config is expecting.
List value expected.
Updates cause replacement.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
default¶
Default value for the input if none is specified.
String value expected.
Updates cause replacement.
type¶
Type of the value of the input.
String value expected.
Updates cause replacement.
Defaults to “String”.
Allowed values: String, Number, CommaDelimitedList, Json, Boolean
Map containing options specific to the configuration management tool used by this resource.
Map value expected.
Updates cause replacement.
Schema representing the outputs that this software config will produce.
List value expected.
Updates cause replacement.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
error_output¶
Denotes that the deployment is in an error state if this output has a value.
Boolean value expected.
Updates cause replacement.
Defaults to “False”.
type¶
Type of the value of the output.
String value expected.
Updates cause replacement.
Defaults to “String”.
Allowed values: String, Number, CommaDelimitedList, Json, Boolean
The config value of the software config.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::SoftwareConfig
properties:
config: String
group: String
inputs: [{"type": String, "name": String, "description": String, "default": String}, {"type": String, "name": String, "description": String, "default": String}, ...]
options: {...}
outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]
Note
Available since 2014.1 (Icehouse)
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 current 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.
ID of resource to apply configuration to. Normally this should be a Nova server ID.
String value expected.
Updates cause replacement.
Which lifecycle actions of the deployment resource will result in this deployment being triggered.
List value expected.
Can be updated without replacement.
Defaults to “[‘CREATE’, ‘UPDATE’]”.
Allowed values: CREATE, UPDATE, DELETE, SUSPEND, RESUME
ID of software configuration resource to execute when applying to the server.
String value expected.
Can be updated without replacement.
Input values to apply to the software configuration on this server.
Map value expected.
Can be updated without replacement.
Name of the derived config associated with this deployment. This is used to apply a sort order to the list of configurations currently deployed to a server.
String value expected.
Can be updated without replacement.
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. TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT. HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. ZAQAR_SIGNAL will create a dedicated zaqar queue to be signaled using the provided keystone credentials. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal.
String value expected.
Updates cause replacement.
Defaults to “CFN_SIGNAL”.
Allowed values: CFN_SIGNAL, TEMP_URL_SIGNAL, HEAT_SIGNAL, NO_SIGNAL, ZAQAR_SIGNAL
Returned status code from the configuration execution
Captured stderr from the configuration execution.
Captured stdout from the configuration execution.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::SoftwareDeployment
properties:
actions: [Value, Value, ...]
config: String
input_values: {...}
name: String
server: String
signal_transport: String
Note
Available since 5.0.0 (Liberty)
This resource associates a group of servers with some configuration which is to be deployed to all servers in the group.
The properties work in a similar way to OS::Heat::SoftwareDeployment, and in addition to the attributes documented, you may pass any attribute supported by OS::Heat::SoftwareDeployment, including those exposing arbitrary outputs, and return a map of deployment names to the specified attribute.
Which lifecycle actions of the deployment resource will result in this deployment being triggered.
List value expected.
Can be updated without replacement.
Defaults to “[‘CREATE’, ‘UPDATE’]”.
Allowed values: CREATE, UPDATE, DELETE, SUSPEND, RESUME
ID of software configuration resource to execute when applying to the server.
String value expected.
Can be updated without replacement.
Input values to apply to the software configuration on this server.
Map value expected.
Can be updated without replacement.
Name of the derived config associated with this deployment. This is used to apply a sort order to the list of configurations currently deployed to a server.
String value expected.
Can be updated without replacement.
A map of Nova names and IDs to apply configuration to.
Map value expected.
Can be updated without replacement.
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. TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT. HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. ZAQAR_SIGNAL will create a dedicated zaqar queue to be signaled using the provided keystone credentials. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal.
String value expected.
Updates cause replacement.
Defaults to “CFN_SIGNAL”.
Allowed values: CFN_SIGNAL, TEMP_URL_SIGNAL, HEAT_SIGNAL, NO_SIGNAL, ZAQAR_SIGNAL
A map of Nova names and returned status code from the configuration execution
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.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::SoftwareDeploymentGroup
properties:
actions: [Value, Value, ...]
config: String
input_values: {...}
name: String
servers: {...}
signal_transport: String
A Resource representing a stack which can be created using specified context.
Template that specifies the stack to be created as a resource.
String value expected.
Can be updated without replacement.
Context for this stack.
Map value expected.
Updates cause replacement.
Map properties:
region_name¶
Region name in which this stack will be created.
String value expected.
Updates cause replacement.
Set of parameters passed to this stack.
Map value expected.
Can be updated without replacement.
Defaults to “{}”.
Number of minutes to wait for this stack creation.
Integer value expected.
Can be updated without replacement.
A dict of key-value pairs output from the stack.
Detailed information about resource.
Name of the stack.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::Stack
properties:
context: {"region_name": String}
parameters: {...}
template: String
timeout: Integer
Note
Available since 2014.1 (Icehouse)
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.
Map representing the configuration data structure which will be serialized to JSON format.
Map value expected.
Updates cause replacement.
Namespace to group this software config by when delivered to a server. This may imply what configuration tool is going to perform the configuration.
String value expected.
Updates cause replacement.
Defaults to “Heat::Ungrouped”.
Schema representing the inputs that this software config is expecting.
List value expected.
Updates cause replacement.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
default¶
Default value for the input if none is specified.
String value expected.
Updates cause replacement.
type¶
Type of the value of the input.
String value expected.
Updates cause replacement.
Defaults to “String”.
Allowed values: String, Number, CommaDelimitedList, Json, Boolean
Map containing options specific to the configuration management tool used by this resource.
Map value expected.
Updates cause replacement.
Schema representing the outputs that this software config will produce.
List value expected.
Updates cause replacement.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
error_output¶
Denotes that the deployment is in an error state if this output has a value.
Boolean value expected.
Updates cause replacement.
Defaults to “False”.
type¶
Type of the value of the output.
String value expected.
Updates cause replacement.
Defaults to “String”.
Allowed values: String, Number, CommaDelimitedList, Json, Boolean
The config value of the software config.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::StructuredConfig
properties:
config: {...}
group: String
inputs: [{"type": String, "name": String, "description": String, "default": String}, {"type": String, "name": String, "description": String, "default": String}, ...]
options: {...}
outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]
Note
Available since 2014.1 (Icehouse)
A deployment resource like OS::Heat::SoftwareDeployment, but which performs input value substitution on the config defined by a OS::Heat::StructuredConfig resource.
Some configuration tools have no concept of inputs, so the input value substitution needs to occur in the deployment resource. An example of this is the JSON metadata consumed by the cfn-init tool.
Where the config contains {get_input: input_name} this will be substituted with the value of input_name in this resource’s input_values. If get_input needs to be passed through to the substituted configuration then a different input_key property value can be specified.
ID of resource to apply configuration to. Normally this should be a Nova server ID.
String value expected.
Updates cause replacement.
Which lifecycle actions of the deployment resource will result in this deployment being triggered.
List value expected.
Can be updated without replacement.
Defaults to “[‘CREATE’, ‘UPDATE’]”.
Allowed values: CREATE, UPDATE, DELETE, SUSPEND, RESUME
ID of software configuration resource to execute when applying to the server.
String value expected.
Can be updated without replacement.
Name of key to use for substituting inputs during deployment
String value expected.
Updates cause replacement.
Defaults to “get_input”.
Input values to apply to the software configuration on this server.
Map value expected.
Can be updated without replacement.
Perform a check on the input values passed to verify that each required input has a corresponding value. When the property is set to STRICT and no value is passed, an exception is raised.
String value expected.
Updates cause replacement.
Defaults to “LAX”.
Allowed values: LAX, STRICT
Name of the derived config associated with this deployment. This is used to apply a sort order to the list of configurations currently deployed to a server.
String value expected.
Can be updated without replacement.
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. TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT. HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. ZAQAR_SIGNAL will create a dedicated zaqar queue to be signaled using the provided keystone credentials. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal.
String value expected.
Updates cause replacement.
Defaults to “CFN_SIGNAL”.
Allowed values: CFN_SIGNAL, TEMP_URL_SIGNAL, HEAT_SIGNAL, NO_SIGNAL, ZAQAR_SIGNAL
Returned status code from the configuration execution
Captured stderr from the configuration execution.
Captured stdout from the configuration execution.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::StructuredDeployment
properties:
actions: [Value, Value, ...]
config: String
input_key: String
input_values: {...}
input_values_validate: String
name: String
server: String
signal_transport: String
Note
Available since 5.0.0 (Liberty)
Which lifecycle actions of the deployment resource will result in this deployment being triggered.
List value expected.
Can be updated without replacement.
Defaults to “[‘CREATE’, ‘UPDATE’]”.
Allowed values: CREATE, UPDATE, DELETE, SUSPEND, RESUME
ID of software configuration resource to execute when applying to the server.
String value expected.
Can be updated without replacement.
Name of key to use for substituting inputs during deployment
String value expected.
Updates cause replacement.
Defaults to “get_input”.
Input values to apply to the software configuration on this server.
Map value expected.
Can be updated without replacement.
Perform a check on the input values passed to verify that each required input has a corresponding value. When the property is set to STRICT and no value is passed, an exception is raised.
String value expected.
Updates cause replacement.
Defaults to “LAX”.
Allowed values: LAX, STRICT
Name of the derived config associated with this deployment. This is used to apply a sort order to the list of configurations currently deployed to a server.
String value expected.
Can be updated without replacement.
A map of Nova names and IDs to apply configuration to.
Map value expected.
Can be updated without replacement.
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. TEMP_URL_SIGNAL will create a Swift TempURL to be signaled via HTTP PUT. HEAT_SIGNAL will allow calls to the Heat API resource-signal using the provided keystone credentials. ZAQAR_SIGNAL will create a dedicated zaqar queue to be signaled using the provided keystone credentials. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal.
String value expected.
Updates cause replacement.
Defaults to “CFN_SIGNAL”.
Allowed values: CFN_SIGNAL, TEMP_URL_SIGNAL, HEAT_SIGNAL, NO_SIGNAL, ZAQAR_SIGNAL
A map of Nova names and returned status code from the configuration execution
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.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::StructuredDeploymentGroup
properties:
actions: [Value, Value, ...]
config: String
input_key: String
input_values: {...}
input_values_validate: String
name: String
servers: {...}
signal_transport: String
Note
Available since 2014.2 (Juno)
URL of TempURL where resource will signal completion and optionally upload data.
String value expected.
Updates cause replacement.
The maximum number of seconds to wait for the resource to signal completion. Once the timeout is reached, creation of the signal resource will fail.
Number value expected.
Updates cause replacement.
The value must be in the range 1 to 43200.
The number of success signals that must be received before the stack creation process continues.
Integer value expected.
Updates cause replacement.
Defaults to “1”.
The value must be in the range 1 to 1000.
JSON data that was uploaded via the SwiftSignalHandle.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::SwiftSignal
properties:
count: Integer
handle: String
timeout: Number
Note
Available since 2014.2 (Juno)
Convenience attribute, provides curl CLI command prefix, which can be used for signalling handle completion or failure. You can signal success by adding –data-binary ‘{“status”: “SUCCESS”}’ , or signal failure by adding –data-binary ‘{“status”: “FAILURE”}’
Endpoint/url which can be used for signalling handle
Detailed information about resource.
Tokens are not needed for Swift TempURLs. This attribute is being kept for compatibility with the OS::Heat::WaitConditionHandle resource
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::SwiftSignalHandle
Note
Available since 5.0.0 (Liberty)
A resource which stores the string value that was provided.
This resource is to be used only for testing. It has control knobs such as ‘update_replace’, ‘fail’, ‘wait_secs’.
Options for simulating waiting.
Map value expected.
Can be updated without replacement.
Map properties:
create¶
Seconds to wait after a create. Defaults to the global wait_secs
Number value expected.
Can be updated without replacement.
delete¶
Seconds to wait after a delete. Defaults to the global wait_secs
Number value expected.
Can be updated without replacement.
update¶
Seconds to wait after an update. Defaults to the global wait_secs
Number value expected.
Can be updated without replacement.
Client to poll.
String value expected.
Can be updated without replacement.
Defaults to “”.
Client entity to poll.
String value expected.
Can be updated without replacement.
Defaults to “”.
Value which can be set to fail the resource operation to test failure scenarios.
Boolean value expected.
Can be updated without replacement.
Defaults to “False”.
Value which can be set to trigger update replace for the particular resource
Boolean value expected.
Can be updated without replacement.
Defaults to “False”.
The input string to be stored.
String value expected.
Can be updated without replacement.
Defaults to “test_string”.
Seconds to wait after an action (-1 is infinite)
Number value expected.
Can be updated without replacement.
Defaults to “0”.
The string that was stored. This value is also available by referencing the resource.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::TestResource
properties:
action_wait_secs: {"create": Number, "delete": Number, "update": Number}
client_name: String
entity_name: String
fail: Boolean
update_replace: Boolean
value: String
wait_secs: Number
Note
Available since 2014.1 (Icehouse)
This works identically to a regular WaitConditionHandle, except that on update it clears all signals received and changes the handle. Using this handle means that you must setup the signal senders to send their signals again any time the update handle changes. This allows us to roll out new configurations and be confident that they are rolled out once UPDATE COMPLETE is reached.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::UpdateWaitConditionHandle
Note
Available since 2014.2 (Juno)
A reference to the wait condition handle used to signal this wait condition.
String value expected.
Updates cause replacement.
The number of seconds to wait for the correct number of signals to arrive.
Number value expected.
Updates cause replacement.
The value must be in the range 1 to 43200.
The number of success signals that must be received before the stack creation process continues.
Integer value expected.
Can be updated without replacement.
Defaults to “1”.
The value must be at least 1.
JSON string containing data associated with wait condition signals sent to the handle.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::WaitCondition
properties:
count: Integer
handle: String
timeout: Number
Note
Available since 2014.2 (Juno)
Convenience attribute, provides curl CLI command prefix, which can be used for signalling handle completion or failure. You can signal success by adding –data-binary ‘{“status”: “SUCCESS”}’ , or signal failure by adding –data-binary ‘{“status”: “FAILURE”}’
Endpoint/url which can be used for signalling handle
Detailed information about resource.
Token for stack-user which can be used for signalling handle
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::WaitConditionHandle
Note
Available since 5.0.0 (Liberty) - Supported versions: keystone v3
Heat Template Resource for Keystone Service Endpoint.
Interface type of keystone service endpoint.
String value expected.
Can be updated without replacement.
Allowed values: public, internal, admin
Name or Id of keystone service.
String value expected.
Can be updated without replacement.
Value must be of type keystone.service
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Keystone::Endpoint
properties:
interface: String
name: String
region: String
service: String
url: String
Note
Available since 2015.1 (Kilo) - Supported versions: keystone v3
Heat Template Resource for Keystone Group.
Description of keystone group.
String value expected.
Can be updated without replacement.
Defaults to “”.
Name or id of keystone domain.
String value expected.
Can be updated without replacement.
Defaults to “default”.
Value must be of type keystone.domain
List of role assignments.
List value expected.
Can be updated without replacement.
List contents:
*¶
Map between role with either project or domain.
Map value expected.
Can be updated without replacement.
Map properties:
domain¶
Keystone domain
String value expected.
Can be updated without replacement.
Value must be of type keystone.domain
project¶
Keystone project
String value expected.
Can be updated without replacement.
Value must be of type keystone.project
role¶
Keystone role
String value expected.
Can be updated without replacement.
Value must be of type keystone.role
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Keystone::Group
properties:
description: String
domain: String
name: String
roles: [{"project": String, "role": String, "domain": String}, {"project": String, "role": String, "domain": String}, ...]
Note
Available since 5.0.0 (Liberty) - Supported versions: keystone v3
Resource for granting roles to a group.
Name or id of keystone group.
String value expected.
Can be updated without replacement.
Value must be of type keystone.group
List of role assignments.
List value expected.
Can be updated without replacement.
List contents:
*¶
Map between role with either project or domain.
Map value expected.
Can be updated without replacement.
Map properties:
domain¶
Keystone domain
String value expected.
Can be updated without replacement.
Value must be of type keystone.domain
project¶
Keystone project
String value expected.
Can be updated without replacement.
Value must be of type keystone.project
role¶
Keystone role
String value expected.
Can be updated without replacement.
Value must be of type keystone.role
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Keystone::GroupRoleAssignment
properties:
group: String
roles: [{"project": String, "role": String, "domain": String}, {"project": String, "role": String, "domain": String}, ...]
Note
Available since 2015.1 (Kilo) - Supported versions: keystone v3
Heat Template Resource for Keystone Project.
Description of keystone project.
String value expected.
Can be updated without replacement.
Defaults to “”.
Name or id of keystone domain.
String value expected.
Can be updated without replacement.
Defaults to “default”.
Value must be of type keystone.domain
This project is enabled or disabled.
Boolean value expected.
Can be updated without replacement.
Defaults to “True”.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Keystone::Project
properties:
description: String
domain: String
enabled: Boolean
name: String
Note
Available since 2015.1 (Kilo) - Supported versions: keystone v3
Heat Template Resource for Keystone Role.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Keystone::Role
properties:
name: String
Note
Available since 5.0.0 (Liberty) - Supported versions: keystone v3
Heat Template Resource for Keystone Service.
Description of keystone service.
String value expected.
Can be updated without replacement.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Keystone::Service
properties:
description: String
name: String
type: String
Note
Available since 2015.1 (Kilo) - Supported versions: keystone v3
Heat Template Resource for Keystone User.
Default project of keystone user.
String value expected.
Can be updated without replacement.
Value must be of type keystone.project
Description of keystone user.
String value expected.
Can be updated without replacement.
Defaults to “”.
Name of keystone domain.
String value expected.
Can be updated without replacement.
Defaults to “default”.
Value must be of type keystone.domain
Keystone user is enabled or disabled
Boolean value expected.
Can be updated without replacement.
Defaults to “True”.
keystone user groups.
List value expected.
Can be updated without replacement.
List contents:
*¶
keystone user group.
String value expected.
Can be updated without replacement.
Value must be of type keystone.group
List of role assignments.
List value expected.
Can be updated without replacement.
List contents:
*¶
Map between role with either project or domain.
Map value expected.
Can be updated without replacement.
Map properties:
domain¶
Keystone domain
String value expected.
Can be updated without replacement.
Value must be of type keystone.domain
project¶
Keystone project
String value expected.
Can be updated without replacement.
Value must be of type keystone.project
role¶
Keystone role
String value expected.
Can be updated without replacement.
Value must be of type keystone.role
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Keystone::User
properties:
default_project: String
description: String
domain: String
email: String
enabled: Boolean
groups: [String, String, ...]
name: String
password: String
roles: [{"project": String, "role": String, "domain": String}, {"project": String, "role": String, "domain": String}, ...]
Note
Available since 5.0.0 (Liberty) - Supported versions: keystone v3
Resource for granting roles to a user.
Name or id of keystone user.
String value expected.
Can be updated without replacement.
Value must be of type keystone.user
List of role assignments.
List value expected.
Can be updated without replacement.
List contents:
*¶
Map between role with either project or domain.
Map value expected.
Can be updated without replacement.
Map properties:
domain¶
Keystone domain
String value expected.
Can be updated without replacement.
Value must be of type keystone.domain
project¶
Keystone project
String value expected.
Can be updated without replacement.
Value must be of type keystone.project
role¶
Keystone role
String value expected.
Can be updated without replacement.
Value must be of type keystone.role
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Keystone::UserRoleAssignment
properties:
roles: [{"project": String, "role": String, "domain": String}, {"project": String, "role": String, "domain": String}, ...]
user: String
Note
Available since 5.0.0 (Liberty)
A resource for the BayModel in Magnum.
The Container Orchestration Engine for this bay model.
String value expected.
Updates cause replacement.
Allowed values: kubernetes, swarm
The external network to attach the Bay.
String value expected.
Updates cause replacement.
Value must be of type neutron.network
The image name or UUID to use as a base image for this baymodel.
String value expected.
Updates cause replacement.
Value must be of type glance.image
The name or id of the nova ssh keypair.
String value expected.
Updates cause replacement.
Value must be of type nova.keypair
The DNS nameserver address.
String value expected.
Updates cause replacement.
Value must be of type ip_addr
The size in GB of the docker volume.
Integer value expected.
Updates cause replacement.
The value must be at least 1.
The fixed network to attach the Bay.
String value expected.
Updates cause replacement.
Value must be of type neutron.network
The flavor of this bay model.
String value expected.
Updates cause replacement.
Value must be of type nova.flavor
The flavor of the master node for this bay model.
String value expected.
Updates cause replacement.
Value must be of type nova.flavor
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Magnum::BayModel
properties:
coe: String
dns_nameserver: String
docker_volume_size: Integer
external_network: String
fixed_network: String
flavor: String
image: String
keypair: String
master_flavor: String
name: String
ssh_authorized_key: String
Note
Available since 5.0.0 (Liberty)
A security_service is a set of options that defines a security domain for a particular shared filesystem protocol, such as an Active Directory domain or a Kerberos domain.
Security service type.
String value expected.
Updates cause replacement.
Allowed values: ldap, kerberos, active_directory
Security service description.
String value expected.
Can be updated without replacement.
DNS IP address used inside tenant’s network.
String value expected.
Can be updated without replacement.
Security service IP address or hostname.
String value expected.
Can be updated without replacement.
Security service user or group used by tenant.
String value expected.
Can be updated without replacement.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Manila::SecurityService
properties:
description: String
dns_ip: String
domain: String
name: String
password: String
server: String
type: String
user: String
Note
Available since 5.0.0 (Liberty)
Time of the first execution in format “YYYY-MM-DD HH:MM”.
String value expected.
Updates cause replacement.
Cron expression.
String value expected.
Updates cause replacement.
Value must be of type cron_expression
Time of the next execution in format “YYYY-MM-DD HH:MM:SS”.
Number of remaining executions.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Mistral::CronTrigger
properties:
count: Integer
first_time: String
name: String
pattern: String
workflow: {"name": String, "input": {...}}
Note
Available since 2015.1 (Kilo)
Dictionary containing workflow tasks.
List value expected.
Can be updated without replacement.
List contents:
*¶
Map value expected.
Can be updated without replacement.
Map properties:
action¶
Name of the action associated with the task. Either action or workflow may be defined in the task.
String value expected.
Can be updated without replacement.
input¶
Actual input parameter values of the task.
Map value expected.
Can be updated without replacement.
keep_result¶
Note
Available since 5.0.0 (Liberty)
Allowing not to store action results after task completion.
Boolean value expected.
Can be updated without replacement.
on_complete¶
List of tasks which will run after the task has completed regardless of whether it is successful or not.
List value expected.
Can be updated without replacement.
on_error¶
List of tasks which will run after the task has completed with an error.
List value expected.
Can be updated without replacement.
on_success¶
List of tasks which will run after the task has completed successfully.
List value expected.
Can be updated without replacement.
pause_before¶
Note
Available since 5.0.0 (Liberty)
Defines whether Mistral Engine should put the workflow on hold or not before starting a task.
Boolean value expected.
Can be updated without replacement.
publish¶
Dictionary of variables to publish to the workflow context.
Map value expected.
Can be updated without replacement.
requires¶
List of tasks which should be executed before this task. Used only in reverse workflows.
List value expected.
Can be updated without replacement.
retry¶
Note
Available since 5.0.0 (Liberty)
Defines a pattern how task should be repeated in case of an error.
Map value expected.
Can be updated without replacement.
target¶
Note
Available since 5.0.0 (Liberty)
It defines an executor to which task action should be sent to.
String value expected.
Can be updated without replacement.
timeout¶
Note
Available since 5.0.0 (Liberty)
Defines a period of time in seconds after which a task will be failed automatically by engine if hasn’t completed.
Integer value expected.
Can be updated without replacement.
wait_after¶
Note
Available since 5.0.0 (Liberty)
Defines a delay in seconds that Mistral Engine should wait after a task has completed before starting next tasks defined in on-success, on-error or on-complete.
Integer value expected.
Can be updated without replacement.
wait_before¶
Note
Available since 5.0.0 (Liberty)
Defines a delay in seconds that Mistral Engine should wait before starting a task.
Integer value expected.
Can be updated without replacement.
with_items¶
Note
Available since 5.0.0 (Liberty)
If configured, it allows to run action or workflow associated with a task multiple times on a provided list of items.
String value expected.
Can be updated without replacement.
workflow¶
Name of the workflow associated with the task. Can be defined by intrinsic function get_resource or by name of the referenced workflow, i.e. { workflow: wf_name } or { workflow: { get_resource: wf_name }}. Either action or workflow may be defined in the task.
String value expected.
Can be updated without replacement.
policies¶
Note
DEPRECATED since 5.0.0 (Liberty) - Add needed policies directly to the task, Policy keyword is not needed
Note
Available since 2015.1 (Kilo)
Dictionary-like section defining task policies that influence how Mistral Engine runs tasks. Must satisfy Mistral DSL v2.
Map value expected.
Can be updated without replacement.
Workflow type.
String value expected.
Can be updated without replacement.
Allowed values: direct, reverse
Dictionary which contains input for workflow.
Map value expected.
Can be updated without replacement.
Any data structure arbitrarily containing YAQL expressions that defines workflow output. May be nested.
Map value expected.
Can be updated without replacement.
Workflow additional parameters. If Workflow is reverse typed, params requires ‘task_name’, which defines initial task.
Map value expected.
Can be updated without replacement.
Note
Available since 5.0.0 (Liberty)
Default settings for some of task attributes defined at workflow level.
Map value expected.
Can be updated without replacement.
Map properties:
on_complete¶
List of tasks which will run after the task has completed regardless of whether it is successful or not.
List value expected.
Can be updated without replacement.
on_error¶
List of tasks which will run after the task has completed with an error.
List value expected.
Can be updated without replacement.
on_success¶
List of tasks which will run after the task has completed successfully.
List value expected.
Can be updated without replacement.
pause_before¶
Defines whether Mistral Engine should put the workflow on hold or not before starting a task
Boolean value expected.
Can be updated without replacement.
requires¶
List of tasks which should be executed before this task. Used only in reverse workflows.
List value expected.
Can be updated without replacement.
retry¶
Defines a pattern how task should be repeated in case of an error.
Map value expected.
Can be updated without replacement.
timeout¶
Defines a period of time in seconds after which a task will be failed automatically by engine if hasn’t completed.
Integer value expected.
Can be updated without replacement.
wait_after¶
Defines a delay in seconds that Mistral Engine should wait after a task has completed before starting next tasks defined in on-success, on-error or on-complete.
Integer value expected.
Can be updated without replacement.
wait_before¶
Defines a delay in seconds that Mistral Engine should wait before starting a task.
Integer value expected.
Can be updated without replacement.
A signed url to create executions for workflows specified in Workflow resource.
A dictionary which contains name and input of the workflow.
List of workflows’ executions, each of them is a dictionary with information about execution. Each dictionary returns values for next keys: id, workflow_name, created_at, updated_at, state for current execution state, input, output.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Mistral::Workflow
properties:
description: String
input: {...}
name: String
output: {...}
params: {...}
task_defaults: {"timeout": Integer, "wait_after": Integer, "on_error": [Value, Value, ...], "on_success": [Value, Value, ...], "on_complete": [Value, Value, ...], "requires": [Value, Value, ...], "retry": {...}, "pause_before": Boolean, "wait_before": Integer}
tasks: [{"wait_after": Integer, "workflow": String, "on_error": [Value, Value, ...], "on_success": [Value, Value, ...], "action": String, "name": String, "with_items": String, "input": {...}, "wait_before": Integer, "pause_before": Boolean, "requires": [Value, Value, ...], "description": String, "timeout": Integer, "target": String, "on_complete": [Value, Value, ...], "retry": {...}, "keep_result": Boolean, "publish": {...}, "policies": {...}}, {"wait_after": Integer, "workflow": String, "on_error": [Value, Value, ...], "on_success": [Value, Value, ...], "action": String, "name": String, "with_items": String, "input": {...}, "wait_before": Integer, "pause_before": Boolean, "requires": [Value, Value, ...], "description": String, "timeout": Integer, "target": String, "on_complete": [Value, Value, ...], "retry": {...}, "keep_result": Boolean, "publish": {...}, "policies": {...}}, ...]
type: String
A resource for the Firewall resource in Neutron FWaaS.
The ID of the firewall policy that this firewall is associated with.
String value expected.
Can be updated without replacement.
Administrative state of the firewall. If false (down), firewall does not forward packets and will drop all traffic to/from VMs behind the firewall.
Boolean value expected.
Can be updated without replacement.
Defaults to “True”.
Description for the firewall.
String value expected.
Can be updated without replacement.
Note
Available since 5.0.0 (Liberty)
Extra parameters to include in the “firewall” object in the creation request. Parameters are often specific to installed hardware or extensions.
Map value expected.
Updates cause replacement.
Defaults to “{}”.
The administrative state of the firewall.
Description of the firewall.
Unique identifier of the firewall policy used to create the firewall.
Name for the firewall.
Detailed information about resource.
The status of the firewall.
Id of the tenant owning the firewall.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::Firewall
properties:
admin_state_up: Boolean
description: String
firewall_policy_id: String
name: String
shared: Boolean
value_specs: {...}
A resource for the FirewallPolicy resource in Neutron FWaaS.
An ordered list of firewall rules to apply to the firewall.
List value expected.
Can be updated without replacement.
Whether this policy should be audited. When set to True, each time the firewall policy or the associated firewall rules are changed, this attribute will be set to False and will have to be explicitly set to True through an update operation.
Boolean value expected.
Can be updated without replacement.
Defaults to “False”.
Description for the firewall policy.
String value expected.
Can be updated without replacement.
Audit status of this firewall policy.
Description of the firewall policy.
List of firewall rules in this firewall policy.
Name for the firewall policy.
Detailed information about resource.
Id of the tenant owning the firewall policy.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::FirewallPolicy
properties:
audited: Boolean
description: String
firewall_rules: [Value, Value, ...]
name: String
shared: Boolean
A resource for the FirewallRule resource in Neutron FWaaS.
Action to be performed on the traffic matching the rule.
String value expected.
Can be updated without replacement.
Defaults to “deny”.
Allowed values: allow, deny
Description for the firewall rule.
String value expected.
Can be updated without replacement.
Destination IP address or CIDR.
String value expected.
Can be updated without replacement.
Value must be of type net_cidr
Destination port number or a range.
String value expected.
Can be updated without replacement.
Whether this rule should be enabled.
Boolean value expected.
Can be updated without replacement.
Defaults to “True”.
Internet protocol version.
String value expected.
Can be updated without replacement.
Defaults to “4”.
Allowed values: 4, 6
Protocol for the firewall rule.
String value expected.
Can be updated without replacement.
Defaults to “any”.
Allowed values: tcp, udp, icmp, any
Source IP address or CIDR.
String value expected.
Can be updated without replacement.
Value must be of type net_cidr
Source port number or a range.
String value expected.
Can be updated without replacement.
Allow or deny action for this firewall rule.
Description of the firewall rule.
Destination ip_address for this firewall rule.
Destination port range for this firewall rule.
Indicates whether this firewall rule is enabled or not.
Unique identifier of the firewall policy to which this firewall rule belongs.
Ip_version for this firewall rule.
Name for the firewall rule.
Position of the rule within the firewall policy.
Protocol value for this firewall rule.
Detailed information about resource.
Source ip_address for this firewall rule.
Source port range for this firewall rule.
Id of the tenant owning the firewall.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::FirewallRule
properties:
action: String
description: String
destination_ip_address: String
destination_port: String
enabled: Boolean
ip_version: String
name: String
protocol: String
shared: Boolean
source_ip_address: String
source_port: String
Note
Available since 2014.2 (Juno)
Network to allocate floating IP from.
String value expected.
Updates cause replacement.
Value must be of type neutron.network
IP address to use if the port has multiple addresses.
String value expected.
Can be updated without replacement.
Value must be of type ip_addr
Note
Available since 5.0.0 (Liberty)
IP address of the floating IP. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only.
String value expected.
Updates cause replacement.
Value must be of type ip_addr
ID of an existing port with at least one IP address to associate with this floating IP.
String value expected.
Can be updated without replacement.
Value must be of type neutron.port
Extra parameters to include in the “floatingip” object in the creation request. Parameters are often specific to installed hardware or extensions.
Map value expected.
Updates cause replacement.
Defaults to “{}”.
IP address of the associated port, if specified.
The allocated address of this IP.
ID of the network in which this IP is allocated.
ID of the port associated with this IP.
ID of the router used as gateway, set when associated with a port.
Detailed information about resource.
The tenant owning this floating IP.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::FloatingIP
properties:
fixed_ip_address: String
floating_ip_address: String
floating_network: String
port_id: String
value_specs: {...}
ID of the floating IP to associate.
String value expected.
Can be updated without replacement.
ID of an existing port with at least one IP address to associate with this floating IP.
String value expected.
Can be updated without replacement.
Value must be of type neutron.port
IP address to use if the port has multiple addresses.
String value expected.
Can be updated without replacement.
Value must be of type ip_addr
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::FloatingIPAssociation
properties:
fixed_ip_address: String
floatingip_id: String
port_id: String
A resource for managing health monitors for load balancers in Neutron.
The minimum time in seconds between regular connections of the member.
Integer value expected.
Can be updated without replacement.
Number of permissible connection failures before changing the member status to INACTIVE.
Integer value expected.
Can be updated without replacement.
Maximum number of seconds for a monitor to wait for a connection to be established before it times out.
Integer value expected.
Can be updated without replacement.
One of predefined health monitor types.
String value expected.
Updates cause replacement.
Allowed values: PING, TCP, HTTP, HTTPS
The administrative state of the health monitor.
Boolean value expected.
Can be updated without replacement.
Defaults to “True”.
The list of HTTP status codes expected in response from the member to declare it healthy.
String value expected.
Can be updated without replacement.
The HTTP method used for requests by the monitor of type HTTP.
String value expected.
Can be updated without replacement.
The HTTP path used in the HTTP request used by the monitor to test a member health.
String value expected.
Can be updated without replacement.
The administrative state of this health monitor.
The minimum time in seconds between regular connections of the member.
The list of HTTP status codes expected in response from the member to declare it healthy.
The HTTP method used for requests by the monitor of type HTTP.
Number of permissible connection failures before changing the member status to INACTIVE.
Detailed information about resource.
Tenant owning the health monitor.
Maximum number of seconds for a monitor to wait for a connection to be established before it times out.
One of predefined health monitor types.
The HTTP path used in the HTTP request used by the monitor to test a member health.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::HealthMonitor
properties:
admin_state_up: Boolean
delay: Integer
expected_codes: String
http_method: String
max_retries: Integer
timeout: Integer
type: String
url_path: String
A resource for IKE policy in Neutron.
Authentication hash algorithm for the ike policy.
String value expected.
Updates cause replacement.
Defaults to “sha1”.
Allowed values: sha1
Description for the ike policy.
String value expected.
Can be updated without replacement.
Encryption algorithm for the ike policy.
String value expected.
Updates cause replacement.
Defaults to “aes-128”.
Allowed values: 3des, aes-128, aes-192, aes-256
Version for the ike policy.
String value expected.
Updates cause replacement.
Defaults to “v1”.
Allowed values: v1, v2
Safety assessment lifetime configuration for the ike policy.
Map value expected.
Updates cause replacement.
Map properties:
units¶
Safety assessment lifetime units.
String value expected.
Updates cause replacement.
Defaults to “seconds”.
Allowed values: seconds, kilobytes
value¶
Safety assessment lifetime value in specified units.
Integer value expected.
Updates cause replacement.
Defaults to “3600”.
Perfect forward secrecy in lowercase for the ike policy.
String value expected.
Updates cause replacement.
Defaults to “group5”.
Allowed values: group2, group5, group14
Negotiation mode for the ike policy.
String value expected.
Updates cause replacement.
Defaults to “main”.
Allowed values: main
The authentication hash algorithm used by the ike policy.
The description of the ike policy.
The encryption algorithm used by the ike policy.
The version of the ike policy.
The safety assessment lifetime configuration for the ike policy.
The name of the ike policy.
The perfect forward secrecy of the ike policy.
The negotiation mode of the ike policy.
Detailed information about resource.
The unique identifier of the tenant owning the ike policy.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::IKEPolicy
properties:
auth_algorithm: String
description: String
encryption_algorithm: String
ike_version: String
lifetime: {"value": Integer, "units": String}
name: String
pfs: String
phase1_negotiation_mode: String
A resource for IPsec policy in Neutron.
Authentication hash algorithm for the ipsec policy.
String value expected.
Updates cause replacement.
Defaults to “sha1”.
Allowed values: sha1
Description for the ipsec policy.
String value expected.
Can be updated without replacement.
Encapsulation mode for the ipsec policy.
String value expected.
Updates cause replacement.
Defaults to “tunnel”.
Allowed values: tunnel, transport
Encryption algorithm for the ipsec policy.
String value expected.
Updates cause replacement.
Defaults to “aes-128”.
Allowed values: 3des, aes-128, aes-192, aes-256
Safety assessment lifetime configuration for the ipsec policy.
Map value expected.
Updates cause replacement.
Map properties:
units¶
Safety assessment lifetime units.
String value expected.
Updates cause replacement.
Defaults to “seconds”.
Allowed values: seconds, kilobytes
value¶
Safety assessment lifetime value in specified units.
Integer value expected.
Updates cause replacement.
Defaults to “3600”.
Perfect forward secrecy for the ipsec policy.
String value expected.
Updates cause replacement.
Defaults to “group5”.
Allowed values: group2, group5, group14
Transform protocol for the ipsec policy.
String value expected.
Updates cause replacement.
Defaults to “esp”.
Allowed values: esp, ah, ah-esp
The authentication hash algorithm of the ipsec policy.
The description of the ipsec policy.
The encapsulation mode of the ipsec policy.
The encryption algorithm of the ipsec policy.
The safety assessment lifetime configuration of the ipsec policy.
The name of the ipsec policy.
The perfect forward secrecy of the ipsec policy.
Detailed information about resource.
The unique identifier of the tenant owning the ipsec policy.
The transform protocol of the ipsec policy.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::IPsecPolicy
properties:
auth_algorithm: String
description: String
encapsulation_mode: String
encryption_algorithm: String
lifetime: {"value": Integer, "units": String}
name: String
pfs: String
transform_protocol: String
A resource for IPsec site connection in Neutron.
Unique identifier for the ike policy associated with the ipsec site connection.
String value expected.
Updates cause replacement.
Unique identifier for the ipsec policy associated with the ipsec site connection.
String value expected.
Updates cause replacement.
Remote branch router public IPv4 address or IPv6 address or FQDN.
String value expected.
Updates cause replacement.
Remote subnet(s) in CIDR format.
List value expected.
Updates cause replacement.
List contents:
Pre-shared key string for the ipsec site connection.
String value expected.
Updates cause replacement.
Unique identifier for the vpn service associated with the ipsec site connection.
String value expected.
Updates cause replacement.
Administrative state for the ipsec site connection.
Boolean value expected.
Can be updated without replacement.
Defaults to “True”.
Description for the ipsec site connection.
String value expected.
Can be updated without replacement.
Dead Peer Detection protocol configuration for the ipsec site connection.
Map value expected.
Updates cause replacement.
Map properties:
actions¶
Controls DPD protocol mode.
String value expected.
Updates cause replacement.
Defaults to “hold”.
Allowed values: clear, disabled, hold, restart, restart-by-peer
interval¶
Number of seconds for the DPD delay.
Integer value expected.
Updates cause replacement.
Defaults to “30”.
timeout¶
Number of seconds for the DPD timeout.
Integer value expected.
Updates cause replacement.
Defaults to “120”.
Initiator state in lowercase for the ipsec site connection.
String value expected.
Updates cause replacement.
Defaults to “bi-directional”.
Allowed values: bi-directional, response-only
Maximum transmission unit size (in bytes) for the ipsec site connection.
Integer value expected.
Updates cause replacement.
Defaults to “1500”.
Name for the ipsec site connection.
String value expected.
Can be updated without replacement.
The administrative state of the ipsec site connection.
The authentication mode of the ipsec site connection.
The description of the ipsec site connection.
The dead peer detection protocol configuration of the ipsec site connection.
The unique identifier of ike policy associated with the ipsec site connection.
The initiator of the ipsec site connection.
The unique identifier of ipsec policy associated with the ipsec site connection.
The maximum transmission unit size (in bytes) of the ipsec site connection.
The name of the ipsec site connection.
The remote branch router public IPv4 address or IPv6 address or FQDN.
The remote subnet(s) in CIDR format of the ipsec site connection.
The remote branch router identity of the ipsec site connection.
The pre-shared key string of the ipsec site connection.
The route mode of the ipsec site connection.
Detailed information about resource.
The status of the ipsec site connection.
The unique identifier of the tenant owning the ipsec site connection.
The unique identifier of vpn service associated with the ipsec site connection.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::IPsecSiteConnection
properties:
admin_state_up: Boolean
description: String
dpd: {"actions": String, "timeout": Integer, "interval": Integer}
ikepolicy_id: String
initiator: String
ipsecpolicy_id: String
mtu: Integer
name: String
peer_address: String
peer_cidrs: [String, String, ...]
peer_id: String
psk: String
vpnservice_id: String
A resource to link a neutron pool with servers.
The ID of the load balancing pool.
String value expected.
Can be updated without replacement.
Port number on which the servers are running on the members.
Integer value expected.
Updates cause replacement.
The value must be in the range 0 to 65535.
The list of Nova server IDs load balanced.
List value expected.
Can be updated without replacement.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::LoadBalancer
properties:
members: [Value, Value, ...]
pool_id: String
protocol_port: Integer
Note
Available since 2014.1 (Icehouse)
A resource for creating neutron metering label.
Description of the metering label.
Name of the metering label.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::MeteringLabel
properties:
description: String
name: String
shared: Boolean
Note
Available since 2014.1 (Icehouse)
A resource to create rule for some label.
The metering label ID to associate with this metering rule.
String value expected.
Updates cause replacement.
Indicates remote IP prefix to be associated with this metering rule.
String value expected.
Updates cause replacement.
The direction in which metering rule is applied, either ingress or egress.
String value expected.
Updates cause replacement.
Defaults to “ingress”.
Allowed values: ingress, egress
Specify whether the remote_ip_prefix will be excluded or not from traffic counters of the metering label. For example to not count the traffic of a specific IP address of a range.
Boolean value expected.
Updates cause replacement.
Defaults to “False”.
The direction in which metering rule is applied.
Exclude state for cidr.
The metering label ID to associate with this metering rule.
CIDR to be associated with this metering rule.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::MeteringRule
properties:
direction: String
excluded: Boolean
metering_label_id: String
remote_ip_prefix: String
A boolean value specifying the administrative status of the network.
Boolean value expected.
Can be updated without replacement.
Defaults to “True”.
The IDs of the DHCP agent to schedule the network. Note that the default policy setting in Neutron restricts usage of this property to administrative users only.
List value expected.
Can be updated without replacement.
A string specifying a symbolic name for the network, which is not required to be unique.
String value expected.
Can be updated without replacement.
Note
Available since 5.0.0 (Liberty)
Flag to enable/disable port security on the network. It provides the default value for the attribute of the ports created on this network
Boolean value expected.
Can be updated without replacement.
The ID of the tenant which will own the network. Only administrative users can set the tenant identifier; this cannot be changed using authorization policies.
String value expected.
Updates cause replacement.
Extra parameters to include in the “network” object in the creation request. Parameters are often specific to installed hardware or extensions.
Map value expected.
Can be updated without replacement.
Defaults to “{}”.
The administrative status of the network.
Note
Available since 5.0.0 (Liberty)
The maximum transmission unit size(in bytes) for the network.
The name of the network.
Detailed information about resource.
The status of the network.
Subnets of this network.
The tenant owning this network.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::Net
properties:
admin_state_up: Boolean
dhcp_agent_ids: [Value, Value, ...]
name: String
port_security_enabled: Boolean
shared: Boolean
tenant_id: String
value_specs: {...}
Note
Available since 2014.1 (Icehouse)
A resource for the Network Gateway resource in Neutron Network Gateway.
Device info for this network gateway.
List value expected.
Can be updated without replacement.
The length must be at least 1.
List contents:
Connection info for this network gateway.
List value expected.
Can be updated without replacement.
Defaults to “{}”.
List contents:
*¶
Map value expected.
Can be updated without replacement.
Map properties:
segmentation_id¶
The id for L2 segment on the external side of the network gateway. Must be specified when using vlan.
Integer value expected.
Can be updated without replacement.
The value must be in the range 0 to 4094.
network¶
Note
Available since 2014.2 (Juno)
The internal network to connect on the network gateway.
String value expected.
Can be updated without replacement.
Value must be of type neutron.network
segmentation_type¶
L2 segmentation strategy on the external side of the network gateway.
String value expected.
Can be updated without replacement.
Defaults to “flat”.
Allowed values: flat, vlan
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::NetworkGateway
properties:
connections: [{"segmentation_type": String, "network": String, "network_id": String, "segmentation_id": Integer}, {"segmentation_type": String, "network": String, "network_id": String, "segmentation_id": Integer}, ...]
devices: [{"id": String, "interface_name": String}, {"id": String, "interface_name": String}, ...]
name: String
A resource for managing load balancer pools in Neutron.
The algorithm used to distribute load between the members of the pool.
String value expected.
Can be updated without replacement.
Allowed values: ROUND_ROBIN, LEAST_CONNECTIONS, SOURCE_IP
Protocol for balancing.
String value expected.
Updates cause replacement.
Allowed values: TCP, HTTP, HTTPS
Note
Available since 2014.2 (Juno)
The subnet for the port on which the members of the pool will be connected.
String value expected.
Updates cause replacement.
Value must be of type neutron.subnet
IP address and port of the pool.
Map value expected.
Updates cause replacement.
Map properties:
address¶
IP address of the vip.
String value expected.
Updates cause replacement.
Value must be of type ip_addr
admin_state_up¶
The administrative state of this vip.
Boolean value expected.
Updates cause replacement.
Defaults to “True”.
connection_limit¶
The maximum number of connections per second allowed for the vip.
Integer value expected.
Updates cause replacement.
protocol_port¶
TCP port on which to listen for client traffic that is associated with the vip address.
Integer value expected.
Updates cause replacement.
session_persistence¶
Configuration of session persistence.
Map value expected.
Updates cause replacement.
Map properties:
cookie_name¶
Name of the cookie, required if type is APP_COOKIE.
String value expected.
Updates cause replacement.
type¶
Method of implementation of session persistence feature.
String value expected.
Updates cause replacement.
Allowed values: SOURCE_IP, HTTP_COOKIE, APP_COOKIE
subnet¶
Subnet of the vip.
String value expected.
Updates cause replacement.
Value must be of type neutron.subnet
The administrative state of this pool.
Boolean value expected.
Can be updated without replacement.
Defaults to “True”.
List of health monitors associated with the pool.
List value expected.
Can be updated without replacement.
Defaults to “[]”.
Note
Available since 5.0.0 (Liberty)
LBaaS provider to implement this load balancer instance.
String value expected.
Updates cause replacement.
The administrative state of this pool.
Description of the pool.
The algorithm used to distribute load between the members of the pool.
Name of the pool.
Protocol to balance.
Detailed information about resource.
The subnet for the port on which the members of the pool will be connected.
Tenant owning the pool.
Vip associated with the pool.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::Pool
properties:
admin_state_up: Boolean
description: String
lb_method: String
monitors: [Value, Value, ...]
name: String
protocol: String
provider: String
subnet: String
vip: {"connection_limit": Integer, "address": String, "description": String, "protocol_port": Integer, "session_persistence": {"type": String, "cookie_name": String}, "name": String, "admin_state_up": Boolean, "subnet": String}
Note
Available since 2014.1 (Icehouse)
A resource to handle load balancer members.
IP address of the pool member on the pool network.
String value expected.
Updates cause replacement.
Value must be of type ip_addr
The ID of the load balancing pool.
String value expected.
Can be updated without replacement.
TCP port on which the pool member listens for requests or connections.
Integer value expected.
Updates cause replacement.
The value must be in the range 0 to 65535.
The administrative state of the pool member.
Boolean value expected.
Updates cause replacement.
Defaults to “True”.
Weight of pool member in the pool (default to 1).
Integer value expected.
Can be updated without replacement.
The value must be in the range 0 to 256.
IP address of the pool member.
The administrative state of this pool member.
The ID of the load balancing pool.
TCP port on which the pool member listens for requests or connections.
Detailed information about resource.
Tenant owning the pool member.
Weight of the pool member in the pool.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::PoolMember
properties:
address: String
admin_state_up: Boolean
pool_id: String
protocol_port: Integer
weight: Integer
Note
Available since 2014.2 (Juno)
Network this port belongs to. If you plan to use current port to assign Floating IP, you should specify fixed_ips with subnet. Note if this changes to a different network update, the port will be replaced
String value expected.
Can be updated without replacement.
Value must be of type neutron.network
The administrative state of this port.
Boolean value expected.
Can be updated without replacement.
Defaults to “True”.
Additional MAC/IP address pairs allowed to pass through the port.
List value expected.
Can be updated without replacement.
List contents:
*¶
Map value expected.
Can be updated without replacement.
Map properties:
ip_address¶
IP address to allow through this port.
String value expected.
Can be updated without replacement.
Value must be of type net_cidr
mac_address¶
MAC address to allow through this port.
String value expected.
Can be updated without replacement.
Value must be of type mac_addr
Note
Available since 2015.1 (Kilo)
The vnic type to be bound on the neutron port. To support SR-IOV PCI passthrough networking, you can request that the neutron port to be realized as normal (virtual nic), direct (pci passthrough), or macvtap (virtual interface with a tap-like software interface). Note that this only works for Neutron deployments that support the bindings extension.
String value expected.
Can be updated without replacement.
Allowed values: normal, direct, macvtap
Name of the network owning the port. The value is typically network:floatingip or network:router_interface or network:dhcp
String value expected.
Can be updated without replacement.
Desired IPs for this port.
List value expected.
Can be updated without replacement.
Defaults to “[]”.
List contents:
*¶
Map value expected.
Can be updated without replacement.
Map properties:
subnet¶
Note
Available since 2014.2 (Juno)
Subnet in which to allocate the IP address for this port.
String value expected.
Can be updated without replacement.
Value must be of type neutron.subnet
ip_address¶
IP address desired in the subnet for this port.
String value expected.
Can be updated without replacement.
Value must be of type ip_addr
MAC address to give to this port.
String value expected.
Updates cause replacement.
Value must be of type mac_addr
Note
Available since 5.0.0 (Liberty)
Flag to enable/disable port security on the port. When disable this feature(set it to False), there will be no packages filtering, like security-group and address-pairs.
Boolean value expected.
Can be updated without replacement.
Policy on how to respond to a stack-update for this resource. REPLACE_ALWAYS will replace the port regardless of any property changes. AUTO will update the existing port for any changed update-allowed property.
String value expected.
Can be updated without replacement.
Defaults to “AUTO”.
Allowed values: REPLACE_ALWAYS, AUTO
Security group IDs to associate with this port.
List value expected.
Can be updated without replacement.
Extra parameters to include in the “port” object in the creation request.
Map value expected.
Updates cause replacement.
Defaults to “{}”.
The administrative state of this port.
Additional MAC/IP address pairs allowed to pass through a port.
Unique identifier for the device.
Name of the network owning the port.
Fixed IP addresses.
MAC address of the port.
Friendly name of the port.
Unique identifier for the network owning the port.
A list of security groups for the port.
Detailed information about resource.
The status of the port.
A list of all subnet attributes for the port.
Tenant owning the port.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::Port
properties:
admin_state_up: Boolean
allowed_address_pairs: [{"ip_address": String, "mac_address": String}, {"ip_address": String, "mac_address": String}, ...]
binding:vnic_type: String
device_id: String
device_owner: String
fixed_ips: [{"ip_address": String, "subnet_id": String, "subnet": String}, {"ip_address": String, "subnet_id": String, "subnet": String}, ...]
mac_address: String
name: String
network: String
port_security_enabled: Boolean
replacement_policy: String
security_groups: [Value, Value, ...]
value_specs: {...}
Note
Available since 2014.1 (Icehouse)
A string specifying the provider network type for the network.
String value expected.
Can be updated without replacement.
Allowed values: vlan, flat
A string specifying physical network mapping for the network.
String value expected.
Can be updated without replacement.
A boolean value specifying the administrative status of the network.
Boolean value expected.
Can be updated without replacement.
Defaults to “True”.
A string specifying a symbolic name for the network, which is not required to be unique.
String value expected.
Can be updated without replacement.
A string specifying the segmentation id for the network.
String value expected.
Can be updated without replacement.
Detailed information about resource.
The status of the network.
Subnets of this network.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::ProviderNet
properties:
admin_state_up: Boolean
name: String
network_type: String
physical_network: String
segmentation_id: String
shared: Boolean
The administrative state of the router.
Boolean value expected.
Can be updated without replacement.
Defaults to “True”.
Note
Available since 2015.1 (Kilo)
Indicates whether or not to create a distributed router. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only. This property can not be used in conjunction with the L3 agent ID.
Boolean value expected.
Updates cause replacement.
External network gateway configuration for a router.
Map value expected.
Can be updated without replacement.
Map properties:
enable_snat¶
Enables Source NAT on the router gateway. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only.
Boolean value expected.
Can be updated without replacement.
network¶
ID or name of the external network for the gateway.
String value expected.
Can be updated without replacement.
Note
Available since 2015.1 (Kilo)
Indicates whether or not to create a highly available router. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only. And now neutron do not support distributed and ha at the same time.
Boolean value expected.
Updates cause replacement.
Note
Available since 2015.1 (Kilo)
ID list of the L3 agent. User can specify multi-agents for highly available router. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only.
List value expected.
Can be updated without replacement.
List contents:
Extra parameters to include in the creation request.
Map value expected.
Can be updated without replacement.
Defaults to “{}”.
Note
DEPRECATED since 2015.1 (Kilo) - Use property l3_agent_ids.
Note
Available since 2014.1 (Icehouse)
ID of the L3 agent. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only.
String value expected.
Can be updated without replacement.
Administrative state of the router.
Gateway network for the router.
Friendly name of the router.
Detailed information about resource.
The status of the router.
Tenant owning the router.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::Router
properties:
admin_state_up: Boolean
distributed: Boolean
external_gateway_info: {"enable_snat": Boolean, "network": String}
ha: Boolean
l3_agent_ids: [String, String, ...]
name: String
value_specs: {...}
The router.
String value expected.
Updates cause replacement.
Value must be of type neutron.router
Note
Available since 2015.1 (Kilo)
The port, either subnet or port should be specified.
String value expected.
Updates cause replacement.
Value must be of type neutron.port
The subnet, either subnet or port should be specified.
String value expected.
Updates cause replacement.
Value must be of type neutron.subnet
Note
DEPRECATED since 2015.1 (Kilo) - Use property port.
Note
Available since 2014.1 (Icehouse)
The port id, either subnet or port_id should be specified.
String value expected.
Updates cause replacement.
Value must be of type neutron.port
Note
DEPRECATED since 2015.1 (Kilo) - Use property router.
Note
Available since 2013.1 (Grizzly)
ID of the router.
String value expected.
Updates cause replacement.
Value must be of type neutron.router
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::RouterInterface
properties:
port: String
router: String
subnet: String
Note
Available since 2014.1 (Icehouse)
Description of the security group.
String value expected.
Can be updated without replacement.
A string specifying a symbolic name for the security group, which is not required to be unique.
String value expected.
Can be updated without replacement.
List of security group rules.
List value expected.
Can be updated without replacement.
Defaults to “[]”.
List contents:
*¶
Map value expected.
Can be updated without replacement.
Map properties:
direction¶
The direction in which the security group rule is applied. For a compute instance, an ingress security group rule matches traffic that is incoming (ingress) for that instance. An egress rule is applied to traffic leaving the instance.
String value expected.
Can be updated without replacement.
Defaults to “ingress”.
Allowed values: ingress, egress
ethertype¶
Ethertype of the traffic.
String value expected.
Can be updated without replacement.
Defaults to “IPv4”.
Allowed values: IPv4, IPv6
port_range_max¶
The maximum port number in the range that is matched by the security group rule. The port_range_min attribute constrains the port_range_max attribute. If the protocol is ICMP, this value must be an ICMP type.
Integer value expected.
Can be updated without replacement.
The value must be in the range 0 to 65535.
port_range_min¶
The minimum port number in the range that is matched by the security group rule. If the protocol is TCP or UDP, this value must be less than or equal to the value of the port_range_max attribute. If the protocol is ICMP, this value must be an ICMP type.
Integer value expected.
Can be updated without replacement.
The value must be in the range 0 to 65535.
protocol¶
The protocol that is matched by the security group rule. Valid values include tcp, udp, and icmp.
String value expected.
Can be updated without replacement.
remote_group_id¶
The remote group ID to be associated with this security group rule. If no value is specified then this rule will use this security group for the remote_group_id. The remote mode parameter must be set to “remote_group_id”.
String value expected.
Can be updated without replacement.
remote_ip_prefix¶
The remote IP prefix (CIDR) to be associated with this security group rule.
String value expected.
Can be updated without replacement.
Value must be of type net_cidr
remote_mode¶
Whether to specify a remote group or a remote IP prefix.
String value expected.
Can be updated without replacement.
Defaults to “remote_ip_prefix”.
Allowed values: remote_ip_prefix, remote_group_id
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::SecurityGroup
properties:
description: String
name: String
rules: [{"protocol": String, "port_range_max": Integer, "remote_group_id": String, "remote_ip_prefix": String, "direction": String, "port_range_min": Integer, "remote_mode": String, "ethertype": String}, {"protocol": String, "port_range_max": Integer, "remote_group_id": String, "remote_ip_prefix": String, "direction": String, "port_range_min": Integer, "remote_mode": String, "ethertype": String}, ...]
Note
Available since 2014.2 (Juno)
The ID of the attached network.
String value expected.
Updates cause replacement.
Value must be of type neutron.network
The start and end addresses for the allocation pools.
List value expected.
Can be updated without replacement.
List contents:
A specified set of DNS name servers to be used.
List value expected.
Can be updated without replacement.
Defaults to “[]”.
Set to true if DHCP is enabled and false if DHCP is disabled.
Boolean value expected.
Can be updated without replacement.
Defaults to “True”.
The gateway IP address. Set to any of [ null | ~ | “” ] to create the subnet without a gateway. If omitted, the first IP address within the subnet is assigned to the gateway.
String value expected.
Can be updated without replacement.
The IP version, which is 4 or 6.
Integer value expected.
Updates cause replacement.
Defaults to “4”.
Allowed values: 4, 6
Note
Available since 2015.1 (Kilo)
IPv6 address mode. dhcpv6-stateful, dhcpv6-stateless, or slaac.
String value expected.
Updates cause replacement.
Allowed values: dhcpv6-stateful, dhcpv6-stateless, slaac
Note
Available since 2015.1 (Kilo)
IPv6 RA (Router Advertisement) mode. dhcpv6-stateful, dhcpv6-stateless, or slaac.
String value expected.
Updates cause replacement.
Allowed values: dhcpv6-stateful, dhcpv6-stateless, slaac
The ID of the tenant who owns the network. Only administrative users can specify a tenant ID other than their own.
String value expected.
Updates cause replacement.
Extra parameters to include in the creation request.
Map value expected.
Can be updated without replacement.
Defaults to “{}”.
Ip allocation pools and their ranges.
CIDR block notation for this subnet.
List of dns nameservers.
‘true’ if DHCP is enabled for this subnet; ‘false’ otherwise.
Ip of the subnet’s gateway.
Additional routes for this subnet.
Ip version for the subnet.
Friendly name of the subnet.
Parent network of the subnet.
Detailed information about resource.
Tenant owning the subnet.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::Subnet
properties:
allocation_pools: [{"start": String, "end": String}, {"start": String, "end": String}, ...]
cidr: String
dns_nameservers: [Value, Value, ...]
enable_dhcp: Boolean
gateway_ip: String
host_routes: [{"nexthop": String, "destination": String}, {"nexthop": String, "destination": String}, ...]
ip_version: Integer
ipv6_address_mode: String
ipv6_ra_mode: String
name: String
network: String
tenant_id: String
value_specs: {...}
A resource for VPN service in Neutron.
Note
Available since 2015.1 (Kilo)
The router to which the vpn service will be inserted.
String value expected.
Updates cause replacement.
Value must be of type neutron.router
Note
Available since 2014.2 (Juno)
Subnet in which the vpn service will be created.
String value expected.
Updates cause replacement.
Value must be of type neutron.subnet
Administrative state for the vpn service.
Boolean value expected.
Can be updated without replacement.
Defaults to “True”.
Description for the vpn service.
String value expected.
Can be updated without replacement.
Note
DEPRECATED since 2015.1 (Kilo) - Use property router
Note
Available since 2013.2 (Havana)
Unique identifier for the router to which the vpn service will be inserted.
String value expected.
Updates cause replacement.
Value must be of type neutron.router
The administrative state of the vpn service.
The description of the vpn service.
The name of the vpn service.
The unique identifier of the router to which the vpn service was inserted.
Detailed information about resource.
The status of the vpn service.
The unique identifier of the subnet in which the vpn service was created.
The unique identifier of the tenant owning the vpn service.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::VPNService
properties:
admin_state_up: Boolean
description: String
name: String
router: String
subnet: String
Note
Available since 2014.2 (Juno)
A resource for creating OpenStack virtual hardware templates.
Due to default nova security policy usage of this resource is limited to being used by administrators only. The rights may also be delegated to other users by redefining the access controls on the nova-api server.
Note that the current implementation of the Nova Flavor resource does not allow specifying the name and flavorid properties for the resource. This is done to avoid potential naming collision upon flavor creation as all flavor have a global scope.
Here is an example nova flavor resource:
heat_template_version: 2013-05-23
description: Heat Flavor creation example
resources:
test_flavor:
type: OS::Nova::Flavor
properties:
ram: 1024
vcpus: 1
disk: 20
swap: 2
extra_specs: {"quota:disk_read_bytes_sec": "10240000"}
Size of local disk in GB. The “0” size is a special case that uses the native base image size as the size of the ephemeral root volume.
Integer value expected.
Updates cause replacement.
Defaults to “0”.
Size of a secondary ephemeral data disk in GB.
Integer value expected.
Updates cause replacement.
Defaults to “0”.
Key/Value pairs to extend the capabilities of the flavor.
Map value expected.
Can be updated without replacement.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Nova::Flavor
properties:
disk: Integer
ephemeral: Integer
extra_specs: {...}
ram: Integer
rxtx_factor: Number
swap: Integer
vcpus: Integer
Note
Available since 2014.1 (Icehouse)
Allocate a floating IP from a given floating IP pool.
String value expected.
Updates cause replacement.
Allocated floating IP address.
Pool from which floating IP is allocated.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Nova::FloatingIP
properties:
pool: String
Note
Available since 2014.1 (Icehouse)
ID of the floating IP to assign to the server.
String value expected.
Can be updated without replacement.
Server to assign floating IP to.
String value expected.
Can be updated without replacement.
Value must be of type nova.server
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Nova::FloatingIPAssociation
properties:
floating_ip: String
server_id: String
Note
Available since 2014.1 (Icehouse)
A resource for creating Nova key pairs.
Note that if a new key is generated setting save_private_key to True results in the system saving the private key which can then be retrieved via the private_key attribute of this resource.
Setting the public_key property means that the private_key attribute of this resource will always return an empty string regardless of the save_private_key setting since there will be no private key data to save.
The name of the key pair.
String value expected.
Updates cause replacement.
The length must be in the range 1 to 255.
The optional public key. This allows users to supply the public key from a pre-existing key pair. If not supplied, a new key pair will be generated.
String value expected.
Updates cause replacement.
True if the system should remember a generated private key; False otherwise.
Boolean value expected.
Updates cause replacement.
Defaults to “False”.
The private key if it has been saved.
The public key.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Nova::KeyPair
properties:
name: String
public_key: String
save_private_key: Boolean
The ID or name of the flavor to boot onto.
String value expected.
Can be updated without replacement.
Value must be of type nova.flavor
The administrator password for the server.
String value expected.
Can be updated without replacement.
Name of the availability zone for server placement.
String value expected.
Updates cause replacement.
Block device mappings for this server.
List value expected.
Updates cause replacement.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
delete_on_termination¶
Indicate whether the volume should be deleted when the server is terminated.
Boolean value expected.
Updates cause replacement.
device_name¶
A device name where the volume will be attached in the system at /dev/device_name. This value is typically vda.
String value expected.
Updates cause replacement.
snapshot_id¶
The ID of the snapshot to create a volume from.
String value expected.
Updates cause replacement.
Value must be of type cinder.snapshot
volume_id¶
The ID of the volume to boot from. Only one of volume_id or snapshot_id should be provided.
String value expected.
Updates cause replacement.
Value must be of type cinder.volume
volume_size¶
The size of the volume, in GB. It is safe to leave this blank and have the Compute service infer the size.
Integer value expected.
Updates cause replacement.
Note
Available since 2015.1 (Kilo)
Block device mappings v2 for this server.
List value expected.
Updates cause replacement.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
boot_index¶
Integer used for ordering the boot disks.
Integer value expected.
Updates cause replacement.
delete_on_termination¶
Indicate whether the volume should be deleted when the server is terminated.
Boolean value expected.
Updates cause replacement.
device_name¶
A device name where the volume will be attached in the system at /dev/device_name. This value is typically vda.
String value expected.
Updates cause replacement.
device_type¶
Device type: at the moment we can make distinction only between disk and cdrom.
String value expected.
Updates cause replacement.
Allowed values: cdrom, disk
disk_bus¶
Bus of the device: hypervisor driver chooses a suitable default if omitted.
String value expected.
Updates cause replacement.
Allowed values: ide, lame_bus, scsi, usb, virtio
image_id¶
The ID of the image to create a volume from.
String value expected.
Updates cause replacement.
Value must be of type glance.image
snapshot_id¶
The ID of the snapshot to create a volume from.
String value expected.
Updates cause replacement.
Value must be of type cinder.snapshot
volume_id¶
The volume_id can be boot or non-boot device to the server.
String value expected.
Updates cause replacement.
Value must be of type cinder.volume
volume_size¶
Size of the block device in GB. If it is omitted, hypervisor driver calculates size.
Integer value expected.
Updates cause replacement.
If True, enable config drive on the server.
Boolean value expected.
Updates cause replacement.
Control how the disk is partitioned when the server is created.
String value expected.
Updates cause replacement.
Allowed values: AUTO, MANUAL
Policy on how to apply a flavor update; either by requesting a server resize or by replacing the entire server.
String value expected.
Can be updated without replacement.
Defaults to “RESIZE”.
Allowed values: RESIZE, REPLACE
The ID or name of the image to boot with.
String value expected.
Can be updated without replacement.
Value must be of type glance.image
Policy on how to apply an image-id update; either by requesting a server rebuild or by replacing the entire server
String value expected.
Can be updated without replacement.
Defaults to “REBUILD”.
Allowed values: REBUILD, REPLACE, REBUILD_PRESERVE_EPHEMERAL
Name of keypair to inject into the server.
String value expected.
Updates cause replacement.
Value must be of type nova.keypair
Arbitrary key/value metadata to store for this server. Both keys and values must be 255 characters or less. Non-string values will be serialized to JSON (and the serialized string must be 255 characters or less).
Map value expected.
Can be updated without replacement.
An ordered list of nics to be added to this server, with information about connected networks, fixed ips, port etc.
List value expected.
Can be updated without replacement.
List contents:
*¶
Map value expected.
Can be updated without replacement.
Map properties:
fixed_ip¶
Fixed IP address to specify for the port created on the requested network.
String value expected.
Can be updated without replacement.
Value must be of type ip_addr
network¶
Name or ID of network to create a port on.
String value expected.
Can be updated without replacement.
Value must be of type neutron.network
port¶
ID of an existing port to associate with this server.
String value expected.
Can be updated without replacement.
Value must be of type neutron.port
subnet¶
Note
Available since 5.0.0 (Liberty)
Subnet in which to allocate the IP address for port. Used for creating port, based on derived properties. If subnet is specified, network property becomes optional.
String value expected.
Can be updated without replacement.
A map of files to create/overwrite on the server upon boot. Keys are file names and values are the file contents.
Map value expected.
Updates cause replacement.
Defaults to “{}”.
A UUID for the set of servers being requested.
String value expected.
Updates cause replacement.
Arbitrary key-value pairs specified by the client to help boot a server.
Map value expected.
Updates cause replacement.
List of security group names or IDs. Cannot be used if neutron ports are associated with this server; assign security groups to the ports instead.
List value expected.
Updates cause replacement.
Defaults to “[]”.
How the server should receive the metadata required for software configuration. POLL_SERVER_CFN will allow calls to the cfn API action DescribeStackResource authenticated with the provided keypair. POLL_SERVER_HEAT will allow calls to the Heat API resource-show using the provided keystone credentials. POLL_TEMP_URL will create and populate a Swift TempURL with metadata for polling. ZAQAR_MESSAGE will create a dedicated zaqar queue and post the metadata for polling.
String value expected.
Can be updated without replacement.
Defaults to “POLL_SERVER_CFN”.
Allowed values: POLL_SERVER_CFN, POLL_SERVER_HEAT, POLL_TEMP_URL, ZAQAR_MESSAGE
User data script to be executed by cloud-init.
String value expected.
Updates cause replacement.
Defaults to “”.
How the user_data should be formatted for the server. For HEAT_CFNTOOLS, the user_data is bundled as part of the heat-cfntools cloud-init boot configuration data. For RAW the user_data is passed to Nova unmodified. For SOFTWARE_CONFIG user_data is bundled as part of the software config data, and metadata is derived from any associated SoftwareDeployment resources.
String value expected.
Updates cause replacement.
Defaults to “HEAT_CFNTOOLS”.
Allowed values: HEAT_CFNTOOLS, RAW, SOFTWARE_CONFIG
The manually assigned alternative public IPv4 address of the server.
The manually assigned alternative public IPv6 address of the server.
A dict of all network addresses with corresponding port_id. Each network will have two keys in dict, they are network name and network id. The port ID may be obtained through the following expression: “{get_attr: [<server>, addresses, <network name_or_id>, 0, port]}”.
Note
Available since 2015.1 (Kilo)
URLs of server’s consoles. To get a specific console type, the requested type can be specified as parameter to the get_attr function, e.g. get_attr: [ <server>, console_urls, novnc ]. Currently supported types are novnc, xvpvnc, spice-html5, rdp-html5, serial.
AWS compatible instance name.
Name of the server.
A dict of assigned network addresses of the form: {“public”: [ip1, ip2...], “private”: [ip3, ip4], “public_uuid”: [ip1, ip2...], “private_uuid”: [ip3, ip4]}. Each network will have two keys in dict, they are network name and network id.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Nova::Server
properties:
admin_pass: String
availability_zone: String
block_device_mapping: [{"snapshot_id": String, "volume_size": Integer, "delete_on_termination": Boolean, "device_name": String, "volume_id": String}, {"snapshot_id": String, "volume_size": Integer, "delete_on_termination": Boolean, "device_name": String, "volume_id": String}, ...]
block_device_mapping_v2: [{"disk_bus": String, "snapshot_id": String, "boot_index": Integer, "swap_size": Integer, "volume_id": String, "device_type": String, "delete_on_termination": Boolean, "volume_size": Integer, "device_name": String, "image_id": String}, {"disk_bus": String, "snapshot_id": String, "boot_index": Integer, "swap_size": Integer, "volume_id": String, "device_type": String, "delete_on_termination": Boolean, "volume_size": Integer, "device_name": String, "image_id": String}, ...]
config_drive: Boolean
diskConfig: String
flavor: String
flavor_update_policy: String
image: String
image_update_policy: String
key_name: String
metadata: {...}
name: String
networks: [{"uuid": String, "network": String, "port": String, "fixed_ip": String, "subnet": String}, {"uuid": String, "network": String, "port": String, "fixed_ip": String, "subnet": String}, ...]
personality: {...}
reservation_id: String
scheduler_hints: {...}
security_groups: [Value, Value, ...]
software_config_transport: String
user_data: String
user_data_format: String
Note
Available since 2014.2 (Juno)
A resource for managing a Nova server group.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Nova::ServerGroup
properties:
name: String
policies: [String, String, ...]
ID of the Cluster Template used for Node Groups and configurations.
String value expected.
Updates cause replacement.
Version of Hadoop running on instances.
String value expected.
Updates cause replacement.
Plugin name.
String value expected.
Updates cause replacement.
Value must be of type sahara.plugin
Note
Available since 2015.1 (Kilo)
Default name or UUID of the image used to boot Hadoop nodes.
String value expected.
Updates cause replacement.
Value must be of type sahara.image
Keypair added to instances to make them accessible for user.
String value expected.
Updates cause replacement.
Value must be of type nova.keypair
Name or UUID of network.
String value expected.
Updates cause replacement.
Value must be of type neutron.network
Note
Available since 5.0.0 (Liberty)
Configure most important configs automatically.
Boolean value expected.
Updates cause replacement.
Note
DEPRECATED since 2015.1 (Kilo) - Use property default_image_id.
Note
Available since 2014.2 (Juno)
Name or UUID of the image used to boot Hadoop nodes.
String value expected.
Updates cause replacement.
Value must be of type glance.image
Cluster information.
Detailed information about resource.
Cluster status.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Sahara::Cluster
properties:
cluster_template_id: String
default_image_id: String
hadoop_version: String
key_name: String
name: String
neutron_management_network: String
plugin_name: String
use_autoconfig: Boolean
Note
Available since 2014.2 (Juno)
Version of Hadoop running on instances.
String value expected.
Can be updated without replacement.
Plugin name.
String value expected.
Can be updated without replacement.
Value must be of type sahara.plugin
List of processes to enable anti-affinity for.
List value expected.
Can be updated without replacement.
List contents:
Cluster configs dictionary.
Map value expected.
Can be updated without replacement.
ID of the default image to use for the template.
String value expected.
Can be updated without replacement.
Value must be of type sahara.image
Description of the Sahara Group Template.
String value expected.
Can be updated without replacement.
Defaults to “”.
Name for the Sahara Cluster Template.
String value expected.
Can be updated without replacement.
The length must be in the range 1 to 50.
Value must match pattern: ^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])$
Name or UUID of network.
String value expected.
Can be updated without replacement.
Value must be of type neutron.network
Node groups.
List value expected.
Can be updated without replacement.
List contents:
*¶
Map value expected.
Can be updated without replacement.
Map properties:
count¶
Number of instances in the Node group.
Integer value expected.
Can be updated without replacement.
The value must be at least 1.
node_group_template_id¶
ID of the Node Group Template.
String value expected.
Can be updated without replacement.
Note
Available since 5.0.0 (Liberty)
Configure most important configs automatically.
Boolean value expected.
Updates cause replacement.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Sahara::ClusterTemplate
properties:
anti_affinity: [String, String, ...]
cluster_configs: {...}
default_image_id: String
description: String
hadoop_version: String
name: String
neutron_management_network: String
node_groups: [{"name": String, "node_group_template_id": String, "count": Integer}, {"name": String, "node_group_template_id": String, "count": Integer}, ...]
plugin_name: String
use_autoconfig: Boolean
Note
Available since 5.0.0 (Liberty)
A resource for creating sahara data source.
A data source stores an URL which designates the location of input or output data and any credentials needed to access the location.
Type of the data source.
String value expected.
Can be updated without replacement.
Allowed values: swift, hdfs, maprfs
Credentials used for swift. Not required if sahara is configured to use proxy users and delegated trusts for access.
Map value expected.
Can be updated without replacement.
Map properties:
password¶
Password for accessing the data source URL.
String value expected.
Can be updated without replacement.
user¶
Username for accessing the data source URL.
String value expected.
Can be updated without replacement.
Description of the data source.
String value expected.
Can be updated without replacement.
Defaults to “”.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Sahara::DataSource
properties:
credentials: {"user": String, "password": String}
description: String
name: String
type: String
url: String
Note
Available since 2014.2 (Juno)
Name or ID Nova flavor for the nodes.
String value expected.
Updates cause replacement.
Value must be of type nova.flavor
Version of Hadoop running on instances.
String value expected.
Updates cause replacement.
List of processes to run on every node.
List value expected.
Updates cause replacement.
The length must be at least 1.
List contents:
Plugin name.
String value expected.
Updates cause replacement.
Value must be of type sahara.plugin
Defines whether auto-assign security group to this Node Group template.
Boolean value expected.
Updates cause replacement.
Availability zone to create servers in.
String value expected.
Updates cause replacement.
Description of the Node Group Template.
String value expected.
Updates cause replacement.
Defaults to “”.
Name or UUID of the Neutron floating IP network or name of the Nova floating ip pool to use. Should not be provided when used with Nova-network that auto-assign floating IPs.
String value expected.
Updates cause replacement.
ID of the image to use for the template.
String value expected.
Updates cause replacement.
Value must be of type sahara.image
Note
Available since 5.0.0 (Liberty)
Provide access to nodes using other nodes of the cluster as proxy gateways.
Boolean value expected.
Updates cause replacement.
Name for the Sahara Node Group Template.
String value expected.
Updates cause replacement.
The length must be in the range 1 to 50.
Value must match pattern: ^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])$
List of security group names or IDs to assign to this Node Group template.
List value expected.
Updates cause replacement.
List contents:
Note
Available since 5.0.0 (Liberty)
Configure most important configs automatically.
Boolean value expected.
Updates cause replacement.
Note
Available since 5.0.0 (Liberty)
Create volumes on the same physical port as an instance.
Boolean value expected.
Updates cause replacement.
Type of the volume to create on Cinder backend.
String value expected.
Updates cause replacement.
Value must be of type cinder.vtype
Availability zone to create volumes in.
String value expected.
Updates cause replacement.
Volumes per node.
Integer value expected.
Updates cause replacement.
The value must be at least 0.
Size of the volumes, in GB.
Integer value expected.
Updates cause replacement.
The value must be at least 1.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Sahara::NodeGroupTemplate
properties:
auto_security_group: Boolean
availability_zone: String
description: String
flavor: String
floating_ip_pool: String
hadoop_version: String
image_id: String
is_proxy_gateway: Boolean
name: String
node_configs: {...}
node_processes: [String, String, ...]
plugin_name: String
security_groups: [String, String, ...]
use_autoconfig: Boolean
volume_local_to_instance: Boolean
volume_type: String
volumes_availability_zone: String
volumes_per_node: Integer
volumes_size: Integer
Note
Available since 2015.1 (Kilo)
If True, delete any objects in the container when the container is deleted. Otherwise, deleting a non-empty container will result in an error.
Boolean value expected.
Updates cause replacement.
Defaults to “False”.
A map of user-defined meta data to associate with the account. Each key in the map will set the header X-Account-Meta-{key} with the corresponding value.
Map value expected.
Updates cause replacement.
Defaults to “{}”.
A map of user-defined meta data to associate with the container. Each key in the map will set the header X-Container-Meta-{key} with the corresponding value.
Map value expected.
Updates cause replacement.
Defaults to “{}”.
Specify the ACL permissions on who can read objects in the container.
String value expected.
Updates cause replacement.
Specify the ACL permissions on who can write objects to the container.
String value expected.
Updates cause replacement.
Name for the container. If not specified, a unique name will be generated.
String value expected.
Updates cause replacement.
The number of bytes stored in the container.
The host from the container URL.
A map containing all headers for the container.
The number of objects stored in the container.
The parent URL of the container.
The URL of the container.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Swift::Container
properties:
PurgeOnDelete: Boolean
X-Account-Meta: {...}
X-Container-Meta: {...}
X-Container-Read: String
X-Container-Write: String
name: String
Note
Available since 2015.1 (Kilo)
Name of registered datastore type.
String value expected.
Updates cause replacement.
The length must be no greater than 255.
Name of the registered datastore version. It must exist for provided datastore type. Defaults to using single active version. If several active versions exist for provided datastore type, explicit value for this parameter must be specified.
String value expected.
Updates cause replacement.
The length must be no greater than 255.
List of database instances.
List value expected.
Updates cause replacement.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
flavor¶
Flavor of the instance.
String value expected.
Updates cause replacement.
Value must be of type trove.flavor
volume_size¶
Size of the instance disk volume in GB.
Integer value expected.
Updates cause replacement.
The value must be in the range 1 to 150.
Name of the cluster to create.
String value expected.
Updates cause replacement.
The length must be no greater than 255.
A list of instances ids.
A list of cluster instance IPs.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Trove::Cluster
properties:
datastore_type: String
datastore_version: String
instances: [{"volume_size": Integer, "flavor": String}, {"volume_size": Integer, "flavor": String}, ...]
name: String
Note
Available since 2014.1 (Icehouse)
OpenStack cloud database instance resource.
Reference to a flavor for creating DB instance.
String value expected.
Updates cause replacement.
Value must be of type trove.flavor
Database volume size in GB.
Integer value expected.
Updates cause replacement.
The value must be in the range 1 to 150.
Name of the availability zone for DB instance.
String value expected.
Updates cause replacement.
List of databases to be created on DB instance creation.
List value expected.
Updates cause replacement.
Defaults to “[]”.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
character_set¶
Set of symbols and encodings.
String value expected.
Updates cause replacement.
Defaults to “utf8”.
collate¶
Set of rules for comparing characters in a character set.
String value expected.
Updates cause replacement.
Defaults to “utf8_general_ci”.
name¶
Specifies database names for creating databases on instance creation.
String value expected.
Updates cause replacement.
The length must be no greater than 64.
Value must match pattern: [a-zA-Z0-9_]+[a-zA-Z0-9_@?#\s]*[a-zA-Z0-9_]+
Name of registered datastore type.
String value expected.
Updates cause replacement.
The length must be no greater than 255.
Name of the registered datastore version. It must exist for provided datastore type. Defaults to using single active version. If several active versions exist for provided datastore type, explicit value for this parameter must be specified.
String value expected.
Updates cause replacement.
The length must be no greater than 255.
Name of the DB instance to create.
String value expected.
Updates cause replacement.
The length must be no greater than 255.
List of network interfaces to create on instance.
List value expected.
Updates cause replacement.
Defaults to “[]”.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
fixed_ip¶
Fixed IPv4 address for this NIC.
String value expected.
Updates cause replacement.
Value must be of type ip_addr
network¶
Name or UUID of the network to attach this NIC to. Either port or network must be specified.
String value expected.
Updates cause replacement.
Value must be of type neutron.network
port¶
Name or UUID of Neutron port to attach this NIC to. Either port or network must be specified.
String value expected.
Updates cause replacement.
Value must be of type neutron.port
Note
Available since 5.0.0 (Liberty)
The number of replicas to be created.
Integer value expected.
Updates cause replacement.
Note
Available since 5.0.0 (Liberty)
Identifier of the source instance to replicate.
String value expected.
Updates cause replacement.
List of users to be created on DB instance creation.
List value expected.
Updates cause replacement.
Defaults to “[]”.
List contents:
*¶
Map value expected.
Updates cause replacement.
Map properties:
host¶
The host from which a user is allowed to connect to the database.
String value expected.
Updates cause replacement.
Defaults to “%”.
name¶
User name to create a user on instance creation.
String value expected.
Updates cause replacement.
The length must be no greater than 16.
Value must match pattern: [a-zA-Z0-9_]+[a-zA-Z0-9_@?#\s]*[a-zA-Z0-9_]+
password¶
Password for those users on instance creation.
String value expected.
Updates cause replacement.
Value must match pattern: [a-zA-Z0-9_]+[a-zA-Z0-9_@?#\s]*[a-zA-Z0-9_]+
Hostname of the instance.
Api endpoint reference of the instance.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Trove::Instance
properties:
availability_zone: String
databases: [{"name": String, "collate": String, "character_set": String}, {"name": String, "collate": String, "character_set": String}, ...]
datastore_type: String
datastore_version: String
flavor: String
name: String
networks: [{"network": String, "port": String, "fixed_ip": String}, {"network": String, "port": String, "fixed_ip": String}, ...]
replica_count: Integer
replica_of: String
restore_point: String
size: Integer
users: [{"name": String, "password": String, "host": String, "databases": [String, String, ...]}, {"name": String, "password": String, "host": String, "databases": [String, String, ...]}, ...]
Note
Available since 2014.2 (Juno)
Arbitrary key/value metadata to store contextual information about this queue.
Map value expected.
Can be updated without replacement.
The resource href of the queue.
Note
DEPRECATED since 2015.1 (Kilo) - Use get_resource|Ref command instead. For example: { get_resource : <resource_name> }
Note
Available since 2014.1 (Icehouse)
ID of the queue.
Detailed information about resource.
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Zaqar::Queue
properties:
metadata: {...}
name: String