openstack-manuals/doc/user-guide/section_dashboard_stacks.xml
Christian Berendt 6be4f5775f Unified the syntax of the XML root element (user-guide)
The XML root element of Docbook XML files should match the following
format:

<ELEMENT 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="THE_XML_ID_OF_THE_ELEMENT">

Change-Id: Ic59684221ba99632c71e3f9b5f97ec74f56793a4
2014-07-09 19:51:07 +02:00

228 lines
10 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<section 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="dashboard_stacks">
<title>Launch and manage stacks</title>
<?dbhtml stop-chunking?>
<para>OpenStack Orchestration is a service that you can use to
orchestrate multiple composite cloud applications. This
service supports use of both the Amazon Web Services (AWS)
CloudFormation template format through both a Query API that
is compatible with CloudFormation and the native OpenStack
<glossterm>Heat Orchestration Template (HOT)</glossterm>
format through a REST API.</para>
<para>These flexible template languages enable application
developers to describe and automate the deployment of
infrastructure, services, and applications. The templates
enable creation of most OpenStack resource types, such as
instances, floating IP addresses, volumes, security groups,
and users. The resources, once created, are referred to as
stacks.</para>
<para>The template languages are described in
<link
xlink:href="http://docs.openstack.org/developer/heat/template_guide/index.html"
>the Template Guide</link> in the <link
xlink:href="http://docs.openstack.org/developer/heat/">Heat
developer documentation</link>.</para>
<section xml:id="dashboard_create_stacks">
<title>Launch a stack</title>
<procedure>
<step>
<para>Log in to the dashboard, choose a project, and click
<guibutton>Stacks</guibutton> in the
<guilabel>Orchestration</guilabel> category on the
<guilabel>Projects</guilabel> tab.</para>
</step>
<step>
<para>Click <guibutton>Launch Stack</guibutton>.</para>
<para/>
</step>
<step>
<para>In the <guilabel>Select Template</guilabel> dialog box,
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>
<para>Click <guibutton>Next</guibutton>.
</para>
</step>
<step>
<para>In the <guilabel>Launch Stack</guilabel> dialog box, specify
the following values.</para>
<informaltable rules="all" width="75%">
<col width="30%"/>
<col width="70%"/>
<tbody>
<tr>
<td><para><guilabel>Stack Name</guilabel></para></td>
<td><para>Enter a name to identify the stack.</para></td>
</tr>
<tr>
<td><para><guilabel>Creation Timeout (minutes)</guilabel></para></td>
<td><para>Specify the number of minutes that can
elapse before the launch of the stack times out.</para></td>
</tr>
<tr>
<td><para><guilabel>Rollback On Failure</guilabel></para></td>
<td><para>Select this check box if you want if you
want the service to roll back changes if the stack
fails to launch.</para></td>
</tr>
<tr>
<td><para><guilabel>Password for user "demo"</guilabel></para></td>
<td><para>Specify the password that the default user
uses when the stack is created.</para></td>
</tr>
<tr>
<td><para><guilabel>DBUsername</guilabel></para></td>
<td><para>Specify the name of the database user.</para></td>
</tr>
<tr>
<td><para><guilabel>LinuxDistribution</guilabel></para></td>
<td><para>Specify the Linux distribution that is
used in the stack.</para></td>
</tr>
<tr>
<td><para><guilabel>DBRootPassword</guilabel></para></td>
<td><para>Specify the root password for the database.</para></td>
</tr>
<tr>
<td><para><guilabel>KeyName</guilabel></para></td>
<td><para>Specify the name of the key pair to use to
log in to the stack.</para></td>
</tr>
<tr>
<td><para><guilabel>DBName</guilabel></para></td>
<td><para>Specify the name of the database.</para></td>
</tr>
<tr>
<td><para><guilabel>DBPassword</guilabel></para></td>
<td><para>Specify the password for the database.</para></td>
</tr>
<tr>
<td><para><guilabel>InstanceType</guilabel></para></td>
<td><para>Specify the flavor for the instance.</para></td>
</tr>
</tbody>
</informaltable>
</step>
<step>
<para>Click <guilabel>Launch</guilabel> to create a
stack.</para>
</step>
<step>
<para>The <guilabel>Stacks</guilabel> tab shows the stack.</para>
</step>
</procedure>
<para>After the stack is created, click on the stack name to see the
following details:</para>
<variablelist>
<varlistentry>
<term><guilabel>Topology</guilabel></term>
<listitem>
<para>The topology of the stack.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Overview</guilabel></term>
<listitem>
<para>The parameters and details of the stack.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Resources</guilabel></term>
<listitem>
<para>The resources used by the stack.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Events</guilabel></term>
<listitem>
<para>The events related to the stack.</para>
</listitem>
</varlistentry>
</variablelist>
</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">
<title>Delete a stack</title>
<para>When you delete a stack, you cannot undo this action.</para>
<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 delete.</para>
</step>
<step>
<para>Click <guibutton>Delete
Stack</guibutton>.</para>
</step>
<step>
<para>In the confirmation dialog box, click
<guibutton>Delete Stack</guibutton> to confirm
the deletion.</para>
</step>
</procedure>
</section>
</section>