openstack-manuals/doc/user-guide/section_dashboard_stacks.xml
Mike Spreitzer 50300bdd40 Added pointers to template documentation.
Also added "Heat Orchestration Template" and "Stack"
to the glossary.

Also made a few other changes suggested by reviewers.

Change-Id: I9856f9664cc104eda7a37d9a0a43ee1a0e534aca
Closes-Bug: 1281691
2014-03-24 16:32:21 -04:00

197 lines
8.4 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section [
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
]>
<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>
<para>Use the Orchestration service to orchestrate multiple
composite cloud applications. This service supports use of both
the AWS CloudFormation template format through a Query API and
the OpenStack-native
<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
allow creation of most OpenStack resource types such as
instances, floating IPs, volumes, security groups, and
users.</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.</para>
</step>
<step>
<para>Click <guibutton>Launch
Stack</guibutton>.</para>
<para/>
</step>
<step>
<para>In the <guilabel>Select Template</guilabel>
window, choose a template source option,
<guilabel>URL</guilabel>,
<guilabel>File</guilabel>, or <guilabel>Direct
Input</guilabel>, from the drop-down
list.</para>
</step>
<step>
<para>Enter the URL, browse to the file location, or
directly include the template based on your
previous selection.</para>
</step>
<step>
<para>In the <guilabel>Launch Stack</guilabel> window,
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>A name to identify the
stack.</para></td>
</tr>
<tr>
<td><para><guilabel>Creation Timeout
(minutes)</guilabel></para></td>
<td><para>Creation Timeout in
minutes.</para></td>
</tr>
<tr>
<td><para><guilabel>Rollback On
Failure</guilabel></para></td>
<td><para>Check this option if you want
Heat to rollback on
failure.</para></td>
</tr>
<tr>
<td><para><guilabel>Password for user
"demo"</guilabel></para></td>
<td><para>Password for the user logged
in.</para></td>
</tr>
<tr>
<td><para><guilabel>DBUsername</guilabel></para></td>
<td><para>Database user name.</para></td>
</tr>
<tr>
<td><para><guilabel>LinuxDistribution</guilabel></para></td>
<td><para>Linux Distribution used in the
stacks.</para></td>
</tr>
<tr>
<td><para><guilabel>DBRootPassword</guilabel></para></td>
<td><para>Database root
password.</para></td>
</tr>
<tr>
<td><para><guilabel>KeyName</guilabel></para></td>
<td><para>Name of the keypair.</para></td>
</tr>
<tr>
<td><para><guilabel>DBName</guilabel></para></td>
<td><para>Database name.</para></td>
</tr>
<tr>
<td><para><guilabel>DBPassword</guilabel></para></td>
<td><para>Database password.</para></td>
</tr>
<tr>
<td><para><guilabel>InstanceType</guilabel></para></td>
<td><para>Flavor of the
instance.</para></td>
</tr>
</tbody>
</informaltable>
</step>
<step>
<para>Click <guilabel>Launch</guilabel> to create a
stack.</para>
</step>
<step>
<para>The dashboard shows the stack in the
<guilabel>Stacks</guilabel> category.</para>
</step>
</procedure>
<para>After the stack is created, click on the stack name to
see these details:</para>
<variablelist>
<varlistentry>
<term><guilabel>Topology</guilabel></term>
<listitem>
<para>The topology of the stack created.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Overview</guilabel></term>
<listitem>
<para>The parameters and details of the stack
under the following headings:
<guilabel>Info</guilabel>,
<guilabel>Status</guilabel>,
<guilabel>Outputs</guilabel>,
<guilabel>Stack Parameters</guilabel>, and
<guilabel>Launch
Parameters</guilabel>.</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_delete_stacks">
<title>Delete stacks</title>
<procedure>
<step>
<para>Log in to the dashboard.</para>
</step>
<step>
<para>On the <guilabel>Project</guilabel> tab, click
the <guilabel>Stacks</guilabel> category.</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 <guilabel>Confirm Delete Stack</guilabel>
window, click <guibutton>Delete Stack</guibutton>
to confirm the deletion. You cannot undo this
action.</para>
</step>
</procedure>
</section>
</section>