Unsupported Heat Resource Types

These resources are enabled, but are not officially supported.

OS::Aodh::CombinationAlarm

Note

DEPRECATED since 7.0.0 (Newton) - The combination alarm is deprecated and disabled by default in Aodh.

Note

Available since 2014.1 (Icehouse)

A resource that implements combination of Aodh alarms.

Allows to use alarm as a combination of other alarms with some operator: activate this alarm if any alarm in combination has been activated or if all alarms in combination have been activated.

Required Properties

alarm_ids

List of alarm identifiers to combine.

List value expected.

Can be updated without replacement.

The length must be at least 1.

Optional Properties

alarm_actions

A list of URLs (webhooks) to invoke when state transitions to alarm.

List value expected.

Can be updated without replacement.

description

Description for the alarm.

String value expected.

Can be updated without replacement.

enabled

True if alarm evaluation/actioning is enabled.

Boolean value expected.

Can be updated without replacement.

Defaults to “true”.

insufficient_data_actions

A list of URLs (webhooks) to invoke when state transitions to insufficient-data.

List value expected.

Can be updated without replacement.

ok_actions

A list of URLs (webhooks) to invoke when state transitions to ok.

List value expected.

Can be updated without replacement.

operator

Operator used to combine the alarms.

String value expected.

Can be updated without replacement.

Allowed values: and, or

repeat_actions

False to trigger actions when the threshold is reached AND the alarm’s state has changed. By default, actions are called each time the threshold is reached.

Boolean value expected.

Can be updated without replacement.

Defaults to “true”.

severity

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

time_constraints

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:

description

Description for the time constraint.

String value expected.

Updates cause replacement.

duration

Duration for the time constraint.

Integer value expected.

Updates cause replacement.

The value must be at least 0.

name

Name for the time constraint.

String value expected.

Updates cause replacement.

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

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Aodh::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, "start": String, "timezone": String, "name": String, "description": String}, {"duration": Integer, "start": String, "timezone": String, "name": String, "description": String}, ...]

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. Instead, use the mark-unhealthy API to mark a resource as needing replacement, and then a stack update to perform the replacement while respecting the dependencies and not deleting them unnecessarily.

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) - Use of this resource is discouraged. Please use OS::Heat::SoftwareDeploymentGroup instead.

Required Properties

servers

A map of names and server IDs to apply configuration to. The name is arbitrary and is used as the Heat resource name for the corresponding deployment.

Map value expected.

Can be updated without replacement.

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.

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.

update_policy

batch_create

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.

rolling_update

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.

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) - Use of this resource is discouraged. Please use OS::Heat::StructuredDeploymentGroup instead.

Required Properties

servers

A map of names and server IDs to apply configuration to. The name is arbitrary and is used as the Heat resource name for the corresponding deployment.

Map value expected.

Can be updated without replacement.

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.

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.

update_policy

batch_create

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.

rolling_update

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.

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::Neutron::ExtraRoute

Note

UNSUPPORTED - Use this resource at your own risk.

Resource for specifying extra routes for Neutron router.

Resource allows to specify nexthop IP and destination network for router.

Required Properties

destination

Network in CIDR notation.

String value expected.

Updates cause replacement.

nexthop

Nexthop IP address.

String value expected.

Updates cause replacement.

router_id

The router id.

String value expected.

Updates cause replacement.

Value must be of type neutron.router

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Neutron::ExtraRoute
    properties:
      destination: String
      nexthop: String
      router_id: String

OS::Neutron::HealthMonitor

Note

DEPRECATED since 7.0.0 (Newton) - Neutron LBaaS v1 is deprecated in the Liberty release and is planned to be removed in a future release. Going forward, the LBaaS V2 should be used.

A resource for managing health monitors for loadbalancers in Neutron.

A health monitor is used to determine whether or not back-end members of the VIP’s pool are usable for processing a request. A pool can have several health monitors associated with it. There are different types of health monitors supported by the OpenStack LBaaS service:

  • PING: used to ping the members using ICMP.
  • TCP: used to connect to the members using TCP.
  • HTTP: used to send an HTTP request to the member.
  • HTTPS: used to send a secure HTTP request to the member.

Required Properties

delay

The minimum time in milliseconds between regular connections of the member.

Integer value expected.

Can be updated without replacement.

max_retries

Number of permissible connection failures before changing the member status to INACTIVE.

Integer value expected.

Can be updated without replacement.

timeout

Maximum number of milliseconds for a monitor to wait for a connection to be established before it times out.

Integer value expected.

Can be updated without replacement.

type

One of predefined health monitor types.

String value expected.

Updates cause replacement.

Allowed values: PING, TCP, HTTP, HTTPS

Optional Properties

admin_state_up

The administrative state of the health monitor.

Boolean value expected.

Can be updated without replacement.

Defaults to “True”.

expected_codes

