openstack/openstack-manuals
Code Issues Proposed changes

Clean up heat CLI section

Browse Source 
bug: #1216909

Change-Id: I9d21aaabeb70e2669fd1728da52a7ad335a105ee
author: diane fleming
This commit is contained in:
Diane Fleming 2013-09-22 15:44:13 -05:00
parent df5d8ec997
commit 5dfff9b231
1 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
doc/user-guide/section_heat_cli.xml
View File

@ -6,14 +6,14 @@
xmlns:html="http://www.w3.org/1999/xhtml" version="5.0" xmlns:html="http://www.w3.org/1999/xhtml" version="5.0"
xml:id="heat-stack-create"> xml:id="heat-stack-create">
<title>Create and manage stacks</title> <title>Create and manage stacks</title>
<section xml:id="create_stacks_proc"> <title>Create a stack from an example template file</title>
<procedure> <procedure>
<title>To create a stack from an example template file</title>
<step> <step>
<para>To create a stack, or template, from an <link <para>To create a stack, or template, from an <link
xlink:href="https://github.com/openstack/heat-templates">example template xlink:href="https://github.com/openstack/heat-templates">example template
file</link>, run following command:</para> file</link>, run following command:</para>
<screen><prompt>$</prompt> <userinput><?db-font-size 75%?>heat stack-create mystack --template-file=/path/to/heat/templates/WordPress_Single_Instance.template <screen><prompt>$</prompt> <userinput><?db-font-size 75%?>heat stack-create mystack --template-file=/path/to/heat/templates/WordPress_Single_Instance.template \
--parameters="InstanceType=m1.large;DBUsername=wp;DBPassword=verybadpassword;KeyName=heat_key;LinuxDistribution=F17"</userinput></screen> --parameters="InstanceType=m1.large;DBUsername=wp;DBPassword=verybadpassword;KeyName=heat_key;LinuxDistribution=F17"</userinput></screen>
<para>The <literal>--parameters</literal> values that you specify <para>The <literal>--parameters</literal> values that you specify
depend on which parameters are defined in the depend on which parameters are defined in the
template. If the template file is hosted on a website, template. If the template file is hosted on a website,
@ -38,8 +38,11 @@
message.</para> message.</para>
</step> </step>
</procedure> </procedure>
</section>
<section xml:id="stack_get_info"><title>Get information about stacks</title>
<para>To explore the state and history of a particular stack, you can
run a number of commands.</para>
<procedure> <procedure>
<title>To list stacks</title>
<step> <step>
<para>To see which stacks are visible to the current user, <para>To see which stacks are visible to the current user,
run the following command: run the following command:
@ -50,19 +53,16 @@
| 7edc7480-bda5-4e1c-9d5d-f567d3b6a050 | my-otherstack | CREATE_FAILED | 2013-04-03T23:28:20Z | | 7edc7480-bda5-4e1c-9d5d-f567d3b6a050 | my-otherstack | CREATE_FAILED | 2013-04-03T23:28:20Z |
+--------------------------------------+---------------+-----------------+----------------------+</computeroutput></screen></para> +--------------------------------------+---------------+-----------------+----------------------+</computeroutput></screen></para>
</step> </step>
</procedure> <step>
<procedure xml:id="heat-stack-details">
<title>To view stack details</title>
<para>To explore the state and history of a particular stack, you can run a number of commands.</para>
<step>
<para>To show the details of a stack, run the following <para>To show the details of a stack, run the following
command:</para> command:</para>
<screen><prompt>$</prompt> <userinput><?db-font-size 75%?>heat stack-show mystack</userinput></screen></step> <screen><prompt>$</prompt> <userinput>heat stack-show mystack</userinput></screen></step>
<step><para>A stack consists of a collection of resources. To list the <step><para>A stack consists of a collection of resources. To list the
resources, including their status, in a stack, run the resources and their status, run the following
following command:</para> command:</para>
<screen><prompt>$</prompt> <userinput><?db-font-size 75%?>heat resource-list mystack</userinput></screen> <screen><prompt>$</prompt> <userinput>heat resource-list mystack</userinput></screen>
<screen><computeroutput><?db-font-size 65%?>+---------------------+--------------------+-----------------+----------------------+ <screen><?db-font-size 65%?><computeroutput>+---------------------+--------------------+-----------------+----------------------+
| logical_resource_id | resource_type | resource_status | updated_time | | logical_resource_id | resource_type | resource_status | updated_time |
+---------------------+--------------------+-----------------+----------------------+ +---------------------+--------------------+-----------------+----------------------+
| WikiDatabase | AWS::EC2::Instance | CREATE_COMPLETE | 2013-04-03T23:25:56Z | | WikiDatabase | AWS::EC2::Instance | CREATE_COMPLETE | 2013-04-03T23:25:56Z |
@ -71,14 +71,13 @@
<step> <step>
<para>To show the details for the specified resource in a <para>To show the details for the specified resource in a
stack, run the following command:</para> stack, run the following command:</para>
<screen><prompt>$</prompt> <userinput><?db-font-size 75%?>heat resource-show mystack WikiDatabase</userinput></screen> <screen><prompt>$</prompt> <userinput>heat resource-show mystack WikiDatabase</userinput></screen>
<para>Some resources have associated metadata which can <para>Some resources have associated metadata which can
change throughout the life-cycle of a resource:</para> change throughout the life-cycle of a resource:</para>
<screen><prompt>$</prompt> <userinput><?db-font-size 75%?>heat resource-metadata mystack WikiDatabase</userinput></screen></step> <screen><prompt>$</prompt> <userinput>heat resource-metadata mystack WikiDatabase</userinput></screen></step>
<step><para>A series of events is generated during the <step><para>A series of events is generated during the life-cycle of a
life-cycle of a stack. This command will display those stack. This command displays those events:</para>
events.</para> <screen><prompt>$</prompt> <userinput>heat event-list mystack</userinput></screen><screen><computeroutput><?db-font-size 65%?>+---------------------+----+------------------------+-----------------+----------------------+
<screen><prompt>$</prompt> <userinput><?db-font-size 75%?>heat event-list mystack</userinput></screen><screen><computeroutput><?db-font-size 65%?>+---------------------+----+------------------------+-----------------+----------------------+
| logical_resource_id | id | resource_status_reason | resource_status | event_time | | logical_resource_id | id | resource_status_reason | resource_status | event_time |
+---------------------+----+------------------------+-----------------+----------------------+ +---------------------+----+------------------------+-----------------+----------------------+
| WikiDatabase | 1 | state changed | IN_PROGRESS | 2013-04-03T23:22:09Z | | WikiDatabase | 1 | state changed | IN_PROGRESS | 2013-04-03T23:22:09Z |
@ -86,16 +85,16 @@
+---------------------+----+------------------------+-----------------+----------------------+</computeroutput></screen> +---------------------+----+------------------------+-----------------+----------------------+</computeroutput></screen>
</step><step><para>To show the details for a particular event, run the following </step><step><para>To show the details for a particular event, run the following
command:</para> command:</para>
<screen><prompt>$</prompt> <userinput><?db-font-size 75%?>heat event-show WikiDatabase 1</userinput></screen> <screen><prompt>$</prompt> <userinput>heat event-show WikiDatabase 1</userinput></screen>
</step> </step>
</procedure> </procedure>
<procedure xml:id="heat-stack-update"> </section>
<title>To update a stack</title> <section xml:id="heat-stack-update"><title>Update stacks</title>
<procedure>
<step> <step>
<para>To update an existing stack from a modified template <para>To update an existing stack from a modified template
file, run a command like the following file, run the following command:</para><screen><prompt>$</prompt> <userinput>heat stack-update mystack --template-file=/path/to/heat/templates/WordPress_Single_Instance_v2.template
command:</para><screen><prompt>$</prompt> <userinput><?db-font-size 75%?>heat stack-update mystack --template-file=/path/to/heat/templates/WordPress_Single_Instance_v2.template --parameters="InstanceType=m1.large;DBUsername=wp;DBPassword=verybadpassword;KeyName=heat_key;LinuxDistribution=F17"</userinput></screen><screen><?db-font-size 65%?><computeroutput>+--------------------------------------+---------------+-----------------+----------------------+
--parameters="InstanceType=m1.large;DBUsername=wp;DBPassword=verybadpassword;KeyName=heat_key;LinuxDistribution=F17"</userinput></screen><screen><computeroutput><?db-font-size 65%?>+--------------------------------------+---------------+-----------------+----------------------+
| id | stack_name | stack_status | creation_time | | id | stack_name | stack_status | creation_time |
+--------------------------------------+---------------+-----------------+----------------------+ +--------------------------------------+---------------+-----------------+----------------------+
| 4c712026-dcd5-4664-90b8-0915494c1332 | mystack | UPDATE_COMPLETE | 2013-04-03T23:22:08Z | | 4c712026-dcd5-4664-90b8-0915494c1332 | mystack | UPDATE_COMPLETE | 2013-04-03T23:22:08Z |
@ -105,4 +104,5 @@
are replaced with new resources.</para> are replaced with new resources.</para>
</step> </step>
</procedure> </procedure>
</section>
</section> </section>