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¶: Available since 8.0.0 (Ocata)

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¶: Available since 8.0.0 (Ocata)

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¶: Available since 8.0.0 (Ocata)

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

Available since 8.0.0 (Ocata)

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¶: 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”
statistic¶: Meter statistic to evaluate.

String value expected.

Can be updated without replacement.

Allowed values: “count”, “avg”, “sum”, “min”, “max”
time_constraints¶: 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¶
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¶: Available since 7.0.0 (Newton)

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¶: UNSUPPORTED - Currently, no value is supported for this option.

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, ...]

OS::Sahara::Cluster¶

A resource for managing Sahara clusters.

The Cluster entity represents a collection of VM instances that all have the same data processing framework installed. It is mainly characterized by a VM image with a pre-installed framework which will be used for cluster deployment. Users may choose one of the pre-configured Cluster Templates to start a Cluster. To get access to VMs after a Cluster has started, the user should specify a keypair.

Required Properties¶

cluster_template_id¶: ID of the Cluster Template used for Node Groups and configurations.

String value expected.

Updates cause replacement.

Value must be of type sahara.cluster_template
hadoop_version¶: Version of Hadoop running on instances.

String value expected.

Updates cause replacement.
neutron_management_network¶: Name or UUID of network.

String value expected.

Updates cause replacement.

Value must be of type neutron.network
plugin_name¶: Plugin name.

String value expected.

Updates cause replacement.

Value must be of type sahara.plugin

Optional Properties¶

default_image_id¶: 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
key_name¶: Keypair added to instances to make them accessible for user.

String value expected.

Updates cause replacement.

Value must be of type nova.keypair
name¶: Hadoop cluster name.

String value expected.

Updates cause replacement.

The length must be in the range 1 to 80.

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])$
shares¶: Available since 6.0.0 (Mitaka)

List of manila shares to be mounted.

List value expected.

Updates cause replacement.

List contents:

Map value expected.

Updates cause replacement.

Map properties:

access_level¶
Optional.

Governs permissions set in manila for the cluster ips.

String value expected.

Updates cause replacement.

Defaults to "rw"

Allowed values: “rw”, “ro”

id¶
Required.

Id of the manila share.

String value expected.

Updates cause replacement.

path¶
Optional.

Local path on each cluster node on which to mount the share. Defaults to ‘/mnt/{share_id}’.

String value expected.

Updates cause replacement.
use_autoconfig¶: Available since 5.0.0 (Liberty)

Configure most important configs automatically.

Boolean value expected.

Updates cause replacement.

Attributes¶

info¶: Cluster information.
show¶: Detailed information about resource.
status¶: Cluster status.

HOT Syntax¶

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
      shares: [{"id": String, "path": String, "access_level": String}, {"id": String, "path": String, "access_level": String}, ...]
      use_autoconfig: Boolean

OS::Sahara::ClusterTemplate¶

A resource for managing Sahara cluster templates.

A Cluster Template is designed to bring Node Group Templates together to form a Cluster. A Cluster Template defines what Node Groups will be included and how many instances will be created in each. Some data processing framework configurations can not be applied to a single node, but to a whole Cluster. A user can specify these kinds of configurations in a Cluster Template. Sahara enables users to specify which processes should be added to an anti-affinity group within a Cluster Template. If a process is included into an anti-affinity group, it means that VMs where this process is going to be launched should be scheduled to different hardware hosts.

Required Properties¶

hadoop_version¶: Version of Hadoop running on instances.

String value expected.

Can be updated without replacement.
plugin_name¶: Plugin name.

String value expected.

Can be updated without replacement.

Value must be of type sahara.plugin

Optional Properties¶

anti_affinity¶: List of processes to enable anti-affinity for.

List value expected.

Can be updated without replacement.

List contents:

Optional.

String value expected.

Can be updated without replacement.
cluster_configs¶: Cluster configs dictionary.

Map value expected.

Can be updated without replacement.
default_image_id¶: 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¶: Description of the Sahara Group Template.

String value expected.

Can be updated without replacement.

Defaults to ""
name¶: 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])$
neutron_management_network¶: Name or UUID of network.

String value expected.

Can be updated without replacement.

Value must be of type neutron.network
node_groups¶: Node groups.

List value expected.

Can be updated without replacement.