The list of HTTP status codes expected in response from the member to declare it healthy.

String value expected.

Can be updated without replacement.

http_method

The HTTP method used for requests by the monitor of type HTTP.

String value expected.

Can be updated without replacement.

url_path

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.

Attributes

admin_state_up

The administrative state of this health monitor.

delay

The minimum time in milliseconds between regular connections of the member.

expected_codes

The list of HTTP status codes expected in response from the member to declare it healthy.

http_method

The HTTP method used for requests by the monitor of type HTTP.

max_retries

Number of permissible connection failures before changing the member status to INACTIVE.

show

Detailed information about resource.

tenant_id

Tenant owning the health monitor.

timeout

Maximum number of milliseconds for a monitor to wait for a connection to be established before it times out.

type

One of predefined health monitor types.

url_path

The HTTP path used in the HTTP request used by the monitor to test a member health.

HOT Syntax

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

OS::Neutron::LoadBalancer

Note

DEPRECATED since 7.0.0 (Newton) - Neutron LBaaS v1 is deprecated in the Liberty release and is planned to be removed in a future release. Going forward, the LBaaS V2 should be used.

Note

Available since 2014.1 (Icehouse)

A resource to link a neutron pool with servers.

A loadbalancer allows linking a neutron pool with specified servers to some port.

Required Properties

pool_id

The ID of the load balancing pool.

String value expected.

Can be updated without replacement.

protocol_port

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.

Optional Properties

members

The list of Nova server IDs load balanced.

List value expected.

Can be updated without replacement.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Neutron::LoadBalancer
    properties:
      members: [Value, Value, ...]
      pool_id: String
      protocol_port: Integer

OS::Neutron::Pool

Note

DEPRECATED since 7.0.0 (Newton) - Neutron LBaaS v1 is deprecated in the Liberty release and is planned to be removed in a future release. Going forward, the LBaaS V2 should be used.

A resource for managing load balancer pools in Neutron.

A load balancing pool is a logical set of devices, such as web servers, that you group together to receive and process traffic. The loadbalancing function chooses a member of the pool according to the configured load balancing method to handle the new requests or connections received on the VIP address. There is only one pool for a VIP.

Required Properties

lb_method

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

Protocol for balancing.

String value expected.

Updates cause replacement.

Allowed values: TCP, HTTP, HTTPS

subnet

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

vip

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.

description

Description of the vip.

String value expected.

Updates cause replacement.

name

Name of the vip.

String 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:

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

Optional Properties

admin_state_up

The administrative state of this pool.

Boolean value expected.

Can be updated without replacement.

Defaults to “True”.

description

Description of the pool.

String value expected.

Can be updated without replacement.

monitors

List of health monitors associated with the pool.

List value expected.

Can be updated without replacement.

Defaults to “[]”.

name

Name of the pool.

String value expected.

Updates cause replacement.

provider

Note

Available since 5.0.0 (Liberty)

LBaaS provider to implement this load balancer instance.

String value expected.

Updates cause replacement.

Value must be of type neutron.lb.provider

Attributes

admin_state_up

The administrative state of this pool.

description

Description of the pool.

lb_method

The algorithm used to distribute load between the members of the pool.

name

Name of the pool.

protocol

Protocol to balance.

provider

Note

Available since 5.0.0 (Liberty)

Provider implementing this load balancer instance.

show

Detailed information about resource.

subnet_id

The subnet for the port on which the members of the pool will be connected.

tenant_id

Tenant owning the pool.

vip

Vip associated with the pool.

HOT Syntax

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: {"session_persistence": {"cookie_name": String, "type": String}, "subnet": String, "name": String, "address": String, "protocol_port": Integer, "connection_limit": Integer, "admin_state_up": Boolean, "description": String}

OS::Neutron::PoolMember

Note

DEPRECATED since 7.0.0 (Newton) - Neutron LBaaS v1 is deprecated in the Liberty release and is planned to be removed in a future release. Going forward, the LBaaS V2 should be used.

Note

Available since 2014.1 (Icehouse)

A resource to handle loadbalancer members.

A pool member represents the application running on backend server.

Required Properties

address

IP address of the pool member on the pool network.

String value expected.

Updates cause replacement.

Value must be of type ip_addr

pool_id

The ID of the load balancing pool.

String value expected.

Can be updated without replacement.

protocol_port

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.

Optional Properties

admin_state_up

The administrative state of the pool member.

Boolean value expected.

Updates cause replacement.

Defaults to “True”.

weight

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.

Attributes

address

IP address of the pool member.

admin_state_up

The administrative state of this pool member.

pool_id

The ID of the load balancing pool.

protocol_port

TCP port on which the pool member listens for requests or connections.

show

Detailed information about resource.

tenant_id

Tenant owning the pool member.

weight

Weight of the pool member in the pool.

HOT Syntax

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