Unsupported Heat Resource Types¶
These resources are enabled, but are not officially supported.
OS::Heat::HARestarter¶
Note
DEPRECATED since 2015.1 (Kilo) - The HARestarter resource type is deprecated and will be removed in a future release of Heat, once it has support for auto-healing any type of resource. Note that HARestarter does *not* actually restart servers - it deletes and then recreates them. It also does the same to all dependent resources, and may therefore exhibit unexpected and undesirable behaviour. Avoid.
Required Properties¶
InstanceId¶
Instance ID to be restarted.
String value expected.
Updates cause replacement.
Value must be of type nova.server
Attributes¶
AlarmUrl¶
A signed url to handle the alarm (Heat extension).
show¶
Detailed information about resource.
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::HARestarter
properties:
InstanceId: String
OS::Heat::SoftwareDeployments¶
Note
DEPRECATED since 2014.2 (Juno) - This resource is deprecated and use is discouraged. Please use resource OS::Heat:SoftwareDeploymentGroup instead.
Optional Properties¶
actions¶
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
config¶
ID of software configuration resource to execute when applying to the server.
String value expected.
Can be updated without replacement.
input_values¶
Input values to apply to the software configuration on this server.
Map value expected.
Can be updated without replacement.
name¶
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.
servers¶
A map of Nova names and IDs to apply configuration to.
Map value expected.
Can be updated without replacement.
signal_transport¶
How the server should signal to heat with the deployment output values. CFN_SIGNAL will allow an HTTP POST to a CFN keypair signed URL. 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
Attributes¶
deploy_status_codes¶
A map of Nova names and returned status code from the configuration execution
deploy_stderrs¶
A map of Nova names and captured stderrs from the configuration execution to each server.
deploy_stdouts¶
A map of Nova names and captured stdouts from the configuration execution to each server.
show¶
Detailed information about resource.
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::SoftwareDeployments
properties:
actions: [Value, Value, ...]
config: String
input_values: {...}
name: String
servers: {...}
signal_transport: String
OS::Heat::StructuredDeployments¶
Note
DEPRECATED since 2014.2 (Juno) - This resource is deprecated and use is discouraged. Please use resource OS::Heat:StructuredDeploymentGroup instead.
Optional Properties¶
actions¶
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
config¶
ID of software configuration resource to execute when applying to the server.
String value expected.
Can be updated without replacement.
input_key¶
Name of key to use for substituting inputs during deployment
String value expected.
Updates cause replacement.
Defaults to “get_input”.
input_values¶
Input values to apply to the software configuration on this server.
Map value expected.
Can be updated without replacement.
input_values_validate¶
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¶
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.
servers¶
A map of Nova names and IDs to apply configuration to.
Map value expected.
Can be updated without replacement.
signal_transport¶
How the server should signal to heat with the deployment output values. CFN_SIGNAL will allow an HTTP POST to a CFN keypair signed URL. 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
Attributes¶
deploy_status_codes¶
A map of Nova names and returned status code from the configuration execution
deploy_stderrs¶
A map of Nova names and captured stderrs from the configuration execution to each server.
deploy_stdouts¶
A map of Nova names and captured stdouts from the configuration execution to each server.
show¶
Detailed information about resource.
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Heat::StructuredDeployments
properties:
actions: [Value, Value, ...]
config: String
input_key: String
input_values: {...}
input_values_validate: String
name: String
servers: {...}
signal_transport: String
OS::Monasca::AlarmDefinition¶
Note
UNSUPPORTED since 5.0.0 (Liberty)
Heat Template Resource for Monasca Alarm definition. This plug-in requires python-monascaclient>=1.0.22 .So to enable this plug-in, install this client library and restart the heat-engine.
Required Properties¶
expression¶
Expression of the alarm to evaluate.
String value expected.
Can be updated without replacement.
Optional Properties¶
actions_enabled¶
Whether to enable the actions or not.
Boolean value expected.
Can be updated without replacement.
Defaults to “True”.
alarm_actions¶
The notification methods to use when an alarm state is ALARM.
List value expected.
Can be updated without replacement.
List contents:
*¶
Monasca notification
String value expected.
Can be updated without replacement.
Value must be of type monasca.notification
match_by¶
The metric dimensions to match to the alarm dimensions. One or more dimension key names separated by a comma.
List value expected.
Updates cause replacement.
name¶
Name of the alarm. By default, physical resource name is used.
String value expected.
Can be updated without replacement.
ok_actions¶
The notification methods to use when an alarm state is OK.
List value expected.
Can be updated without replacement.
List contents:
*¶
Monasca notification
String value expected.
Can be updated without replacement.
Value must be of type monasca.notification
severity¶
Severity of the alarm.
String value expected.
Can be updated without replacement.
Defaults to “low”.
Allowed values: low, medium, high, critical
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Monasca::AlarmDefinition
properties:
actions_enabled: Boolean
alarm_actions: [String, String, ...]
description: String
expression: String
match_by: [Value, Value, ...]
name: String
ok_actions: [String, String, ...]
severity: String
undetermined_actions: [String, String, ...]
OS::Monasca::Notification¶
Note
UNSUPPORTED since 5.0.0 (Liberty)
Heat Template Resource for Monasca Notification. This plug-in requires python-monascaclient>=1.0.22 .So to enable this plug-in, install this client library and restart the heat-engine.
Required Properties¶
address¶
Address of the notification. It could be a valid email address, url or service key based on notification type.
String value expected.
Can be updated without replacement.
type¶
Type of the notification.
String value expected.
Can be updated without replacement.
Allowed values: email, webhook, pagerduty
Optional Properties¶
name¶
Name of the notification. By default, physical resource name is used.
String value expected.
Can be updated without replacement.
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Monasca::Notification
properties:
address: String
name: String
type: String
OS::Neutron::ExtraRoute¶
Note
UNSUPPORTED - This resource is not supported, use at your own risk.
Required Properties¶
router_id¶
The router id.
String value expected.
Updates cause replacement.
Value must be of type neutron.router
HOT Syntax¶
heat_template_version: 2015-04-30
...
resources:
...
the_resource:
type: OS::Neutron::ExtraRoute
properties:
destination: String
nexthop: String
router_id: String