List contents:

Map value expected.

Can be updated without replacement.

Map properties:

count¶
Required.

Number of instances in the Node group.

Integer value expected.

Can be updated without replacement.

The value must be at least 1.

name¶
Required.

Name of the Node group.

String value expected.

Can be updated without replacement.

node_group_template_id¶
Required.

ID of the Node Group Template.

String value expected.

Can be updated without replacement.
shares¶: Available since 6.0.0 (Mitaka)

List of manila shares to be mounted.

List value expected.

Can be updated without replacement.

List contents:

Map value expected.

Can be updated without replacement.

Map properties:

access_level¶
Optional.

Governs permissions set in manila for the cluster ips.

String value expected.

Can be updated without replacement.

Defaults to "rw"

Allowed values: “rw”, “ro”

id¶
Required.

Id of the manila share.

String value expected.

Can be updated without replacement.

path¶
Optional.

Local path on each cluster node on which to mount the share. Defaults to ‘/mnt/{share_id}’.

String value expected.

Can be updated without replacement.
use_autoconfig¶: Available since 5.0.0 (Liberty)

Configure most important configs automatically.

Boolean value expected.

Updates cause replacement.

Attributes¶

show¶: Detailed information about resource.

HOT Syntax¶

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, "count": Integer, "node_group_template_id": String}, {"name": String, "count": Integer, "node_group_template_id": String}, ...]
      plugin_name: String
      shares: [{"id": String, "path": String, "access_level": String}, {"id": String, "path": String, "access_level": String}, ...]
      use_autoconfig: Boolean

OS::Sahara::DataSource¶

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.

Required Properties¶

type¶: Type of the data source.

String value expected.

Can be updated without replacement.

Allowed values: “swift”, “hdfs”, “maprfs”, “manila”
url¶: URL for the data source.

String value expected.

Can be updated without replacement.

Optional Properties¶

credentials¶: 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¶
Required.

Password for accessing the data source URL.

String value expected.

Can be updated without replacement.

user¶
Required.

Username for accessing the data source URL.

String value expected.

Can be updated without replacement.
description¶: Description of the data source.

String value expected.

Can be updated without replacement.

Defaults to ""
name¶: Name of the data source.

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::Sahara::DataSource
    properties:
      credentials: {"user": String, "password": String}
      description: String
      name: String
      type: String
      url: String

OS::Sahara::ImageRegistry¶

A resource for registering an image in sahara.

Allows to register an image in the sahara image registry and add tags.

Required Properties¶

image¶: ID or name of the image to register.

String value expected.

Updates cause replacement.

Value must be of type glance.image
username¶: Username of privileged user in the image.

String value expected.

Can be updated without replacement.

Optional Properties¶

description¶: Description of the image.

String value expected.

Can be updated without replacement.

Defaults to ""
tags¶: Tags to add to the image.

List value expected.

Can be updated without replacement.

Defaults to []

List contents:

Optional.

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::Sahara::ImageRegistry
    properties:
      description: String
      image: String
      tags: [String, String, ...]
      username: String

OS::Sahara::Job¶

A resource for creating Sahara Job.

A job specifies the type of the job and lists all of the individual job binary objects. Can be launched using resource-signal.

Required Properties¶

type¶: Type of the job.

String value expected.

Updates cause replacement.

Value must be of type sahara.job_type

Optional Properties¶

default_execution_data¶: Default execution data to use when run signal.

Map value expected.

Can be updated without replacement.

Map properties:

args¶
Arguments to add to the job.

List value expected.

Can be updated without replacement.

Defaults to []

List contents:

Optional.

String value expected.

Can be updated without replacement.

cluster¶
Required.

ID or name of the cluster to run the job in.

String value expected.

Can be updated without replacement.

Value must be of type sahara.cluster

configs¶
Config parameters to add to the job.

Map value expected.

Can be updated without replacement.

Defaults to {}

input¶
Optional.

ID or name of the input data source.

String value expected.

Can be updated without replacement.

Value must be of type sahara.data_source

interface¶
Interface arguments to add to the job.

Map value expected.

Can be updated without replacement.

Defaults to {}

is_public¶
Optional.

If True, execution will be shared across the tenants.

Boolean value expected.

Can be updated without replacement.

Defaults to false

