12599 lines
464 KiB
XML
12599 lines
464 KiB
XML
<?xml version='1.0' encoding='UTF-8'?>
|
|
<!--Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.-->
|
|
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="openstack-resource-types">
|
|
<!--WARNING: This file is automatically generated. Do not edit it.-->
|
|
<title>OpenStack Resource Types</title>
|
|
<section xml:id="OS__Barbican__Order">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Barbican::Order</title>
|
|
<section xml:id="OS__Barbican__Order-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">algorithm</term>
|
|
<listitem>
|
|
<para>The algorithm type used to generate the secret.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "aes".</para>
|
|
<para>Allowed values: aes</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Number">bit_length</term>
|
|
<listitem>
|
|
<para>The bit-length of the secret.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: 128, 196, 256</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">expiration</term>
|
|
<listitem>
|
|
<para>The expiration date for the secret in ISO-8601 format.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type iso_8601</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">mode</term>
|
|
<listitem>
|
|
<para>The type/mode of the algorithm associated with the secret information.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "cbc".</para>
|
|
<para>Allowed values: cbc</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Human readable name for the secret.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">payload_content_type</term>
|
|
<listitem>
|
|
<para>The type/format the secret data is provided in.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "application/octet-stream".</para>
|
|
<para>Allowed values: application/octet-stream</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Barbican__Order-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>order_ref</term>
|
|
<listitem>
|
|
<para>The URI to the order.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>secret_ref</term>
|
|
<listitem>
|
|
<para>The URI to the created secret.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>status</term>
|
|
<listitem>
|
|
<para>The status of the order.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Barbican__Order-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Barbican::Order
|
|
properties:
|
|
algorithm: String
|
|
bit_length: Number
|
|
expiration: String
|
|
mode: String
|
|
name: String
|
|
payload_content_type: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Barbican__Order-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Barbican::Order
|
|
Properties:
|
|
algorithm: String
|
|
bit_length: Number
|
|
expiration: String
|
|
mode: String
|
|
name: String
|
|
payload_content_type: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Barbican__Order-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Barbican::Order",
|
|
"Properties": {
|
|
"algorithm": String,
|
|
"bit_length": Number,
|
|
"expiration": String,
|
|
"mode": String,
|
|
"name": String,
|
|
"payload_content_type": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Barbican__Secret">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Barbican::Secret</title>
|
|
<section xml:id="OS__Barbican__Secret-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">algorithm</term>
|
|
<listitem>
|
|
<para>The algorithm type used to generate the secret.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Number">bit_length</term>
|
|
<listitem>
|
|
<para>The bit-length of the secret.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>The value must be at least 0.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">expiration</term>
|
|
<listitem>
|
|
<para>The expiration date for the secret in ISO-8601 format.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type iso_8601</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">mode</term>
|
|
<listitem>
|
|
<para>The type/mode of the algorithm associated with the secret information.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Human readable name for the secret.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">payload</term>
|
|
<listitem>
|
|
<para>The unencrypted plain text of the secret.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">payload_content_encoding</term>
|
|
<listitem>
|
|
<para>The encoding format used to provide the payload data.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: base64</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">payload_content_type</term>
|
|
<listitem>
|
|
<para>The type/format the secret data is provided in.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: text/plain, application/octet-stream</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Barbican__Secret-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>decrypted_payload</term>
|
|
<listitem>
|
|
<para>The decrypted secret payload.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>status</term>
|
|
<listitem>
|
|
<para>The status of the secret.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Barbican__Secret-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Barbican::Secret
|
|
properties:
|
|
algorithm: String
|
|
bit_length: Number
|
|
expiration: String
|
|
mode: String
|
|
name: String
|
|
payload: String
|
|
payload_content_encoding: String
|
|
payload_content_type: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Barbican__Secret-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Barbican::Secret
|
|
Properties:
|
|
algorithm: String
|
|
bit_length: Number
|
|
expiration: String
|
|
mode: String
|
|
name: String
|
|
payload: String
|
|
payload_content_encoding: String
|
|
payload_content_type: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Barbican__Secret-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Barbican::Secret",
|
|
"Properties": {
|
|
"algorithm": String,
|
|
"bit_length": Number,
|
|
"expiration": String,
|
|
"mode": String,
|
|
"name": String,
|
|
"payload": String,
|
|
"payload_content_encoding": String,
|
|
"payload_content_type": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__Alarm">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Ceilometer::Alarm</title>
|
|
<section xml:id="OS__Ceilometer__Alarm-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="List">alarm_actions</term>
|
|
<listitem>
|
|
<para>A list of URLs (webhooks) to invoke when state transitions to alarm.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">comparison_operator</term>
|
|
<listitem>
|
|
<para>Operator used to compare specified statistic with threshold.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: ge, gt, eq, ne, lt, le</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description for the alarm.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">enabled</term>
|
|
<listitem>
|
|
<para>True if alarm evaluation/actioning is enabled.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "true".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">evaluation_periods</term>
|
|
<listitem>
|
|
<para>Number of periods to evaluate over.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">insufficient_data_actions</term>
|
|
<listitem>
|
|
<para>A list of URLs (webhooks) to invoke when state transitions to insufficient-data.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">matching_metadata</term>
|
|
<listitem>
|
|
<para>Meter should match this resource metadata (key=value) additionally to the meter_name.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "{}".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">meter_name</term>
|
|
<listitem>
|
|
<para>Meter name watched by the alarm.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">ok_actions</term>
|
|
<listitem>
|
|
<para>A list of URLs (webhooks) to invoke when state transitions to ok.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">period</term>
|
|
<listitem>
|
|
<para>Period (seconds) to evaluate over.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">query</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo)</para>
|
|
</note>
|
|
<para>A list of query factors, each comparing a Sample attribute with a value. Implicitly combined with matching_metadata, if any.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">field</term>
|
|
<listitem>
|
|
<para>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`.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">op</term>
|
|
<listitem>
|
|
<para>Comparison operator</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: le, ge, eq, lt, gt, ne</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">value</term>
|
|
<listitem>
|
|
<para>String value with which to compare</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">repeat_actions</term>
|
|
<listitem>
|
|
<para>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.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "true".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">statistic</term>
|
|
<listitem>
|
|
<para>Meter statistic to evaluate.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: count, avg, sum, min, max</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Number">threshold</term>
|
|
<listitem>
|
|
<para>Threshold to evaluate against.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__Alarm-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Ceilometer::Alarm
|
|
properties:
|
|
alarm_actions: [Value, Value, ...]
|
|
comparison_operator: String
|
|
description: String
|
|
enabled: Boolean
|
|
evaluation_periods: Integer
|
|
insufficient_data_actions: [Value, Value, ...]
|
|
matching_metadata: {...}
|
|
meter_name: String
|
|
ok_actions: [Value, Value, ...]
|
|
period: Integer
|
|
query: [{"field": String, "value": String, "op": String}, {"field": String, "value": String, "op": String}, ...]
|
|
repeat_actions: Boolean
|
|
statistic: String
|
|
threshold: Number</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__Alarm-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Ceilometer::Alarm
|
|
Properties:
|
|
alarm_actions: [Value, Value, ...]
|
|
comparison_operator: String
|
|
description: String
|
|
enabled: Boolean
|
|
evaluation_periods: Integer
|
|
insufficient_data_actions: [Value, Value, ...]
|
|
matching_metadata: {...}
|
|
meter_name: String
|
|
ok_actions: [Value, Value, ...]
|
|
period: Integer
|
|
query: [{"field": String, "value": String, "op": String}, {"field": String, "value": String, "op": String}, ...]
|
|
repeat_actions: Boolean
|
|
statistic: String
|
|
threshold: Number</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__Alarm-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Ceilometer::Alarm",
|
|
"Properties": {
|
|
"alarm_actions": [Value, Value, ...],
|
|
"comparison_operator": String,
|
|
"description": String,
|
|
"enabled": Boolean,
|
|
"evaluation_periods": Integer,
|
|
"insufficient_data_actions": [Value, Value, ...],
|
|
"matching_metadata": {...},
|
|
"meter_name": String,
|
|
"ok_actions": [Value, Value, ...],
|
|
"period": Integer,
|
|
"query": [{"field": String, "value": String, "op": String}, {"field": String, "value": String, "op": String}, ...],
|
|
"repeat_actions": Boolean,
|
|
"statistic": String,
|
|
"threshold": Number
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__CombinationAlarm">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Ceilometer::CombinationAlarm</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<section xml:id="OS__Ceilometer__CombinationAlarm-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="List">alarm_actions</term>
|
|
<listitem>
|
|
<para>A list of URLs (webhooks) to invoke when state transitions to alarm.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">alarm_ids</term>
|
|
<listitem>
|
|
<para>List of alarm identifiers to combine.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>The length must be at least 1.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description for the alarm.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">enabled</term>
|
|
<listitem>
|
|
<para>True if alarm evaluation/actioning is enabled.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "true".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">insufficient_data_actions</term>
|
|
<listitem>
|
|
<para>A list of URLs (webhooks) to invoke when state transitions to insufficient-data.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">ok_actions</term>
|
|
<listitem>
|
|
<para>A list of URLs (webhooks) to invoke when state transitions to ok.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">operator</term>
|
|
<listitem>
|
|
<para>Operator used to combine the alarms.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: and, or</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">repeat_actions</term>
|
|
<listitem>
|
|
<para>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.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "true".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__CombinationAlarm-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Ceilometer::CombinationAlarm
|
|
properties:
|
|
alarm_actions: [Value, Value, ...]
|
|
alarm_ids: [Value, Value, ...]
|
|
description: String
|
|
enabled: Boolean
|
|
insufficient_data_actions: [Value, Value, ...]
|
|
ok_actions: [Value, Value, ...]
|
|
operator: String
|
|
repeat_actions: Boolean</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__CombinationAlarm-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Ceilometer::CombinationAlarm
|
|
Properties:
|
|
alarm_actions: [Value, Value, ...]
|
|
alarm_ids: [Value, Value, ...]
|
|
description: String
|
|
enabled: Boolean
|
|
insufficient_data_actions: [Value, Value, ...]
|
|
ok_actions: [Value, Value, ...]
|
|
operator: String
|
|
repeat_actions: Boolean</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__CombinationAlarm-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Ceilometer::CombinationAlarm",
|
|
"Properties": {
|
|
"alarm_actions": [Value, Value, ...],
|
|
"alarm_ids": [Value, Value, ...],
|
|
"description": String,
|
|
"enabled": Boolean,
|
|
"insufficient_data_actions": [Value, Value, ...],
|
|
"ok_actions": [Value, Value, ...],
|
|
"operator": String,
|
|
"repeat_actions": Boolean
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__GnocchiAggregationByMetricsAlarm">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Ceilometer::GnocchiAggregationByMetricsAlarm</title>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo)</para>
|
|
</note>
|
|
<section xml:id="OS__Ceilometer__GnocchiAggregationByMetricsAlarm-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">aggregation_method</term>
|
|
<listitem>
|
|
<para>The aggregation method to compare to the threshold</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: mean, sum, last, max, min, std, median, first, count</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">alarm_actions</term>
|
|
<listitem>
|
|
<para>A list of URLs (webhooks) to invoke when state transitions to alarm.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">comparison_operator</term>
|
|
<listitem>
|
|
<para>Operator used to compare specified statistic with threshold.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: ge, gt, eq, ne, lt, le</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description for the alarm.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">enabled</term>
|
|
<listitem>
|
|
<para>True if alarm evaluation/actioning is enabled.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "true".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">evaluation_periods</term>
|
|
<listitem>
|
|
<para>Number of periods to evaluate over.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">granularity</term>
|
|
<listitem>
|
|
<para>The time range in seconds.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">insufficient_data_actions</term>
|
|
<listitem>
|
|
<para>A list of URLs (webhooks) to invoke when state transitions to insufficient-data.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">metrics</term>
|
|
<listitem>
|
|
<para>A list of metric ids.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">ok_actions</term>
|
|
<listitem>
|
|
<para>A list of URLs (webhooks) to invoke when state transitions to ok.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">repeat_actions</term>
|
|
<listitem>
|
|
<para>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.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "true".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Number">threshold</term>
|
|
<listitem>
|
|
<para>Threshold to evaluate against.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__GnocchiAggregationByMetricsAlarm-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Ceilometer::GnocchiAggregationByMetricsAlarm
|
|
properties:
|
|
aggregation_method: String
|
|
alarm_actions: [Value, Value, ...]
|
|
comparison_operator: String
|
|
description: String
|
|
enabled: Boolean
|
|
evaluation_periods: Integer
|
|
granularity: Integer
|
|
insufficient_data_actions: [Value, Value, ...]
|
|
metrics: [Value, Value, ...]
|
|
ok_actions: [Value, Value, ...]
|
|
repeat_actions: Boolean
|
|
threshold: Number</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__GnocchiAggregationByMetricsAlarm-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Ceilometer::GnocchiAggregationByMetricsAlarm
|
|
Properties:
|
|
aggregation_method: String
|
|
alarm_actions: [Value, Value, ...]
|
|
comparison_operator: String
|
|
description: String
|
|
enabled: Boolean
|
|
evaluation_periods: Integer
|
|
granularity: Integer
|
|
insufficient_data_actions: [Value, Value, ...]
|
|
metrics: [Value, Value, ...]
|
|
ok_actions: [Value, Value, ...]
|
|
repeat_actions: Boolean
|
|
threshold: Number</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__GnocchiAggregationByMetricsAlarm-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Ceilometer::GnocchiAggregationByMetricsAlarm",
|
|
"Properties": {
|
|
"aggregation_method": String,
|
|
"alarm_actions": [Value, Value, ...],
|
|
"comparison_operator": String,
|
|
"description": String,
|
|
"enabled": Boolean,
|
|
"evaluation_periods": Integer,
|
|
"granularity": Integer,
|
|
"insufficient_data_actions": [Value, Value, ...],
|
|
"metrics": [Value, Value, ...],
|
|
"ok_actions": [Value, Value, ...],
|
|
"repeat_actions": Boolean,
|
|
"threshold": Number
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__GnocchiAggregationByResourcesAlarm">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Ceilometer::GnocchiAggregationByResourcesAlarm</title>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo)</para>
|
|
</note>
|
|
<section xml:id="OS__Ceilometer__GnocchiAggregationByResourcesAlarm-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">aggregation_method</term>
|
|
<listitem>
|
|
<para>The aggregation method to compare to the threshold</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: mean, sum, last, max, min, std, median, first, count</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">alarm_actions</term>
|
|
<listitem>
|
|
<para>A list of URLs (webhooks) to invoke when state transitions to alarm.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">comparison_operator</term>
|
|
<listitem>
|
|
<para>Operator used to compare specified statistic with threshold.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: ge, gt, eq, ne, lt, le</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description for the alarm.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">enabled</term>
|
|
<listitem>
|
|
<para>True if alarm evaluation/actioning is enabled.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "true".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">evaluation_periods</term>
|
|
<listitem>
|
|
<para>Number of periods to evaluate over.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">granularity</term>
|
|
<listitem>
|
|
<para>The time range in seconds.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">insufficient_data_actions</term>
|
|
<listitem>
|
|
<para>A list of URLs (webhooks) to invoke when state transitions to insufficient-data.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">metric</term>
|
|
<listitem>
|
|
<para>Metric name watched by the alarm.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">ok_actions</term>
|
|
<listitem>
|
|
<para>A list of URLs (webhooks) to invoke when state transitions to ok.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">query</term>
|
|
<listitem>
|
|
<para>The query to filter the metrics</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">repeat_actions</term>
|
|
<listitem>
|
|
<para>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.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "true".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">resource_type</term>
|
|
<listitem>
|
|
<para>Resource type</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Number">threshold</term>
|
|
<listitem>
|
|
<para>Threshold to evaluate against.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__GnocchiAggregationByResourcesAlarm-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Ceilometer::GnocchiAggregationByResourcesAlarm
|
|
properties:
|
|
aggregation_method: String
|
|
alarm_actions: [Value, Value, ...]
|
|
comparison_operator: String
|
|
description: String
|
|
enabled: Boolean
|
|
evaluation_periods: Integer
|
|
granularity: Integer
|
|
insufficient_data_actions: [Value, Value, ...]
|
|
metric: String
|
|
ok_actions: [Value, Value, ...]
|
|
query: String
|
|
repeat_actions: Boolean
|
|
resource_type: String
|
|
threshold: Number</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__GnocchiAggregationByResourcesAlarm-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Ceilometer::GnocchiAggregationByResourcesAlarm
|
|
Properties:
|
|
aggregation_method: String
|
|
alarm_actions: [Value, Value, ...]
|
|
comparison_operator: String
|
|
description: String
|
|
enabled: Boolean
|
|
evaluation_periods: Integer
|
|
granularity: Integer
|
|
insufficient_data_actions: [Value, Value, ...]
|
|
metric: String
|
|
ok_actions: [Value, Value, ...]
|
|
query: String
|
|
repeat_actions: Boolean
|
|
resource_type: String
|
|
threshold: Number</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__GnocchiAggregationByResourcesAlarm-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Ceilometer::GnocchiAggregationByResourcesAlarm",
|
|
"Properties": {
|
|
"aggregation_method": String,
|
|
"alarm_actions": [Value, Value, ...],
|
|
"comparison_operator": String,
|
|
"description": String,
|
|
"enabled": Boolean,
|
|
"evaluation_periods": Integer,
|
|
"granularity": Integer,
|
|
"insufficient_data_actions": [Value, Value, ...],
|
|
"metric": String,
|
|
"ok_actions": [Value, Value, ...],
|
|
"query": String,
|
|
"repeat_actions": Boolean,
|
|
"resource_type": String,
|
|
"threshold": Number
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__GnocchiResourcesAlarm">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Ceilometer::GnocchiResourcesAlarm</title>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo)</para>
|
|
</note>
|
|
<section xml:id="OS__Ceilometer__GnocchiResourcesAlarm-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">aggregation_method</term>
|
|
<listitem>
|
|
<para>The aggregation method to compare to the threshold</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: mean, sum, last, max, min, std, median, first, count</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">alarm_actions</term>
|
|
<listitem>
|
|
<para>A list of URLs (webhooks) to invoke when state transitions to alarm.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">comparison_operator</term>
|
|
<listitem>
|
|
<para>Operator used to compare specified statistic with threshold.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: ge, gt, eq, ne, lt, le</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description for the alarm.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">enabled</term>
|
|
<listitem>
|
|
<para>True if alarm evaluation/actioning is enabled.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "true".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">evaluation_periods</term>
|
|
<listitem>
|
|
<para>Number of periods to evaluate over.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">granularity</term>
|
|
<listitem>
|
|
<para>The time range in seconds.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">insufficient_data_actions</term>
|
|
<listitem>
|
|
<para>A list of URLs (webhooks) to invoke when state transitions to insufficient-data.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">metric</term>
|
|
<listitem>
|
|
<para>Metric name watched by the alarm.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">ok_actions</term>
|
|
<listitem>
|
|
<para>A list of URLs (webhooks) to invoke when state transitions to ok.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">repeat_actions</term>
|
|
<listitem>
|
|
<para>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.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "true".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">resource_id</term>
|
|
<listitem>
|
|
<para>Id of a resource</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">resource_type</term>
|
|
<listitem>
|
|
<para>Resource type</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Number">threshold</term>
|
|
<listitem>
|
|
<para>Threshold to evaluate against.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__GnocchiResourcesAlarm-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Ceilometer::GnocchiResourcesAlarm
|
|
properties:
|
|
aggregation_method: String
|
|
alarm_actions: [Value, Value, ...]
|
|
comparison_operator: String
|
|
description: String
|
|
enabled: Boolean
|
|
evaluation_periods: Integer
|
|
granularity: Integer
|
|
insufficient_data_actions: [Value, Value, ...]
|
|
metric: String
|
|
ok_actions: [Value, Value, ...]
|
|
repeat_actions: Boolean
|
|
resource_id: String
|
|
resource_type: String
|
|
threshold: Number</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__GnocchiResourcesAlarm-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Ceilometer::GnocchiResourcesAlarm
|
|
Properties:
|
|
aggregation_method: String
|
|
alarm_actions: [Value, Value, ...]
|
|
comparison_operator: String
|
|
description: String
|
|
enabled: Boolean
|
|
evaluation_periods: Integer
|
|
granularity: Integer
|
|
insufficient_data_actions: [Value, Value, ...]
|
|
metric: String
|
|
ok_actions: [Value, Value, ...]
|
|
repeat_actions: Boolean
|
|
resource_id: String
|
|
resource_type: String
|
|
threshold: Number</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Ceilometer__GnocchiResourcesAlarm-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Ceilometer::GnocchiResourcesAlarm",
|
|
"Properties": {
|
|
"aggregation_method": String,
|
|
"alarm_actions": [Value, Value, ...],
|
|
"comparison_operator": String,
|
|
"description": String,
|
|
"enabled": Boolean,
|
|
"evaluation_periods": Integer,
|
|
"granularity": Integer,
|
|
"insufficient_data_actions": [Value, Value, ...],
|
|
"metric": String,
|
|
"ok_actions": [Value, Value, ...],
|
|
"repeat_actions": Boolean,
|
|
"resource_id": String,
|
|
"resource_type": String,
|
|
"threshold": Number
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Cinder__Volume">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Cinder::Volume</title>
|
|
<section xml:id="OS__Cinder__Volume-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">availability_zone</term>
|
|
<listitem>
|
|
<para>The availability zone in which the volume will be created.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">backup_id</term>
|
|
<listitem>
|
|
<para>If specified, the backup to create the volume from.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>A description of the volume.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">image</term>
|
|
<listitem>
|
|
<para>If specified, the name or ID of the image to create the volume from.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type glance.image</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">metadata</term>
|
|
<listitem>
|
|
<para>Key/value pairs to associate with the volume.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>A name used to distinguish the volume.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">scheduler_hints</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo)</para>
|
|
</note>
|
|
<para>Arbitrary key-value pairs specified by the client to help the Cinder scheduler creating a volume.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">size</term>
|
|
<listitem>
|
|
<para>The size of the volume in GB. On update only increase in size is supported.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>The value must be at least 1.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">snapshot_id</term>
|
|
<listitem>
|
|
<para>If specified, the snapshot to create the volume from.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type cinder.snapshot</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">source_volid</term>
|
|
<listitem>
|
|
<para>If specified, the volume to use as source.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type cinder.volume</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">volume_type</term>
|
|
<listitem>
|
|
<para>If specified, the type of volume to use, mapping to a specific backend.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type cinder.vtype</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">imageRef</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED - Use property image.</para>
|
|
</note>
|
|
<para>The ID of the image to create the volume from.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Cinder__Volume-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>attachments</term>
|
|
<listitem>
|
|
<para>The list of attachments of the volume.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>availability_zone</term>
|
|
<listitem>
|
|
<para>The availability zone in which the volume is located.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>bootable</term>
|
|
<listitem>
|
|
<para>Boolean indicating if the volume can be booted or not.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>created_at</term>
|
|
<listitem>
|
|
<para>The timestamp indicating volume creation.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>display_description</term>
|
|
<listitem>
|
|
<para>Description of the volume.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>display_name</term>
|
|
<listitem>
|
|
<para>Name of the volume.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>encrypted</term>
|
|
<listitem>
|
|
<para>Boolean indicating if the volume is encrypted or not.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>metadata</term>
|
|
<listitem>
|
|
<para>Key/value pairs associated with the volume.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>metadata_values</term>
|
|
<listitem>
|
|
<para>Key/value pairs associated with the volume in raw dict form.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>size</term>
|
|
<listitem>
|
|
<para>The size of the volume in GB.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>snapshot_id</term>
|
|
<listitem>
|
|
<para>The snapshot the volume was created from, if any.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>source_volid</term>
|
|
<listitem>
|
|
<para>The volume used as source, if any.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>status</term>
|
|
<listitem>
|
|
<para>The current status of the volume.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>volume_type</term>
|
|
<listitem>
|
|
<para>The type of the volume mapping to a backend, if any.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Cinder__Volume-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Cinder::Volume
|
|
properties:
|
|
availability_zone: String
|
|
backup_id: String
|
|
description: String
|
|
image: String
|
|
metadata: {...}
|
|
name: String
|
|
scheduler_hints: {...}
|
|
size: Integer
|
|
snapshot_id: String
|
|
source_volid: String
|
|
volume_type: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Cinder__Volume-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Cinder::Volume
|
|
Properties:
|
|
availability_zone: String
|
|
backup_id: String
|
|
description: String
|
|
image: String
|
|
metadata: {...}
|
|
name: String
|
|
scheduler_hints: {...}
|
|
size: Integer
|
|
snapshot_id: String
|
|
source_volid: String
|
|
volume_type: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Cinder__Volume-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Cinder::Volume",
|
|
"Properties": {
|
|
"availability_zone": String,
|
|
"backup_id": String,
|
|
"description": String,
|
|
"image": String,
|
|
"metadata": {...},
|
|
"name": String,
|
|
"scheduler_hints": {...},
|
|
"size": Integer,
|
|
"snapshot_id": String,
|
|
"source_volid": String,
|
|
"volume_type": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Cinder__VolumeAttachment">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Cinder::VolumeAttachment</title>
|
|
<section xml:id="OS__Cinder__VolumeAttachment-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">instance_uuid</term>
|
|
<listitem>
|
|
<para>The ID of the server to which the volume attaches.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">mountpoint</term>
|
|
<listitem>
|
|
<para>The location where the volume is exposed on the instance. This assignment may not be honored and it is advised that the path /dev/disk/by-id/virtio-<VolumeId> be used instead.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">volume_id</term>
|
|
<listitem>
|
|
<para>The ID of the volume to be attached.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Value must be of type cinder.volume</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Cinder__VolumeAttachment-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Cinder::VolumeAttachment
|
|
properties:
|
|
instance_uuid: String
|
|
mountpoint: String
|
|
volume_id: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Cinder__VolumeAttachment-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Cinder::VolumeAttachment
|
|
Properties:
|
|
instance_uuid: String
|
|
mountpoint: String
|
|
volume_id: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Cinder__VolumeAttachment-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Cinder::VolumeAttachment",
|
|
"Properties": {
|
|
"instance_uuid": String,
|
|
"mountpoint": String,
|
|
"volume_id": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Cinder__VolumeType">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Cinder::VolumeType</title>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo)</para>
|
|
</note>
|
|
<para>A resource for creating OpenStack virtual hardware templates.</para>
|
|
<para>Note that default cinder security policy usage of this resource
|
|
is limited to being used by administrators only.</para>
|
|
<section xml:id="OS__Cinder__VolumeType-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">metadata</term>
|
|
<listitem>
|
|
<para>The extra specs key and value pairs of the volume type.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name of the volume type.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Cinder__VolumeType-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Cinder::VolumeType
|
|
properties:
|
|
metadata: {...}
|
|
name: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Cinder__VolumeType-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Cinder::VolumeType
|
|
Properties:
|
|
metadata: {...}
|
|
name: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Cinder__VolumeType-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Cinder::VolumeType",
|
|
"Properties": {
|
|
"metadata": {...},
|
|
"name": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Glance__Image">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Glance::Image</title>
|
|
<note>
|
|
<para>Available since 2014.2 (Juno)</para>
|
|
</note>
|
|
<para>A resource managing for image in Glance.</para>
|
|
<section xml:id="OS__Glance__Image-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">container_format</term>
|
|
<listitem>
|
|
<para>Container format of image.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Allowed values: ami, ari, aki, bare, ova, ovf</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">disk_format</term>
|
|
<listitem>
|
|
<para>Disk format of image.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Allowed values: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, iso</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">id</term>
|
|
<listitem>
|
|
<para>The image ID. Glance will generate a UUID if not specified.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">is_public</term>
|
|
<listitem>
|
|
<para>Scope of image accessibility. Public or private. Default value is False means private.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "False".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">location</term>
|
|
<listitem>
|
|
<para>URL where the data for this image already resides. For example, if the image data is stored in swift, you could specify "swift://example.com/container/obj".</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">min_disk</term>
|
|
<listitem>
|
|
<para>Amount of disk space (in GB) required to boot image. Default value is 0 if not specified and means no limit on the disk size.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>The value must be at least 0.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">min_ram</term>
|
|
<listitem>
|
|
<para>Amount of ram (in MB) required to boot image. Default value is 0 if not specified and means no limit on the ram size.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>The value must be at least 0.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name for the image. The name of an image is not unique to a Image Service node.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">protected</term>
|
|
<listitem>
|
|
<para>Whether the image can be deleted. If the value is True, the image is protected and cannot be deleted.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Glance__Image-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Glance::Image
|
|
properties:
|
|
container_format: String
|
|
disk_format: String
|
|
id: String
|
|
is_public: Boolean
|
|
location: String
|
|
min_disk: Integer
|
|
min_ram: Integer
|
|
name: String
|
|
protected: Boolean</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Glance__Image-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Glance::Image
|
|
Properties:
|
|
container_format: String
|
|
disk_format: String
|
|
id: String
|
|
is_public: Boolean
|
|
location: String
|
|
min_disk: Integer
|
|
min_ram: Integer
|
|
name: String
|
|
protected: Boolean</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Glance__Image-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Glance::Image",
|
|
"Properties": {
|
|
"container_format": String,
|
|
"disk_format": String,
|
|
"id": String,
|
|
"is_public": Boolean,
|
|
"location": String,
|
|
"min_disk": Integer,
|
|
"min_ram": Integer,
|
|
"name": String,
|
|
"protected": Boolean
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__AccessPolicy">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::AccessPolicy</title>
|
|
<section xml:id="OS__Heat__AccessPolicy-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="List">AllowedResources</term>
|
|
<listitem>
|
|
<para>Resources that users are allowed to access by the DescribeStackResource API.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__AccessPolicy-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::AccessPolicy
|
|
properties:
|
|
AllowedResources: [Value, Value, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__AccessPolicy-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::AccessPolicy
|
|
Properties:
|
|
AllowedResources: [Value, Value, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__AccessPolicy-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::AccessPolicy",
|
|
"Properties": {
|
|
"AllowedResources": [Value, Value, ...]
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__AutoScalingGroup">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::AutoScalingGroup</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<para>An autoscaling group that can scale arbitrary resources.</para>
|
|
<section xml:id="OS__Heat__AutoScalingGroup-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Integer">cooldown</term>
|
|
<listitem>
|
|
<para>Cooldown period, in seconds.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">desired_capacity</term>
|
|
<listitem>
|
|
<para>Desired initial number of resources.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">max_size</term>
|
|
<listitem>
|
|
<para>Maximum number of resources in the group.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>The value must be at least 0.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">min_size</term>
|
|
<listitem>
|
|
<para>Minimum number of resources in the group.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>The value must be at least 0.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">resource</term>
|
|
<listitem>
|
|
<para>Resource definition for the resources in the group, in HOT format. The value of this property is the definition of a resource just as if it had been declared in the template itself.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">rolling_updates</term>
|
|
<listitem>
|
|
<para>Policy for rolling updates for this scaling group.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "{'min_in_service': 0, 'pause_time': 0, 'max_batch_size': 1}".</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Number">max_batch_size</term>
|
|
<listitem>
|
|
<para>The maximum number of resources to replace at once.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "1".</para>
|
|
<para>The value must be at least 0.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Number">min_in_service</term>
|
|
<listitem>
|
|
<para>The minimum number of resources in service while rolling updates are being executed.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "0".</para>
|
|
<para>The value must be at least 0.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Number">pause_time</term>
|
|
<listitem>
|
|
<para>The number of seconds to wait between batches of updates.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "0".</para>
|
|
<para>The value must be at least 0.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__AutoScalingGroup-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>current_size</term>
|
|
<listitem>
|
|
<para>The current size of AutoscalingResourceGroup.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>outputs</term>
|
|
<listitem>
|
|
<para>A map of resource names to the specified attribute of each individual resource.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>outputs_list</term>
|
|
<listitem>
|
|
<para>A list of the specified attribute of each individual resource.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__AutoScalingGroup-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::AutoScalingGroup
|
|
properties:
|
|
cooldown: Integer
|
|
desired_capacity: Integer
|
|
max_size: Integer
|
|
min_size: Integer
|
|
resource: {...}
|
|
rolling_updates: {"min_in_service": Number, "pause_time": Number, "max_batch_size": Number}</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__AutoScalingGroup-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::AutoScalingGroup
|
|
Properties:
|
|
cooldown: Integer
|
|
desired_capacity: Integer
|
|
max_size: Integer
|
|
min_size: Integer
|
|
resource: {...}
|
|
rolling_updates: {"min_in_service": Number, "pause_time": Number, "max_batch_size": Number}</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__AutoScalingGroup-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::AutoScalingGroup",
|
|
"Properties": {
|
|
"cooldown": Integer,
|
|
"desired_capacity": Integer,
|
|
"max_size": Integer,
|
|
"min_size": Integer,
|
|
"resource": {...},
|
|
"rolling_updates": {"min_in_service": Number, "pause_time": Number, "max_batch_size": Number}
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__CWLiteAlarm">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::CWLiteAlarm</title>
|
|
<note>
|
|
<para>DEPRECATED - OS::Heat::CWLiteAlarm is deprecated, use OS::Ceilometer::Alarm instead.</para>
|
|
</note>
|
|
<section xml:id="OS__Heat__CWLiteAlarm-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="List">AlarmActions</term>
|
|
<listitem>
|
|
<para>A list of actions to execute when state transitions to alarm.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">AlarmDescription</term>
|
|
<listitem>
|
|
<para>Description for the alarm.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">ComparisonOperator</term>
|
|
<listitem>
|
|
<para>Operator used to compare the specified Statistic with Threshold.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Allowed values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">Dimensions</term>
|
|
<listitem>
|
|
<para>A list of dimensions (arbitrary name/value pairs) associated with the metric.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">EvaluationPeriods</term>
|
|
<listitem>
|
|
<para>Number of periods to evaluate over.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">InsufficientDataActions</term>
|
|
<listitem>
|
|
<para>A list of actions to execute when state transitions to insufficient-data.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">MetricName</term>
|
|
<listitem>
|
|
<para>Metric name watched by the alarm.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">Namespace</term>
|
|
<listitem>
|
|
<para>Namespace for the metric.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">OKActions</term>
|
|
<listitem>
|
|
<para>A list of actions to execute when state transitions to ok.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">Period</term>
|
|
<listitem>
|
|
<para>Period (seconds) to evaluate over.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">Statistic</term>
|
|
<listitem>
|
|
<para>Metric statistic to evaluate.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Allowed values: SampleCount, Average, Sum, Minimum, Maximum</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">Threshold</term>
|
|
<listitem>
|
|
<para>Threshold to evaluate against.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">Units</term>
|
|
<listitem>
|
|
<para>Unit for the metric.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__CWLiteAlarm-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::CWLiteAlarm
|
|
properties:
|
|
AlarmActions: [Value, Value, ...]
|
|
AlarmDescription: String
|
|
ComparisonOperator: String
|
|
Dimensions: [Value, Value, ...]
|
|
EvaluationPeriods: String
|
|
InsufficientDataActions: [Value, Value, ...]
|
|
MetricName: String
|
|
Namespace: String
|
|
OKActions: [Value, Value, ...]
|
|
Period: String
|
|
Statistic: String
|
|
Threshold: String
|
|
Units: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__CWLiteAlarm-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::CWLiteAlarm
|
|
Properties:
|
|
AlarmActions: [Value, Value, ...]
|
|
AlarmDescription: String
|
|
ComparisonOperator: String
|
|
Dimensions: [Value, Value, ...]
|
|
EvaluationPeriods: String
|
|
InsufficientDataActions: [Value, Value, ...]
|
|
MetricName: String
|
|
Namespace: String
|
|
OKActions: [Value, Value, ...]
|
|
Period: String
|
|
Statistic: String
|
|
Threshold: String
|
|
Units: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__CWLiteAlarm-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::CWLiteAlarm",
|
|
"Properties": {
|
|
"AlarmActions": [Value, Value, ...],
|
|
"AlarmDescription": String,
|
|
"ComparisonOperator": String,
|
|
"Dimensions": [Value, Value, ...],
|
|
"EvaluationPeriods": String,
|
|
"InsufficientDataActions": [Value, Value, ...],
|
|
"MetricName": String,
|
|
"Namespace": String,
|
|
"OKActions": [Value, Value, ...],
|
|
"Period": String,
|
|
"Statistic": String,
|
|
"Threshold": String,
|
|
"Units": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__CloudConfig">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::CloudConfig</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<para>A configuration resource for representing cloud-init cloud-config.</para>
|
|
<para>This resource allows cloud-config YAML to be defined and stored by the
|
|
config API. Any intrinsic functions called in the config will be resolved
|
|
before storing the result.</para>
|
|
<para>This resource will generally be referenced by OS::Nova::Server user_data,
|
|
or OS::Heat::MultipartMime parts config. Since cloud-config is boot-only
|
|
configuration, any changes to the definition will result in the
|
|
replacement of all servers which reference it.</para>
|
|
<section xml:id="OS__Heat__CloudConfig-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">cloud_config</term>
|
|
<listitem>
|
|
<para>Map representing the cloud-config data structure which will be formatted as YAML.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__CloudConfig-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>config</term>
|
|
<listitem>
|
|
<para>The config value of the software config.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__CloudConfig-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::CloudConfig
|
|
properties:
|
|
cloud_config: {...}</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__CloudConfig-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::CloudConfig
|
|
Properties:
|
|
cloud_config: {...}</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__CloudConfig-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::CloudConfig",
|
|
"Properties": {
|
|
"cloud_config": {...}
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__HARestarter">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::HARestarter</title>
|
|
<note>
|
|
<para>DEPRECATED - The HARestarter resource type is unsupported 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.</para>
|
|
</note>
|
|
<section xml:id="OS__Heat__HARestarter-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">InstanceId</term>
|
|
<listitem>
|
|
<para>Instance ID to be restarted.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Value must be of type nova.server</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__HARestarter-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>AlarmUrl</term>
|
|
<listitem>
|
|
<para>A signed url to handle the alarm (Heat extension).</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__HARestarter-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::HARestarter
|
|
properties:
|
|
InstanceId: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__HARestarter-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::HARestarter
|
|
Properties:
|
|
InstanceId: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__HARestarter-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::HARestarter",
|
|
"Properties": {
|
|
"InstanceId": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__InstanceGroup">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::InstanceGroup</title>
|
|
<section xml:id="OS__Heat__InstanceGroup-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="List">AvailabilityZones</term>
|
|
<listitem>
|
|
<para>Not Implemented.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">LaunchConfigurationName</term>
|
|
<listitem>
|
|
<para>The reference to a LaunchConfiguration resource.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">LoadBalancerNames</term>
|
|
<listitem>
|
|
<para>List of LoadBalancer resources.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">Size</term>
|
|
<listitem>
|
|
<para>Desired number of instances.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">Tags</term>
|
|
<listitem>
|
|
<para>Tags to attach to this group.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">Key</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">Value</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__InstanceGroup-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>InstanceList</term>
|
|
<listitem>
|
|
<para>A comma-delimited list of server ip addresses. (Heat extension).</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__InstanceGroup-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::InstanceGroup
|
|
properties:
|
|
AvailabilityZones: [Value, Value, ...]
|
|
LaunchConfigurationName: String
|
|
LoadBalancerNames: [Value, Value, ...]
|
|
Size: Integer
|
|
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__InstanceGroup-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::InstanceGroup
|
|
Properties:
|
|
AvailabilityZones: [Value, Value, ...]
|
|
LaunchConfigurationName: String
|
|
LoadBalancerNames: [Value, Value, ...]
|
|
Size: Integer
|
|
Tags: [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__InstanceGroup-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::InstanceGroup",
|
|
"Properties": {
|
|
"AvailabilityZones": [Value, Value, ...],
|
|
"LaunchConfigurationName": String,
|
|
"LoadBalancerNames": [Value, Value, ...],
|
|
"Size": Integer,
|
|
"Tags": [{"Value": String, "Key": String}, {"Value": String, "Key": String}, ...]
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__MultipartMime">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::MultipartMime</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<para>A resource which assembles a collection of software configurations
|
|
as a multi-part mime message.</para>
|
|
<para>Parts in the message can be populated with inline configuration or
|
|
references to other config resources. If the referenced resource is itself
|
|
a valid multi-part mime message, that will be broken into parts and
|
|
those parts appended to this message.</para>
|
|
<para>The resulting multi-part mime message will be stored by the configs API
|
|
and can be referenced in properties such as OS::Nova::Server user_data.</para>
|
|
<para>This resource is generally used to build a list of cloud-init
|
|
configuration elements including scripts and cloud-config. Since
|
|
cloud-init is boot-only configuration, any changes to the definition
|
|
will result in the replacement of all servers which reference it.</para>
|
|
<section xml:id="OS__Heat__MultipartMime-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="List">parts</term>
|
|
<listitem>
|
|
<para>Parts belonging to this message.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "[]".</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">config</term>
|
|
<listitem>
|
|
<para>Content of part to attach, either inline or by referencing the ID of another software config resource</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">filename</term>
|
|
<listitem>
|
|
<para>Optional filename to associate with part.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">subtype</term>
|
|
<listitem>
|
|
<para>Optional subtype to specify with the type.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">type</term>
|
|
<listitem>
|
|
<para>Whether the part content is text or multipart.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "text".</para>
|
|
<para>Allowed values: text, multipart</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__MultipartMime-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>config</term>
|
|
<listitem>
|
|
<para>The config value of the software config.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__MultipartMime-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::MultipartMime
|
|
properties:
|
|
parts: [{"type": String, "subtype": String, "config": String, "filename": String}, {"type": String, "subtype": String, "config": String, "filename": String}, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__MultipartMime-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::MultipartMime
|
|
Properties:
|
|
parts: [{"type": String, "subtype": String, "config": String, "filename": String}, {"type": String, "subtype": String, "config": String, "filename": String}, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__MultipartMime-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::MultipartMime",
|
|
"Properties": {
|
|
"parts": [{"type": String, "subtype": String, "config": String, "filename": String}, {"type": String, "subtype": String, "config": String, "filename": String}, ...]
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__RandomString">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::RandomString</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<para>A resource which generates a random string.</para>
|
|
<para>This is useful for configuring passwords and secrets on services.</para>
|
|
<section xml:id="OS__Heat__RandomString-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="List">character_classes</term>
|
|
<listitem>
|
|
<para>A list of character class and their constraints to generate the random string from.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">class</term>
|
|
<listitem>
|
|
<para>A character class and its corresponding min constraint to generate the random string from.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "lettersdigits".</para>
|
|
<para>Allowed values: lettersdigits, letters, lowercase, uppercase, digits, hexdigits, octdigits</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">min</term>
|
|
<listitem>
|
|
<para>The minimum number of characters from this character class that will be in the generated string.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "1".</para>
|
|
<para>The value must be in the range 1 to 512.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">character_sequences</term>
|
|
<listitem>
|
|
<para>A list of character sequences and their constraints to generate the random string from.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Integer">min</term>
|
|
<listitem>
|
|
<para>The minimum number of characters from this sequence that will be in the generated string.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "1".</para>
|
|
<para>The value must be in the range 1 to 512.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">sequence</term>
|
|
<listitem>
|
|
<para>A character sequence and its corresponding min constraint to generate the random string from.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">length</term>
|
|
<listitem>
|
|
<para>Length of the string to generate.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "32".</para>
|
|
<para>The value must be in the range 1 to 512.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">salt</term>
|
|
<listitem>
|
|
<para>Value which can be set or changed on stack update to trigger the resource for replacement with a new random string . The salt value itself is ignored by the random generator.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">sequence</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED - Use property character_classes.</para>
|
|
</note>
|
|
<para>Sequence of characters to build the random string from.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: lettersdigits, letters, lowercase, uppercase, digits, hexdigits, octdigits</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__RandomString-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>value</term>
|
|
<listitem>
|
|
<para>The random string generated by this resource. This value is also available by referencing the resource.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__RandomString-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::RandomString
|
|
properties:
|
|
character_classes: [{"class": String, "min": Integer}, {"class": String, "min": Integer}, ...]
|
|
character_sequences: [{"min": Integer, "sequence": String}, {"min": Integer, "sequence": String}, ...]
|
|
length: Integer
|
|
salt: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__RandomString-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::RandomString
|
|
Properties:
|
|
character_classes: [{"class": String, "min": Integer}, {"class": String, "min": Integer}, ...]
|
|
character_sequences: [{"min": Integer, "sequence": String}, {"min": Integer, "sequence": String}, ...]
|
|
length: Integer
|
|
salt: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__RandomString-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::RandomString",
|
|
"Properties": {
|
|
"character_classes": [{"class": String, "min": Integer}, {"class": String, "min": Integer}, ...],
|
|
"character_sequences": [{"min": Integer, "sequence": String}, {"min": Integer, "sequence": String}, ...],
|
|
"length": Integer,
|
|
"salt": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__ResourceGroup">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::ResourceGroup</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<para>A resource that creates one or more identically configured nested
|
|
resources.</para>
|
|
<para>In addition to the <citetitle>refs</citetitle> attribute, this resource implements synthetic
|
|
attributes that mirror those of the resources in the group. When
|
|
getting an attribute from this resource, however, a list of attribute
|
|
values for each resource in the group is returned. To get attribute values
|
|
for a single resource in the group, synthetic attributes of the form
|
|
<citetitle>resource.{resource index}.{attribute name}</citetitle> can be used. The resource ID
|
|
of a particular resource in the group can be obtained via the synthetic
|
|
attribute <citetitle>resource.{resource index}</citetitle>.</para>
|
|
<para>While each resource in the group will be identically configured, this
|
|
resource does allow for some index-based customization of the properties
|
|
of the resources in the group. For example:</para>
|
|
<programlisting>resources:
|
|
my_indexed_group:
|
|
type: OS::Heat::ResourceGroup
|
|
properties:
|
|
count: 3
|
|
resource_def:
|
|
type: OS::Nova::Server
|
|
properties:
|
|
# create a unique name for each server
|
|
# using its index in the group
|
|
name: my_server_%index%
|
|
image: CentOS 6.5
|
|
flavor: 4GB Performance</programlisting>
|
|
<para>would result in a group of three servers having the same image and flavor,
|
|
but names of <citetitle>my_server_0</citetitle>, <citetitle>my_server_1</citetitle>, and <citetitle>my_server_2</citetitle>. The variable
|
|
used for substitution can be customized by using the <citetitle>index_var</citetitle> property.</para>
|
|
<section xml:id="OS__Heat__ResourceGroup-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Integer">count</term>
|
|
<listitem>
|
|
<para>The number of instances to create.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "1".</para>
|
|
<para>The value must be at least 0.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">index_var</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2014.2 (Juno)</para>
|
|
</note>
|
|
<para>A variable that this resource will use to replace with the current index of a given resource in the group. Can be used, for example, to customize the name property of grouped servers in order to differentiate them when listed with nova client.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "%index%".</para>
|
|
<para>The length must be at least 3.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">removal_policies</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo)</para>
|
|
</note>
|
|
<para>Policies for removal of resources on update</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "[]".</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Policy to be processed when doing an update which requires removal of specific resources.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="List">resource_list</term>
|
|
<listitem>
|
|
<para>List of resources to be removed when doing an update which requires removal of specific resources. The resource may be specified several ways: (1) The resource name, as in the nested stack, (2) The resource reference returned from get_resource in a template, as available via the 'refs' attribute Note this is destructive on update when specified; even if the count is not being reduced, and once a resource name is removed, it's name is never reused in subsequent updates</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "[]".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">resource_def</term>
|
|
<listitem>
|
|
<para>Resource definition for the resources in the group. The value of this property is the definition of a resource just as if it had been declared in the template itself.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">properties</term>
|
|
<listitem>
|
|
<para>Property values for the resources in the group</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">type</term>
|
|
<listitem>
|
|
<para>The type of the resources in the group</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__ResourceGroup-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>attributes</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2014.2 (Juno)</para>
|
|
</note>
|
|
<para>A map of resource names to the specified attribute of each individual resource. Requires heat_template_version: 2014-10-16.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>refs</term>
|
|
<listitem>
|
|
<para>A list of resource IDs for the resources in the group</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__ResourceGroup-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::ResourceGroup
|
|
properties:
|
|
count: Integer
|
|
index_var: String
|
|
removal_policies: [{"resource_list": [Value, Value, ...]}, {"resource_list": [Value, Value, ...]}, ...]
|
|
resource_def: {"type": String, "properties": {...}}</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__ResourceGroup-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::ResourceGroup
|
|
Properties:
|
|
count: Integer
|
|
index_var: String
|
|
removal_policies: [{"resource_list": [Value, Value, ...]}, {"resource_list": [Value, Value, ...]}, ...]
|
|
resource_def: {"type": String, "properties": {...}}</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__ResourceGroup-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::ResourceGroup",
|
|
"Properties": {
|
|
"count": Integer,
|
|
"index_var": String,
|
|
"removal_policies": [{"resource_list": [Value, Value, ...]}, {"resource_list": [Value, Value, ...]}, ...],
|
|
"resource_def": {"type": String, "properties": {...}}
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__ScalingPolicy">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::ScalingPolicy</title>
|
|
<para>A resource to manage scaling of <citetitle>OS::Heat::AutoScalingGroup</citetitle>.</para>
|
|
<para><emphasis role="Note"/> while it may incidentally support
|
|
<citetitle>AWS::AutoScaling::AutoScalingGroup</citetitle> for now, please don't use it for that
|
|
purpose and use <citetitle>AWS::AutoScaling::ScalingPolicy</citetitle> instead.</para>
|
|
<section xml:id="OS__Heat__ScalingPolicy-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">adjustment_type</term>
|
|
<listitem>
|
|
<para>Type of adjustment (absolute or percentage).</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Allowed values: change_in_capacity, exact_capacity, percent_change_in_capacity</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">auto_scaling_group_id</term>
|
|
<listitem>
|
|
<para>AutoScaling group ID to apply policy to.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Number">cooldown</term>
|
|
<listitem>
|
|
<para>Cooldown period, in seconds.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Number">scaling_adjustment</term>
|
|
<listitem>
|
|
<para>Size of adjustment.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__ScalingPolicy-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>alarm_url</term>
|
|
<listitem>
|
|
<para>A signed url to handle the alarm.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__ScalingPolicy-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::ScalingPolicy
|
|
properties:
|
|
adjustment_type: String
|
|
auto_scaling_group_id: String
|
|
cooldown: Number
|
|
scaling_adjustment: Number</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__ScalingPolicy-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::ScalingPolicy
|
|
Properties:
|
|
adjustment_type: String
|
|
auto_scaling_group_id: String
|
|
cooldown: Number
|
|
scaling_adjustment: Number</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__ScalingPolicy-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::ScalingPolicy",
|
|
"Properties": {
|
|
"adjustment_type": String,
|
|
"auto_scaling_group_id": String,
|
|
"cooldown": Number,
|
|
"scaling_adjustment": Number
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareComponent">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::SoftwareComponent</title>
|
|
<note>
|
|
<para>Available since 2014.2 (Juno)</para>
|
|
</note>
|
|
<para>A resource for describing and storing a software component.</para>
|
|
<para>This resource is similar to OS::Heat::SoftwareConfig. In contrast to
|
|
SoftwareConfig which allows for storing only one configuration (e.g. one
|
|
script), SoftwareComponent allows for storing multiple configurations to
|
|
address handling of all lifecycle hooks (CREATE, UPDATE, SUSPEND, RESUME,
|
|
DELETE) for a software component in one place.</para>
|
|
<para>This resource is backed by the persistence layer and the API of the
|
|
SoftwareConfig resource, and only adds handling for the additional
|
|
'configs' property and attribute.</para>
|
|
<section xml:id="OS__Heat__SoftwareComponent-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="List">configs</term>
|
|
<listitem>
|
|
<para>The list of configurations for the different lifecycle actions of the represented software component.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>The length must be at least 1.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="List">actions</term>
|
|
<listitem>
|
|
<para>Lifecycle actions to which the configuration applies. The string values provided for this property can include the standard resource actions CREATE, DELETE, UPDATE, SUSPEND and RESUME supported by Heat.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "['CREATE', 'UPDATE']".</para>
|
|
<para>The length must be at least 1.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">config</term>
|
|
<listitem>
|
|
<para>Configuration script or manifest which specifies what actual configuration is performed.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">tool</term>
|
|
<listitem>
|
|
<para>The configuration tool used to actually apply the configuration on a server. This string property has to be understood by in-instance tools running inside deployed servers.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">inputs</term>
|
|
<listitem>
|
|
<para>Schema representing the inputs that this software config is expecting.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">default</term>
|
|
<listitem>
|
|
<para>Default value for the input if none is specified.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description of the input.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name of the input.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">type</term>
|
|
<listitem>
|
|
<para>Type of the value of the input.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "String".</para>
|
|
<para>Allowed values: String, Number, CommaDelimitedList, Json</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">options</term>
|
|
<listitem>
|
|
<para>Map containing options specific to the configuration management tool used by this resource.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">outputs</term>
|
|
<listitem>
|
|
<para>Schema representing the outputs that this software config will produce.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description of the output.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">error_output</term>
|
|
<listitem>
|
|
<para>Denotes that the deployment is in an error state if this output has a value.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "False".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name of the output.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">type</term>
|
|
<listitem>
|
|
<para>Type of the value of the output.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "String".</para>
|
|
<para>Allowed values: String, Number, CommaDelimitedList, Json</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareComponent-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>config</term>
|
|
<listitem>
|
|
<para>The config value of the software config.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareComponent-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::SoftwareComponent
|
|
properties:
|
|
configs: [{"tool": String, "config": String, "actions": [String, String, ...]}, {"tool": String, "config": String, "actions": [String, String, ...]}, ...]
|
|
inputs: [{"default": String, "type": String, "name": String, "description": String}, {"default": String, "type": String, "name": String, "description": String}, ...]
|
|
options: {...}
|
|
outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareComponent-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::SoftwareComponent
|
|
Properties:
|
|
configs: [{"tool": String, "config": String, "actions": [String, String, ...]}, {"tool": String, "config": String, "actions": [String, String, ...]}, ...]
|
|
inputs: [{"default": String, "type": String, "name": String, "description": String}, {"default": String, "type": String, "name": String, "description": String}, ...]
|
|
options: {...}
|
|
outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareComponent-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::SoftwareComponent",
|
|
"Properties": {
|
|
"configs": [{"tool": String, "config": String, "actions": [String, String, ...]}, {"tool": String, "config": String, "actions": [String, String, ...]}, ...],
|
|
"inputs": [{"default": String, "type": String, "name": String, "description": String}, {"default": String, "type": String, "name": String, "description": String}, ...],
|
|
"options": {...},
|
|
"outputs": [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareConfig">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::SoftwareConfig</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<para>A resource for describing and storing software configuration.</para>
|
|
<para>The software_configs API which backs this resource creates immutable
|
|
configs, so any change to the template resource definition will result
|
|
in a new config being created, and the old one being deleted.</para>
|
|
<para>Configs can be defined in the same template which uses them, or they can
|
|
be created in one stack, and passed to another stack via a parameter.</para>
|
|
<para>A config resource can be referenced in other resource properties which
|
|
are config-aware. This includes the properties OS::Nova::Server user_data,
|
|
OS::Heat::SoftwareDeployment config and OS::Heat::MultipartMime parts
|
|
config.</para>
|
|
<para>Along with the config script itself, this resource can define schemas for
|
|
inputs and outputs which the config script is expected to consume and
|
|
produce. Inputs and outputs are optional and will map to concepts which
|
|
are specific to the configuration tool being used.</para>
|
|
<section xml:id="OS__Heat__SoftwareConfig-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">config</term>
|
|
<listitem>
|
|
<para>Configuration script or manifest which specifies what actual configuration is performed.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">group</term>
|
|
<listitem>
|
|
<para>Namespace to group this software config by when delivered to a server. This may imply what configuration tool is going to perform the configuration.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "Heat::Ungrouped".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">inputs</term>
|
|
<listitem>
|
|
<para>Schema representing the inputs that this software config is expecting.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">default</term>
|
|
<listitem>
|
|
<para>Default value for the input if none is specified.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description of the input.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name of the input.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">type</term>
|
|
<listitem>
|
|
<para>Type of the value of the input.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "String".</para>
|
|
<para>Allowed values: String, Number, CommaDelimitedList, Json</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">options</term>
|
|
<listitem>
|
|
<para>Map containing options specific to the configuration management tool used by this resource.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">outputs</term>
|
|
<listitem>
|
|
<para>Schema representing the outputs that this software config will produce.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description of the output.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">error_output</term>
|
|
<listitem>
|
|
<para>Denotes that the deployment is in an error state if this output has a value.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "False".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name of the output.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">type</term>
|
|
<listitem>
|
|
<para>Type of the value of the output.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "String".</para>
|
|
<para>Allowed values: String, Number, CommaDelimitedList, Json</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareConfig-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>config</term>
|
|
<listitem>
|
|
<para>The config value of the software config.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareConfig-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::SoftwareConfig
|
|
properties:
|
|
config: String
|
|
group: String
|
|
inputs: [{"default": String, "type": String, "name": String, "description": String}, {"default": String, "type": String, "name": String, "description": String}, ...]
|
|
options: {...}
|
|
outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareConfig-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::SoftwareConfig
|
|
Properties:
|
|
config: String
|
|
group: String
|
|
inputs: [{"default": String, "type": String, "name": String, "description": String}, {"default": String, "type": String, "name": String, "description": String}, ...]
|
|
options: {...}
|
|
outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareConfig-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::SoftwareConfig",
|
|
"Properties": {
|
|
"config": String,
|
|
"group": String,
|
|
"inputs": [{"default": String, "type": String, "name": String, "description": String}, {"default": String, "type": String, "name": String, "description": String}, ...],
|
|
"options": {...},
|
|
"outputs": [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareDeployment">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::SoftwareDeployment</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<para>This resource associates a server with some configuration which
|
|
is to be deployed to that server.</para>
|
|
<para>A deployment allows input values to be specified which map to the inputs
|
|
schema defined in the config resource. These input values are interpreted
|
|
by the configuration tool in a tool-specific manner.</para>
|
|
<para>Whenever this resource goes to an IN_PROGRESS state, it creates an
|
|
ephemeral config that includes the inputs values plus a number of extra
|
|
inputs which have names prefixed with deploy_. The extra inputs relate
|
|
to the current state of the stack, along with the information and
|
|
credentials required to signal back the deployment results.</para>
|
|
<para>Unless signal_transport=NO_SIGNAL, this resource will remain in an
|
|
IN_PROGRESS state until the server signals it with the output values
|
|
for that deployment. Those output values are then available as resource
|
|
attributes, along with the default attributes deploy_stdout,
|
|
deploy_stderr and deploy_status_code.</para>
|
|
<para>Specifying actions other than the default CREATE and UPDATE will result
|
|
in the deployment being triggered in those actions. For example this would
|
|
allow cleanup configuration to be performed during actions SUSPEND and
|
|
DELETE. A config could be designed to only work with some specific
|
|
actions, or a config can read the value of the deploy_action input to
|
|
allow conditional logic to perform different configuration for different
|
|
actions.</para>
|
|
<section xml:id="OS__Heat__SoftwareDeployment-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="List">actions</term>
|
|
<listitem>
|
|
<para>Which stack actions will result in this deployment being triggered.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "['CREATE', 'UPDATE']".</para>
|
|
<para>Allowed values: CREATE, UPDATE, DELETE, SUSPEND, RESUME</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">config</term>
|
|
<listitem>
|
|
<para>ID of software configuration resource to execute when applying to the server.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">input_values</term>
|
|
<listitem>
|
|
<para>Input values to apply to the software configuration on this server.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>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.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">server</term>
|
|
<listitem>
|
|
<para>ID of Nova server to apply configuration to.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type nova.server</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">signal_transport</term>
|
|
<listitem>
|
|
<para>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. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "CFN_SIGNAL".</para>
|
|
<para>Allowed values: CFN_SIGNAL, TEMP_URL_SIGNAL, HEAT_SIGNAL, NO_SIGNAL</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareDeployment-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>deploy_status_code</term>
|
|
<listitem>
|
|
<para>Returned status code from the configuration execution</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>deploy_stderr</term>
|
|
<listitem>
|
|
<para>Captured stderr from the configuration execution.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>deploy_stdout</term>
|
|
<listitem>
|
|
<para>Captured stdout from the configuration execution.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareDeployment-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::SoftwareDeployment
|
|
properties:
|
|
actions: [Value, Value, ...]
|
|
config: String
|
|
input_values: {...}
|
|
name: String
|
|
server: String
|
|
signal_transport: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareDeployment-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::SoftwareDeployment
|
|
Properties:
|
|
actions: [Value, Value, ...]
|
|
config: String
|
|
input_values: {...}
|
|
name: String
|
|
server: String
|
|
signal_transport: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareDeployment-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::SoftwareDeployment",
|
|
"Properties": {
|
|
"actions": [Value, Value, ...],
|
|
"config": String,
|
|
"input_values": {...},
|
|
"name": String,
|
|
"server": String,
|
|
"signal_transport": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareDeployments">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::SoftwareDeployments</title>
|
|
<note>
|
|
<para>Available since 2014.2 (Juno)</para>
|
|
</note>
|
|
<section xml:id="OS__Heat__SoftwareDeployments-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="List">actions</term>
|
|
<listitem>
|
|
<para>Which stack actions will result in this deployment being triggered.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "['CREATE', 'UPDATE']".</para>
|
|
<para>Allowed values: CREATE, UPDATE, DELETE, SUSPEND, RESUME</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">config</term>
|
|
<listitem>
|
|
<para>ID of software configuration resource to execute when applying to the server.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">input_values</term>
|
|
<listitem>
|
|
<para>Input values to apply to the software configuration on this server.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>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.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">servers</term>
|
|
<listitem>
|
|
<para>A map of Nova names and IDs to apply configuration to.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">signal_transport</term>
|
|
<listitem>
|
|
<para>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. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "CFN_SIGNAL".</para>
|
|
<para>Allowed values: CFN_SIGNAL, TEMP_URL_SIGNAL, HEAT_SIGNAL, NO_SIGNAL</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareDeployments-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>deploy_status_codes</term>
|
|
<listitem>
|
|
<para>A map of Nova names and returned status code from the configuration execution</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>deploy_stderrs</term>
|
|
<listitem>
|
|
<para>A map of Nova names and captured stderrs from the configuration execution to each server.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>deploy_stdouts</term>
|
|
<listitem>
|
|
<para>A map of Nova names and captured stdouts from the configuration execution to each server.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareDeployments-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::SoftwareDeployments
|
|
properties:
|
|
actions: [Value, Value, ...]
|
|
config: String
|
|
input_values: {...}
|
|
name: String
|
|
servers: {...}
|
|
signal_transport: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareDeployments-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::SoftwareDeployments
|
|
Properties:
|
|
actions: [Value, Value, ...]
|
|
config: String
|
|
input_values: {...}
|
|
name: String
|
|
servers: {...}
|
|
signal_transport: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__SoftwareDeployments-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::SoftwareDeployments",
|
|
"Properties": {
|
|
"actions": [Value, Value, ...],
|
|
"config": String,
|
|
"input_values": {...},
|
|
"name": String,
|
|
"servers": {...},
|
|
"signal_transport": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__Stack">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::Stack</title>
|
|
<para>A Resource representing a stack which can be created using specified
|
|
context.</para>
|
|
<section xml:id="OS__Heat__Stack-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">context</term>
|
|
<listitem>
|
|
<para>Context for this stack.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">region_name</term>
|
|
<listitem>
|
|
<para>Region name in which this stack will be created.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">parameters</term>
|
|
<listitem>
|
|
<para>Set of parameters passed to this stack.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "{}".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">template</term>
|
|
<listitem>
|
|
<para>Template that specifies the stack to be created as a resource.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Number">timeout</term>
|
|
<listitem>
|
|
<para>Number of minutes to wait for this stack creation.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__Stack-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>outputs</term>
|
|
<listitem>
|
|
<para>A dict of key-value pairs output from the stack.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>stack_name</term>
|
|
<listitem>
|
|
<para>Name of the stack.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__Stack-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::Stack
|
|
properties:
|
|
context: {"region_name": String}
|
|
parameters: {...}
|
|
template: String
|
|
timeout: Number</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__Stack-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::Stack
|
|
Properties:
|
|
context: {"region_name": String}
|
|
parameters: {...}
|
|
template: String
|
|
timeout: Number</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__Stack-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::Stack",
|
|
"Properties": {
|
|
"context": {"region_name": String},
|
|
"parameters": {...},
|
|
"template": String,
|
|
"timeout": Number
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__StructuredConfig">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::StructuredConfig</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<para>This resource is like OS::Heat::SoftwareConfig except that the config
|
|
property is represented by a Map rather than a String.</para>
|
|
<para>This is useful for configuration tools which use YAML or JSON as their
|
|
configuration syntax. The resulting configuration is transferred,
|
|
stored and returned by the software_configs API as parsed JSON.</para>
|
|
<section xml:id="OS__Heat__StructuredConfig-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">config</term>
|
|
<listitem>
|
|
<para>Map representing the configuration data structure which will be serialized to JSON format.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">group</term>
|
|
<listitem>
|
|
<para>Namespace to group this software config by when delivered to a server. This may imply what configuration tool is going to perform the configuration.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "Heat::Ungrouped".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">inputs</term>
|
|
<listitem>
|
|
<para>Schema representing the inputs that this software config is expecting.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">default</term>
|
|
<listitem>
|
|
<para>Default value for the input if none is specified.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description of the input.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name of the input.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">type</term>
|
|
<listitem>
|
|
<para>Type of the value of the input.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "String".</para>
|
|
<para>Allowed values: String, Number, CommaDelimitedList, Json</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">options</term>
|
|
<listitem>
|
|
<para>Map containing options specific to the configuration management tool used by this resource.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">outputs</term>
|
|
<listitem>
|
|
<para>Schema representing the outputs that this software config will produce.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description of the output.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">error_output</term>
|
|
<listitem>
|
|
<para>Denotes that the deployment is in an error state if this output has a value.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "False".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name of the output.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">type</term>
|
|
<listitem>
|
|
<para>Type of the value of the output.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "String".</para>
|
|
<para>Allowed values: String, Number, CommaDelimitedList, Json</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__StructuredConfig-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>config</term>
|
|
<listitem>
|
|
<para>The config value of the software config.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__StructuredConfig-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::StructuredConfig
|
|
properties:
|
|
config: {...}
|
|
group: String
|
|
inputs: [{"default": String, "type": String, "name": String, "description": String}, {"default": String, "type": String, "name": String, "description": String}, ...]
|
|
options: {...}
|
|
outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__StructuredConfig-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::StructuredConfig
|
|
Properties:
|
|
config: {...}
|
|
group: String
|
|
inputs: [{"default": String, "type": String, "name": String, "description": String}, {"default": String, "type": String, "name": String, "description": String}, ...]
|
|
options: {...}
|
|
outputs: [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__StructuredConfig-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::StructuredConfig",
|
|
"Properties": {
|
|
"config": {...},
|
|
"group": String,
|
|
"inputs": [{"default": String, "type": String, "name": String, "description": String}, {"default": String, "type": String, "name": String, "description": String}, ...],
|
|
"options": {...},
|
|
"outputs": [{"type": String, "name": String, "error_output": Boolean, "description": String}, {"type": String, "name": String, "error_output": Boolean, "description": String}, ...]
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__StructuredDeployment">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::StructuredDeployment</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<para>A deployment resource like OS::Heat::SoftwareDeployment, but which
|
|
performs input value substitution on the config defined by a
|
|
OS::Heat::StructuredConfig resource.</para>
|
|
<para>Some configuration tools have no concept of inputs, so the input value
|
|
substitution needs to occur in the deployment resource. An example of this
|
|
is the JSON metadata consumed by the cfn-init tool.</para>
|
|
<para>Where the config contains {get_input: input_name} this will be substituted
|
|
with the value of input_name in this resource's input_values. If get_input
|
|
needs to be passed through to the substituted configuration then a
|
|
different input_key property value can be specified.</para>
|
|
<section xml:id="OS__Heat__StructuredDeployment-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="List">actions</term>
|
|
<listitem>
|
|
<para>Which stack actions will result in this deployment being triggered.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "['CREATE', 'UPDATE']".</para>
|
|
<para>Allowed values: CREATE, UPDATE, DELETE, SUSPEND, RESUME</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">config</term>
|
|
<listitem>
|
|
<para>ID of software configuration resource to execute when applying to the server.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">input_key</term>
|
|
<listitem>
|
|
<para>Name of key to use for substituting inputs during deployment</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "get_input".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">input_values</term>
|
|
<listitem>
|
|
<para>Input values to apply to the software configuration on this server.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">input_values_validate</term>
|
|
<listitem>
|
|
<para>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.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "LAX".</para>
|
|
<para>Allowed values: LAX, STRICT</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>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.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">server</term>
|
|
<listitem>
|
|
<para>ID of Nova server to apply configuration to.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type nova.server</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">signal_transport</term>
|
|
<listitem>
|
|
<para>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. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "CFN_SIGNAL".</para>
|
|
<para>Allowed values: CFN_SIGNAL, TEMP_URL_SIGNAL, HEAT_SIGNAL, NO_SIGNAL</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__StructuredDeployment-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>deploy_status_code</term>
|
|
<listitem>
|
|
<para>Returned status code from the configuration execution</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>deploy_stderr</term>
|
|
<listitem>
|
|
<para>Captured stderr from the configuration execution.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>deploy_stdout</term>
|
|
<listitem>
|
|
<para>Captured stdout from the configuration execution.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__StructuredDeployment-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::StructuredDeployment
|
|
properties:
|
|
actions: [Value, Value, ...]
|
|
config: String
|
|
input_key: String
|
|
input_values: {...}
|
|
input_values_validate: String
|
|
name: String
|
|
server: String
|
|
signal_transport: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__StructuredDeployment-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::StructuredDeployment
|
|
Properties:
|
|
actions: [Value, Value, ...]
|
|
config: String
|
|
input_key: String
|
|
input_values: {...}
|
|
input_values_validate: String
|
|
name: String
|
|
server: String
|
|
signal_transport: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__StructuredDeployment-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::StructuredDeployment",
|
|
"Properties": {
|
|
"actions": [Value, Value, ...],
|
|
"config": String,
|
|
"input_key": String,
|
|
"input_values": {...},
|
|
"input_values_validate": String,
|
|
"name": String,
|
|
"server": String,
|
|
"signal_transport": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__StructuredDeployments">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::StructuredDeployments</title>
|
|
<note>
|
|
<para>Available since 2014.2 (Juno)</para>
|
|
</note>
|
|
<section xml:id="OS__Heat__StructuredDeployments-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="List">actions</term>
|
|
<listitem>
|
|
<para>Which stack actions will result in this deployment being triggered.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "['CREATE', 'UPDATE']".</para>
|
|
<para>Allowed values: CREATE, UPDATE, DELETE, SUSPEND, RESUME</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">config</term>
|
|
<listitem>
|
|
<para>ID of software configuration resource to execute when applying to the server.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">input_key</term>
|
|
<listitem>
|
|
<para>Name of key to use for substituting inputs during deployment</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "get_input".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">input_values</term>
|
|
<listitem>
|
|
<para>Input values to apply to the software configuration on this server.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">input_values_validate</term>
|
|
<listitem>
|
|
<para>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.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "LAX".</para>
|
|
<para>Allowed values: LAX, STRICT</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>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.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">servers</term>
|
|
<listitem>
|
|
<para>A map of Nova names and IDs to apply configuration to.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">signal_transport</term>
|
|
<listitem>
|
|
<para>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. NO_SIGNAL will result in the resource going to the COMPLETE state without waiting for any signal.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "CFN_SIGNAL".</para>
|
|
<para>Allowed values: CFN_SIGNAL, TEMP_URL_SIGNAL, HEAT_SIGNAL, NO_SIGNAL</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__StructuredDeployments-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>deploy_status_codes</term>
|
|
<listitem>
|
|
<para>A map of Nova names and returned status code from the configuration execution</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>deploy_stderrs</term>
|
|
<listitem>
|
|
<para>A map of Nova names and captured stderrs from the configuration execution to each server.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>deploy_stdouts</term>
|
|
<listitem>
|
|
<para>A map of Nova names and captured stdouts from the configuration execution to each server.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__StructuredDeployments-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
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</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__StructuredDeployments-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
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</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__StructuredDeployments-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"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
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__SwiftSignal">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::SwiftSignal</title>
|
|
<note>
|
|
<para>Available since 2014.2 (Juno)</para>
|
|
</note>
|
|
<section xml:id="OS__Heat__SwiftSignal-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Number">count</term>
|
|
<listitem>
|
|
<para>The number of success signals that must be received before the stack creation process continues.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "1".</para>
|
|
<para>The value must be in the range 1 to 1000.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">handle</term>
|
|
<listitem>
|
|
<para>URL of TempURL where resource will signal completion and optionally upload data.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Number">timeout</term>
|
|
<listitem>
|
|
<para>The maximum number of seconds to wait for the resource to signal completion. Once the timeout is reached, creation of the signal resource will fail.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>The value must be in the range 1 to 43200.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__SwiftSignal-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>data</term>
|
|
<listitem>
|
|
<para>JSON data that was uploaded via the SwiftSignalHandle.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__SwiftSignal-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::SwiftSignal
|
|
properties:
|
|
count: Number
|
|
handle: String
|
|
timeout: Number</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__SwiftSignal-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::SwiftSignal
|
|
Properties:
|
|
count: Number
|
|
handle: String
|
|
timeout: Number</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__SwiftSignal-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::SwiftSignal",
|
|
"Properties": {
|
|
"count": Number,
|
|
"handle": String,
|
|
"timeout": Number
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__SwiftSignalHandle">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::SwiftSignalHandle</title>
|
|
<note>
|
|
<para>Available since 2014.2 (Juno)</para>
|
|
</note>
|
|
<section xml:id="OS__Heat__SwiftSignalHandle-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>curl_cli</term>
|
|
<listitem>
|
|
<para>Convenience attribute, provides curl CLI command prefix, which can be used for signalling handle completion or failure. You can signal success by adding --data-binary '{"status": "SUCCESS"}' , or signal failure by adding --data-binary '{"status": "FAILURE"}'</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>endpoint</term>
|
|
<listitem>
|
|
<para>Endpoint/url which can be used for signalling handle</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>token</term>
|
|
<listitem>
|
|
<para>Tokens are not needed for Swift TempURLs. This attribute is being kept for compatibility with the OS::Heat::WaitConditionHandle resource</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__SwiftSignalHandle-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::SwiftSignalHandle</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__SwiftSignalHandle-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::SwiftSignalHandle</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__SwiftSignalHandle-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::SwiftSignalHandle"
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__UpdateWaitConditionHandle">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::UpdateWaitConditionHandle</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<para>This works identically to a regular WaitConditionHandle, except that
|
|
on update it clears all signals received and changes the handle. Using
|
|
this handle means that you must setup the signal senders to send their
|
|
signals again any time the update handle changes. This allows us to roll
|
|
out new configurations and be confident that they are rolled out once
|
|
UPDATE COMPLETE is reached.</para>
|
|
<section xml:id="OS__Heat__UpdateWaitConditionHandle-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::UpdateWaitConditionHandle</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__UpdateWaitConditionHandle-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::UpdateWaitConditionHandle</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__UpdateWaitConditionHandle-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::UpdateWaitConditionHandle"
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__WaitCondition">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::WaitCondition</title>
|
|
<note>
|
|
<para>Available since 2014.2 (Juno)</para>
|
|
</note>
|
|
<section xml:id="OS__Heat__WaitCondition-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Number">count</term>
|
|
<listitem>
|
|
<para>The number of success signals that must be received before the stack creation process continues.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "1".</para>
|
|
<para>The value must be at least 1.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">handle</term>
|
|
<listitem>
|
|
<para>A reference to the wait condition handle used to signal this wait condition.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Number">timeout</term>
|
|
<listitem>
|
|
<para>The number of seconds to wait for the correct number of signals to arrive.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>The value must be in the range 1 to 43200.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__WaitCondition-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>data</term>
|
|
<listitem>
|
|
<para>JSON serialized dict containing data associated with wait condition signals sent to the handle.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__WaitCondition-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::WaitCondition
|
|
properties:
|
|
count: Number
|
|
handle: String
|
|
timeout: Number</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__WaitCondition-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::WaitCondition
|
|
Properties:
|
|
count: Number
|
|
handle: String
|
|
timeout: Number</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__WaitCondition-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::WaitCondition",
|
|
"Properties": {
|
|
"count": Number,
|
|
"handle": String,
|
|
"timeout": Number
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Heat__WaitConditionHandle">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Heat::WaitConditionHandle</title>
|
|
<note>
|
|
<para>Available since 2014.2 (Juno)</para>
|
|
</note>
|
|
<section xml:id="OS__Heat__WaitConditionHandle-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>curl_cli</term>
|
|
<listitem>
|
|
<para>Convenience attribute, provides curl CLI command prefix, which can be used for signalling handle completion or failure. You can signal success by adding --data-binary '{"status": "SUCCESS"}' , or signal failure by adding --data-binary '{"status": "FAILURE"}'</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>endpoint</term>
|
|
<listitem>
|
|
<para>Endpoint/url which can be used for signalling handle</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>token</term>
|
|
<listitem>
|
|
<para>Token for stack-user which can be used for signalling handle</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Heat__WaitConditionHandle-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Heat::WaitConditionHandle</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__WaitConditionHandle-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Heat::WaitConditionHandle</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Heat__WaitConditionHandle-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Heat::WaitConditionHandle"
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Keystone__Group">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Keystone::Group</title>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo) - Supported versions: keystone v3</para>
|
|
</note>
|
|
<para>Heat Template Resource for Keystone Group.</para>
|
|
<para>heat_template_version: 2013-05-23</para>
|
|
<para>description: Sample Keystone Group template</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>parameters:</term>
|
|
<listitem>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>group_name:</term>
|
|
<listitem>
|
|
<para>type: string
|
|
description: Keystone group name</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>group_description:</term>
|
|
<listitem>
|
|
<para>type: string
|
|
description: Keystone group description</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>group_domain:</term>
|
|
<listitem>
|
|
<para>type: string
|
|
description: Keystone group domain name</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>group_role:</term>
|
|
<listitem>
|
|
<para>type: string
|
|
description: role</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>group_role_domain:</term>
|
|
<listitem>
|
|
<para>type: string
|
|
description: group role domain</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>group_role_project:</term>
|
|
<listitem>
|
|
<para>type: string
|
|
description: group role project</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>resources:</term>
|
|
<listitem>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>admin_group:</term>
|
|
<listitem>
|
|
<para>type: OS::Keystone::Group
|
|
properties:</para>
|
|
<blockquote>
|
|
<para>name: {get_param: group_name}
|
|
domain: {get_param: group_domain}
|
|
description: {get_param: group_description}
|
|
roles:</para>
|
|
<blockquote>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>role: {get_param: group_role}
|
|
domain: {get_param: group_role_domain}</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>role: {get_param: group_role}
|
|
project: {get_param: group_role_project}</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</blockquote>
|
|
</blockquote>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<section xml:id="OS__Keystone__Group-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description of keystone group.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">domain</term>
|
|
<listitem>
|
|
<para>Name or id of keystone domain.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "default".</para>
|
|
<para>Value must be of type keystone.domain</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name of keystone group.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">roles</term>
|
|
<listitem>
|
|
<para>List of role assignments.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Map between role with either project or domain.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">domain</term>
|
|
<listitem>
|
|
<para>Keystone domain</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type keystone.domain</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">project</term>
|
|
<listitem>
|
|
<para>Keystone project</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type keystone.project</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">role</term>
|
|
<listitem>
|
|
<para>Keystone role</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Value must be of type keystone.role</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Keystone__Group-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Keystone::Group
|
|
properties:
|
|
description: String
|
|
domain: String
|
|
name: String
|
|
roles: [{"project": String, "domain": String, "role": String}, {"project": String, "domain": String, "role": String}, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Keystone__Group-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Keystone::Group
|
|
Properties:
|
|
description: String
|
|
domain: String
|
|
name: String
|
|
roles: [{"project": String, "domain": String, "role": String}, {"project": String, "domain": String, "role": String}, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Keystone__Group-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Keystone::Group",
|
|
"Properties": {
|
|
"description": String,
|
|
"domain": String,
|
|
"name": String,
|
|
"roles": [{"project": String, "domain": String, "role": String}, {"project": String, "domain": String, "role": String}, ...]
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Keystone__Project">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Keystone::Project</title>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo) - Supported versions: keystone v3</para>
|
|
</note>
|
|
<para>Heat Template Resource for Keystone Project.</para>
|
|
<para>heat_template_version: 2013-05-23</para>
|
|
<para>description: Sample Keystone Project template</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>parameters:</term>
|
|
<listitem>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>project_name:</term>
|
|
<listitem>
|
|
<para>type: string
|
|
description: Keystone project name</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>project_description:</term>
|
|
<listitem>
|
|
<para>type: string
|
|
description: Keystone project description</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>project_enabled:</term>
|
|
<listitem>
|
|
<para>type: boolean
|
|
description: Keystone project is enabled or disabled</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>project_domain:</term>
|
|
<listitem>
|
|
<para>type: string
|
|
description: Keystone project domain name or id</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>resources:</term>
|
|
<listitem>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>admin_project:</term>
|
|
<listitem>
|
|
<para>type: OS::Keystone::Project
|
|
properties:</para>
|
|
<blockquote>
|
|
<para>name: {get_param: project_name}
|
|
domain: {get_param: project_domain}
|
|
description: {get_param: project_description}
|
|
enabled: {get_param: project_enabled}</para>
|
|
</blockquote>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<section xml:id="OS__Keystone__Project-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description of keystone project.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">domain</term>
|
|
<listitem>
|
|
<para>Name or id of keystone domain.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "default".</para>
|
|
<para>Value must be of type keystone.domain</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">enabled</term>
|
|
<listitem>
|
|
<para>This project is enabled or disabled.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "True".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name of keystone project.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Keystone__Project-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Keystone::Project
|
|
properties:
|
|
description: String
|
|
domain: String
|
|
enabled: Boolean
|
|
name: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Keystone__Project-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Keystone::Project
|
|
Properties:
|
|
description: String
|
|
domain: String
|
|
enabled: Boolean
|
|
name: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Keystone__Project-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Keystone::Project",
|
|
"Properties": {
|
|
"description": String,
|
|
"domain": String,
|
|
"enabled": Boolean,
|
|
"name": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Keystone__Role">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Keystone::Role</title>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo) - Supported versions: keystone v3</para>
|
|
</note>
|
|
<para>Heat Template Resource for Keystone Role.</para>
|
|
<para>heat_template_version: 2013-05-23</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>parameters:</term>
|
|
<listitem>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>role_name:</term>
|
|
<listitem>
|
|
<para>type: string
|
|
description: Keystone role name</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>resources:</term>
|
|
<listitem>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>sample_role:</term>
|
|
<listitem>
|
|
<para>type: OS::Keystone::Role
|
|
properties:</para>
|
|
<blockquote>
|
|
<para>name: {get_param: role_name}</para>
|
|
</blockquote>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<section xml:id="OS__Keystone__Role-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name of keystone role.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Keystone__Role-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Keystone::Role
|
|
properties:
|
|
name: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Keystone__Role-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Keystone::Role
|
|
Properties:
|
|
name: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Keystone__Role-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Keystone::Role",
|
|
"Properties": {
|
|
"name": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Keystone__User">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Keystone::User</title>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo) - Supported versions: keystone v3</para>
|
|
</note>
|
|
<para>Heat Template Resource for Keystone User.</para>
|
|
<para>heat_template_version: 2013-05-23</para>
|
|
<para>description: Sample Keystone User template</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>parameters:</term>
|
|
<listitem>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>user_name:</term>
|
|
<listitem>
|
|
<para>type: string
|
|
description: Keystone user name</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>user_description:</term>
|
|
<listitem>
|
|
<para>type: string
|
|
description: Keystone user description</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>user_enabled:</term>
|
|
<listitem>
|
|
<para>type: boolean
|
|
description: Keystone user is enabled or disabled</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>user_domain:</term>
|
|
<listitem>
|
|
<para>type: string
|
|
description: Keystone user domain name</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>user_email:</term>
|
|
<listitem>
|
|
<para>type: string
|
|
description: Keystone user email address</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>user_password:</term>
|
|
<listitem>
|
|
<para>type: string
|
|
description: Keystone user password</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>user_default_project:</term>
|
|
<listitem>
|
|
<para>type: string
|
|
description: Keystone user default project id</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>user_groups:</term>
|
|
<listitem>
|
|
<para>type: comma_delimited_list
|
|
description: Keystone groups, where this user is part of</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>group_role:</term>
|
|
<listitem>
|
|
<para>type: string
|
|
description: role</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>group_role_domain:</term>
|
|
<listitem>
|
|
<para>type: string
|
|
description: group role domain</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>group_role_project:</term>
|
|
<listitem>
|
|
<para>type: string
|
|
description: group role project</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>resources:</term>
|
|
<listitem>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>admin_user:</term>
|
|
<listitem>
|
|
<para>type: OS::Keystone::User
|
|
properties:</para>
|
|
<blockquote>
|
|
<para>name: {get_param: user_name}
|
|
domain: {get_param: user_domain}
|
|
description: {get_param: user_description}
|
|
enabled: {get_param: user_enabled}
|
|
email: {get_param: user_email}
|
|
password: {get_param: user_password}
|
|
default_project: {get_param: user_default_project}
|
|
groups: {get_param: user_groups}
|
|
roles:</para>
|
|
<blockquote>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>role: {get_param: group_role}
|
|
domain: {get_param: group_role_domain}</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>role: {get_param: group_role}
|
|
project: {get_param: group_role_project}</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</blockquote>
|
|
</blockquote>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<section xml:id="OS__Keystone__User-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">default_project</term>
|
|
<listitem>
|
|
<para>Default project of keystone user.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type keystone.project</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description of keystone user.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">domain</term>
|
|
<listitem>
|
|
<para>Name of keystone domain.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "default".</para>
|
|
<para>Value must be of type keystone.domain</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">email</term>
|
|
<listitem>
|
|
<para>Email address of keystone user.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">enabled</term>
|
|
<listitem>
|
|
<para>Keystone user is enabled or disabled</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "True".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">groups</term>
|
|
<listitem>
|
|
<para>keystone user groups.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">*</term>
|
|
<listitem>
|
|
<para>keystone user group.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type keystone.group</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name of keystone user.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">password</term>
|
|
<listitem>
|
|
<para>Password of keystone user.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">roles</term>
|
|
<listitem>
|
|
<para>List of role assignments.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Map between role with either project or domain.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">domain</term>
|
|
<listitem>
|
|
<para>Keystone domain</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type keystone.domain</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">project</term>
|
|
<listitem>
|
|
<para>Keystone project</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type keystone.project</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">role</term>
|
|
<listitem>
|
|
<para>Keystone role</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Value must be of type keystone.role</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Keystone__User-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Keystone::User
|
|
properties:
|
|
default_project: String
|
|
description: String
|
|
domain: String
|
|
email: String
|
|
enabled: Boolean
|
|
groups: [String, String, ...]
|
|
name: String
|
|
password: String
|
|
roles: [{"project": String, "domain": String, "role": String}, {"project": String, "domain": String, "role": String}, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Keystone__User-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Keystone::User
|
|
Properties:
|
|
default_project: String
|
|
description: String
|
|
domain: String
|
|
email: String
|
|
enabled: Boolean
|
|
groups: [String, String, ...]
|
|
name: String
|
|
password: String
|
|
roles: [{"project": String, "domain": String, "role": String}, {"project": String, "domain": String, "role": String}, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Keystone__User-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Keystone::User",
|
|
"Properties": {
|
|
"default_project": String,
|
|
"description": String,
|
|
"domain": String,
|
|
"email": String,
|
|
"enabled": Boolean,
|
|
"groups": [String, String, ...],
|
|
"name": String,
|
|
"password": String,
|
|
"roles": [{"project": String, "domain": String, "role": String}, {"project": String, "domain": String, "role": String}, ...]
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__ExtraRoute">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::ExtraRoute</title>
|
|
<section xml:id="OS__Neutron__ExtraRoute-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">destination</term>
|
|
<listitem>
|
|
<para>Network in CIDR notation.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">nexthop</term>
|
|
<listitem>
|
|
<para>Nexthop IP address.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">router_id</term>
|
|
<listitem>
|
|
<para>The router id.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Value must be of type neutron.router</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__ExtraRoute-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::ExtraRoute
|
|
properties:
|
|
destination: String
|
|
nexthop: String
|
|
router_id: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__ExtraRoute-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::ExtraRoute
|
|
Properties:
|
|
destination: String
|
|
nexthop: String
|
|
router_id: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__ExtraRoute-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::ExtraRoute",
|
|
"Properties": {
|
|
"destination": String,
|
|
"nexthop": String,
|
|
"router_id": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Firewall">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::Firewall</title>
|
|
<para>A resource for the Firewall resource in Neutron FWaaS.</para>
|
|
<section xml:id="OS__Neutron__Firewall-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Boolean">admin_state_up</term>
|
|
<listitem>
|
|
<para>Administrative state of the firewall. If false (down), firewall does not forward packets and will drop all traffic to/from VMs behind the firewall.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "True".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description for the firewall.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">firewall_policy_id</term>
|
|
<listitem>
|
|
<para>The ID of the firewall policy that this firewall is associated with.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name for the firewall.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">shared</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo)</para>
|
|
</note>
|
|
<para>Whether this firewall should be shared across all tenants. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "False".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Firewall-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>admin_state_up</term>
|
|
<listitem>
|
|
<para>The administrative state of the firewall.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>description</term>
|
|
<listitem>
|
|
<para>Description of the firewall.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>firewall_policy_id</term>
|
|
<listitem>
|
|
<para>Unique identifier of the firewall policy used to create the firewall.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>name</term>
|
|
<listitem>
|
|
<para>Name for the firewall.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>shared</term>
|
|
<listitem>
|
|
<para>Shared status of this firewall.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>show</term>
|
|
<listitem>
|
|
<para>All attributes.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>status</term>
|
|
<listitem>
|
|
<para>The status of the firewall.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>tenant_id</term>
|
|
<listitem>
|
|
<para>Id of the tenant owning the firewall.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Firewall-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::Firewall
|
|
properties:
|
|
admin_state_up: Boolean
|
|
description: String
|
|
firewall_policy_id: String
|
|
name: String
|
|
shared: Boolean</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Firewall-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::Firewall
|
|
Properties:
|
|
admin_state_up: Boolean
|
|
description: String
|
|
firewall_policy_id: String
|
|
name: String
|
|
shared: Boolean</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Firewall-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::Firewall",
|
|
"Properties": {
|
|
"admin_state_up": Boolean,
|
|
"description": String,
|
|
"firewall_policy_id": String,
|
|
"name": String,
|
|
"shared": Boolean
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__FirewallPolicy">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::FirewallPolicy</title>
|
|
<para>A resource for the FirewallPolicy resource in Neutron FWaaS.</para>
|
|
<section xml:id="OS__Neutron__FirewallPolicy-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Boolean">audited</term>
|
|
<listitem>
|
|
<para>Whether this policy should be audited. When set to True, each time the firewall policy or the associated firewall rules are changed, this attribute will be set to False and will have to be explicitly set to True through an update operation.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "False".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description for the firewall policy.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">firewall_rules</term>
|
|
<listitem>
|
|
<para>An ordered list of firewall rules to apply to the firewall.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name for the firewall policy.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">shared</term>
|
|
<listitem>
|
|
<para>Whether this policy should be shared across all tenants.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "False".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__FirewallPolicy-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>audited</term>
|
|
<listitem>
|
|
<para>Audit status of this firewall policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>description</term>
|
|
<listitem>
|
|
<para>Description of the firewall policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>firewall_rules</term>
|
|
<listitem>
|
|
<para>List of firewall rules in this firewall policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>name</term>
|
|
<listitem>
|
|
<para>Name for the firewall policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>shared</term>
|
|
<listitem>
|
|
<para>Shared status of this firewall policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>tenant_id</term>
|
|
<listitem>
|
|
<para>Id of the tenant owning the firewall policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__FirewallPolicy-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::FirewallPolicy
|
|
properties:
|
|
audited: Boolean
|
|
description: String
|
|
firewall_rules: [Value, Value, ...]
|
|
name: String
|
|
shared: Boolean</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__FirewallPolicy-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::FirewallPolicy
|
|
Properties:
|
|
audited: Boolean
|
|
description: String
|
|
firewall_rules: [Value, Value, ...]
|
|
name: String
|
|
shared: Boolean</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__FirewallPolicy-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::FirewallPolicy",
|
|
"Properties": {
|
|
"audited": Boolean,
|
|
"description": String,
|
|
"firewall_rules": [Value, Value, ...],
|
|
"name": String,
|
|
"shared": Boolean
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__FirewallRule">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::FirewallRule</title>
|
|
<para>A resource for the FirewallRule resource in Neutron FWaaS.</para>
|
|
<section xml:id="OS__Neutron__FirewallRule-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">action</term>
|
|
<listitem>
|
|
<para>Action to be performed on the traffic matching the rule.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "deny".</para>
|
|
<para>Allowed values: allow, deny</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description for the firewall rule.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">destination_ip_address</term>
|
|
<listitem>
|
|
<para>Destination IP address or CIDR.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">destination_port</term>
|
|
<listitem>
|
|
<para>Destination port number or a range.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">enabled</term>
|
|
<listitem>
|
|
<para>Whether this rule should be enabled.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "True".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">ip_version</term>
|
|
<listitem>
|
|
<para>Internet protocol version.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "4".</para>
|
|
<para>Allowed values: 4, 6</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name for the firewall rule.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">protocol</term>
|
|
<listitem>
|
|
<para>Protocol for the firewall rule.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "any".</para>
|
|
<para>Allowed values: tcp, udp, icmp, any</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">shared</term>
|
|
<listitem>
|
|
<para>Whether this rule should be shared across all tenants.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "False".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">source_ip_address</term>
|
|
<listitem>
|
|
<para>Source IP address or CIDR.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">source_port</term>
|
|
<listitem>
|
|
<para>Source port number or a range.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__FirewallRule-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>action</term>
|
|
<listitem>
|
|
<para>Allow or deny action for this firewall rule.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>description</term>
|
|
<listitem>
|
|
<para>Description of the firewall rule.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>destination_ip_address</term>
|
|
<listitem>
|
|
<para>Destination ip_address for this firewall rule.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>destination_port</term>
|
|
<listitem>
|
|
<para>Destination port range for this firewall rule.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>enabled</term>
|
|
<listitem>
|
|
<para>Indicates whether this firewall rule is enabled or not.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>firewall_policy_id</term>
|
|
<listitem>
|
|
<para>Unique identifier of the firewall policy to which this firewall rule belongs.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>ip_version</term>
|
|
<listitem>
|
|
<para>Ip_version for this firewall rule.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>name</term>
|
|
<listitem>
|
|
<para>Name for the firewall rule.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>position</term>
|
|
<listitem>
|
|
<para>Position of the rule within the firewall policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>protocol</term>
|
|
<listitem>
|
|
<para>Protocol value for this firewall rule.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>shared</term>
|
|
<listitem>
|
|
<para>Shared status of this firewall rule.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>source_ip_address</term>
|
|
<listitem>
|
|
<para>Source ip_address for this firewall rule.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>source_port</term>
|
|
<listitem>
|
|
<para>Source port range for this firewall rule.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>tenant_id</term>
|
|
<listitem>
|
|
<para>Id of the tenant owning the firewall.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__FirewallRule-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::FirewallRule
|
|
properties:
|
|
action: String
|
|
description: String
|
|
destination_ip_address: String
|
|
destination_port: String
|
|
enabled: Boolean
|
|
ip_version: String
|
|
name: String
|
|
protocol: String
|
|
shared: Boolean
|
|
source_ip_address: String
|
|
source_port: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__FirewallRule-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::FirewallRule
|
|
Properties:
|
|
action: String
|
|
description: String
|
|
destination_ip_address: String
|
|
destination_port: String
|
|
enabled: Boolean
|
|
ip_version: String
|
|
name: String
|
|
protocol: String
|
|
shared: Boolean
|
|
source_ip_address: String
|
|
source_port: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__FirewallRule-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::FirewallRule",
|
|
"Properties": {
|
|
"action": String,
|
|
"description": String,
|
|
"destination_ip_address": String,
|
|
"destination_port": String,
|
|
"enabled": Boolean,
|
|
"ip_version": String,
|
|
"name": String,
|
|
"protocol": String,
|
|
"shared": Boolean,
|
|
"source_ip_address": String,
|
|
"source_port": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__FloatingIP">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::FloatingIP</title>
|
|
<section xml:id="OS__Neutron__FloatingIP-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">fixed_ip_address</term>
|
|
<listitem>
|
|
<para>IP address to use if the port has multiple addresses.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">floating_network</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2014.2 (Juno)</para>
|
|
</note>
|
|
<para>Network to allocate floating IP from.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.network</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">port_id</term>
|
|
<listitem>
|
|
<para>ID of an existing port with at least one IP address to associate with this floating IP.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.port</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">value_specs</term>
|
|
<listitem>
|
|
<para>Extra parameters to include in the "floatingip" object in the creation request. Parameters are often specific to installed hardware or extensions.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "{}".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">floating_network_id</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED - Use property floating_network.</para>
|
|
</note>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.network</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__FloatingIP-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>fixed_ip_address</term>
|
|
<listitem>
|
|
<para>IP address of the associated port, if specified.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>floating_ip_address</term>
|
|
<listitem>
|
|
<para>The allocated address of this IP.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>floating_network_id</term>
|
|
<listitem>
|
|
<para>ID of the network in which this IP is allocated.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>port_id</term>
|
|
<listitem>
|
|
<para>ID of the port associated with this IP.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>router_id</term>
|
|
<listitem>
|
|
<para>ID of the router used as gateway, set when associated with a port.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>show</term>
|
|
<listitem>
|
|
<para>All attributes.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>tenant_id</term>
|
|
<listitem>
|
|
<para>The tenant owning this floating IP.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__FloatingIP-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::FloatingIP
|
|
properties:
|
|
fixed_ip_address: String
|
|
floating_network: String
|
|
port_id: String
|
|
value_specs: {...}</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__FloatingIP-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::FloatingIP
|
|
Properties:
|
|
fixed_ip_address: String
|
|
floating_network: String
|
|
port_id: String
|
|
value_specs: {...}</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__FloatingIP-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::FloatingIP",
|
|
"Properties": {
|
|
"fixed_ip_address": String,
|
|
"floating_network": String,
|
|
"port_id": String,
|
|
"value_specs": {...}
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__FloatingIPAssociation">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::FloatingIPAssociation</title>
|
|
<section xml:id="OS__Neutron__FloatingIPAssociation-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">fixed_ip_address</term>
|
|
<listitem>
|
|
<para>IP address to use if the port has multiple addresses.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">floatingip_id</term>
|
|
<listitem>
|
|
<para>ID of the floating IP to associate.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">port_id</term>
|
|
<listitem>
|
|
<para>ID of an existing port with at least one IP address to associate with this floating IP.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Value must be of type neutron.port</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__FloatingIPAssociation-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::FloatingIPAssociation
|
|
properties:
|
|
fixed_ip_address: String
|
|
floatingip_id: String
|
|
port_id: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__FloatingIPAssociation-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::FloatingIPAssociation
|
|
Properties:
|
|
fixed_ip_address: String
|
|
floatingip_id: String
|
|
port_id: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__FloatingIPAssociation-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::FloatingIPAssociation",
|
|
"Properties": {
|
|
"fixed_ip_address": String,
|
|
"floatingip_id": String,
|
|
"port_id": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__HealthMonitor">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::HealthMonitor</title>
|
|
<para>A resource for managing health monitors for load balancers in Neutron.</para>
|
|
<section xml:id="OS__Neutron__HealthMonitor-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Boolean">admin_state_up</term>
|
|
<listitem>
|
|
<para>The administrative state of the health monitor.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "True".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">delay</term>
|
|
<listitem>
|
|
<para>The minimum time in seconds between regular connections of the member.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">expected_codes</term>
|
|
<listitem>
|
|
<para>The list of HTTP status codes expected in response from the member to declare it healthy.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">http_method</term>
|
|
<listitem>
|
|
<para>The HTTP method used for requests by the monitor of type HTTP.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">max_retries</term>
|
|
<listitem>
|
|
<para>Number of permissible connection failures before changing the member status to INACTIVE.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">timeout</term>
|
|
<listitem>
|
|
<para>Maximum number of seconds for a monitor to wait for a connection to be established before it times out.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">type</term>
|
|
<listitem>
|
|
<para>One of predefined health monitor types.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Allowed values: PING, TCP, HTTP, HTTPS</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">url_path</term>
|
|
<listitem>
|
|
<para>The HTTP path used in the HTTP request used by the monitor to test a member health.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__HealthMonitor-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>admin_state_up</term>
|
|
<listitem>
|
|
<para>The administrative state of this health monitor.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>delay</term>
|
|
<listitem>
|
|
<para>The minimum time in seconds between regular connections of the member.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>expected_codes</term>
|
|
<listitem>
|
|
<para>The list of HTTP status codes expected in response from the member to declare it healthy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>http_method</term>
|
|
<listitem>
|
|
<para>The HTTP method used for requests by the monitor of type HTTP.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>max_retries</term>
|
|
<listitem>
|
|
<para>Number of permissible connection failures before changing the member status to INACTIVE.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>show</term>
|
|
<listitem>
|
|
<para>All attributes.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>tenant_id</term>
|
|
<listitem>
|
|
<para>Tenant owning the health monitor.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>timeout</term>
|
|
<listitem>
|
|
<para>Maximum number of seconds for a monitor to wait for a connection to be established before it times out.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>type</term>
|
|
<listitem>
|
|
<para>One of predefined health monitor types.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>url_path</term>
|
|
<listitem>
|
|
<para>The HTTP path used in the HTTP request used by the monitor to test a member health.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__HealthMonitor-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
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</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__HealthMonitor-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
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</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__HealthMonitor-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"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
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__IKEPolicy">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::IKEPolicy</title>
|
|
<para>A resource for IKE policy in Neutron.</para>
|
|
<section xml:id="OS__Neutron__IKEPolicy-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">auth_algorithm</term>
|
|
<listitem>
|
|
<para>Authentication hash algorithm for the ike policy.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "sha1".</para>
|
|
<para>Allowed values: sha1</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description for the ike policy.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">encryption_algorithm</term>
|
|
<listitem>
|
|
<para>Encryption algorithm for the ike policy.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "aes-128".</para>
|
|
<para>Allowed values: 3des, aes-128, aes-192, aes-256</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">ike_version</term>
|
|
<listitem>
|
|
<para>Version for the ike policy.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "v1".</para>
|
|
<para>Allowed values: v1, v2</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">lifetime</term>
|
|
<listitem>
|
|
<para>Safety assessment lifetime configuration for the ike policy.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">units</term>
|
|
<listitem>
|
|
<para>Safety assessment lifetime units.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "seconds".</para>
|
|
<para>Allowed values: seconds, kilobytes</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">value</term>
|
|
<listitem>
|
|
<para>Safety assessment lifetime value in specified units.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "3600".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name for the ike policy.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">pfs</term>
|
|
<listitem>
|
|
<para>Perfect forward secrecy in lowercase for the ike policy.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "group5".</para>
|
|
<para>Allowed values: group2, group5, group14</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">phase1_negotiation_mode</term>
|
|
<listitem>
|
|
<para>Negotiation mode for the ike policy.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "main".</para>
|
|
<para>Allowed values: main</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__IKEPolicy-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>auth_algorithm</term>
|
|
<listitem>
|
|
<para>The authentication hash algorithm used by the ike policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>description</term>
|
|
<listitem>
|
|
<para>The description of the ike policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>encryption_algorithm</term>
|
|
<listitem>
|
|
<para>The encryption algorithm used by the ike policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>ike_version</term>
|
|
<listitem>
|
|
<para>The version of the ike policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>lifetime</term>
|
|
<listitem>
|
|
<para>The safety assessment lifetime configuration for the ike policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>name</term>
|
|
<listitem>
|
|
<para>The name of the ike policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>pfs</term>
|
|
<listitem>
|
|
<para>The perfect forward secrecy of the ike policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>phase1_negotiation_mode</term>
|
|
<listitem>
|
|
<para>The negotiation mode of the ike policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>tenant_id</term>
|
|
<listitem>
|
|
<para>The unique identifier of the tenant owning the ike policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__IKEPolicy-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::IKEPolicy
|
|
properties:
|
|
auth_algorithm: String
|
|
description: String
|
|
encryption_algorithm: String
|
|
ike_version: String
|
|
lifetime: {"units": String, "value": Integer}
|
|
name: String
|
|
pfs: String
|
|
phase1_negotiation_mode: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__IKEPolicy-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::IKEPolicy
|
|
Properties:
|
|
auth_algorithm: String
|
|
description: String
|
|
encryption_algorithm: String
|
|
ike_version: String
|
|
lifetime: {"units": String, "value": Integer}
|
|
name: String
|
|
pfs: String
|
|
phase1_negotiation_mode: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__IKEPolicy-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::IKEPolicy",
|
|
"Properties": {
|
|
"auth_algorithm": String,
|
|
"description": String,
|
|
"encryption_algorithm": String,
|
|
"ike_version": String,
|
|
"lifetime": {"units": String, "value": Integer},
|
|
"name": String,
|
|
"pfs": String,
|
|
"phase1_negotiation_mode": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__IPsecPolicy">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::IPsecPolicy</title>
|
|
<para>A resource for IPsec policy in Neutron.</para>
|
|
<section xml:id="OS__Neutron__IPsecPolicy-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">auth_algorithm</term>
|
|
<listitem>
|
|
<para>Authentication hash algorithm for the ipsec policy.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "sha1".</para>
|
|
<para>Allowed values: sha1</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description for the ipsec policy.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">encapsulation_mode</term>
|
|
<listitem>
|
|
<para>Encapsulation mode for the ipsec policy.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "tunnel".</para>
|
|
<para>Allowed values: tunnel, transport</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">encryption_algorithm</term>
|
|
<listitem>
|
|
<para>Encryption algorithm for the ipsec policy.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "aes-128".</para>
|
|
<para>Allowed values: 3des, aes-128, aes-192, aes-256</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">lifetime</term>
|
|
<listitem>
|
|
<para>Safety assessment lifetime configuration for the ipsec policy.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">units</term>
|
|
<listitem>
|
|
<para>Safety assessment lifetime units.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "seconds".</para>
|
|
<para>Allowed values: seconds, kilobytes</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">value</term>
|
|
<listitem>
|
|
<para>Safety assessment lifetime value in specified units.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "3600".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name for the ipsec policy.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">pfs</term>
|
|
<listitem>
|
|
<para>Perfect forward secrecy for the ipsec policy.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "group5".</para>
|
|
<para>Allowed values: group2, group5, group14</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">transform_protocol</term>
|
|
<listitem>
|
|
<para>Transform protocol for the ipsec policy.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "esp".</para>
|
|
<para>Allowed values: esp, ah, ah-esp</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__IPsecPolicy-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>auth_algorithm</term>
|
|
<listitem>
|
|
<para>The authentication hash algorithm of the ipsec policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>description</term>
|
|
<listitem>
|
|
<para>The description of the ipsec policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>encapsulation_mode</term>
|
|
<listitem>
|
|
<para>The encapsulation mode of the ipsec policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>encryption_algorithm</term>
|
|
<listitem>
|
|
<para>The encryption algorithm of the ipsec policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>lifetime</term>
|
|
<listitem>
|
|
<para>The safety assessment lifetime configuration of the ipsec policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>name</term>
|
|
<listitem>
|
|
<para>The name of the ipsec policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>pfs</term>
|
|
<listitem>
|
|
<para>The perfect forward secrecy of the ipsec policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>tenant_id</term>
|
|
<listitem>
|
|
<para>The unique identifier of the tenant owning the ipsec policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>transform_protocol</term>
|
|
<listitem>
|
|
<para>The transform protocol of the ipsec policy.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__IPsecPolicy-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::IPsecPolicy
|
|
properties:
|
|
auth_algorithm: String
|
|
description: String
|
|
encapsulation_mode: String
|
|
encryption_algorithm: String
|
|
lifetime: {"units": String, "value": Integer}
|
|
name: String
|
|
pfs: String
|
|
transform_protocol: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__IPsecPolicy-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::IPsecPolicy
|
|
Properties:
|
|
auth_algorithm: String
|
|
description: String
|
|
encapsulation_mode: String
|
|
encryption_algorithm: String
|
|
lifetime: {"units": String, "value": Integer}
|
|
name: String
|
|
pfs: String
|
|
transform_protocol: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__IPsecPolicy-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::IPsecPolicy",
|
|
"Properties": {
|
|
"auth_algorithm": String,
|
|
"description": String,
|
|
"encapsulation_mode": String,
|
|
"encryption_algorithm": String,
|
|
"lifetime": {"units": String, "value": Integer},
|
|
"name": String,
|
|
"pfs": String,
|
|
"transform_protocol": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__IPsecSiteConnection">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::IPsecSiteConnection</title>
|
|
<para>A resource for IPsec site connection in Neutron.</para>
|
|
<section xml:id="OS__Neutron__IPsecSiteConnection-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Boolean">admin_state_up</term>
|
|
<listitem>
|
|
<para>Administrative state for the ipsec site connection.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "True".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description for the ipsec site connection.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">dpd</term>
|
|
<listitem>
|
|
<para>Dead Peer Detection protocol configuration for the ipsec site connection.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">actions</term>
|
|
<listitem>
|
|
<para>Controls DPD protocol mode.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "hold".</para>
|
|
<para>Allowed values: clear, disabled, hold, restart, restart-by-peer</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">interval</term>
|
|
<listitem>
|
|
<para>Number of seconds for the DPD delay.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "30".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">timeout</term>
|
|
<listitem>
|
|
<para>Number of seconds for the DPD timeout.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "120".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">ikepolicy_id</term>
|
|
<listitem>
|
|
<para>Unique identifier for the ike policy associated with the ipsec site connection.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">initiator</term>
|
|
<listitem>
|
|
<para>Initiator state in lowercase for the ipsec site connection.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "bi-directional".</para>
|
|
<para>Allowed values: bi-directional, response-only</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">ipsecpolicy_id</term>
|
|
<listitem>
|
|
<para>Unique identifier for the ipsec policy associated with the ipsec site connection.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">mtu</term>
|
|
<listitem>
|
|
<para>Maximum transmission unit size (in bytes) for the ipsec site connection.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "1500".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name for the ipsec site connection.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">peer_address</term>
|
|
<listitem>
|
|
<para>Remote branch router public IPv4 address or IPv6 address or FQDN.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">peer_cidrs</term>
|
|
<listitem>
|
|
<para>Remote subnet(s) in CIDR format.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">peer_id</term>
|
|
<listitem>
|
|
<para>Remote branch router identity.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">psk</term>
|
|
<listitem>
|
|
<para>Pre-shared key string for the ipsec site connection.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">vpnservice_id</term>
|
|
<listitem>
|
|
<para>Unique identifier for the vpn service associated with the ipsec site connection.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__IPsecSiteConnection-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>admin_state_up</term>
|
|
<listitem>
|
|
<para>The administrative state of the ipsec site connection.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>auth_mode</term>
|
|
<listitem>
|
|
<para>The authentication mode of the ipsec site connection.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>description</term>
|
|
<listitem>
|
|
<para>The description of the ipsec site connection.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>dpd</term>
|
|
<listitem>
|
|
<para>The dead peer detection protocol configuration of the ipsec site connection.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>ikepolicy_id</term>
|
|
<listitem>
|
|
<para>The unique identifier of ike policy associated with the ipsec site connection.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>initiator</term>
|
|
<listitem>
|
|
<para>The initiator of the ipsec site connection.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>ipsecpolicy_id</term>
|
|
<listitem>
|
|
<para>The unique identifier of ipsec policy associated with the ipsec site connection.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>mtu</term>
|
|
<listitem>
|
|
<para>The maximum transmission unit size (in bytes) of the ipsec site connection.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>name</term>
|
|
<listitem>
|
|
<para>The name of the ipsec site connection.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>peer_address</term>
|
|
<listitem>
|
|
<para>The remote branch router public IPv4 address or IPv6 address or FQDN.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>peer_cidrs</term>
|
|
<listitem>
|
|
<para>The remote subnet(s) in CIDR format of the ipsec site connection.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>peer_id</term>
|
|
<listitem>
|
|
<para>The remote branch router identity of the ipsec site connection.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>psk</term>
|
|
<listitem>
|
|
<para>The pre-shared key string of the ipsec site connection.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>route_mode</term>
|
|
<listitem>
|
|
<para>The route mode of the ipsec site connection.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>status</term>
|
|
<listitem>
|
|
<para>The status of the ipsec site connection.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>tenant_id</term>
|
|
<listitem>
|
|
<para>The unique identifier of the tenant owning the ipsec site connection.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>vpnservice_id</term>
|
|
<listitem>
|
|
<para>The unique identifier of vpn service associated with the ipsec site connection.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__IPsecSiteConnection-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::IPsecSiteConnection
|
|
properties:
|
|
admin_state_up: Boolean
|
|
description: String
|
|
dpd: {"interval": Integer, "timeout": Integer, "actions": String}
|
|
ikepolicy_id: String
|
|
initiator: String
|
|
ipsecpolicy_id: String
|
|
mtu: Integer
|
|
name: String
|
|
peer_address: String
|
|
peer_cidrs: [Value, Value, ...]
|
|
peer_id: String
|
|
psk: String
|
|
vpnservice_id: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__IPsecSiteConnection-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::IPsecSiteConnection
|
|
Properties:
|
|
admin_state_up: Boolean
|
|
description: String
|
|
dpd: {"interval": Integer, "timeout": Integer, "actions": String}
|
|
ikepolicy_id: String
|
|
initiator: String
|
|
ipsecpolicy_id: String
|
|
mtu: Integer
|
|
name: String
|
|
peer_address: String
|
|
peer_cidrs: [Value, Value, ...]
|
|
peer_id: String
|
|
psk: String
|
|
vpnservice_id: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__IPsecSiteConnection-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::IPsecSiteConnection",
|
|
"Properties": {
|
|
"admin_state_up": Boolean,
|
|
"description": String,
|
|
"dpd": {"interval": Integer, "timeout": Integer, "actions": String},
|
|
"ikepolicy_id": String,
|
|
"initiator": String,
|
|
"ipsecpolicy_id": String,
|
|
"mtu": Integer,
|
|
"name": String,
|
|
"peer_address": String,
|
|
"peer_cidrs": [Value, Value, ...],
|
|
"peer_id": String,
|
|
"psk": String,
|
|
"vpnservice_id": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__LoadBalancer">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::LoadBalancer</title>
|
|
<para>A resource to link a neutron pool with servers.</para>
|
|
<section xml:id="OS__Neutron__LoadBalancer-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="List">members</term>
|
|
<listitem>
|
|
<para>The list of Nova server IDs load balanced.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">pool_id</term>
|
|
<listitem>
|
|
<para>The ID of the load balancing pool.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">protocol_port</term>
|
|
<listitem>
|
|
<para>Port number on which the servers are running on the members.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__LoadBalancer-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::LoadBalancer
|
|
properties:
|
|
members: [Value, Value, ...]
|
|
pool_id: String
|
|
protocol_port: Integer</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__LoadBalancer-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::LoadBalancer
|
|
Properties:
|
|
members: [Value, Value, ...]
|
|
pool_id: String
|
|
protocol_port: Integer</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__LoadBalancer-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::LoadBalancer",
|
|
"Properties": {
|
|
"members": [Value, Value, ...],
|
|
"pool_id": String,
|
|
"protocol_port": Integer
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__MeteringLabel">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::MeteringLabel</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<para>A resource for creating neutron metering label.</para>
|
|
<section xml:id="OS__Neutron__MeteringLabel-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description of the metering label.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name of the metering label.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">shared</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo)</para>
|
|
</note>
|
|
<para>Whether the metering label should be shared across all tenants.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "False".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__MeteringLabel-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>description</term>
|
|
<listitem>
|
|
<para>Description of the metering label.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>name</term>
|
|
<listitem>
|
|
<para>Name of the metering label.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>shared</term>
|
|
<listitem>
|
|
<para>Shared status of the metering label.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__MeteringLabel-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::MeteringLabel
|
|
properties:
|
|
description: String
|
|
name: String
|
|
shared: Boolean</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__MeteringLabel-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::MeteringLabel
|
|
Properties:
|
|
description: String
|
|
name: String
|
|
shared: Boolean</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__MeteringLabel-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::MeteringLabel",
|
|
"Properties": {
|
|
"description": String,
|
|
"name": String,
|
|
"shared": Boolean
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__MeteringRule">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::MeteringRule</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<para>A resource to create rule for some label.</para>
|
|
<section xml:id="OS__Neutron__MeteringRule-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">direction</term>
|
|
<listitem>
|
|
<para>The direction in which metering rule is applied, either ingress or egress.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "ingress".</para>
|
|
<para>Allowed values: ingress, egress</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">excluded</term>
|
|
<listitem>
|
|
<para>Specify whether the remote_ip_prefix will be excluded or not from traffic counters of the metering label. For example to not count the traffic of a specific IP address of a range.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "False".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">metering_label_id</term>
|
|
<listitem>
|
|
<para>The metering label ID to associate with this metering rule.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">remote_ip_prefix</term>
|
|
<listitem>
|
|
<para>Indicates remote IP prefix to be associated with this metering rule.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__MeteringRule-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>direction</term>
|
|
<listitem>
|
|
<para>The direction in which metering rule is applied.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>excluded</term>
|
|
<listitem>
|
|
<para>Exclude state for cidr.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>metering_label_id</term>
|
|
<listitem>
|
|
<para>The metering label ID to associate with this metering rule.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>remote_ip_prefix</term>
|
|
<listitem>
|
|
<para>CIDR to be associated with this metering rule.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__MeteringRule-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::MeteringRule
|
|
properties:
|
|
direction: String
|
|
excluded: Boolean
|
|
metering_label_id: String
|
|
remote_ip_prefix: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__MeteringRule-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::MeteringRule
|
|
Properties:
|
|
direction: String
|
|
excluded: Boolean
|
|
metering_label_id: String
|
|
remote_ip_prefix: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__MeteringRule-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::MeteringRule",
|
|
"Properties": {
|
|
"direction": String,
|
|
"excluded": Boolean,
|
|
"metering_label_id": String,
|
|
"remote_ip_prefix": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Net">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::Net</title>
|
|
<section xml:id="OS__Neutron__Net-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Boolean">admin_state_up</term>
|
|
<listitem>
|
|
<para>A boolean value specifying the administrative status of the network.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "True".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">dhcp_agent_ids</term>
|
|
<listitem>
|
|
<para>The IDs of the DHCP agent to schedule the network. Note that the default policy setting in Neutron restricts usage of this property to administrative users only.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>A string specifying a symbolic name for the network, which is not required to be unique.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">shared</term>
|
|
<listitem>
|
|
<para>Whether this network should be shared across all tenants. Note that the default policy setting restricts usage of this attribute to administrative users only.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "False".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">tenant_id</term>
|
|
<listitem>
|
|
<para>The ID of the tenant which will own the network. Only administrative users can set the tenant identifier; this cannot be changed using authorization policies.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">value_specs</term>
|
|
<listitem>
|
|
<para>Extra parameters to include in the "network" object in the creation request. Parameters are often specific to installed hardware or extensions.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "{}".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Net-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>admin_state_up</term>
|
|
<listitem>
|
|
<para>The administrative status of the network.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>name</term>
|
|
<listitem>
|
|
<para>The name of the network.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>show</term>
|
|
<listitem>
|
|
<para>All attributes.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>status</term>
|
|
<listitem>
|
|
<para>The status of the network.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>subnets</term>
|
|
<listitem>
|
|
<para>Subnets of this network.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>tenant_id</term>
|
|
<listitem>
|
|
<para>The tenant owning this network.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Net-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::Net
|
|
properties:
|
|
admin_state_up: Boolean
|
|
dhcp_agent_ids: [Value, Value, ...]
|
|
name: String
|
|
shared: Boolean
|
|
tenant_id: String
|
|
value_specs: {...}</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Net-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::Net
|
|
Properties:
|
|
admin_state_up: Boolean
|
|
dhcp_agent_ids: [Value, Value, ...]
|
|
name: String
|
|
shared: Boolean
|
|
tenant_id: String
|
|
value_specs: {...}</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Net-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::Net",
|
|
"Properties": {
|
|
"admin_state_up": Boolean,
|
|
"dhcp_agent_ids": [Value, Value, ...],
|
|
"name": String,
|
|
"shared": Boolean,
|
|
"tenant_id": String,
|
|
"value_specs": {...}
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__NetworkGateway">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::NetworkGateway</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<para>A resource for the Network Gateway resource in Neutron Network Gateway.</para>
|
|
<section xml:id="OS__Neutron__NetworkGateway-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="List">connections</term>
|
|
<listitem>
|
|
<para>Connection info for this network gateway.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "{}".</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">network</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2014.2 (Juno)</para>
|
|
</note>
|
|
<para>The internal network to connect on the network gateway.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.network</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">segmentation_id</term>
|
|
<listitem>
|
|
<para>The id for L2 segment on the external side of the network gateway. Must be specified when using vlan.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>The value must be in the range 0 to 4094.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">segmentation_type</term>
|
|
<listitem>
|
|
<para>L2 segmentation strategy on the external side of the network gateway.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "flat".</para>
|
|
<para>Allowed values: flat, vlan</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">network_id</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED - Use property network.</para>
|
|
</note>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.network</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">devices</term>
|
|
<listitem>
|
|
<para>Device info for this network gateway.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>The length must be at least 1.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">id</term>
|
|
<listitem>
|
|
<para>The device id for the network gateway.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">interface_name</term>
|
|
<listitem>
|
|
<para>The interface name for the network gateway.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>The name of the network gateway.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__NetworkGateway-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>default</term>
|
|
<listitem>
|
|
<para>A boolean value of default flag.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>show</term>
|
|
<listitem>
|
|
<para>All attributes.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__NetworkGateway-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::NetworkGateway
|
|
properties:
|
|
connections: [{"network_id": String, "segmentation_id": Integer, "segmentation_type": String, "network": String}, {"network_id": String, "segmentation_id": Integer, "segmentation_type": String, "network": String}, ...]
|
|
devices: [{"interface_name": String, "id": String}, {"interface_name": String, "id": String}, ...]
|
|
name: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__NetworkGateway-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::NetworkGateway
|
|
Properties:
|
|
connections: [{"network_id": String, "segmentation_id": Integer, "segmentation_type": String, "network": String}, {"network_id": String, "segmentation_id": Integer, "segmentation_type": String, "network": String}, ...]
|
|
devices: [{"interface_name": String, "id": String}, {"interface_name": String, "id": String}, ...]
|
|
name: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__NetworkGateway-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::NetworkGateway",
|
|
"Properties": {
|
|
"connections": [{"network_id": String, "segmentation_id": Integer, "segmentation_type": String, "network": String}, {"network_id": String, "segmentation_id": Integer, "segmentation_type": String, "network": String}, ...],
|
|
"devices": [{"interface_name": String, "id": String}, {"interface_name": String, "id": String}, ...],
|
|
"name": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Pool">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::Pool</title>
|
|
<para>A resource for managing load balancer pools in Neutron.</para>
|
|
<section xml:id="OS__Neutron__Pool-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Boolean">admin_state_up</term>
|
|
<listitem>
|
|
<para>The administrative state of this pool.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "True".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description of the pool.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">lb_method</term>
|
|
<listitem>
|
|
<para>The algorithm used to distribute load between the members of the pool.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Allowed values: ROUND_ROBIN, LEAST_CONNECTIONS, SOURCE_IP</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">monitors</term>
|
|
<listitem>
|
|
<para>List of health monitors associated with the pool.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "[]".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name of the pool.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">protocol</term>
|
|
<listitem>
|
|
<para>Protocol for balancing.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Allowed values: TCP, HTTP, HTTPS</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">subnet</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2014.2 (Juno)</para>
|
|
</note>
|
|
<para>The subnet for the port on which the members of the pool will be connected.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.subnet</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">vip</term>
|
|
<listitem>
|
|
<para>IP address and port of the pool.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">address</term>
|
|
<listitem>
|
|
<para>IP address of the vip.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">admin_state_up</term>
|
|
<listitem>
|
|
<para>The administrative state of this vip.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "True".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">connection_limit</term>
|
|
<listitem>
|
|
<para>The maximum number of connections per second allowed for the vip.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description of the vip.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name of the vip.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">protocol_port</term>
|
|
<listitem>
|
|
<para>TCP port on which to listen for client traffic that is associated with the vip address.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">session_persistence</term>
|
|
<listitem>
|
|
<para>Configuration of session persistence.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">cookie_name</term>
|
|
<listitem>
|
|
<para>Name of the cookie, required if type is APP_COOKIE.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">type</term>
|
|
<listitem>
|
|
<para>Method of implementation of session persistence feature.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Allowed values: SOURCE_IP, HTTP_COOKIE, APP_COOKIE</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">subnet</term>
|
|
<listitem>
|
|
<para>Subnet of the vip.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.subnet</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">subnet_id</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED - Use property subnet.</para>
|
|
</note>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.subnet</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Pool-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>admin_state_up</term>
|
|
<listitem>
|
|
<para>The administrative state of this pool.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>description</term>
|
|
<listitem>
|
|
<para>Description of the pool.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>lb_method</term>
|
|
<listitem>
|
|
<para>The algorithm used to distribute load between the members of the pool.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>name</term>
|
|
<listitem>
|
|
<para>Name of the pool.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>protocol</term>
|
|
<listitem>
|
|
<para>Protocol to balance.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>subnet_id</term>
|
|
<listitem>
|
|
<para>The subnet for the port on which the members of the pool will be connected.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>tenant_id</term>
|
|
<listitem>
|
|
<para>Tenant owning the pool.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>vip</term>
|
|
<listitem>
|
|
<para>Vip associated with the pool.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Pool-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::Pool
|
|
properties:
|
|
admin_state_up: Boolean
|
|
description: String
|
|
lb_method: String
|
|
monitors: [Value, Value, ...]
|
|
name: String
|
|
protocol: 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}</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Pool-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::Pool
|
|
Properties:
|
|
admin_state_up: Boolean
|
|
description: String
|
|
lb_method: String
|
|
monitors: [Value, Value, ...]
|
|
name: String
|
|
protocol: 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}</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Pool-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::Pool",
|
|
"Properties": {
|
|
"admin_state_up": Boolean,
|
|
"description": String,
|
|
"lb_method": String,
|
|
"monitors": [Value, Value, ...],
|
|
"name": String,
|
|
"protocol": 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}
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__PoolMember">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::PoolMember</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<para>A resource to handle load balancer members.</para>
|
|
<section xml:id="OS__Neutron__PoolMember-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">address</term>
|
|
<listitem>
|
|
<para>IP address of the pool member on the pool network.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">admin_state_up</term>
|
|
<listitem>
|
|
<para>The administrative state of the pool member.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "True".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">pool_id</term>
|
|
<listitem>
|
|
<para>The ID of the load balancing pool.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">protocol_port</term>
|
|
<listitem>
|
|
<para>TCP port on which the pool member listens for requests or connections.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>The value must be in the range 0 to 65535.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">weight</term>
|
|
<listitem>
|
|
<para>Weight of pool member in the pool (default to 1).</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>The value must be in the range 0 to 256.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__PoolMember-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>address</term>
|
|
<listitem>
|
|
<para>IP address of the pool member.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>admin_state_up</term>
|
|
<listitem>
|
|
<para>The administrative state of this pool member.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>pool_id</term>
|
|
<listitem>
|
|
<para>The ID of the load balancing pool.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>protocol_port</term>
|
|
<listitem>
|
|
<para>TCP port on which the pool member listens for requests or connections.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>show</term>
|
|
<listitem>
|
|
<para>All attributes.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>tenant_id</term>
|
|
<listitem>
|
|
<para>Tenant owning the pool member.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>weight</term>
|
|
<listitem>
|
|
<para>Weight of the pool member in the pool.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__PoolMember-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::PoolMember
|
|
properties:
|
|
address: String
|
|
admin_state_up: Boolean
|
|
pool_id: String
|
|
protocol_port: Integer
|
|
weight: Integer</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__PoolMember-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::PoolMember
|
|
Properties:
|
|
address: String
|
|
admin_state_up: Boolean
|
|
pool_id: String
|
|
protocol_port: Integer
|
|
weight: Integer</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__PoolMember-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::PoolMember",
|
|
"Properties": {
|
|
"address": String,
|
|
"admin_state_up": Boolean,
|
|
"pool_id": String,
|
|
"protocol_port": Integer,
|
|
"weight": Integer
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Port">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::Port</title>
|
|
<section xml:id="OS__Neutron__Port-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Boolean">admin_state_up</term>
|
|
<listitem>
|
|
<para>The administrative state of this port.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "True".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">allowed_address_pairs</term>
|
|
<listitem>
|
|
<para>Additional MAC/IP address pairs allowed to pass through the port.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">ip_address</term>
|
|
<listitem>
|
|
<para>IP address to allow through this port.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">mac_address</term>
|
|
<listitem>
|
|
<para>MAC address to allow through this port.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">binding:vnic_type</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo)</para>
|
|
</note>
|
|
<para>The vnic type to be bound on the neutron port. To support SR-IOV PCI passthrough networking, you can request that the neutron port to be realized as normal (virtual nic), direct (pci passthrough), or macvtap (virtual interface with a tap-like software interface). Note that this only works for Neutron deployments that support the bindings extension.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: normal, direct, macvtap</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">device_id</term>
|
|
<listitem>
|
|
<para>Device ID of this port.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">device_owner</term>
|
|
<listitem>
|
|
<para>Name of the network owning the port. The value is typically network:floatingip or network:router_interface or network:dhcp</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">fixed_ips</term>
|
|
<listitem>
|
|
<para>Desired IPs for this port.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "[]".</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">ip_address</term>
|
|
<listitem>
|
|
<para>IP address desired in the subnet for this port.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">subnet</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2014.2 (Juno)</para>
|
|
</note>
|
|
<para>Subnet in which to allocate the IP address for this port.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.subnet</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">subnet_id</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED - Use property subnet.</para>
|
|
</note>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.subnet</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">mac_address</term>
|
|
<listitem>
|
|
<para>MAC address to give to this port.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>A symbolic name for this port.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">network</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2014.2 (Juno)</para>
|
|
</note>
|
|
<para>Network this port belongs to. If you plan to use current port to assign Floating IP, you should specify fixed_ips with subnet</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.network</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">replacement_policy</term>
|
|
<listitem>
|
|
<para>Policy on how to respond to a stack-update for this resource. REPLACE_ALWAYS will replace the port regardless of any property changes. AUTO will update the existing port for any changed update-allowed property.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "AUTO".</para>
|
|
<para>Allowed values: REPLACE_ALWAYS, AUTO</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">security_groups</term>
|
|
<listitem>
|
|
<para>Security group IDs to associate with this port.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">value_specs</term>
|
|
<listitem>
|
|
<para>Extra parameters to include in the "port" object in the creation request.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "{}".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">network_id</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED - Use property network.</para>
|
|
</note>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.network</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Port-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>admin_state_up</term>
|
|
<listitem>
|
|
<para>The administrative state of this port.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>allowed_address_pairs</term>
|
|
<listitem>
|
|
<para>Additional MAC/IP address pairs allowed to pass through a port.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>device_id</term>
|
|
<listitem>
|
|
<para>Unique identifier for the device.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>device_owner</term>
|
|
<listitem>
|
|
<para>Name of the network owning the port.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>fixed_ips</term>
|
|
<listitem>
|
|
<para>Fixed IP addresses.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>mac_address</term>
|
|
<listitem>
|
|
<para>MAC address of the port.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>name</term>
|
|
<listitem>
|
|
<para>Friendly name of the port.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>network_id</term>
|
|
<listitem>
|
|
<para>Unique identifier for the network owning the port.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>security_groups</term>
|
|
<listitem>
|
|
<para>A list of security groups for the port.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>show</term>
|
|
<listitem>
|
|
<para>All attributes.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>status</term>
|
|
<listitem>
|
|
<para>The status of the port.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>subnets</term>
|
|
<listitem>
|
|
<para>A list of all subnet attributes for the port.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>tenant_id</term>
|
|
<listitem>
|
|
<para>Tenant owning the port.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Port-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::Port
|
|
properties:
|
|
admin_state_up: Boolean
|
|
allowed_address_pairs: [{"ip_address": String, "mac_address": String}, {"ip_address": String, "mac_address": String}, ...]
|
|
binding:vnic_type: String
|
|
device_id: String
|
|
device_owner: String
|
|
fixed_ips: [{"subnet_id": String, "subnet": String, "ip_address": String}, {"subnet_id": String, "subnet": String, "ip_address": String}, ...]
|
|
mac_address: String
|
|
name: String
|
|
network: String
|
|
replacement_policy: String
|
|
security_groups: [Value, Value, ...]
|
|
value_specs: {...}</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Port-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::Port
|
|
Properties:
|
|
admin_state_up: Boolean
|
|
allowed_address_pairs: [{"ip_address": String, "mac_address": String}, {"ip_address": String, "mac_address": String}, ...]
|
|
binding:vnic_type: String
|
|
device_id: String
|
|
device_owner: String
|
|
fixed_ips: [{"subnet_id": String, "subnet": String, "ip_address": String}, {"subnet_id": String, "subnet": String, "ip_address": String}, ...]
|
|
mac_address: String
|
|
name: String
|
|
network: String
|
|
replacement_policy: String
|
|
security_groups: [Value, Value, ...]
|
|
value_specs: {...}</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Port-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::Port",
|
|
"Properties": {
|
|
"admin_state_up": Boolean,
|
|
"allowed_address_pairs": [{"ip_address": String, "mac_address": String}, {"ip_address": String, "mac_address": String}, ...],
|
|
"binding:vnic_type": String,
|
|
"device_id": String,
|
|
"device_owner": String,
|
|
"fixed_ips": [{"subnet_id": String, "subnet": String, "ip_address": String}, {"subnet_id": String, "subnet": String, "ip_address": String}, ...],
|
|
"mac_address": String,
|
|
"name": String,
|
|
"network": String,
|
|
"replacement_policy": String,
|
|
"security_groups": [Value, Value, ...],
|
|
"value_specs": {...}
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__ProviderNet">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::ProviderNet</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<section xml:id="OS__Neutron__ProviderNet-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Boolean">admin_state_up</term>
|
|
<listitem>
|
|
<para>A boolean value specifying the administrative status of the network.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "True".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>A string specifying a symbolic name for the network, which is not required to be unique.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">network_type</term>
|
|
<listitem>
|
|
<para>A string specifying the provider network type for the network.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Allowed values: vlan, flat</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">physical_network</term>
|
|
<listitem>
|
|
<para>A string specifying physical network mapping for the network.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">segmentation_id</term>
|
|
<listitem>
|
|
<para>A string specifying the segmentation id for the network.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">shared</term>
|
|
<listitem>
|
|
<para>Whether this network should be shared across all tenants.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "True".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__ProviderNet-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>show</term>
|
|
<listitem>
|
|
<para>All attributes.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>status</term>
|
|
<listitem>
|
|
<para>The status of the network.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>subnets</term>
|
|
<listitem>
|
|
<para>Subnets of this network.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__ProviderNet-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::ProviderNet
|
|
properties:
|
|
admin_state_up: Boolean
|
|
name: String
|
|
network_type: String
|
|
physical_network: String
|
|
segmentation_id: String
|
|
shared: Boolean</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__ProviderNet-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::ProviderNet
|
|
Properties:
|
|
admin_state_up: Boolean
|
|
name: String
|
|
network_type: String
|
|
physical_network: String
|
|
segmentation_id: String
|
|
shared: Boolean</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__ProviderNet-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::ProviderNet",
|
|
"Properties": {
|
|
"admin_state_up": Boolean,
|
|
"name": String,
|
|
"network_type": String,
|
|
"physical_network": String,
|
|
"segmentation_id": String,
|
|
"shared": Boolean
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Router">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::Router</title>
|
|
<section xml:id="OS__Neutron__Router-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Boolean">admin_state_up</term>
|
|
<listitem>
|
|
<para>The administrative state of the router.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "True".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">distributed</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo)</para>
|
|
</note>
|
|
<para>Indicates whether or not to create a distributed router. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only. This property can not be used in conjunction with the L3 agent ID.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">external_gateway_info</term>
|
|
<listitem>
|
|
<para>External network gateway configuration for a router.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Boolean">enable_snat</term>
|
|
<listitem>
|
|
<para>Enables Source NAT on the router gateway. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">network</term>
|
|
<listitem>
|
|
<para>ID or name of the external network for the gateway.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">ha</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo)</para>
|
|
</note>
|
|
<para>Indicates whether or not to create a highly available router. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only. And now neutron do not support distributed and ha at the same time.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">l3_agent_ids</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo)</para>
|
|
</note>
|
|
<para>ID list of the L3 agent. User can specify multi-agents for highly available router. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>The name of the router.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">value_specs</term>
|
|
<listitem>
|
|
<para>Extra parameters to include in the creation request.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "{}".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">l3_agent_id</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED - Deprecated in Kilo. Use property l3_agent_ids.</para>
|
|
</note>
|
|
<para>ID of the L3 agent. NOTE: The default policy setting in Neutron restricts usage of this property to administrative users only.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Router-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>admin_state_up</term>
|
|
<listitem>
|
|
<para>Administrative state of the router.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>external_gateway_info</term>
|
|
<listitem>
|
|
<para>Gateway network for the router.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>name</term>
|
|
<listitem>
|
|
<para>Friendly name of the router.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>show</term>
|
|
<listitem>
|
|
<para>All attributes.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>status</term>
|
|
<listitem>
|
|
<para>The status of the router.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>tenant_id</term>
|
|
<listitem>
|
|
<para>Tenant owning the router.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Router-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::Router
|
|
properties:
|
|
admin_state_up: Boolean
|
|
distributed: Boolean
|
|
external_gateway_info: {"enable_snat": Boolean, "network": String}
|
|
ha: Boolean
|
|
l3_agent_ids: [String, String, ...]
|
|
name: String
|
|
value_specs: {...}</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Router-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::Router
|
|
Properties:
|
|
admin_state_up: Boolean
|
|
distributed: Boolean
|
|
external_gateway_info: {"enable_snat": Boolean, "network": String}
|
|
ha: Boolean
|
|
l3_agent_ids: [String, String, ...]
|
|
name: String
|
|
value_specs: {...}</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Router-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::Router",
|
|
"Properties": {
|
|
"admin_state_up": Boolean,
|
|
"distributed": Boolean,
|
|
"external_gateway_info": {"enable_snat": Boolean, "network": String},
|
|
"ha": Boolean,
|
|
"l3_agent_ids": [String, String, ...],
|
|
"name": String,
|
|
"value_specs": {...}
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__RouterGateway">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::RouterGateway</title>
|
|
<note>
|
|
<para>DEPRECATED - RouterGateway resource is deprecated and should not be used. Instead use the `external_gateway_info` property in the router resource to set up the gateway.</para>
|
|
</note>
|
|
<section xml:id="OS__Neutron__RouterGateway-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">network</term>
|
|
<listitem>
|
|
<para>external network for the gateway.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.network</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">router_id</term>
|
|
<listitem>
|
|
<para>ID of the router.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Value must be of type neutron.router</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">network_id</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED - Use property network.</para>
|
|
</note>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.network</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__RouterGateway-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::RouterGateway
|
|
properties:
|
|
network: String
|
|
router_id: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__RouterGateway-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::RouterGateway
|
|
Properties:
|
|
network: String
|
|
router_id: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__RouterGateway-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::RouterGateway",
|
|
"Properties": {
|
|
"network": String,
|
|
"router_id": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__RouterInterface">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::RouterInterface</title>
|
|
<section xml:id="OS__Neutron__RouterInterface-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">port</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo)</para>
|
|
</note>
|
|
<para>The port, either subnet or port should be specified.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.port</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">router</term>
|
|
<listitem>
|
|
<para>The router.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.router</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">subnet</term>
|
|
<listitem>
|
|
<para>The subnet, either subnet or port should be specified.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.subnet</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">port_id</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED - Deprecated in Kilo. Use property port.</para>
|
|
</note>
|
|
<para>The port id, either subnet or port_id should be specified.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.port</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">router_id</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED - Use property router.</para>
|
|
</note>
|
|
<para>ID of the router.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.router</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">subnet_id</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED - Use property subnet.</para>
|
|
</note>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.subnet</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__RouterInterface-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::RouterInterface
|
|
properties:
|
|
port: String
|
|
router: String
|
|
subnet: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__RouterInterface-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::RouterInterface
|
|
Properties:
|
|
port: String
|
|
router: String
|
|
subnet: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__RouterInterface-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::RouterInterface",
|
|
"Properties": {
|
|
"port": String,
|
|
"router": String,
|
|
"subnet": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__SecurityGroup">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::SecurityGroup</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<section xml:id="OS__Neutron__SecurityGroup-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description of the security group.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>A string specifying a symbolic name for the security group, which is not required to be unique.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">rules</term>
|
|
<listitem>
|
|
<para>List of security group rules.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "[]".</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">direction</term>
|
|
<listitem>
|
|
<para>The direction in which the security group rule is applied. For a compute instance, an ingress security group rule matches traffic that is incoming (ingress) for that instance. An egress rule is applied to traffic leaving the instance.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "ingress".</para>
|
|
<para>Allowed values: ingress, egress</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">ethertype</term>
|
|
<listitem>
|
|
<para>Ethertype of the traffic.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "IPv4".</para>
|
|
<para>Allowed values: IPv4, IPv6</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">port_range_max</term>
|
|
<listitem>
|
|
<para>The maximum port number in the range that is matched by the security group rule. The port_range_min attribute constrains the port_range_max attribute. If the protocol is ICMP, this value must be an ICMP type.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">port_range_min</term>
|
|
<listitem>
|
|
<para>The minimum port number in the range that is matched by the security group rule. If the protocol is TCP or UDP, this value must be less than or equal to the value of the port_range_max attribute. If the protocol is ICMP, this value must be an ICMP type.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">protocol</term>
|
|
<listitem>
|
|
<para>The protocol that is matched by the security group rule. Valid values include tcp, udp, and icmp.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">remote_group_id</term>
|
|
<listitem>
|
|
<para>The remote group ID to be associated with this security group rule. If no value is specified then this rule will use this security group for the remote_group_id. The remote mode parameter must be set to "remote_group_id".</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">remote_ip_prefix</term>
|
|
<listitem>
|
|
<para>The remote IP prefix (CIDR) to be associated with this security group rule.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">remote_mode</term>
|
|
<listitem>
|
|
<para>Whether to specify a remote group or a remote IP prefix.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "remote_ip_prefix".</para>
|
|
<para>Allowed values: remote_ip_prefix, remote_group_id</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__SecurityGroup-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::SecurityGroup
|
|
properties:
|
|
description: String
|
|
name: String
|
|
rules: [{"remote_group_id": String, "direction": String, "remote_ip_prefix": String, "port_range_min": Integer, "remote_mode": String, "ethertype": String, "port_range_max": Integer, "protocol": String}, {"remote_group_id": String, "direction": String, "remote_ip_prefix": String, "port_range_min": Integer, "remote_mode": String, "ethertype": String, "port_range_max": Integer, "protocol": String}, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__SecurityGroup-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::SecurityGroup
|
|
Properties:
|
|
description: String
|
|
name: String
|
|
rules: [{"remote_group_id": String, "direction": String, "remote_ip_prefix": String, "port_range_min": Integer, "remote_mode": String, "ethertype": String, "port_range_max": Integer, "protocol": String}, {"remote_group_id": String, "direction": String, "remote_ip_prefix": String, "port_range_min": Integer, "remote_mode": String, "ethertype": String, "port_range_max": Integer, "protocol": String}, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__SecurityGroup-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::SecurityGroup",
|
|
"Properties": {
|
|
"description": String,
|
|
"name": String,
|
|
"rules": [{"remote_group_id": String, "direction": String, "remote_ip_prefix": String, "port_range_min": Integer, "remote_mode": String, "ethertype": String, "port_range_max": Integer, "protocol": String}, {"remote_group_id": String, "direction": String, "remote_ip_prefix": String, "port_range_min": Integer, "remote_mode": String, "ethertype": String, "port_range_max": Integer, "protocol": String}, ...]
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Subnet">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::Subnet</title>
|
|
<section xml:id="OS__Neutron__Subnet-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="List">allocation_pools</term>
|
|
<listitem>
|
|
<para>The start and end addresses for the allocation pools.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">end</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">start</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">cidr</term>
|
|
<listitem>
|
|
<para>The CIDR.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">dns_nameservers</term>
|
|
<listitem>
|
|
<para>A specified set of DNS name servers to be used.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "[]".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">enable_dhcp</term>
|
|
<listitem>
|
|
<para>Set to true if DHCP is enabled and false if DHCP is disabled.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "True".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">gateway_ip</term>
|
|
<listitem>
|
|
<para>The gateway IP address. Set to any of [ null | ~ | "" ] to create the subnet without a gateway. If omitted, the first IP address within the subnet is assigned to the gateway.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">host_routes</term>
|
|
<listitem>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">destination</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">nexthop</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">ip_version</term>
|
|
<listitem>
|
|
<para>The IP version, which is 4 or 6.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "4".</para>
|
|
<para>Allowed values: 4, 6</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">ipv6_address_mode</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo)</para>
|
|
</note>
|
|
<para>IPv6 address mode. dhcpv6-stateful, dhcpv6-stateless, or slaac.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: dhcpv6-stateful, dhcpv6-stateless, slaac</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">ipv6_ra_mode</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo)</para>
|
|
</note>
|
|
<para>IPv6 RA (Router Advertisement) mode. dhcpv6-stateful, dhcpv6-stateless, or slaac.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: dhcpv6-stateful, dhcpv6-stateless, slaac</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>The name of the subnet.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">network</term>
|
|
<listitem>
|
|
<para>The ID of the attached network.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.network</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">tenant_id</term>
|
|
<listitem>
|
|
<para>The ID of the tenant who owns the network. Only administrative users can specify a tenant ID other than their own.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">value_specs</term>
|
|
<listitem>
|
|
<para>Extra parameters to include in the creation request.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "{}".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">network_id</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED - Use property network.</para>
|
|
</note>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.network</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Subnet-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>allocation_pools</term>
|
|
<listitem>
|
|
<para>Ip allocation pools and their ranges.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>cidr</term>
|
|
<listitem>
|
|
<para>CIDR block notation for this subnet.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>dns_nameservers</term>
|
|
<listitem>
|
|
<para>List of dns nameservers.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>enable_dhcp</term>
|
|
<listitem>
|
|
<para>'true' if DHCP is enabled for this subnet; 'false' otherwise.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>gateway_ip</term>
|
|
<listitem>
|
|
<para>Ip of the subnet's gateway.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>host_routes</term>
|
|
<listitem>
|
|
<para>Additional routes for this subnet.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>ip_version</term>
|
|
<listitem>
|
|
<para>Ip version for the subnet.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>name</term>
|
|
<listitem>
|
|
<para>Friendly name of the subnet.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>network_id</term>
|
|
<listitem>
|
|
<para>Parent network of the subnet.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>show</term>
|
|
<listitem>
|
|
<para>All attributes.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>tenant_id</term>
|
|
<listitem>
|
|
<para>Tenant owning the subnet.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Subnet-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::Subnet
|
|
properties:
|
|
allocation_pools: [{"start": String, "end": String}, {"start": String, "end": String}, ...]
|
|
cidr: String
|
|
dns_nameservers: [Value, Value, ...]
|
|
enable_dhcp: Boolean
|
|
gateway_ip: String
|
|
host_routes: [{"nexthop": String, "destination": String}, {"nexthop": String, "destination": String}, ...]
|
|
ip_version: Integer
|
|
ipv6_address_mode: String
|
|
ipv6_ra_mode: String
|
|
name: String
|
|
network: String
|
|
tenant_id: String
|
|
value_specs: {...}</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Subnet-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::Subnet
|
|
Properties:
|
|
allocation_pools: [{"start": String, "end": String}, {"start": String, "end": String}, ...]
|
|
cidr: String
|
|
dns_nameservers: [Value, Value, ...]
|
|
enable_dhcp: Boolean
|
|
gateway_ip: String
|
|
host_routes: [{"nexthop": String, "destination": String}, {"nexthop": String, "destination": String}, ...]
|
|
ip_version: Integer
|
|
ipv6_address_mode: String
|
|
ipv6_ra_mode: String
|
|
name: String
|
|
network: String
|
|
tenant_id: String
|
|
value_specs: {...}</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__Subnet-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::Subnet",
|
|
"Properties": {
|
|
"allocation_pools": [{"start": String, "end": String}, {"start": String, "end": String}, ...],
|
|
"cidr": String,
|
|
"dns_nameservers": [Value, Value, ...],
|
|
"enable_dhcp": Boolean,
|
|
"gateway_ip": String,
|
|
"host_routes": [{"nexthop": String, "destination": String}, {"nexthop": String, "destination": String}, ...],
|
|
"ip_version": Integer,
|
|
"ipv6_address_mode": String,
|
|
"ipv6_ra_mode": String,
|
|
"name": String,
|
|
"network": String,
|
|
"tenant_id": String,
|
|
"value_specs": {...}
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Neutron__VPNService">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Neutron::VPNService</title>
|
|
<para>A resource for VPN service in Neutron.</para>
|
|
<section xml:id="OS__Neutron__VPNService-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Boolean">admin_state_up</term>
|
|
<listitem>
|
|
<para>Administrative state for the vpn service.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "True".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description for the vpn service.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name for the vpn service.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">router</term>
|
|
<listitem>
|
|
<para>The router to which the vpn service will be inserted.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.router</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">subnet</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2014.2 (Juno)</para>
|
|
</note>
|
|
<para>Subnet in which the vpn service will be created.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.subnet</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">router_id</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED - Use property router</para>
|
|
</note>
|
|
<para>Unique identifier for the router to which the vpn service will be inserted.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.router</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">subnet_id</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED - Use property subnet.</para>
|
|
</note>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.subnet</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__VPNService-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>admin_state_up</term>
|
|
<listitem>
|
|
<para>The administrative state of the vpn service.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>description</term>
|
|
<listitem>
|
|
<para>The description of the vpn service.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>name</term>
|
|
<listitem>
|
|
<para>The name of the vpn service.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>router_id</term>
|
|
<listitem>
|
|
<para>The unique identifier of the router to which the vpn service was inserted.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>show</term>
|
|
<listitem>
|
|
<para>All attributes.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>status</term>
|
|
<listitem>
|
|
<para>The status of the vpn service.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>subnet_id</term>
|
|
<listitem>
|
|
<para>The unique identifier of the subnet in which the vpn service was created.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>tenant_id</term>
|
|
<listitem>
|
|
<para>The unique identifier of the tenant owning the vpn service.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Neutron__VPNService-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Neutron::VPNService
|
|
properties:
|
|
admin_state_up: Boolean
|
|
description: String
|
|
name: String
|
|
router: String
|
|
subnet: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__VPNService-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Neutron::VPNService
|
|
Properties:
|
|
admin_state_up: Boolean
|
|
description: String
|
|
name: String
|
|
router: String
|
|
subnet: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Neutron__VPNService-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Neutron::VPNService",
|
|
"Properties": {
|
|
"admin_state_up": Boolean,
|
|
"description": String,
|
|
"name": String,
|
|
"router": String,
|
|
"subnet": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Nova__Flavor">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Nova::Flavor</title>
|
|
<para>A resource for creating OpenStack virtual hardware templates.</para>
|
|
<para>Due to default nova security policy usage of this resource is limited to
|
|
being used by administrators only. The rights may also be delegated to
|
|
other users by redefining the access controls on the nova-api server.</para>
|
|
<para>Note that the current implementation of the Nova Flavor resource does not
|
|
allow specifying the name and flavorid properties for the resource.
|
|
This is done to avoid potential naming collision upon flavor creation as
|
|
all flavor have a global scope.</para>
|
|
<section xml:id="OS__Nova__Flavor-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Integer">disk</term>
|
|
<listitem>
|
|
<para>Size of local disk in GB. Set the value to 0 to remove limit on disk size.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">ephemeral</term>
|
|
<listitem>
|
|
<para>Size of a secondary ephemeral data disk in GB.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "0".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">extra_specs</term>
|
|
<listitem>
|
|
<para>Key/Value pairs to extend the capabilities of the flavor.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">ram</term>
|
|
<listitem>
|
|
<para>Memory in MB for the flavor.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Number">rxtx_factor</term>
|
|
<listitem>
|
|
<para>RX/TX factor.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "1.0".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">swap</term>
|
|
<listitem>
|
|
<para>Swap space in MB.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "0".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">vcpus</term>
|
|
<listitem>
|
|
<para>Number of VCPUs for the flavor.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Nova__Flavor-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Nova::Flavor
|
|
properties:
|
|
disk: Integer
|
|
ephemeral: Integer
|
|
extra_specs: {...}
|
|
ram: Integer
|
|
rxtx_factor: Number
|
|
swap: Integer
|
|
vcpus: Integer</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Nova__Flavor-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Nova::Flavor
|
|
Properties:
|
|
disk: Integer
|
|
ephemeral: Integer
|
|
extra_specs: {...}
|
|
ram: Integer
|
|
rxtx_factor: Number
|
|
swap: Integer
|
|
vcpus: Integer</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Nova__Flavor-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Nova::Flavor",
|
|
"Properties": {
|
|
"disk": Integer,
|
|
"ephemeral": Integer,
|
|
"extra_specs": {...},
|
|
"ram": Integer,
|
|
"rxtx_factor": Number,
|
|
"swap": Integer,
|
|
"vcpus": Integer
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Nova__FloatingIP">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Nova::FloatingIP</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<section xml:id="OS__Nova__FloatingIP-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">pool</term>
|
|
<listitem>
|
|
<para>Allocate a floating IP from a given floating IP pool.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Nova__FloatingIP-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>ip</term>
|
|
<listitem>
|
|
<para>Allocated floating IP address.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>pool</term>
|
|
<listitem>
|
|
<para>Pool from which floating IP is allocated.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Nova__FloatingIP-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Nova::FloatingIP
|
|
properties:
|
|
pool: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Nova__FloatingIP-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Nova::FloatingIP
|
|
Properties:
|
|
pool: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Nova__FloatingIP-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Nova::FloatingIP",
|
|
"Properties": {
|
|
"pool": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Nova__FloatingIPAssociation">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Nova::FloatingIPAssociation</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<section xml:id="OS__Nova__FloatingIPAssociation-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">floating_ip</term>
|
|
<listitem>
|
|
<para>ID of the floating IP to assign to the server.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">server_id</term>
|
|
<listitem>
|
|
<para>Server to assign floating IP to.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Value must be of type nova.server</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Nova__FloatingIPAssociation-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Nova::FloatingIPAssociation
|
|
properties:
|
|
floating_ip: String
|
|
server_id: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Nova__FloatingIPAssociation-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Nova::FloatingIPAssociation
|
|
Properties:
|
|
floating_ip: String
|
|
server_id: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Nova__FloatingIPAssociation-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Nova::FloatingIPAssociation",
|
|
"Properties": {
|
|
"floating_ip": String,
|
|
"server_id": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Nova__KeyPair">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Nova::KeyPair</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<para>A resource for creating Nova key pairs.</para>
|
|
<para><emphasis role="Note"/> that if a new key is generated setting <citetitle>save_private_key</citetitle> to
|
|
<citetitle>True</citetitle> results in the system saving the private key which can then be
|
|
retrieved via the <citetitle>private_key</citetitle> attribute of this resource.</para>
|
|
<para>Setting the <citetitle>public_key</citetitle> property means that the <citetitle>private_key</citetitle> attribute
|
|
of this resource will always return an empty string regardless of the
|
|
<citetitle>save_private_key</citetitle> setting since there will be no private key data to
|
|
save.</para>
|
|
<section xml:id="OS__Nova__KeyPair-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>The name of the key pair.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>The length must be in the range 1 to 255.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">public_key</term>
|
|
<listitem>
|
|
<para>The optional public key. This allows users to supply the public key from a pre-existing key pair. If not supplied, a new key pair will be generated.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">save_private_key</term>
|
|
<listitem>
|
|
<para>True if the system should remember a generated private key; False otherwise.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "False".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Nova__KeyPair-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>private_key</term>
|
|
<listitem>
|
|
<para>The private key if it has been saved.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>public_key</term>
|
|
<listitem>
|
|
<para>The public key.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Nova__KeyPair-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Nova::KeyPair
|
|
properties:
|
|
name: String
|
|
public_key: String
|
|
save_private_key: Boolean</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Nova__KeyPair-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Nova::KeyPair
|
|
Properties:
|
|
name: String
|
|
public_key: String
|
|
save_private_key: Boolean</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Nova__KeyPair-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Nova::KeyPair",
|
|
"Properties": {
|
|
"name": String,
|
|
"public_key": String,
|
|
"save_private_key": Boolean
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Nova__Server">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Nova::Server</title>
|
|
<para>Resource for Rackspace Cloud Servers.</para>
|
|
<section xml:id="OS__Nova__Server-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">admin_pass</term>
|
|
<listitem>
|
|
<para>The administrator password for the server.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">availability_zone</term>
|
|
<listitem>
|
|
<para>Name of the availability zone for server placement.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">block_device_mapping</term>
|
|
<listitem>
|
|
<para>Block device mappings for this server.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Boolean">delete_on_termination</term>
|
|
<listitem>
|
|
<para>Indicate whether the volume should be deleted when the server is terminated.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">device_name</term>
|
|
<listitem>
|
|
<para>A device name where the volume will be attached in the system at /dev/device_name. This value is typically vda.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">snapshot_id</term>
|
|
<listitem>
|
|
<para>The ID of the snapshot to create a volume from.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type cinder.snapshot</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">volume_id</term>
|
|
<listitem>
|
|
<para>The ID of the volume to boot from. Only one of volume_id or snapshot_id should be provided.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type cinder.volume</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">volume_size</term>
|
|
<listitem>
|
|
<para>The size of the volume, in GB. It is safe to leave this blank and have the Compute service infer the size.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">block_device_mapping_v2</term>
|
|
<listitem>
|
|
<para>Block device mappings v2 for this server.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Integer">boot_index</term>
|
|
<listitem>
|
|
<para>Integer used for ordering the boot disks.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">delete_on_termination</term>
|
|
<listitem>
|
|
<para>Indicate whether the volume should be deleted when the server is terminated.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">device_name</term>
|
|
<listitem>
|
|
<para>A device name where the volume will be attached in the system at /dev/device_name. This value is typically vda.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">device_type</term>
|
|
<listitem>
|
|
<para>Device type: at the moment we can make distinction only between disk and cdrom.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: cdrom, disk</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">disk_bus</term>
|
|
<listitem>
|
|
<para>Bus of the device: hypervisor driver chooses a suitable default if omitted.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: ide, lame_bus, scsi, usb, virtio</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">image_id</term>
|
|
<listitem>
|
|
<para>The ID of the image to create a volume from.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type glance.image</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">snapshot_id</term>
|
|
<listitem>
|
|
<para>The ID of the snapshot to create a volume from.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type cinder.snapshot</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">swap_size</term>
|
|
<listitem>
|
|
<para>The size of the swap, in MB.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">volume_id</term>
|
|
<listitem>
|
|
<para>The volume_id can be boot or non-boot device to the server.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type cinder.volume</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">volume_size</term>
|
|
<listitem>
|
|
<para>Size of the block device in GB. If it is omitted, hypervisor driver calculates size.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Boolean">config_drive</term>
|
|
<listitem>
|
|
<para>If True, enable config drive on the server.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">diskConfig</term>
|
|
<listitem>
|
|
<para>Control how the disk is partitioned when the server is created.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Allowed values: AUTO, MANUAL</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">flavor</term>
|
|
<listitem>
|
|
<para>The ID or name of the flavor to boot onto.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Value must be of type nova.flavor</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">flavor_update_policy</term>
|
|
<listitem>
|
|
<para>Policy on how to apply a flavor update; either by requesting a server resize or by replacing the entire server.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "RESIZE".</para>
|
|
<para>Allowed values: RESIZE, REPLACE</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">image</term>
|
|
<listitem>
|
|
<para>The ID or name of the image to boot with.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type glance.image</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">image_update_policy</term>
|
|
<listitem>
|
|
<para>Policy on how to apply an image-id update; either by requesting a server rebuild or by replacing the entire server</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property, defaults to "REBUILD".</para>
|
|
<para>Allowed values: REBUILD, REPLACE, REBUILD_PRESERVE_EPHEMERAL</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">key_name</term>
|
|
<listitem>
|
|
<para>Name of keypair to inject into the server.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type nova.keypair</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">metadata</term>
|
|
<listitem>
|
|
<para>Arbitrary key/value metadata to store for this server. Both keys and values must be 255 characters or less. Non-string values will be serialized to JSON (and the serialized string must be 255 characters or less).</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Server name.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">networks</term>
|
|
<listitem>
|
|
<para>An ordered list of nics to be added to this server, with information about connected networks, fixed ips, port etc.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">fixed_ip</term>
|
|
<listitem>
|
|
<para>Fixed IP address to specify for the port created on the requested network.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">network</term>
|
|
<listitem>
|
|
<para>Name or ID of network to create a port on.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.network</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">port</term>
|
|
<listitem>
|
|
<para>ID of an existing port to associate with this server.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.port</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">uuid</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED - Use property network.</para>
|
|
</note>
|
|
<para>ID of network to create a port on.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.network</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">personality</term>
|
|
<listitem>
|
|
<para>A map of files to create/overwrite on the server upon boot. Keys are file names and values are the file contents.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "{}".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">reservation_id</term>
|
|
<listitem>
|
|
<para>A UUID for the set of servers being requested.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">scheduler_hints</term>
|
|
<listitem>
|
|
<para>Arbitrary key-value pairs specified by the client to help boot a server.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">security_groups</term>
|
|
<listitem>
|
|
<para>List of security group names or IDs. Cannot be used if neutron ports are associated with this server; assign security groups to the ports instead.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "[]".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">software_config_transport</term>
|
|
<listitem>
|
|
<para>How the server should receive the metadata required for software configuration. POLL_SERVER_CFN will allow calls to the cfn API action DescribeStackResource authenticated with the provided keypair. POLL_SERVER_HEAT will allow calls to the Heat API resource-show using the provided keystone credentials. POLL_TEMP_URL will create and populate a Swift TempURL with metadata for polling.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "POLL_SERVER_CFN".</para>
|
|
<para>Allowed values: POLL_SERVER_CFN, POLL_SERVER_HEAT, POLL_TEMP_URL</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">user_data</term>
|
|
<listitem>
|
|
<para>User data script to be executed by cloud-init.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">user_data_format</term>
|
|
<listitem>
|
|
<para>How the user_data should be formatted for the server. For HEAT_CFNTOOLS, the user_data is bundled as part of the heat-cfntools cloud-init boot configuration data. For RAW the user_data is passed to Nova unmodified. For SOFTWARE_CONFIG user_data is bundled as part of the software config data, and metadata is derived from any associated SoftwareDeployment resources.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "HEAT_CFNTOOLS".</para>
|
|
<para>Allowed values: HEAT_CFNTOOLS, RAW, SOFTWARE_CONFIG</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">admin_user</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED</para>
|
|
</note>
|
|
<para>Name of the administrative user to use on the server. This property will be removed from Juno in favor of the default cloud-init user set up for each image (e.g. "ubuntu" for Ubuntu 12.04+, "fedora" for Fedora 19+ and "cloud-user" for CentOS/RHEL 6.5).</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Nova__Server-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>accessIPv4</term>
|
|
<listitem>
|
|
<para>The manually assigned alternative public IPv4 address of the server.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>accessIPv6</term>
|
|
<listitem>
|
|
<para>The manually assigned alternative public IPv6 address of the server.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>addresses</term>
|
|
<listitem>
|
|
<para>A dict of all network addresses with corresponding port_id. The port ID may be obtained through the following expression: "{get_attr: [<server>, addresses, <network name>, 0, port]}".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>console_urls</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo)</para>
|
|
</note>
|
|
<para>URLs of server's consoles. To get a specific console type, the requested type can be specified as parameter to the get_attr function, e.g. get_attr: [ <server>, console_urls, novnc ]. Currently supported types are novnc, xvpvnc, spice-html5, rdp-html5, serial.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>first_address</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED - Use the networks attribute instead of first_address. For example: "{get_attr: [<server name>, networks, <network name>, 0]}"</para>
|
|
</note>
|
|
<para>Convenience attribute to fetch the first assigned network address, or an empty string if nothing has been assigned at this time. Result may not be predictable if the server has addresses from more than one network.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>instance_name</term>
|
|
<listitem>
|
|
<para>AWS compatible instance name.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>name</term>
|
|
<listitem>
|
|
<para>Name of the server.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>networks</term>
|
|
<listitem>
|
|
<para>A dict of assigned network addresses of the form: {"public": [ip1, ip2...], "private": [ip3, ip4]}.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>show</term>
|
|
<listitem>
|
|
<para>A dict of all server details as returned by the API.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Nova__Server-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Nova::Server
|
|
properties:
|
|
admin_pass: String
|
|
availability_zone: String
|
|
block_device_mapping: [{"volume_size": Integer, "volume_id": String, "snapshot_id": String, "delete_on_termination": Boolean, "device_name": String}, {"volume_size": Integer, "volume_id": String, "snapshot_id": String, "delete_on_termination": Boolean, "device_name": String}, ...]
|
|
block_device_mapping_v2: [{"disk_bus": String, "image_id": String, "boot_index": Integer, "device_type": String, "swap_size": Integer, "volume_id": String, "delete_on_termination": Boolean, "snapshot_id": String, "volume_size": Integer, "device_name": String}, {"disk_bus": String, "image_id": String, "boot_index": Integer, "device_type": String, "swap_size": Integer, "volume_id": String, "delete_on_termination": Boolean, "snapshot_id": String, "volume_size": Integer, "device_name": String}, ...]
|
|
config_drive: Boolean
|
|
diskConfig: String
|
|
flavor: String
|
|
flavor_update_policy: String
|
|
image: String
|
|
image_update_policy: String
|
|
key_name: String
|
|
metadata: {...}
|
|
name: String
|
|
networks: [{"port": String, "fixed_ip": String, "uuid": String, "network": String}, {"port": String, "fixed_ip": String, "uuid": String, "network": String}, ...]
|
|
personality: {...}
|
|
reservation_id: String
|
|
scheduler_hints: {...}
|
|
security_groups: [Value, Value, ...]
|
|
software_config_transport: String
|
|
user_data: String
|
|
user_data_format: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Nova__Server-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Nova::Server
|
|
Properties:
|
|
admin_pass: String
|
|
availability_zone: String
|
|
block_device_mapping: [{"volume_size": Integer, "volume_id": String, "snapshot_id": String, "delete_on_termination": Boolean, "device_name": String}, {"volume_size": Integer, "volume_id": String, "snapshot_id": String, "delete_on_termination": Boolean, "device_name": String}, ...]
|
|
block_device_mapping_v2: [{"disk_bus": String, "image_id": String, "boot_index": Integer, "device_type": String, "swap_size": Integer, "volume_id": String, "delete_on_termination": Boolean, "snapshot_id": String, "volume_size": Integer, "device_name": String}, {"disk_bus": String, "image_id": String, "boot_index": Integer, "device_type": String, "swap_size": Integer, "volume_id": String, "delete_on_termination": Boolean, "snapshot_id": String, "volume_size": Integer, "device_name": String}, ...]
|
|
config_drive: Boolean
|
|
diskConfig: String
|
|
flavor: String
|
|
flavor_update_policy: String
|
|
image: String
|
|
image_update_policy: String
|
|
key_name: String
|
|
metadata: {...}
|
|
name: String
|
|
networks: [{"port": String, "fixed_ip": String, "uuid": String, "network": String}, {"port": String, "fixed_ip": String, "uuid": String, "network": String}, ...]
|
|
personality: {...}
|
|
reservation_id: String
|
|
scheduler_hints: {...}
|
|
security_groups: [Value, Value, ...]
|
|
software_config_transport: String
|
|
user_data: String
|
|
user_data_format: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Nova__Server-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Nova::Server",
|
|
"Properties": {
|
|
"admin_pass": String,
|
|
"availability_zone": String,
|
|
"block_device_mapping": [{"volume_size": Integer, "volume_id": String, "snapshot_id": String, "delete_on_termination": Boolean, "device_name": String}, {"volume_size": Integer, "volume_id": String, "snapshot_id": String, "delete_on_termination": Boolean, "device_name": String}, ...],
|
|
"block_device_mapping_v2": [{"disk_bus": String, "image_id": String, "boot_index": Integer, "device_type": String, "swap_size": Integer, "volume_id": String, "delete_on_termination": Boolean, "snapshot_id": String, "volume_size": Integer, "device_name": String}, {"disk_bus": String, "image_id": String, "boot_index": Integer, "device_type": String, "swap_size": Integer, "volume_id": String, "delete_on_termination": Boolean, "snapshot_id": String, "volume_size": Integer, "device_name": String}, ...],
|
|
"config_drive": Boolean,
|
|
"diskConfig": String,
|
|
"flavor": String,
|
|
"flavor_update_policy": String,
|
|
"image": String,
|
|
"image_update_policy": String,
|
|
"key_name": String,
|
|
"metadata": {...},
|
|
"name": String,
|
|
"networks": [{"port": String, "fixed_ip": String, "uuid": String, "network": String}, {"port": String, "fixed_ip": String, "uuid": String, "network": String}, ...],
|
|
"personality": {...},
|
|
"reservation_id": String,
|
|
"scheduler_hints": {...},
|
|
"security_groups": [Value, Value, ...],
|
|
"software_config_transport": String,
|
|
"user_data": String,
|
|
"user_data_format": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Nova__ServerGroup">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Nova::ServerGroup</title>
|
|
<note>
|
|
<para>Available since 2014.2 (Juno)</para>
|
|
</note>
|
|
<para>A resource for managing a Nova server group.</para>
|
|
<section xml:id="OS__Nova__ServerGroup-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Server Group name.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">policies</term>
|
|
<listitem>
|
|
<para>A list of string policies to apply. Defaults to anti-affinity.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "['anti-affinity']".</para>
|
|
<para>Allowed values: anti-affinity, affinity</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Nova__ServerGroup-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Nova::ServerGroup
|
|
properties:
|
|
name: String
|
|
policies: [String, String, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Nova__ServerGroup-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Nova::ServerGroup
|
|
Properties:
|
|
name: String
|
|
policies: [String, String, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Nova__ServerGroup-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Nova::ServerGroup",
|
|
"Properties": {
|
|
"name": String,
|
|
"policies": [String, String, ...]
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Sahara__Cluster">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Sahara::Cluster</title>
|
|
<section xml:id="OS__Sahara__Cluster-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">cluster_template_id</term>
|
|
<listitem>
|
|
<para>ID of the Cluster Template used for Node Groups and configurations.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">default_image_id</term>
|
|
<listitem>
|
|
<para>Default name or UUID of the image used to boot Hadoop nodes.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type sahara.image</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">hadoop_version</term>
|
|
<listitem>
|
|
<para>Version of Hadoop running on instances.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">key_name</term>
|
|
<listitem>
|
|
<para>Keypair added to instances to make them accessible for user.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type nova.keypair</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Hadoop cluster name.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">neutron_management_network</term>
|
|
<listitem>
|
|
<para>Name or UUID of network.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.network</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">plugin_name</term>
|
|
<listitem>
|
|
<para>Plugin name.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">image</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED - Property was deprecated in Kilo release. Use property default_image_id.</para>
|
|
</note>
|
|
<para>Name or UUID of the image used to boot Hadoop nodes.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type glance.image</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Sahara__Cluster-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>info</term>
|
|
<listitem>
|
|
<para>Cluster information.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>status</term>
|
|
<listitem>
|
|
<para>Cluster status.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Sahara__Cluster-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
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</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Sahara__Cluster-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
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</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Sahara__Cluster-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"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
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Sahara__ClusterTemplate">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Sahara::ClusterTemplate</title>
|
|
<note>
|
|
<para>Available since 2014.2 (Juno)</para>
|
|
</note>
|
|
<section xml:id="OS__Sahara__ClusterTemplate-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="List">anti_affinity</term>
|
|
<listitem>
|
|
<para>List of processes to enable anti-affinity for.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">cluster_configs</term>
|
|
<listitem>
|
|
<para>Cluster configs dictionary.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">default_image_id</term>
|
|
<listitem>
|
|
<para>ID of the default image to use for the template.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type sahara.image</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description of the Sahara Group Template.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">hadoop_version</term>
|
|
<listitem>
|
|
<para>Version of Hadoop running on instances.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name for the Sahara Cluster Template.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>The length must be in the range 1 to 50.</para>
|
|
<para>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])$</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">neutron_management_network</term>
|
|
<listitem>
|
|
<para>Name or UUID of network.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.network</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">node_groups</term>
|
|
<listitem>
|
|
<para>Node groups.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Integer">count</term>
|
|
<listitem>
|
|
<para>Number of instances in the Node group.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>The value must be at least 1.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name of the Node group.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">node_group_template_id</term>
|
|
<listitem>
|
|
<para>ID of the Node Group Template.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">plugin_name</term>
|
|
<listitem>
|
|
<para>Plugin name.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Sahara__ClusterTemplate-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
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: [{"count": Integer, "name": String, "node_group_template_id": String}, {"count": Integer, "name": String, "node_group_template_id": String}, ...]
|
|
plugin_name: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Sahara__ClusterTemplate-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
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: [{"count": Integer, "name": String, "node_group_template_id": String}, {"count": Integer, "name": String, "node_group_template_id": String}, ...]
|
|
plugin_name: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Sahara__ClusterTemplate-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"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": [{"count": Integer, "name": String, "node_group_template_id": String}, {"count": Integer, "name": String, "node_group_template_id": String}, ...],
|
|
"plugin_name": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Sahara__NodeGroupTemplate">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Sahara::NodeGroupTemplate</title>
|
|
<note>
|
|
<para>Available since 2014.2 (Juno)</para>
|
|
</note>
|
|
<section xml:id="OS__Sahara__NodeGroupTemplate-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Boolean">auto_security_group</term>
|
|
<listitem>
|
|
<para>Defines whether auto-assign security group to this Node Group template.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">availability_zone</term>
|
|
<listitem>
|
|
<para>Availability zone to create servers in.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">description</term>
|
|
<listitem>
|
|
<para>Description of the Node Group Template.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">flavor</term>
|
|
<listitem>
|
|
<para>Name or ID Nova flavor for the nodes.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Value must be of type nova.flavor</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">floating_ip_pool</term>
|
|
<listitem>
|
|
<para>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.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">hadoop_version</term>
|
|
<listitem>
|
|
<para>Version of Hadoop running on instances.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">image_id</term>
|
|
<listitem>
|
|
<para>ID of the image to use for the template.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type sahara.image</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name for the Sahara Node Group Template.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>The length must be in the range 1 to 50.</para>
|
|
<para>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])$</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">node_configs</term>
|
|
<listitem>
|
|
<para>Dictionary of node configurations.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">node_processes</term>
|
|
<listitem>
|
|
<para>List of processes to run on every node.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>The length must be at least 1.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">plugin_name</term>
|
|
<listitem>
|
|
<para>Plugin name.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">security_groups</term>
|
|
<listitem>
|
|
<para>List of security group names or IDs to assign to this Node Group template.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">volume_type</term>
|
|
<listitem>
|
|
<para>Type of the volume to create on Cinder backend.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type cinder.vtype</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">volumes_availability_zone</term>
|
|
<listitem>
|
|
<para>Availability zone to create volumes in.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">volumes_per_node</term>
|
|
<listitem>
|
|
<para>Volumes per node.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>The value must be at least 0.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">volumes_size</term>
|
|
<listitem>
|
|
<para>Size of the volumes, in GB.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>The value must be at least 1.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Sahara__NodeGroupTemplate-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
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
|
|
name: String
|
|
node_configs: {...}
|
|
node_processes: [String, String, ...]
|
|
plugin_name: String
|
|
security_groups: [String, String, ...]
|
|
volume_type: String
|
|
volumes_availability_zone: String
|
|
volumes_per_node: Integer
|
|
volumes_size: Integer</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Sahara__NodeGroupTemplate-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
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
|
|
name: String
|
|
node_configs: {...}
|
|
node_processes: [String, String, ...]
|
|
plugin_name: String
|
|
security_groups: [String, String, ...]
|
|
volume_type: String
|
|
volumes_availability_zone: String
|
|
volumes_per_node: Integer
|
|
volumes_size: Integer</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Sahara__NodeGroupTemplate-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"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,
|
|
"name": String,
|
|
"node_configs": {...},
|
|
"node_processes": [String, String, ...],
|
|
"plugin_name": String,
|
|
"security_groups": [String, String, ...],
|
|
"volume_type": String,
|
|
"volumes_availability_zone": String,
|
|
"volumes_per_node": Integer,
|
|
"volumes_size": Integer
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Swift__Container">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Swift::Container</title>
|
|
<section xml:id="OS__Swift__Container-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Boolean">PurgeOnDelete</term>
|
|
<listitem>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo)</para>
|
|
</note>
|
|
<para>If True, delete any objects in the container when the container is deleted. Otherwise, deleting a non-empty container will result in an error.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "False".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">X-Account-Meta</term>
|
|
<listitem>
|
|
<para>A map of user-defined meta data to associate with the account. Each key in the map will set the header X-Account-Meta-{key} with the corresponding value.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "{}".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Map">X-Container-Meta</term>
|
|
<listitem>
|
|
<para>A map of user-defined meta data to associate with the container. Each key in the map will set the header X-Container-Meta-{key} with the corresponding value.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "{}".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">X-Container-Read</term>
|
|
<listitem>
|
|
<para>Specify the ACL permissions on who can read objects in the container.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">X-Container-Write</term>
|
|
<listitem>
|
|
<para>Specify the ACL permissions on who can write objects to the container.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name for the container. If not specified, a unique name will be generated.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Swift__Container-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>BytesUsed</term>
|
|
<listitem>
|
|
<para>The number of bytes stored in the container.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>DomainName</term>
|
|
<listitem>
|
|
<para>The host from the container URL.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>HeadContainer</term>
|
|
<listitem>
|
|
<para>A map containing all headers for the container.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>ObjectCount</term>
|
|
<listitem>
|
|
<para>The number of objects stored in the container.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>RootURL</term>
|
|
<listitem>
|
|
<para>The parent URL of the container.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>WebsiteURL</term>
|
|
<listitem>
|
|
<para>The URL of the container.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Swift__Container-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Swift::Container
|
|
properties:
|
|
PurgeOnDelete: Boolean
|
|
X-Account-Meta: {...}
|
|
X-Container-Meta: {...}
|
|
X-Container-Read: String
|
|
X-Container-Write: String
|
|
name: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Swift__Container-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Swift::Container
|
|
Properties:
|
|
PurgeOnDelete: Boolean
|
|
X-Account-Meta: {...}
|
|
X-Container-Meta: {...}
|
|
X-Container-Read: String
|
|
X-Container-Write: String
|
|
name: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Swift__Container-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Swift::Container",
|
|
"Properties": {
|
|
"PurgeOnDelete": Boolean,
|
|
"X-Account-Meta": {...},
|
|
"X-Container-Meta": {...},
|
|
"X-Container-Read": String,
|
|
"X-Container-Write": String,
|
|
"name": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Trove__Cluster">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Trove::Cluster</title>
|
|
<note>
|
|
<para>Available since 2015.1 (Kilo)</para>
|
|
</note>
|
|
<section xml:id="OS__Trove__Cluster-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">datastore_type</term>
|
|
<listitem>
|
|
<para>Name of registered datastore type.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>The length must be no greater than 255.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">datastore_version</term>
|
|
<listitem>
|
|
<para>Name of the registered datastore version. It must exist for provided datastore type. Defaults to using single active version. If several active versions exist for provided datastore type, explicit value for this parameter must be specified.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>The length must be no greater than 255.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">instances</term>
|
|
<listitem>
|
|
<para>List of database instances.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">flavor</term>
|
|
<listitem>
|
|
<para>Flavor of the instance.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Value must be of type trove.flavor</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">volume_size</term>
|
|
<listitem>
|
|
<para>Size of the instance disk volume in GB.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>The value must be in the range 1 to 150.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name of the cluster to create.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>The length must be no greater than 255.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Trove__Cluster-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>instances</term>
|
|
<listitem>
|
|
<para>A list of instances ids.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>ip</term>
|
|
<listitem>
|
|
<para>IP of the cluster.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Trove__Cluster-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Trove::Cluster
|
|
properties:
|
|
datastore_type: String
|
|
datastore_version: String
|
|
instances: [{"volume_size": Integer, "flavor": String}, {"volume_size": Integer, "flavor": String}, ...]
|
|
name: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Trove__Cluster-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Trove::Cluster
|
|
Properties:
|
|
datastore_type: String
|
|
datastore_version: String
|
|
instances: [{"volume_size": Integer, "flavor": String}, {"volume_size": Integer, "flavor": String}, ...]
|
|
name: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Trove__Cluster-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Trove::Cluster",
|
|
"Properties": {
|
|
"datastore_type": String,
|
|
"datastore_version": String,
|
|
"instances": [{"volume_size": Integer, "flavor": String}, {"volume_size": Integer, "flavor": String}, ...],
|
|
"name": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Trove__Instance">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Trove::Instance</title>
|
|
<note>
|
|
<para>Available since 2014.1 (Icehouse)</para>
|
|
</note>
|
|
<para>OpenStack cloud database instance resource.</para>
|
|
<section xml:id="OS__Trove__Instance-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">availability_zone</term>
|
|
<listitem>
|
|
<para>Name of the availability zone for DB instance.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">databases</term>
|
|
<listitem>
|
|
<para>List of databases to be created on DB instance creation.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "[]".</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">character_set</term>
|
|
<listitem>
|
|
<para>Set of symbols and encodings.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "utf8".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">collate</term>
|
|
<listitem>
|
|
<para>Set of rules for comparing characters in a character set.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "utf8_general_ci".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Specifies database names for creating databases on instance creation.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>The length must be no greater than 64.</para>
|
|
<para>Value must match pattern: [a-zA-Z0-9_]+[a-zA-Z0-9_@?#\s]*[a-zA-Z0-9_]+</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">datastore_type</term>
|
|
<listitem>
|
|
<para>Name of registered datastore type.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>The length must be no greater than 255.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">datastore_version</term>
|
|
<listitem>
|
|
<para>Name of the registered datastore version. It must exist for provided datastore type. Defaults to using single active version. If several active versions exist for provided datastore type, explicit value for this parameter must be specified.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>The length must be no greater than 255.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">flavor</term>
|
|
<listitem>
|
|
<para>Reference to a flavor for creating DB instance.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Value must be of type trove.flavor</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name of the DB instance to create.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>The length must be no greater than 255.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">networks</term>
|
|
<listitem>
|
|
<para>List of network interfaces to create on instance.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "[]".</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">fixed_ip</term>
|
|
<listitem>
|
|
<para>Fixed IPv4 address for this NIC.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">network</term>
|
|
<listitem>
|
|
<para>Name or UUID of the network to attach this NIC to. Either port or network must be specified.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.network</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">port</term>
|
|
<listitem>
|
|
<para>Name or UUID of Neutron port to attach this NIC to. Either port or network must be specified.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>Value must be of type neutron.port</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">restore_point</term>
|
|
<listitem>
|
|
<para>DB instance restore point.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="Integer">size</term>
|
|
<listitem>
|
|
<para>Database volume size in GB.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>The value must be in the range 1 to 150.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="List">users</term>
|
|
<listitem>
|
|
<para>List of users to be created on DB instance creation.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "[]".</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
<para>
|
|
<emphasis>Map properties:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="List">databases</term>
|
|
<listitem>
|
|
<para>Names of databases that those users can access on instance creation.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>The length must be at least 1.</para>
|
|
<para>
|
|
<emphasis>List contents:</emphasis>
|
|
</para>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="String">*</term>
|
|
<listitem>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">host</term>
|
|
<listitem>
|
|
<para>The host from which a user is allowed to connect to the database.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Optional property, defaults to "%".</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>User name to create a user on instance creation.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>The length must be no greater than 16.</para>
|
|
<para>Value must match pattern: [a-zA-Z0-9_]+[a-zA-Z0-9_@?#\s]*[a-zA-Z0-9_]+</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">password</term>
|
|
<listitem>
|
|
<para>Password for those users on instance creation.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
<para>Value must match pattern: [a-zA-Z0-9_]+[a-zA-Z0-9_@?#\s]*[a-zA-Z0-9_]+</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Trove__Instance-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>hostname</term>
|
|
<listitem>
|
|
<para>Hostname of the instance.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>href</term>
|
|
<listitem>
|
|
<para>Api endpoint reference of the instance.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Trove__Instance-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Trove::Instance
|
|
properties:
|
|
availability_zone: String
|
|
databases: [{"character_set": String, "name": String, "collate": String}, {"character_set": String, "name": String, "collate": String}, ...]
|
|
datastore_type: String
|
|
datastore_version: String
|
|
flavor: String
|
|
name: String
|
|
networks: [{"fixed_ip": String, "network": String, "port": String}, {"fixed_ip": String, "network": String, "port": String}, ...]
|
|
restore_point: String
|
|
size: Integer
|
|
users: [{"host": String, "password": String, "name": String, "databases": [String, String, ...]}, {"host": String, "password": String, "name": String, "databases": [String, String, ...]}, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Trove__Instance-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Trove::Instance
|
|
Properties:
|
|
availability_zone: String
|
|
databases: [{"character_set": String, "name": String, "collate": String}, {"character_set": String, "name": String, "collate": String}, ...]
|
|
datastore_type: String
|
|
datastore_version: String
|
|
flavor: String
|
|
name: String
|
|
networks: [{"fixed_ip": String, "network": String, "port": String}, {"fixed_ip": String, "network": String, "port": String}, ...]
|
|
restore_point: String
|
|
size: Integer
|
|
users: [{"host": String, "password": String, "name": String, "databases": [String, String, ...]}, {"host": String, "password": String, "name": String, "databases": [String, String, ...]}, ...]</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Trove__Instance-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Trove::Instance",
|
|
"Properties": {
|
|
"availability_zone": String,
|
|
"databases": [{"character_set": String, "name": String, "collate": String}, {"character_set": String, "name": String, "collate": String}, ...],
|
|
"datastore_type": String,
|
|
"datastore_version": String,
|
|
"flavor": String,
|
|
"name": String,
|
|
"networks": [{"fixed_ip": String, "network": String, "port": String}, {"fixed_ip": String, "network": String, "port": String}, ...],
|
|
"restore_point": String,
|
|
"size": Integer,
|
|
"users": [{"host": String, "password": String, "name": String, "databases": [String, String, ...]}, {"host": String, "password": String, "name": String, "databases": [String, String, ...]}, ...]
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
<section xml:id="OS__Zaqar__Queue">
|
|
<?dbhtml stop-chunking?>
|
|
<title>OS::Zaqar::Queue</title>
|
|
<section xml:id="OS__Zaqar__Queue-props">
|
|
<title>Properties</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term role="Map">metadata</term>
|
|
<listitem>
|
|
<para>Arbitrary key/value metadata to store contextual information about this queue.</para>
|
|
<para>Can be updated without replacement.</para>
|
|
<para>Optional property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term role="String">name</term>
|
|
<listitem>
|
|
<para>Name of the queue instance to create.</para>
|
|
<para>Updates cause replacement.</para>
|
|
<para>Required property.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Zaqar__Queue-attrs">
|
|
<title>Attributes</title>
|
|
<variablelist role="definition_list">
|
|
<varlistentry>
|
|
<term>href</term>
|
|
<listitem>
|
|
<para>The resource href of the queue.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>queue_id</term>
|
|
<listitem>
|
|
<note>
|
|
<para>DEPRECATED - Deprecated in kilo. Use get_resource|Ref command instead. For example: { get_resource : <resource_name> }</para>
|
|
</note>
|
|
<para>ID of the queue.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</section>
|
|
<section xml:id="OS__Zaqar__Queue-hot">
|
|
<title>HOT Syntax</title>
|
|
<programlisting language="hot">heat_template_version: 2013-05-23
|
|
...
|
|
resources:
|
|
...
|
|
the_resource:
|
|
type: OS::Zaqar::Queue
|
|
properties:
|
|
metadata: {...}
|
|
name: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Zaqar__Queue-yaml">
|
|
<title>YAML Syntax</title>
|
|
<programlisting language="yaml">HeatTemplateFormatVersion: '2012-12-12'
|
|
...
|
|
Resources:
|
|
...
|
|
TheResource:
|
|
Type: OS::Zaqar::Queue
|
|
Properties:
|
|
metadata: {...}
|
|
name: String</programlisting>
|
|
</section>
|
|
<section xml:id="OS__Zaqar__Queue-json">
|
|
<title>JSON Syntax</title>
|
|
<programlisting language="json">{
|
|
"AWSTemplateFormatVersion" : "2010-09-09",
|
|
...
|
|
"Resources" : {
|
|
"TheResource": {
|
|
"Type": "OS::Zaqar::Queue",
|
|
"Properties": {
|
|
"metadata": {...},
|
|
"name": String
|
|
}
|
|
}
|
|
}
|
|
}</programlisting>
|
|
</section>
|
|
</section>
|
|
</chapter>
|