openstack/openstack-manuals
Code Issues Proposed changes

Updates to the 'Launch a stack' section

Browse Source 
Updated the following:
- Included new procedure to 'Manage a stack'.
- New steps to select the template and environment sources for the stack.
Partial-Bug: #1307860

Change-Id: I5fab0587ce7a81e5092f9e089b4cbb2197c7b8d0
This commit is contained in:
Deepti Navale 2014-05-07 14:28:28 +10:00
parent 6ad68cfa97
commit 740f1c2bce
1 changed files with 89 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

130
doc/user-guide/section_dashboard_stacks.xml
View File

@ -4,7 +4,7 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="dashboard_stacks"> xml:id="dashboard_stacks">
<title>Launch and manage stacks</title> <title>Launch and manage stacks</title>
<?dbhtml stop-chunking?>
<para>OpenStack Orchestration is a service that you can use to <para>OpenStack Orchestration is a service that you can use to
orchestrate multiple composite cloud applications. This orchestrate multiple composite cloud applications. This
service supports use of both the Amazon Web Services (AWS) service supports use of both the Amazon Web Services (AWS)
@ -30,55 +30,77 @@
<title>Launch a stack</title> <title>Launch a stack</title>
<procedure> <procedure>
<step> <step>
<para>Log in to the dashboard, choose a project, and <para>Log in to the dashboard, choose a project, and click
click <guibutton>Stacks</guibutton> in the <guibutton>Stacks</guibutton> in the
<guilabel>Orchestration</guilabel> category on <guilabel>Orchestration</guilabel> category on the
the <guilabel>Projects</guilabel> tab.</para> <guilabel>Projects</guilabel> tab.</para>
</step> </step>
<step> <step>
<para>Click <guibutton>Launch <para>Click <guibutton>Launch Stack</guibutton>.</para>
Stack</guibutton>.</para>
<para/> <para/>
</step> </step>
<step> <step>
<para>In the Select Template dialog box, choose the <para>In the <guilabel>Select Template</guilabel> dialog box,
source of the template from the list.</para> specify the following values.</para>
<informaltable rules="all" width="75%">
<col width="30%"/>
<col width="70%"/>
<tbody>
<tr>
<td><para><guilabel>Template Source</guilabel></para></td>
<td><para>Choose the source of the template from the list.</para></td>
</tr>
<tr>
<td><para><guilabel>Template URL/File/Data</guilabel></para></td>
<td><para>Depending on the source that you selected, enter
the URL, browse to the file location, or directly include
the template.</para></td>
</tr>
<tr>
<td><para><guilabel>Environment Source</guilabel></para></td>
<td><para>Choose the source of the environment from the list.
The environment files contain additional settings for
the stack.</para></td>
</tr>
<tr>
<td><para><guilabel>Environment URL/File/Data</guilabel></para></td>
<td><para>Depending on the source that you selected, enter
the URL, browse to the file location, or directly include
the environment.</para></td>
</tr>
</tbody>
</informaltable>
</step> </step>
<step> <step>
<para>Depending on the source that you selected, enter <para>Click <guibutton>Next</guibutton>.
the URL, browse to the file location, or directly </para>
include the template.</para>
</step> </step>
<step> <step>
<para>In the Launch Stack dialog box, <para>In the <guilabel>Launch Stack</guilabel> dialog box, specify
specify the following values.</para> the following values.</para>
<informaltable rules="all" width="75%"> <informaltable rules="all" width="75%">
<col width="30%"/> <col width="30%"/>
<col width="70%"/> <col width="70%"/>
<tbody> <tbody>
<tr> <tr>
<td><para><guilabel>Stack <td><para><guilabel>Stack Name</guilabel></para></td>
Name</guilabel></para></td>
<td><para>Enter a name to identify the stack.</para></td> <td><para>Enter a name to identify the stack.</para></td>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>Creation Timeout <td><para><guilabel>Creation Timeout (minutes)</guilabel></para></td>
(minutes)</guilabel></para></td> <td><para>Specify the number of minutes that can
<td><para>Specify the number of minutes that can elapse before the launch elapse before the launch of the stack times out.</para></td>
of the stack times out.</para></td>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>Rollback On <td><para><guilabel>Rollback On Failure</guilabel></para></td>
Failure</guilabel></para></td> <td><para>Select this check box if you want if you
<td><para>Select this check box if you want if you want the service to want the service to roll back changes if the stack
roll back changes if the stack fails to launch.</para></td>
fails to launch.</para></td>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>Password for user <td><para><guilabel>Password for user "demo"</guilabel></para></td>
"demo"</guilabel></para></td> <td><para>Specify the password that the default user
<td><para>Specify the password that the default user will use when the uses when the stack is created.</para></td>
stack is created.</para></td>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>DBUsername</guilabel></para></td> <td><para><guilabel>DBUsername</guilabel></para></td>
@ -86,8 +108,8 @@
</tr> </tr>
<tr> <tr>
<td><para><guilabel>LinuxDistribution</guilabel></para></td> <td><para><guilabel>LinuxDistribution</guilabel></para></td>
<td><para>Specify the Linux distribution that will be used in the <td><para>Specify the Linux distribution that is
stack.</para></td> used in the stack.</para></td>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>DBRootPassword</guilabel></para></td> <td><para><guilabel>DBRootPassword</guilabel></para></td>
@ -95,8 +117,8 @@
</tr> </tr>
<tr> <tr>
<td><para><guilabel>KeyName</guilabel></para></td> <td><para><guilabel>KeyName</guilabel></para></td>
<td><para>Specify the name of the key pair that will be used to log into <td><para>Specify the name of the key pair to use to
the stack.</para></td> log in to the stack.</para></td>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>DBName</guilabel></para></td> <td><para><guilabel>DBName</guilabel></para></td>
@ -118,12 +140,11 @@
stack.</para> stack.</para>
</step> </step>
<step> <step>
<para>The dashboard shows the stack on the <para>The <guilabel>Stacks</guilabel> tab shows the stack.</para>
<guilabel>Stacks</guilabel> tab.</para>
</step> </step>
</procedure> </procedure>
<para>After the stack is created, click on the stack name to <para>After the stack is created, click on the stack name to see the
see the following details:</para> following details:</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><guilabel>Topology</guilabel></term> <term><guilabel>Topology</guilabel></term>
@ -134,8 +155,7 @@
<varlistentry> <varlistentry>
<term><guilabel>Overview</guilabel></term> <term><guilabel>Overview</guilabel></term>
<listitem> <listitem>
<para>The parameters and details of the <para>The parameters and details of the stack.</para>
stack.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -152,10 +172,38 @@
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</section> </section>
<section xml:id="dashboard_manage_stacks">
<title>Manage a stack</title>
<procedure>
<step>
<para>Log in to the dashboard, choose a project, and
click <guilabel>Stacks</guilabel>.</para>
</step>
<step>
<para>Select the stack that you want to update.</para>
</step>
<step>
<para>Click <guibutton>Change Stack Template</guibutton>.</para>
</step>
<step>
<para>In the <guilabel>Select Template</guilabel> dialog box,
select the new template source or environment source.</para>
</step>
<step>
<para>Click <guibutton>Next</guibutton>.</para>
<para>The <guilabel>Update Stack Parameters</guilabel> window appears.</para>
</step>
<step>
<para>Enter new values for any parameters that you want to update.</para>
</step>
<step>
<para>Click <guibutton>Update</guibutton>.</para>
</step>
</procedure>
</section>
<section xml:id="dashboard_delete_stacks"> <section xml:id="dashboard_delete_stacks">
<title>Delete a stack</title> <title>Delete a stack</title>
<para>When you delete a stack, you cannot undo this <para>When you delete a stack, you cannot undo this action.</para>
action.</para>
<procedure> <procedure>
<step> <step>
<para>Log in to the dashboard, choose a project, and <para>Log in to the dashboard, choose a project, and