output¶
Optional.

ID or name of the output data source.

String value expected.

Can be updated without replacement.

Value must be of type sahara.data_source

params¶
Parameters to add to the job.

Map value expected.

Can be updated without replacement.

Defaults to {}
description¶: Description of the job.

String value expected.

Can be updated without replacement.
is_protected¶: If True, job will be protected from modifications and can not be deleted until this property is set to False.

Boolean value expected.

Can be updated without replacement.

Defaults to false
is_public¶: If True, job will be shared across the tenants.

Boolean value expected.

Can be updated without replacement.

Defaults to false
libs¶: IDs or names of job’s lib job binaries.

List value expected.

Updates cause replacement.

Defaults to []

List contents:

Optional.

String value expected.

Updates cause replacement.

Value must be of type sahara.job_binary
mains¶: IDs or names of job’s main job binary. In case of specific Sahara service, this property designed as a list, but accepts only one item.

List value expected.

Updates cause replacement.

Defaults to []

The length must be no greater than 1.

List contents:

Optional.

ID of job’s main job binary.

String value expected.

Updates cause replacement.

Value must be of type sahara.job_binary
name¶: Name of the job.

String value expected.

Can be updated without replacement.

The length must be in the range 1 to 50.

Value must match pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]*$

Attributes¶

default_execution_url¶: A signed url to create execution specified in default_execution_data property.
executions¶: List of the job executions.
show¶: Detailed information about resource.

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Sahara::Job
    properties:
      default_execution_data: {"cluster": String, "input": String, "output": String, "configs": {...}, "params": {...}, "args": [String, String, ...], "is_public": Boolean, "interface": {...}}
      description: String
      is_protected: Boolean
      is_public: Boolean
      libs: [String, String, ...]
      mains: [String, String, ...]
      name: String
      type: String

OS::Sahara::JobBinary¶

A resource for creating sahara job binary.

A job binary stores an URL to a single script or Jar file and any credentials needed to retrieve the file.

Required Properties¶

url¶: URL for the job binary. Must be in the format swift://<container>/<path> or internal-db://<uuid>.

String value expected.

Can be updated without replacement.

Optional Properties¶

credentials¶: 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¶
Required.

Password for accessing the job binary URL.

String value expected.

Can be updated without replacement.

user¶
Required.

Username for accessing the job binary URL.

String value expected.

Can be updated without replacement.
description¶: Description of the job binary.

String value expected.

Can be updated without replacement.

Defaults to ""
name¶: Name of the job binary.

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::Sahara::JobBinary
    properties:
      credentials: {"user": String, "password": String}
      description: String
      name: String
      url: String

OS::Sahara::NodeGroupTemplate¶

A resource for managing Sahara node group templates.

A Node Group Template describes a group of nodes within cluster. It contains a list of hadoop processes that will be launched on each instance in a group. Also a Node Group Template may provide node scoped configurations for those processes.

Required Properties¶

flavor¶: Name or ID Nova flavor for the nodes.

String value expected.

Can be updated without replacement.

Value must be of type nova.flavor
hadoop_version¶: Version of Hadoop running on instances.

String value expected.

Can be updated without replacement.
node_processes¶: List of processes to run on every node.

List value expected.

Can be updated without replacement.

The length must be at least 1.

List contents:

Optional.

String value expected.

Can be updated without replacement.
plugin_name¶: Plugin name.

String value expected.

Can be updated without replacement.

Value must be of type sahara.plugin

Optional Properties¶

auto_security_group¶: Defines whether auto-assign security group to this Node Group template.

Boolean value expected.

Can be updated without replacement.
availability_zone¶: Availability zone to create servers in.

String value expected.

Can be updated without replacement.
description¶: Description of the Node Group Template.

String value expected.

Can be updated without replacement.

Defaults to ""
floating_ip_pool¶: 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.

Can be updated without replacement.
image_id¶: ID of the image to use for the template.

String value expected.

Can be updated without replacement.

Value must be of type sahara.image
is_proxy_gateway¶: Available since 5.0.0 (Liberty)

Provide access to nodes using other nodes of the cluster as proxy gateways.

Boolean value expected.

Can be updated without replacement.
name¶: Name for the Sahara Node Group 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])$
node_configs¶: Dictionary of node configurations.

