openstack/openstack-manuals
Code Issues Proposed changes

HOT reference update

Browse Source 
Run the script to import changes from the heat repository.

Change-Id: Id3a93c7e7aa2099e125a692e98a3dbdab9c6e67a
This commit is contained in:
Gauvain Pocentek 2014-11-11 21:21:38 +01:00
parent 1e9d2929ef
commit d816b1f934
3 changed files with 113 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/hot-reference/generated/cfn.xml
View File

@ -63,7 +63,7 @@ under the License.-->
<varlistentry> <varlistentry>
<term role="String">LaunchConfigurationName</term> <term role="String">LaunchConfigurationName</term>
<listitem> <listitem>
<para>Name of LaunchConfiguration resource.</para> <para>The reference to a LaunchConfiguration resource.</para>
<para>Can be updated without replacement.</para> <para>Can be updated without replacement.</para>
<para>Required property.</para> <para>Required property.</para>
</listitem> </listitem>

5
doc/hot-reference/generated/functions.xml
View File

@ -14,7 +14,10 @@ under the License.-->
<!--WARNING: This file is automatically generated. Do not edit it.--> <!--WARNING: This file is automatically generated. Do not edit it.-->
<title>CloudFormation Compatible Functions</title> <title>CloudFormation Compatible Functions</title>
<para>There are a number of functions that you can use to help you write <para>There are a number of functions that you can use to help you write
CloudFormation compatible templates.</para> CloudFormation compatible templates. While most CloudFormation functions are
supported in HOT version '2013-05-23', <emphasis>Fn::Select</emphasis> is the only CloudFormation
function supported in HOT templates since version '2014-10-16' which is
introduced in Juno.</para>
<para>All of these functions (except <emphasis>Ref</emphasis>) start with <emphasis>Fn::</emphasis>.</para> <para>All of these functions (except <emphasis>Ref</emphasis>) start with <emphasis>Fn::</emphasis>.</para>
<section xml:id="ref"> <section xml:id="ref">
<?dbhtml stop-chunking?> <?dbhtml stop-chunking?>

115
doc/hot-reference/generated/openstack.xml
View File

