openstack-manuals/doc/user-guide/section_dashboard_stacks.xml
Chandan kumar 3714af4317 Added Complete Doc conventions in user-guide.
Change-Id: Ibbc5cd3be6343a05a0537508f6e580a597447af4
Partial-Bug: #1121866
2013-12-10 10:36:20 -06:00

188 lines
8.1 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>Heat is a service used to orchestrate multiple composite
cloud applications using the AWS CloudFormation template
format, through both an OpenStack-native ReST API and a
CloudFormation-compatible Query API.</para>
<para>The purpose of Heat is to provide a template based
orchestration for describing a cloud application by executing
appropriate OpenStack API calls to generate running cloud
applications, integrate other core components of OpenStack
into a one-file template system. The templates allow creation
of most OpenStack resource types such as instances, floating
ips, volumes, security groups, users, etc.</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>