Map value expected.

Can be updated without replacement.
security_groups¶: List of security group names or IDs to assign to this Node Group template.

List value expected.

Can be updated without replacement.

List contents:

Optional.

String value expected.

Can be updated without replacement.
shares¶: Available since 6.0.0 (Mitaka)

List of manila shares to be mounted.

List value expected.

Can be updated without replacement.

List contents:

Map value expected.

Can be updated without replacement.

Map properties:

access_level¶
Optional.

Governs permissions set in manila for the cluster ips.

String value expected.

Can be updated without replacement.

Defaults to "rw"

Allowed values: “rw”, “ro”

id¶
Required.

Id of the manila share.

String value expected.

Can be updated without replacement.

path¶
Optional.

Local path on each cluster node on which to mount the share. Defaults to ‘/mnt/{share_id}’.

String value expected.

Can be updated without replacement.
use_autoconfig¶: Available since 5.0.0 (Liberty)

Configure most important configs automatically.

Boolean value expected.

Can be updated without replacement.
volume_local_to_instance¶: Available since 5.0.0 (Liberty)

Create volumes on the same physical port as an instance.

Boolean value expected.

Can be updated without replacement.
volume_type¶: Type of the volume to create on Cinder backend.

String value expected.

Can be updated without replacement.

Value must be of type cinder.vtype
volumes_availability_zone¶: Availability zone to create volumes in.

String value expected.

Can be updated without replacement.
volumes_per_node¶: Volumes per node.

Integer value expected.

Can be updated without replacement.

Defaults to 0

The value must be at least 0.
volumes_size¶: Size of the volumes, in GB.

Integer value expected.

Can be updated without replacement.

The value must be at least 1.

Attributes¶

show¶: Detailed information about resource.

HOT Syntax¶

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, ...]
      shares: [{"id": String, "path": String, "access_level": String}, {"id": String, "path": String, "access_level": String}, ...]
      use_autoconfig: Boolean
      volume_local_to_instance: Boolean
      volume_type: String
      volumes_availability_zone: String
      volumes_per_node: Integer
      volumes_size: Integer

OS::Senlin::Cluster¶

A resource that creates a Senlin Cluster.

Cluster resource in senlin can create and manage objects of the same nature, e.g. Nova servers, Heat stacks, Cinder volumes, etc. The collection of these objects is referred to as a cluster.

Required Properties¶

profile¶: The name or id of the Senlin profile.

String value expected.

Can be updated without replacement.

Value must be of type senlin.profile

Optional Properties¶

desired_capacity¶: Desired initial number of resources in cluster.

Integer value expected.

Can be updated without replacement.

Defaults to 0
max_size¶: Maximum number of resources in the cluster. -1 means unlimited.

Integer value expected.

Can be updated without replacement.

Defaults to -1

The value must be at least -1.
metadata¶: Metadata key-values defined for cluster.

Map value expected.

Can be updated without replacement.

Defaults to {}
min_size¶: Minimum number of resources in the cluster.

Integer value expected.

Can be updated without replacement.

Defaults to 0

The value must be at least 0.
name¶: Name of the cluster. By default, physical resource name is used.

String value expected.

Can be updated without replacement.
policies¶: Available since 8.0.0 (Ocata)

A list of policies to attach to this cluster.

List value expected.

Can be updated without replacement.

Defaults to []

List contents:

Map value expected.

Can be updated without replacement.

Map properties:

enabled¶
Optional.

Whether enable this policy on this cluster.

Boolean value expected.

Can be updated without replacement.

Defaults to true

policy¶
Required.

The name or ID of the policy.

String value expected.

Can be updated without replacement.

Value must be of type senlin.policy
timeout¶: The number of seconds to wait for the cluster actions.

Integer value expected.

Can be updated without replacement.

The value must be at least 0.

Attributes¶

collect¶: Available since 8.0.0 (Ocata)

Attributes collected from cluster. According to the jsonpath following this attribute, it will return a list of attributes collected from the nodes of this cluster.
desired_capacity¶: Desired capacity of the cluster.
max_size¶: Max size of the cluster.
metadata¶: Cluster metadata.
min_size¶: Min size of the cluster.
name¶: Cluster name.
nodes¶: Nodes list in the cluster.
policies¶: Available since 8.0.0 (Ocata)