@ -72,7 +72,7 @@ under the License.-->
<term role="Map">matching_metadata</term> <term role="Map">matching_metadata</term>
<listitem> <listitem>
<para>Meter should match this resource metadata (key=value) additionally to the meter_name.</para> <para>Meter should match this resource metadata (key=value) additionally to the meter_name.</para>
<para>Updates cause replacement.</para> <para>Can be updated without replacement.</para>
<para>Optional property, defaults to "{}".</para> <para>Optional property, defaults to "{}".</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -100,6 +100,56 @@ under the License.-->
<para>Optional property.</para> <para>Optional property.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term role="List">query</term>
<listitem>
<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> <varlistentry>
<term role="Boolean">repeat_actions</term> <term role="Boolean">repeat_actions</term>
<listitem> <listitem>
@ -146,6 +196,7 @@ resources:
meter_name: String meter_name: String
ok_actions: [Value, Value, ...] ok_actions: [Value, Value, ...]
period: Integer period: Integer
query: [{"field": String, "value": String, "op": String}, {"field": String, "value": String, "op": String}, ...]
repeat_actions: Boolean repeat_actions: Boolean
statistic: String statistic: String
threshold: Number</programlisting> threshold: Number</programlisting>
@ -169,6 +220,7 @@ Resources:
meter_name: String meter_name: String
ok_actions: [Value, Value, ...] ok_actions: [Value, Value, ...]
period: Integer period: Integer
query: [{"field": String, "value": String, "op": String}, {"field": String, "value": String, "op": String}, ...]
repeat_actions: Boolean repeat_actions: Boolean
statistic: String statistic: String
threshold: Number</programlisting> threshold: Number</programlisting>
@ -192,6 +244,7 @@ Resources:
"meter_name": String, "meter_name": String,
"ok_actions": [Value, Value, ...], "ok_actions": [Value, Value, ...],
"period": Integer, "period": Integer,
"query": [{"field": String, "value": String, "op": String}, {"field": String, "value": String, "op": String}, ...],
"repeat_actions": Boolean, "repeat_actions": Boolean,
"statistic": String, "statistic": String,
"threshold": Number "threshold": Number
@ -390,6 +443,14 @@ Resources:
<para>Optional property.</para> <para>Optional property.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term role="Map">scheduler_hints</term>
<listitem>
<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> <varlistentry>
<term role="Integer">size</term> <term role="Integer">size</term>
<listitem> <listitem>
@ -540,6 +601,7 @@ resources:
image: String image: String
metadata: {...} metadata: {...}
name: String name: String
scheduler_hints: {...}
size: Integer size: Integer
snapshot_id: String snapshot_id: String
source_volid: String source_volid: String
@ -560,6 +622,7 @@ Resources:
image: String image: String
metadata: {...} metadata: {...}
name: String name: String
scheduler_hints: {...}
size: Integer size: Integer
snapshot_id: String snapshot_id: String
source_volid: String source_volid: String
@ -580,6 +643,7 @@ Resources:
"image": String, "image": String,
"metadata": {...}, "metadata": {...},
"name": String, "name": String,
"scheduler_hints": {...},
"size": Integer, "size": Integer,
"snapshot_id": String, "snapshot_id": String,
"source_volid": String, "source_volid": String,
@ -1384,7 +1448,7 @@ Resources:
<varlistentry> <varlistentry>
<term role="String">LaunchConfigurationName</term> <term role="String">LaunchConfigurationName</term>
<listitem> <listitem>
<para>Name of LaunchConfiguration resource.</para> <para>The reference to a LaunchConfiguration resource.</para>
<para>Can be updated without replacement.</para> <para>Can be updated without replacement.</para>
<para>Required property.</para> <para>Required property.</para>
</listitem> </listitem>
@ -1872,6 +1936,40 @@ used for substitution can be customized by using the <citetitle>index_var</citet
<para>The length must be at least 3.</para> <para>The length must be at least 3.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term role="List">removal_policies</term>
<listitem>
<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> <varlistentry>
<term role="Map">resource_def</term> <term role="Map">resource_def</term>
<listitem> <listitem>
@ -1931,6 +2029,7 @@ resources:
properties: properties:
count: Integer count: Integer
index_var: String index_var: String
removal_policies: [{"resource_list": [Value, Value, ...]}, {"resource_list": [Value, Value, ...]}, ...]
resource_def: {"type": String, "properties": {...}}</programlisting> resource_def: {"type": String, "properties": {...}}</programlisting>
</section> </section>
<section xml:id="OS__Heat__ResourceGroup-yaml"> <section xml:id="OS__Heat__ResourceGroup-yaml">
@ -1944,6 +2043,7 @@ Resources:
Properties: Properties:
count: Integer count: Integer
index_var: String index_var: String
removal_policies: [{"resource_list": [Value, Value, ...]}, {"resource_list": [Value, Value, ...]}, ...]
resource_def: {"type": String, "properties": {...}}</programlisting> resource_def: {"type": String, "properties": {...}}</programlisting>
</section> </section>
<section xml:id="OS__Heat__ResourceGroup-json"> <section xml:id="OS__Heat__ResourceGroup-json">
@ -1957,6 +2057,7 @@ Resources:
"Properties": { "Properties": {
"count": Integer, "count": Integer,
"index_var": String, "index_var": String,
"removal_policies": [{"resource_list": [Value, Value, ...]}, {"resource_list": [Value, Value, ...]}, ...],
"resource_def": {"type": String, "properties": {...}} "resource_def": {"type": String, "properties": {...}}
} }
} }
@ -2079,7 +2180,7 @@ DELETE) for a software component in one place.</para>
<para>This resource is backed by the persistence layer and the API of the <para>This resource is backed by the persistence layer and the API of the
SoftwareConfig resource, and only adds handling for the additional SoftwareConfig resource, and only adds handling for the additional
'configs' property and attribute.</para> 'configs' property and attribute.</para>
<para>Available since 2014.1 (Icehouse).</para> <para>Available since 2014.2 (Juno).</para>
<section xml:id="OS__Heat__SoftwareComponent-props"> <section xml:id="OS__Heat__SoftwareComponent-props">
<title>Properties</title> <title>Properties</title>
<variablelist role="definition_list"> <variablelist role="definition_list">
@ -2714,7 +2815,7 @@ Resources:
<section xml:id="OS__Heat__SoftwareDeployments"> <section xml:id="OS__Heat__SoftwareDeployments">
<?dbhtml stop-chunking?> <?dbhtml stop-chunking?>
<title>OS::Heat::SoftwareDeployments</title> <title>OS::Heat::SoftwareDeployments</title>
<para>Available since 2014.1 (Icehouse).</para> <para>Available since 2014.2 (Juno).</para>
<section xml:id="OS__Heat__SoftwareDeployments-props"> <section xml:id="OS__Heat__SoftwareDeployments-props">
<title>Properties</title> <title>Properties</title>
<variablelist role="definition_list"> <variablelist role="definition_list">
@ -3220,7 +3321,7 @@ Resources:
<section xml:id="OS__Heat__StructuredDeployments"> <section xml:id="OS__Heat__StructuredDeployments">
<?dbhtml stop-chunking?> <?dbhtml stop-chunking?>
<title>OS::Heat::StructuredDeployments</title> <title>OS::Heat::StructuredDeployments</title>
<para>Available since 2014.1 (Icehouse).</para> <para>Available since 2014.2 (Juno).</para>
<section xml:id="OS__Heat__StructuredDeployments-props"> <section xml:id="OS__Heat__StructuredDeployments-props">
<title>Properties</title> <title>Properties</title>
<variablelist role="definition_list"> <variablelist role="definition_list">
@ -6618,7 +6719,7 @@ Resources:
<listitem> <listitem>
<para>Security group IDs to associate with this port.</para> <para>Security group IDs to associate with this port.</para>
<para>Can be updated without replacement.</para> <para>Can be updated without replacement.</para>
<para>Optional property, defaults to "[]".</para> <para>Optional property.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -8586,7 +8687,7 @@ Resources:
<varlistentry> <varlistentry>
<term role="List">policies</term> <term role="List">policies</term>
<listitem> <listitem>
<para>A list of string policies to apply.Defaults to anti-affinity.</para> <para>A list of string policies to apply. Defaults to anti-affinity.</para>
<para>Updates cause replacement.</para> <para>Updates cause replacement.</para>
<para>Optional property, defaults to "['anti-affinity']".</para> <para>Optional property, defaults to "['anti-affinity']".</para>
<para>Allowed values: anti-affinity, affinity</para> <para>Allowed values: anti-affinity, affinity</para>