Unsupported Heat Resource Types

These resources are enabled, but are not officially supported.

OS::Aodh::Alarm

A resource that implements alarming service of Aodh.

A resource that allows for the setting alarms based on threshold evaluation for a collection of samples. Also, you can define actions to take if state of watched resource will be satisfied specified conditions. For example, it can watch for the memory consumption and when it reaches 70% on a given instance if the instance has been up for more than 10 min, some action will be called.

Required Properties

meter_name
Meter name watched by the alarm.
String value expected.
Updates cause replacement.
threshold
Threshold to evaluate against.
Number value expected.
Can be updated without replacement.

Optional Properties

alarm_actions
A list of URLs (webhooks) to invoke when state transitions to alarm.
List value expected.
Can be updated without replacement.
alarm_queues
A list of Zaqar queues to post to when state transitions to alarm.
List value expected.
Can be updated without replacement.
Defaults to []
List contents:
Optional.
String value expected.
Can be updated without replacement.
Value must be of type zaqar.queue
comparison_operator
Operator used to compare specified statistic with threshold.
String value expected.
Can be updated without replacement.
Allowed values: “le”, “ge”, “eq”, “lt”, “gt”, “ne”
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"
evaluation_periods
Number of periods to evaluate over.
Integer value expected.
Can be updated without replacement.
insufficient_data_actions
A list of URLs (webhooks) to invoke when state transitions to insufficient-data.
List value expected.
Can be updated without replacement.
insufficient_data_queues
A list of Zaqar queues to post to when state transitions to insufficient-data.
List value expected.
Can be updated without replacement.
Defaults to []
List contents:
Optional.
String value expected.
Can be updated without replacement.
Value must be of type zaqar.queue
matching_metadata
Meter should match this resource metadata (key=value) additionally to the meter_name.
Map value expected.
Can be updated without replacement.
Defaults to {}
ok_actions
A list of URLs (webhooks) to invoke when state transitions to ok.
List value expected.
Can be updated without replacement.
ok_queues
A list of Zaqar queues to post to when state transitions to ok.
List value expected.
Can be updated without replacement.
Defaults to []
List contents:
Optional.
String value expected.
Can be updated without replacement.
Value must be of type zaqar.queue
period
Period (seconds) to evaluate over.
Integer value expected.
Can be updated without replacement.
query
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
Optional.
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
Optional.
Comparison operator.
String value expected.
Can be updated without replacement.
Allowed values: “le”, “ge”, “eq”, “lt”, “gt”, “ne”
type
Optional.
The type of the attribute.
String value expected.
Can be updated without replacement.
Defaults to "string"
Allowed values: “integer”, “float”, “string”, “boolean”, “datetime”
value
Optional.
String value with which to compare.
String value expected.
Can be updated without replacement.
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
Severity of the alarm.
String value expected.
Can be updated without replacement.
Defaults to "low"
Allowed values: “low”, “moderate”, “critical”
statistic
Meter statistic to evaluate.
String value expected.
Can be updated without replacement.
Allowed values: “count”, “avg”, “sum”, “min”, “max”
time_constraints
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
Optional.
Description for the time constraint.
String value expected.
Updates cause replacement.
duration
Required.
Duration for the time constraint.
Integer value expected.
Updates cause replacement.
The value must be at least 0.
name
Required.
Name for the time constraint.
String value expected.
Updates cause replacement.
start
Required.
Start time for the time constraint. A CRON expression property.
String value expected.
Updates cause replacement.
Value must be of type cron_expression
timezone
Optional.
Timezone for the time constraint (eg. ‘Asia/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::Alarm
    properties:
      alarm_actions: [Value, Value, ...]
      alarm_queues: [String, String, ...]
      comparison_operator: String
      description: String
      enabled: Boolean
      evaluation_periods: Integer
      insufficient_data_actions: [Value, Value, ...]
      insufficient_data_queues: [String, String, ...]
      matching_metadata: {...}
      meter_name: String
      ok_actions: [Value, Value, ...]
      ok_queues: [String, String, ...]
      period: Integer
      query: [{"field": String, "type": String, "op": String, "value": String}, {"field": String, "type": String, "op": String, "value": String}, ...]
      repeat_actions: Boolean
      severity: String
      statistic: String
      threshold: Number
      time_constraints: [{"name": String, "start": String, "description": String, "duration": Integer, "timezone": String}, {"name": String, "start": String, "description": String, "duration": Integer, "timezone": String}, ...]

OS::Monasca::AlarmDefinition

Heat Template Resource for Monasca Alarm definition.

Monasca Alarm definition helps to define the required expression for a given alarm situation. This plugin helps to create, update and delete the alarm definition.

Alarm definitions is necessary to describe and manage alarms in a one-to-many relationship in order to avoid having to manually declare each alarm even though they may share many common attributes and differ in only one, such as hostname.

Required Properties

expression
Expression of the alarm to evaluate.
String value expected.
Updates cause 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.
Defaults to []
List contents:
Optional.
Monasca notification.
String value expected.
Can be updated without replacement.
Value must be of type monasca.notification
description
Description of the alarm.
String value expected.
Can be updated without replacement.
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.
Defaults to []
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.
Defaults to []
List contents:
Optional.
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”
undetermined_actions
The notification methods to use when an alarm state is UNDETERMINED.
List value expected.
Can be updated without replacement.
Defaults to []
List contents:
Optional.
Monasca notification.
String value expected.
Can be updated without replacement.
Value must be of type monasca.notification

Attributes

show

Detailed information about resource.

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

Heat Template Resource for Monasca Notification.

A resource which is used to notificate if there is some alarm. Monasca Notification helps to declare the hook points, which will be invoked once alarm is generated. This plugin helps to create, update and delete the notification.

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.
The length must be no greater than 512.
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.
period
Interval in seconds to invoke webhooks if the alarm state does not transition away from the defined trigger state. A value of 0 will disable continuous notifications. This property is only applicable for the webhook notification type and has default period interval of 60 seconds.
Integer value expected.
Can be updated without replacement.
Allowed values: 0, 60

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Monasca::Notification
    properties:
      address: String
      name: String
      period: Integer
      type: String

OS::Neutron::ExtraRoute

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

“Heat Template Resource for networking-sfc flow-classifier.

This resource used to select the traffic that can access the service chain. Traffic that matches any flow classifier will be directed to the first port in the chain.

Optional Properties

description
Description for the Flow Classifier.
String value expected.
Can be updated without replacement.
destination_ip_prefix
Destination IP prefix or subnet.
String value expected.
Updates cause replacement.
Value must be of type net_cidr
destination_port_range_max
Destination protocol port maximum.
Integer value expected.
Updates cause replacement.
The value must be in the range 1 to 65535.
destination_port_range_min
Destination protocol port minimum.
Integer value expected.
Updates cause replacement.
The value must be in the range 1 to 65535.
ethertype
L2 ethertype.
String value expected.
Updates cause replacement.
Defaults to "IPv4"
Allowed values: “IPv4”, “IPv6”
logical_destination_port
ID or name of the neutron destination port.
String value expected.
Updates cause replacement.
Value must be of type neutron.port
logical_source_port
ID or name of the neutron source port.
String value expected.
Updates cause replacement.
Value must be of type neutron.port
name
Name of the Flow Classifier.
String value expected.
Can be updated without replacement.
protocol
IP Protocol for the Flow Classifier.
String value expected.
Updates cause replacement.
Allowed values: “tcp”, “udp”, “icmp”
source_ip_prefix
Source IP prefix or subnet.
String value expected.
Updates cause replacement.
Value must be of type net_cidr
source_port_range_max
Source protocol port Maximum.
Integer value expected.
Updates cause replacement.
The value must be in the range 1 to 65535.
source_port_range_min
Source protocol port Minimum.
Integer value expected.
Updates cause replacement.
The value must be in the range 1 to 65535.
l7_parameters
Dictionary of L7-parameters.
Map value expected.
Updates cause replacement.

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Neutron::FlowClassifier
    properties:
      description: String
      destination_ip_prefix: String
      destination_port_range_max: Integer
      destination_port_range_min: Integer
      ethertype: String
      logical_destination_port: String
      logical_source_port: String
      name: String
      protocol: String
      source_ip_prefix: String
      source_port_range_max: Integer
      source_port_range_min: Integer

OS::Neutron::PortChain

A resource for neutron networking-sfc.

This resource used to define the service function path by arranging networking-sfc port-pair-groups and set of flow classifiers, to specify the classified traffic flows to enter the chain.

Required Properties

port_pair_groups
A list of port pair groups to apply to the Port Chain.
List value expected.
Can be updated without replacement.
List contents:
Optional.
Port Pair Group ID or Name .
String value expected.
Can be updated without replacement.
Value must be of type neutron.port_pair_group

Optional Properties

chain_parameters
Dictionary of chain parameters. Currently, only correlation=mpls is supported by default.
Map value expected.
Updates cause replacement.
Defaults to {"correlation": "mpls"}
description
Description for the Port Chain.
String value expected.
Can be updated without replacement.
flow_classifiers
A list of flow classifiers to apply to the Port Chain.
List value expected.
Can be updated without replacement.
Defaults to []
List contents:
Optional.
Flow Classifier ID or Name .
String value expected.
Can be updated without replacement.
Value must be of type neutron.flow_classifier
name
Name of the Port Chain.
String 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::PortChain
    properties:
      chain_parameters: {...}
      description: String
      flow_classifiers: [String, String, ...]
      name: String
      port_pair_groups: [String, String, ...]

OS::Neutron::PortPair

A resource for neutron networking-sfc port-pair.

This plug-in requires networking-sfc>=1.0.0. So to enable this plug-in, install this library and restart the heat-engine.

A Port Pair represents a service function instance. The ingress port and the egress port of the service function may be specified. If a service function has one bidirectional port, the ingress port has the same value as the egress port.

Required Properties

egress
ID or name of the egress neutron port.
String value expected.
Updates cause replacement.
Value must be of type neutron.port
ingress
ID or name of the ingress neutron port.
String value expected.
Updates cause replacement.
Value must be of type neutron.port

Optional Properties

description
Description for the Port Pair.
String value expected.
Can be updated without replacement.
name
Name for the Port Pair.
String value expected.
Can be updated without replacement.
service_function_parameters
Dictionary of service function parameter. Currently only correlation=None is supported.
Map value expected.
Updates cause replacement.
Defaults to {"correlation": null}

Attributes

show

Detailed information about resource.

HOT Syntax

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Neutron::PortPair
    properties:
      description: String
      egress: String
      ingress: String
      name: String
      service_function_parameters: {...}

OS::Neutron::PortPairGroup

Heat Template Resource for networking-sfc port-pair-group.

Multiple port-pairs may be included in a port-pair-group to allow the specification of a set of functionally equivalent Service Functions that can be used for load distribution.

Required Properties

port_pairs
A list of Port Pair IDs or names to apply.
List value expected.
Can be updated without replacement.
List contents:
Optional.
Port Pair ID or name .
String value expected.
Can be updated without replacement.
Value must be of type neutron.port_pair

Optional Properties

description
Description for the Port Pair Group.
String value expected.
Can be updated without replacement.
name
Name for the Port Pair Group.
String 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::PortPairGroup
    properties:
      description: String
      name: String
      port_pairs: [String, String, ...]