Policies attached to the cluster.
show¶: Detailed information about resource.

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Senlin::Cluster
    properties:
      desired_capacity: Integer
      max_size: Integer
      metadata: {...}
      min_size: Integer
      name: String
      policies: [{"policy": String, "enabled": Boolean}, {"policy": String, "enabled": Boolean}, ...]
      profile: String
      timeout: Integer

OS::Senlin::Node¶

A resource that creates a Senlin Node.

Node is an object that belongs to at most one Cluster, it can be created based on a profile.

Required Properties¶

profile¶: Name or ID of senlin profile to create this node.

String value expected.

Can be updated without replacement.

Value must be of type senlin.profile

Optional Properties¶

cluster¶: Available since 8.0.0 (Ocata)

The name of senlin cluster to attach to.

String value expected.

Can be updated without replacement.

Value must be of type senlin.cluster
metadata¶: Metadata key-values defined for node.

Map value expected.

Can be updated without replacement.
name¶: Name of the senlin node. By default, physical resource name is used.

String value expected.

Can be updated without replacement.

Attributes¶

cluster_id¶: The cluster ID this node belongs to.
details¶: The details of physical object.
show¶: Detailed information about resource.

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Senlin::Node
    properties:
      cluster: String
      metadata: {...}
      name: String
      profile: String

OS::Senlin::Policy¶

A resource that creates a Senlin Policy.

A policy is a set of rules that can be checked and/or enforced when an action is performed on a Cluster.

Required Properties¶

type¶: The type of senlin policy.

String value expected.

Updates cause replacement.

Value must be of type senlin.policy_type

Optional Properties¶

bindings¶: A list of clusters to which this policy is attached.

List value expected.

Can be updated without replacement.

List contents:

Map value expected.

Can be updated without replacement.

Map properties:

cluster¶
Required.

The name or ID of target cluster.

String value expected.

Can be updated without replacement.

Value must be of type senlin.cluster

enabled¶
Optional.

Whether enable this policy on that cluster.

Boolean value expected.

Can be updated without replacement.

Defaults to true
name¶: Name of the senlin policy. By default, physical resource name is used.

String value expected.

Can be updated without replacement.
properties¶: Properties of this policy.

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::Senlin::Policy
    properties:
      bindings: [{"cluster": String, "enabled": Boolean}, {"cluster": String, "enabled": Boolean}, ...]
      name: String
      properties: {...}
      type: String

OS::Senlin::Profile¶

A resource that creates a Senlin Profile.

Profile resource in senlin is a template describing how to create nodes in cluster.

Required Properties¶

type¶: The type of profile.

String value expected.

Updates cause replacement.

Value must be of type senlin.profile_type

Optional Properties¶

metadata¶: Metadata key-values defined for profile.

Map value expected.

Can be updated without replacement.
name¶: Name of the senlin profile. By default, physical resource name is used.

String value expected.

Can be updated without replacement.
properties¶: Properties for profile.

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::Senlin::Profile
    properties:
      metadata: {...}
      name: String
      properties: {...}
      type: String

OS::Senlin::Receiver¶

A resource that creates Senlin Receiver.

Receiver is an abstract resource created at the senlin engine that can be used to hook the engine to some external event/alarm sources.

Required Properties¶

action¶: The action to be executed when the receiver is signaled.

String value expected.

Updates cause replacement.

Allowed values: “CLUSTER_SCALE_OUT”, “CLUSTER_SCALE_IN”
cluster¶: Name or ID of target cluster.

String value expected.

Updates cause replacement.

Value must be of type senlin.cluster

Optional Properties¶

name¶: Name of the senlin receiver. By default, physical resource name is used.

String value expected.

Updates cause replacement.
params¶: The parameters passed to action when the receiver is signaled.

Map value expected.

Updates cause replacement.
type¶: Type of receiver.

String value expected.

Updates cause replacement.

Defaults to "webhook"

Allowed values: “webhook”

Attributes¶

channel¶: The channel for receiving signals.
show¶: Detailed information about resource.

HOT Syntax¶

heat_template_version: 2015-04-30
...
resources:
  ...
  the_resource:
    type: OS::Senlin::Receiver
    properties:
      action: String
      cluster: String
      name: String
      params: {...}
      type: String