openstack
/
openstack-manuals
Code Issues Proposed changes

Edits to the End User Guide dashboard chapter with corrections from Anne G 

Change-Id: Ia9961bbdab446e15930d0b31176c37fe1d532b8f
This commit is contained in:
Karin Levenstein 2014-04-08 14:40:54 -05:00 committed by Anne Gentle
parent 4588778170
commit fca88670a4
13 changed files with 788 additions and 760 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/common/ch_using_openstack_overview.xml
View File

@ -18,21 +18,21 @@
user, you can manage tenants, known as
<glossterm baseform="project">projects</glossterm>, users, services, images,
flavors, and quotas.</para>
<para>The examples in this guide show you how to complete these
tasks with either:</para>
<para>The examples in this guide show you how to perform tasks by
using the following methods:</para>
<itemizedlist>
<listitem>
<para>The OpenStack dashboard. Use this Web-based
graphical interface, code named <link
<para>OpenStack dashboard. Use this web-based graphical
interface, code named <link
xlink:href="https://github.com/openstack/horizon/"
>horizon</link>, to view, create, and manage
resources<phrase audience="adminuser"> and
services</phrase>.</para>
</listitem>
<listitem>
<para>The OpenStack command-line clients. Each core
OpenStack project has a command-line client that lets
you run simple commands to view, create, and manage
<para>OpenStack command-line clients. Each core OpenStack
project has a command-line client that you can use to
run simple commands to view, create, and manage
resources<phrase audience="adminuser"> and
services</phrase> in a cloud and automate tasks by
using scripts.</para>

41
doc/common/section_conventions.xml
View File

@ -6,44 +6,33 @@
xml:id="section_conventions">
<?dbhtml stop-chunking?>
<title>Conventions</title>
<para>
The OpenStack documentation uses several typesetting conventions:
</para>
<para>The OpenStack documentation uses several typesetting
conventions.</para>
<simplesect xml:id="conventions-admonitions">
<title>Admonitions</title>
<para>
Admonitions take three forms:
</para>
<title>Notices</title>
<para>Notices take three forms:</para>
<note>
<para>
This is a note. The information in a note is usually in the form
of a handy tip or reminder.
</para>
<para>The information in a note is usually in the form of a
handy tip or reminder.</para>
</note>
<important>
<para>
This is important. The information in an important admonition is
something you must be aware of before moving on.
</para>
<para>The information in an important notice is something you
must be aware of before proceeding.</para>
</important>
<warning>
<para>
This is a warning. The information in warnings is critical.
Warnings provide additional information about risk of data loss or
security issues.
</para>
<para>The information in warnings is critical. Warnings
provide additional information about risk of data loss or
security issues.</para>
</warning>
</simplesect>
<simplesect xml:id="conventions-prompts">
<title>Command prompts</title>
<para>
Commands prefixed with the <literal>#</literal> prompt are to be
executed by the <literal>root</literal> user. These examples can
also be executed using the <command>sudo</command> command, if
available.
</para>
<para>Commands prefixed with the <literal>#</literal> prompt
are to be executed by the <literal>root</literal> user. These
examples can also be executed by using the
<command>sudo</command> command, if available.</para>
<para>
Commands prefixed with the <literal>$</literal> prompt can be
executed by any user, including <literal>root</literal>.

157
doc/common/section_dashboard_access.xml
View File

@ -18,11 +18,11 @@
<step>
<para>Ask the cloud operator for the host name or public
IP address from which you can access the dashboard,
and your user name and password.</para>
and for your user name and password.</para>
</step>
<step>
<para>Open a Web browser. Make sure that JavaScript and
cookies are enabled.</para>
<para>Open a web browser that has JavaScript and cookies
enabled.</para>
<note>
<para>To use the Virtual Network Computing (VNC)
client for the dashboard, your browser must
@ -37,11 +37,10 @@
</note>
</step>
<step>
<para>In the address bar, type the host name or IP address
for the dashboard:</para>
<screen><userinput>https://<replaceable>IP_ADDRESS_OR_HOSTNAME</replaceable>/</userinput></screen>
<para>In the address bar, enter the host name or IP
address for the dashboard.</para>
<screen><userinput>https://<replaceable>ipAddressOrHostName</replaceable>/</userinput></screen>
<note>
<title>Certificate warning</title>
<para>If a certificate warning appears when you try to
access the URL for the first time, a self-signed
certificate is in use, which is not considered
@ -54,32 +53,38 @@
<para>On the <guilabel>Log In</guilabel> page, enter your
user name and password, and click <guibutton>Sign
In</guibutton>.</para>
<para>The top-level row shows your user name. You can also
access <guilabel>Settings</guilabel> or sign out of
the dashboard.</para>
<para>The top of the window displays your user name. You
can also access <guilabel>Settings</guilabel> or sign
out of the dashboard.</para>
<para>The visible tabs and functions in the dashboard
depend on the access permissions, or <emphasis
role="italic">roles</emphasis>, of the user you
are logged in as.</para>
<para>If you are logged in as an end user, the main screen
shows the <link linkend="dashboard_project_tab"
>Project</link> tab.</para>
<para>If you are logged in as an administrator, the main
screen shows the <link linkend="dashboard_project_tab"
>Project</link> tab and <link
linkend="dashboard_admin_tab">Admin</link>
tab.</para>
are logged in as.<itemizedlist>
<listitem><para>If you are logged in as an end user, the <link
linkend="dashboard_project_tab"
>Project</link> tab is
displayed.</para></listitem>
<listitem><para>If you are logged in as an administrator, the <link
linkend="dashboard_project_tab"
>Project</link> tab and <link
linkend="dashboard_admin_tab"
>Admin</link> tab are
displayed.</para></listitem>
</itemizedlist></para>
</step>
</procedure>
<section xml:id="dashboard_project_tab">
<title>OpenStack dashboard&mdash;Project tab</title>
<para>Select a project from the <guilabel>CURRENT
PROJECT</guilabel> drop-down list on the left side to
view and manage resources in that project.</para>
<para>The <guilabel>Project</guilabel> tab displays the
details of the selected project.</para>
<para>Projects are organizational units in the cloud, and are
also known as tenants or accounts. Each user is a member
of one or more projects. Within a project, a user creates
and manages instances.</para>
<para>From the <guilabel>Project</guilabel> tab, you can view and manage
the resources in a selected project, including instances and images.
You select the project from the <guilabel>CURRENT PROJECT</guilabel>
list at the top of the tab.</para>
<figure xml:id="dashboard_project_user">
<title>Dashboard projects</title>
<title>Project tab</title>
<mediaobject>
<imageobject>
<imagedata fileref="figures/dashboard-project-tab.png"
@ -87,8 +92,9 @@
</imageobject>
</mediaobject>
</figure>
<para>Access the following tabs:</para>
<para><guilabel>Manage Compute</guilabel> tab</para>
<para>From the <guilabel>Project</guilabel> tab, you can
access the following tabs:</para>
<para><guilabel>Manage Compute</guilabel> tabs</para>
<variablelist>
<varlistentry>
<term><guilabel>Overview</guilabel></term>
@ -116,7 +122,7 @@
Snapshots</guilabel></term>
<listitem>
<para>View images, instance snapshots, and volume
snapshots created project users, plus any
snapshots created by project users, plus any
images that are publicly available. Create,
edit, and delete images, and launch instances
from images and snapshots.</para>
@ -129,32 +135,30 @@
<para>Use the following tabs to complete these
tasks:</para>
<formalpara>
<title><guilabel>Security Groups</guilabel>
tab</title>
<title><guilabel>Security
Groups</guilabel></title>
<para>View, create, edit, and delete security
groups and security group rules.</para>
</formalpara>
<formalpara>
<title><guilabel>Keypairs</guilabel>
tab</title>
<para>View, create, edit, and import keypairs,
and delete keypairs.</para>
<title><guilabel>Keypairs</guilabel></title>
<para>View, create, edit, import, and delete
key pairs.</para>
</formalpara>
<formalpara>
<title><guilabel>Floating IPs</guilabel>
tab</title>
<title><guilabel>Floating
IPs</guilabel></title>
<para>Allocate an IP address to or release it
from a project.</para>
</formalpara>
<formalpara>
<title><guilabel>API Access</guilabel>
tab</title>
<title><guilabel>API Access</guilabel></title>
<para>View API endpoints.</para>
</formalpara>
</listitem>
</varlistentry>
</variablelist>
<para><guilabel>Manage Network</guilabel> tab</para>
<para><guilabel>Manage Network</guilabel> tabs</para>
<variablelist>
<varlistentry>
<term><guilabel>Networks</guilabel></term>
@ -189,17 +193,18 @@
<varlistentry>
<term><guilabel>Stacks</guilabel></term>
<listitem>
<para>Use REST API to orchestrate multiple composite cloud
applications</para>
<para>Use the REST API to orchestrate multiple
composite cloud applications.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="dashboard_admin_tab">
<title>OpenStack dashboard&mdash;Admin tab</title>
<para>Enables administrative users to view usage and manage
instances, volumes, flavors, images, projects, users,
services, and quotas.</para>
<para>Administrative users can use the
<guilabel>Admin</guilabel> tab to view usage and to
manage instances, volumes, flavors, images, projects,
users, services, and quotas.</para>
<figure xml:id="dashboard_admin_project_tab">
<title>Admin tab</title>
<mediaobject>
@ -223,33 +228,34 @@
<listitem>
<para>Use the following tabs to view the following usages:</para>
<formalpara>
<title><guilabel>Global Disk Usage</guilabel>
tab</title>
<para>View the global disk usage for all tenants as an
average over the last 30 days.</para>
<title><guilabel>Global Disk
Usage</guilabel></title>
<para>View the disk usage for all tenants as
an average over the last 30 days.</para>
</formalpara>
<formalpara>
<title><guilabel>Global Network Traffic Usage</guilabel>
tab</title>
<para>View the global network usage for all tenants as
an average over the last 30 days.</para>
<title><guilabel>Global Network Traffic
Usage</guilabel></title>
<para>View the network usage for all tenants
as an average over the last 30
days.</para>
</formalpara>
<formalpara>
<title><guilabel>Global Object Storage Usage</guilabel>
tab</title>
<para>View the global object storage usage for all
tenants as an average over the last 30
days.</para>
<title><guilabel>Global Object Storage
Usage</guilabel></title>
<para>View the object storage usage for all
tenants as an average over the last 30
days.</para>
</formalpara>
<formalpara>
<title><guilabel>Global Network Usage</guilabel>
tab</title>
<para>View the global network usage for all tenants as
an average over the last 30 days.</para>
<title><guilabel>Global Network
Usage</guilabel></title>
<para>View the network usage for all tenants
as an average over the last 30
days.</para>
</formalpara>
<formalpara>
<title><guilabel>Stats</guilabel>
tab</title>
<title><guilabel>Stats</guilabel></title>
<para>View the statistics of all resources.</para>
</formalpara>
</listitem>
@ -280,9 +286,9 @@
<varlistentry>
<term><guilabel>Flavors</guilabel></term>
<listitem>
<para>View, create, edit, view extra specs for,
and delete flavors. A flavor is size for an
instance.</para>
<para>View, create, edit, view extra
specifications for, and delete flavors. A
flavor is size of an instance.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -318,27 +324,30 @@
<varlistentry>
<term><guilabel>System Info</guilabel></term>
<listitem>
<para>Use the following tabs to view the service info:</para>
<para>Use the following tabs to view the service
information:</para>
<formalpara>
<title><guilabel>Services</guilabel> tab</title>
<title><guilabel>Services</guilabel></title>
<para>View a list of the services.</para>
</formalpara>
<formalpara>
<title><guilabel>Compute Services</guilabel> tab</title>
<title><guilabel>Compute
Services</guilabel></title>
<para>View a list of all Compute services.</para>
</formalpara>
<formalpara>
<title><guilabel>Availability Zones</guilabel>
tab</title>
<title><guilabel>Availability
Zones</guilabel></title>
<para>View the availability zones.</para>
</formalpara>
<formalpara>
<title><guilabel>Host Aggregates</guilabel> tab</title>
<title><guilabel>Host
Aggregates</guilabel></title>
<para>View host aggregates.</para>
</formalpara>
<formalpara>
<title><guilabel>Network Agents</guilabel>
tab</title>
<title><guilabel>Network
Agents</guilabel></title>
<para>View the network agents.</para>
</formalpara>
</listitem>

13
doc/user-guide/bk-user-guide.xml
View File

@ -35,7 +35,7 @@
</annotation>
</legalnotice>
<abstract>
<para>OpenStack is an open source cloud computing platform
<para>OpenStack is an open-source cloud computing platform
for public and private clouds. A series of
interrelated projects deliver a cloud infrastructure
solution. This guide shows OpenStack end users how to
@ -49,12 +49,11 @@
<revdescription>
<itemizedlist>
<listitem>
<para>Remove the command reference
appendix. This information is now in <link
xlink:href="http://docs.openstack.org/cli-reference/content/"><citetitle>OpenStack
Command Line Interface
Reference</citetitle></link>.
</para>
<para>Removed the command reference appendix. This
information is now in the <link
xlink:href="http://docs.openstack.org/cli-reference/content/"
><citetitle>OpenStack Command-Line
Interface Reference</citetitle></link>.</para>
</listitem>
</itemizedlist>
</revdescription>

5
doc/user-guide/ch_dashboard.xml
View File

@ -11,8 +11,9 @@
</info>
<para>As a cloud end user, you can use the OpenStack dashboard to
provision your own resources within the limits set by
administrators. You can modify these examples to create other
types and sizes of server instances.</para>
administrators. You can modify the examples provided in this
section to create other types and sizes of server
instances.</para>
<?hard-pagebreak?>
<xi:include href="../common/section_dashboard_access.xml"/>
<?hard-pagebreak?>

257
doc/user-guide/section_dashboard_access_and_security.xml
View File

@ -11,39 +11,62 @@
xml:id="Launching_Instances_using_Dashboard">
<title>Configure access and security for instances</title>
<?dbhtml stop-chunking?>
<para>Before you launch a virtual machine, you can add security
group rules to enable users to ping and SSH to the instances.
To do so, you either add rules to the default security group
or add a security group with rules.</para>
<para>Keypairs are SSH credentials that are injected into images
when they are launched. For this to work, the image must
contain the <literal>cloud-init</literal> package. Create at
least one keypair for each project. For information, see <xref
<para>Before you launch an instance, you should add security group
rules to enable users to ping and use SSH to connect to the
instance. To do so, you either <link
xlink:href="#security_groups_add_rule">add rules to the
default security group</link> or add a security group with
rules.</para>
<para>Key pairs are SSH credentials that are injected into an
instance when it is launched. To use key pair injection, the
image that the instance is based on must contain the
<literal>cloud-init</literal> package. Each project should
have at least one key pair. For more information, see <xref
linkend="keypair_add"/>.</para>
<para>If you have generated a keypair with an external tool, you
can import it into OpenStack. The keypair can be used for
multiple instances that belong to a project. For information,
see <xref linkend="dashboard_import_keypair"/>.</para>
<para>If you have generated a key pair with an external tool, you
can import it into OpenStack. The key pair can be used for
multiple instances that belong to a project. For more
information, see <xref linkend="dashboard_import_keypair"
/>.</para>
<para>When an instance is created in OpenStack, it is automatically
assigned a fixed IP address in the network to which the
instance is assigned. This IP address is permanently
associated with the instance until the instance is terminated.
However, in addition to the fixed IP address, a floating IP
address can also be attached to an instance. Unlike fixed IP
addresses, floating IP addresses are able to have their
associations modified at any time, regardless of the state of
the instances involved.</para>
<section xml:id="security_groups_add_rule">
<title>Add rules to the default security group</title>
<title>Add a rule to the default security group</title>
<para>This procedure enables SSH and ICMP (ping) access to
instances. The rules apply to all instances within a given
project, and should be set for every project unless there
is a reason to prohibit SSH or ICMP access to the
instances.</para>
<para>This procedure can be adjusted as necessary to add
additional security group rules to a project, if your
cloud requires them.</para>
<procedure>
<step>
<para>Log in to the dashboard, choose a project, and click the
<guilabel>Access &amp; Security</guilabel> category.
The dashboard shows the security groups that are
available for this project.</para>
<para>Log in to the dashboard, choose a project, and
click <guilabel>Access &amp; Security</guilabel>.
The <guilabel>Security Groups</guilabel> tab shows
the security groups that are available for this
project.</para>
</step>
<step>
<para>Select the default security group and click
<guibutton>Edit Rules</guibutton>.</para>
<para>Select the <guilabel>default</guilabel> security
group and click <guibutton>Edit
Rules</guibutton>.</para>
</step>
<step>
<para>To allow ssh access, click <guibutton>Add
<para>To allow SSH access, click <guibutton>Add
Rule</guibutton>.</para>
</step>
<step>
<para>In the <guilabel>Add Rule</guilabel> window,
enter the following values:</para>
<para>In the Add Rule dialog box, enter the following
values:</para>
<informaltable rules="all" width="75%">
<col width="50%"/>
<col width="50%"/>
@ -77,16 +100,16 @@
</step>
<step>
<para>Click <guibutton>Add</guibutton>.</para>
<para>The ssh port 22 is now open for requests from any IP
address.</para>
<para>Instances will now have SSH port 22 open for
requests from any IP address.</para>
</step>
<step>
<para>To add an ICMP rule, click <guibutton>Add
Rule</guibutton>.</para>
</step>
<step>
<para>In the <guilabel>Add Rule</guilabel> window,
enter the following values:</para>
<para>In the Add Rule dialog box, enter the following
values:</para>
<informaltable rules="all" width="75%">
<col width="50%"/>
<col width="50%"/>
@ -110,92 +133,97 @@
</step>
<step>
<para>Click <guibutton>Add</guibutton>.</para>
<para>Instances will now accept all incoming ICMP
packets.</para>
</step>
</procedure>
</section>
<section xml:id="keypair_add">
<title>Add a keypair</title>
<para>Create at least one keypair for each project.</para>
<title>Add a key pair</title>
<para>Create at least one key pair for each project.</para>
<procedure>
<step>
<para>Log in to the dashboard, choose a
project, and click the <guilabel>Access &amp;
Security</guilabel> category.</para>
<para>Log in to the dashboard, choose a project, and
click <guilabel>Access &amp;
Security</guilabel>.</para>
</step>
<step>
<para>The <guilabel>Keypairs</guilabel> tab shows the
keypairs that are available for this
project.</para>
<para>Click the <guilabel>Keypairs</guilabel> tab,
which shows the key pairs that are available for
this project.</para>
</step>
<step>
<para>Click <guibutton>Create
Keypair</guibutton>.</para>
</step>
<step>
<para>In the <guilabel>Create Keypair</guilabel>
window, enter a name for your keypair, and click
<guibutton>Create Keypair</guibutton>.</para>
<para>In the Create Keypair
dialog box, enter a name for your key pair, and
click <guibutton>Create
Keypair</guibutton>.</para>
</step>
<step>
<para>Respond to the prompt to download the
keypair.</para>
<para>Respond to the prompt to download the key
pair.</para>
</step>
</procedure>
</section>
<section xml:id="dashboard_import_keypair">
<title>Import a keypair</title>
<title>Import a key pair</title>
<procedure>
<step>
<para>Log in to the dashboard, choose a project, and
click the <guilabel>Access &amp;
Security</guilabel> category.</para>
click <guilabel>Access &amp;
Security</guilabel>.</para>
</step>
<step>
<para>The <guilabel>Keypairs</guilabel> tab shows the
keypairs that are available for this
project.</para>
<para>Click the <guilabel>Keypairs</guilabel> tab,
which shows the key pairs that are available for
this project.</para>
</step>
<step>
<para>Click <guibutton>Import
Keypair</guibutton>.</para>
</step>
<step>
<para>In the <guilabel>Import Keypair</guilabel>
window, enter the name of your keypair. In the
<guilabel>Public Key</guilabel> box, copy the
public key. Then, click <guibutton>Import
Keypair</guibutton>.</para>
<para>In the Import Keypair
dialog box, enter the name of your key pair, copy
the public key into the <guilabel>Public
Key</guilabel> box, and then click
<guibutton>Import Keypair</guibutton>.</para>
</step>
<step>
<para>Save the <filename>*.pem</filename> file
locally. To change its permissions so that only
locally.</para></step>
<step><para>To change its permissions so that only
you can read and write to the file, run the
following command:</para>
<screen><prompt>$</prompt> <userinput>chmod 0600 <replaceable>MY_PRIV_KEY</replaceable>.pem</userinput></screen>
<screen><prompt>$</prompt> <userinput>chmod 0600 <replaceable>yourPrivateKey</replaceable>.pem</userinput></screen>
<note>
<para>If you are using the dashboard from a
Windows-based computer, use puttygen to load
the <filename>*.pem</filename> and convert and
save as <filename>*.ppk</filename>. Refer to
<link
Windows computer, use PuTTYgen to load the
<filename>*.pem</filename> file and
convert and save it as
<filename>*.ppk</filename>. For more
information see the <link
xlink:href="http://winscp.net/eng/docs/ui_puttygen"
>WinSCP information</link> for more
details.</para>
>WinSCP web page for
PuTTYgen</link>.</para>
</note>
</step>
<step>
<para>To make the keypair known to SSH, run the
<command>ssh-add</command> command:</para>
<screen><prompt>$</prompt> <userinput>ssh-add <replaceable>MY_PRIV_KEY</replaceable>.pem</userinput></screen>
<para>To make the key pair known to SSH, run the
<command>ssh-add</command> command.</para>
<screen><prompt>$</prompt> <userinput>ssh-add <replaceable>yourPrivateKey</replaceable>.pem</userinput></screen>
</step>
</procedure>
<para>The Compute database registers the public key of the
keypair.</para>
<para>The dashboard lists the keypair in the <guilabel>Access
&amp; Security</guilabel> category.</para>
<para>The Compute database registers the public key of the key
pair.</para>
<para>The dashboard lists the key pair on the <guilabel>Access
&amp; Security</guilabel> tab.</para>
</section>
<section xml:id="add_floating_ip">
<title>Allocating floating IP addresses to instances</title>
<title>Allocate a floating IP address to an instance</title>
<para>When an instance is created in OpenStack, it is
automatically assigned a fixed IP address in the network to
which the instance is assigned. This IP address is
@ -203,80 +231,69 @@
is terminated.
</para>
<para>However, in addition to the fixed IP address, a floating
IP address can also be attached to an instance. Unlike fixed
IP addresses, floating IP addresses are able to have their
associations modified at any time, regardless of the state of
the instances involved. This procedure details the
reservation of a floating IP address from an existing pool of
addresses and the association of that address with a specific
instance.
</para>
IP address can also be attached to an instance. Unlike
fixed IP addresses, floating IP addresses can have their
associations modified at any time, regardless of the state
of the instances involved. This procedure details the
reservation of a floating IP address from an existing pool
of addresses and the association of that address with a
specific instance.</para>
<procedure>
<step>
<para>Log in to the dashboard, choose a project, and
click the <guilabel>Access &amp; Security</guilabel> category.
</para>
<para>Log in to the dashboard, choose a project, and click
<guilabel>Access &amp; Security</guilabel>.</para>
</step>
<step>
<para>The <guilabel>Access &amp; Security</guilabel> window opens to
the <guilabel>Security Groups</guilabel> tab by default.
</para>
<para>Click on the <guilabel>Floating IPs</guilabel> tab. The
<guilabel>Floating IPs</guilabel> tab shows the floating
IP addresses allocated to instances.
</para>
<para>Click the <guilabel>Floating IPs</guilabel> tab,
which shows the floating IP addresses allocated to
instances.</para>
</step>
<step>
<para>Click the <guibutton>Allocate IP to Project</guibutton> button.
</para>
<para>Click <guibutton>Allocate IP to Project</guibutton>.</para>
</step>
<step>
<para>Choose the <guilabel>Pool</guilabel> from which the IP address
should be picked.</para>
<para>Choose the pool from which to pick the IP
address.</para>
</step>
<step>
<para>Click the <guibutton>Allocate IP</guibutton> button.</para>
<para>Click <guibutton>Allocate IP</guibutton>.</para>
</step>
<step>
<para>In the <guilabel>Floating IPs</guilabel> list, click the
<guibutton> Associate</guibutton> button. The <guilabel>Manage
Floating IP Associations</guilabel> window opens.
</para>
<para>In the <guilabel>Floating IPs</guilabel> list, click
<guibutton> Associate</guibutton>.</para>
</step>
<step>
<para>In the <guilabel>Manage Floating IP
Associations</guilabel> window, choose the following options:
<orderedlist>
<listitem>
<para>The <guilabel>IP Address</guilabel> field is
filled automatically.
</para>
<para>You can choose to add a new IP address by using the
<guibutton>+</guibutton> button.</para>
</listitem>
<listitem>
<para>In the <guilabel>Ports to be associated</guilabel> field,
select a port from the dropdown list.</para>
<para>The dropdown lists all the instances with their respective
fixed IP addresses.
</para>
</listitem>
</orderedlist>
</para>
<para>In the Manage Floating IP
Associations dialog box, choose the
following options: <itemizedlist>
<listitem>
<para>The <guilabel>IP Address</guilabel>
field is filled automatically, but you
can add a new IP address by clicking
the <guibutton>+</guibutton>
button.</para>
</listitem>
<listitem>
<para>In the <guilabel>Ports to be
associated</guilabel> field, select
a port from the list.</para>
<para>The list shows all the instances
with their fixed IP addresses.</para>
</listitem>
</itemizedlist>
</para>
</step>
<step>
<para>Click the <guibutton>Associate</guibutton> button.
</para>
<para>Click <guibutton>Associate</guibutton>.</para>
</step>
</procedure>
<note>
<para>To disassociate the IP address from an instance, click the
<guibutton>Disassociate</guibutton> button.</para>
<para>To disassociate an IP address from an instance, click
the <guibutton>Disassociate</guibutton> button.</para>
<para>To release the floating IP address back into the pool of
addresses, click the <guibutton>More</guibutton> dropdown
button and select <guilabel>Release Floating IP</guilabel>
option.
</para>
addresses, click the <guibutton>More</guibutton>
button and select the <guilabel>Release Floating
IP</guilabel> option.</para>
</note>
</section>
</section>

127
doc/user-guide/section_dashboard_create_networks.xml
View File

@ -11,23 +11,29 @@
xml:id="dashboard_create_networks">
<title>Create and manage networks</title>
<?dbhtml stop-chunking?>
<para>OpenStack Networking service provides a scalable system for managing
the network connectivity within an OpenStack cloud deployment.</para>
<para>It can easily and quickly react to changing network needs (for
example, creating and assigning new IP addresses).</para>
<para>The OpenStack Networking service provides a scalable
system for managing the network connectivity within an OpenStack
cloud deployment. It can easily and quickly react to changing
network needs (for example, creating and assigning new IP
addresses).</para>
<para>Networking in OpenStack is complex. This section provides the
basic instructions for creating a network and a router. For
detailed information about managing networks, refer to the <link
xlink:href="http://docs.openstack.org/admin-guide-cloud/content/ch_networking.html"
><emphasis role="italic">OpenStack Cloud Administrator
Guide</emphasis></link>.</para>
<section xml:id="dashboard_create_network">
<title>Create a network</title>
<procedure>
<step>
<para>Log in to the dashboard, choose a project,
and click the <guibutton>Networks</guibutton>
category.</para>
<para>Log in to the dashboard, choose a project, and click
<guibutton>Networks</guibutton>.</para>
</step>
<step>
<para>Click <guibutton>Create Network</guibutton>.</para>
</step>
<step>
<para>In the <guilabel>Create Network</guilabel> window, specify the
<para>In the Create Network dialog box, specify the
following values.</para>
<informaltable rules="all" width="75%">
<col width="30%"/>
@ -41,7 +47,7 @@
<tbody>
<tr>
<td><para><guilabel>Network Name</guilabel></para></td>
<td><para>A name to identify the network.</para></td>
<td><para>Specify a name to identify the network.</para></td>
</tr>
<tr>
<th colspan="2" align="center">
@ -49,33 +55,31 @@
</tr>
<tr>
<td><para><guilabel>Create Subnet</guilabel></para></td>
<td><para>Check this option to create a subnet</para>
<para>You do not have to initially specify
a subnet (although this will result in
the status of 'error' for any attached
instance).</para></td>
<td><para>Select this check box to create a
subnet</para><para>You do not have to specify a subnet
when you create a network, but if you do not, any
attached instance receives an Error status.</para></td>
</tr>
<tr>
<td><para><guilabel>Subnet Name</guilabel></para></td>
<td><para>Name for the subnet.</para></td>
<td><para>Specify a name for the subnet.</para></td>
</tr>
<tr>
<td><para><guilabel>Network Address</guilabel></para></td>
<td><para>IP address for the subnet.</para></td>
<td><para>Specify the IP address for the subnet.</para></td>
</tr>
<tr>
<td><para><guilabel>IP Version</guilabel></para></td>
<td><para>IPv4 or IPv6.</para></td>
<td><para>Select IPv4 or IPv6.</para></td>
</tr>
<tr>
<td><para><guilabel>Gateway IP</guilabel></para></td>
<td><para>IP address for a specific gateway.
This parameter is optional.</para></td>
<td><para>Specify an IP address for a specific gateway. This parameter is
optional.</para></td>
</tr>
<tr>
<td><para><guilabel>Disable Gateway</guilabel></para></td>
<td><para>Check this option to disable gateway
IP address.</para></td>
<td><para>Select this check box to disable a gateway IP address.</para></td>
</tr>
<tr>
<th colspan="2" align="center"
@ -83,31 +87,27 @@
</tr>
<tr>
<td><para><guilabel>Enable DHCP</guilabel></para></td>
<td><para>Check this option to enable DHCP</para></td>
<td><para>Select this check box to enable DHCP.</para></td>
</tr>
<tr>
<td><para><guilabel>Allocation Pools</guilabel></para></td>
<td><para>You can allocate IP address pools.</para></td>
<td><para>Specify IP address pools.</para></td>
</tr>
<tr>
<td><para><guilabel>DNS Name Servers</guilabel></para></td>
<td><para>You can allocate a name for the DNS server.
</para></td>
<td><para>Specify a name for the DNS server.</para></td>
</tr>
<tr>
<td><para><guilabel>Host Routes</guilabel></para></td>
<td><para>Include IP address of host routes.</para></td>
<td><para>Specify the IP address of host routes.</para></td>
</tr>
</tbody>
</informaltable>
</step>
<step>
<para>Click <guilabel>Create</guilabel> to create a
network.</para>
</step>
<step>
<para>The dashboard shows the network in the
<guilabel>Networks</guilabel> category.</para>
<para>Click <guilabel>Create</guilabel>.</para>
<para>The dashboard shows the network on the
<guilabel>Networks</guilabel> tab.</para>
</step>
</procedure>
</section>
@ -115,45 +115,41 @@
<title>Create a router</title>
<procedure>
<step>
<para>Log in to the dashboard, choose a project,
and click the <guibutton>Routers</guibutton>
category.</para>
<para>Log in to the dashboard, choose a project, and click
<guibutton>Routers</guibutton>.</para>
</step>
<step>
<para>Click the <guibutton>Create Router</guibutton> button. The
<guilabel>Create Router</guilabel> window is displayed.</para>
<para>Click <guibutton>Create Router</guibutton>.</para>
</step>
<step><para>Specify a name for the router and click the
<guibutton>Create Router</guibutton> button. The new router is now
displayed in the router list.</para>
<step><para>In the Create Router dialog box, specify a name for the router
and click <guibutton>Create Router</guibutton>.</para>
<para>The new router is now displayed in the
<guilabel>Routers</guilabel> tab.</para>
</step>
<step>
<para>
Click the new router's <guibutton>Set Gateway</guibutton> button.
</para>
<para>Click the new router's <guibutton>Set Gateway</guibutton> button.
</para>
</step>
<step>
<para>
Specify the network to which the router will connect in the
<guilabel>External Network</guilabel> field, and click the
<guibutton>Set Gateway</guibutton> button.
</para>
<para>In the <guilabel>External Network</guilabel> field,
specify the network to which the router will connect, and
then click <guibutton>Set Gateway</guibutton>.</para>
</step>
<step>
<para>To connect a private network to the newly created router:</para>
<para>To connect a private network to the newly created
router, perform the following steps:</para>
<substeps>
<step>
<para>Click on the router name in the router list.</para>
<para>On the <guilabel>Routers</guilabel> tab, click the
name of the router.</para>
</step>
<step>
<para>
Click the <guibutton>Add Interface</guibutton> button. The
<guilabel>Add Interface</guilabel> window is displayed.</para>
<para>On the Router Details page, click <guilabel>Add
Interface</guilabel>.</para>
</step>
<step>
<para>
Specify the following information:
</para>
<para>In the Add Interface dialog box, specify the
following information:</para>
<informaltable rules="all" width="75%">
<col width="30%"/>
<col width="70%"/>
@ -161,7 +157,7 @@
<tr>
<td>
<para><guilabel>Subnet</guilabel>
</para>
</para>
</td>
<td>
<para>Select a subnet.</para>
@ -174,11 +170,9 @@
<td>
<para>Enter the router interface IP address for the
selected subnet.</para>
<note>
<para>If this value is not set, then by default, the
first host IP address in the subnet is used by
OpenStack Networking.</para>
</note>
<para>Note: If this value is not set, then by
default, the first host IP address in the subnet
is used by OpenStack Networking.</para>
</td>
</tr>
</tbody>
@ -189,12 +183,11 @@
</substeps>
</step>
<step>
<para>Click the <guilabel>Add Interface</guilabel> button.</para>
<para>Click <guilabel>Add Interface</guilabel>.</para>
</step>
</procedure>
<para>
You have successfully created the router. You can view the new topology
by clicking <guilabel>Network Topology</guilabel> in the
<guilabel>Manage Network</guilabel> menu.</para>
<para>You have successfully created the router. You can view
the new topology from the <guilabel>Network Topology</guilabel>
tab.</para>
</section>
</section>

96
doc/user-guide/section_dashboard_launch_instances.xml
View File

@ -1,5 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section [
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
@ -13,40 +12,23 @@
<title>Launch and manage instances</title>
<para>Instances are virtual machines that run inside the
cloud.</para>
<para>You can <link linkend="dashboard_launch_instances_from_image">launch
an instance</link> from various sources. The OpenStack
Image Service provides a pool of images that are accessible to
members of different projects.</para>
<para>You can also launch an instance from an image that you have copied to
a persistent volume. The instance boots from the volume, which is provided
by <systemitem class="service">cinder-volume</systemitem> through iSCSI.
When you launch an instance from a volume, especially note the following
steps:</para>
<itemizedlist>
<listitem>
<para>To select from which volume to boot, launch an
instance from an arbitrary image. The image you select
does not boot. It is replaced by the image on the
volume that you choose in the next steps.</para>
<para>To boot a Xen image from a volume, the image you
launch in must be the same type, fully virtualized or
paravirtualized, as the one on the volume.</para>
</listitem>
<listitem>
<para>Select the volume or volume snapshot from which to
boot. Enter a device name. Enter
<literal>vda</literal> for KVM images or
<literal>xvda</literal> for Xen images.</para>
</listitem>
</itemizedlist>
<para>You can <link
linkend="dashboard_launch_instances_from_image">launch an
instance</link> from the following sources:</para>
<itemizedlist><listitem><para>Images uploaded to the OpenStack Image Service, as described
in <xref linkend="dashboard_manage_images"/>.</para></listitem>
<listitem><para>Image that you have copied to a persistent volume. The instance
launches from the volume, which is provided by the
<systemitem class="service"
>cinder-volume</systemitem> API through iSCSI.</para></listitem></itemizedlist>
<?hard-pagebreak?>
<xi:include
href="section_dashboard_launch_instances_from_image.xml"/>
<?hard-pagebreak?>
<section xml:id="ssh-into-instance">
<title>SSH in to your instance</title>
<para>To SSH into your instance, you use the downloaded
keypair file.</para>
<title>Connect to your instance by using SSH</title>
<para>To use SSH to connect to your instance, you use the
downloaded keypair file.</para>
<note>
<para>The user name is <literal>ubuntu</literal> for the
Ubuntu cloud images on TryStack.</para>
@ -56,8 +38,9 @@
<para>Copy the IP address for your instance.</para>
</step>
<step>
<para>Use the SSH command to make a secure connection
to the instance. For example:</para>
<para>Use the <command>ssh</command> command to make a
secure connection to the instance. For
example:</para>
<screen><prompt>$</prompt> <userinput>ssh -i MyKey.pem ubuntu@10.0.0.2</userinput></screen>
</step>
<step>
@ -68,15 +51,14 @@
</section>
<section xml:id="track_usage">
<title>Track usage for instances</title>
<para>You can track usage for instances for each tenant, also
known as a project. You can track costs per month by
showing metrics like number of VCPUs, disks, RAM, and
uptime for all your instances.</para>
<para>You can track usage for instances for each project. You
can track costs per month by showing metrics like number
of vCPUs, disks, RAM, and uptime for all your
instances.</para>
<procedure>
<step>
<para>Log in to the dashboard, choose a project, and
click the <guilabel>Overview</guilabel>
category.</para>
click <guilabel>Overview</guilabel>.</para>
</step>
<step>
<para>To query the instance usage for a month, select
@ -90,56 +72,56 @@
</procedure>
</section>
<section xml:id="instance_snapshots">
<title>Create instance snapshots</title>
<title>Create an instance snapshot</title>
<procedure>
<step>
<para>Log in to the dashboard, choose a project, and
click the <guilabel>Instances</guilabel>
category.</para>
click <guilabel>Instances</guilabel>.</para>
</step>
<step>
<para>Select the instance from which to create a
snapshot. From the <guilabel>Actions</guilabel>
drop-down list, select <guilabel>Create
Snapshot</guilabel>.</para>
snapshot.</para></step>
<step>
<para>From the <guilabel>Actions</guilabel> list,
select <guilabel>Create
Snapshot</guilabel>.</para>
</step>
<step>
<para>In the <guilabel>Create Snapshot</guilabel>
window, enter a name for the snapshot. Click
<guibutton>Create Snapshot</guibutton>. The
<guilabel>Images &amp; Snapshots</guilabel>
<para>In the Create Snapshot dialog box, enter a name
for the snapshot, and then click <guibutton>Create
Snapshot</guibutton>.</para>
<para>The <guilabel>Images &amp; Snapshots</guilabel>
category shows the instance snapshot.</para>
</step>
<step>
</procedure>
<para>To launch an instance from the snapshot, select
the snapshot and click
<guibutton>Launch</guibutton>. Proceed with
<xref
linkend="dashboard_launch_instances_from_image"
/>.</para>
</step>
</procedure>
</section>
<section xml:id="control_instance_states">
<title>Manage an instance</title>
<procedure>
<step>
<para>Log in to the dashboard, choose a project, and
click the <guilabel>Instances</guilabel>
category.</para>
click <guilabel>Instances</guilabel>.</para>
</step>
<step>
<para>Select an instance.</para>
</step>
<step>
<para>In the <guilabel>More</guilabel> drop-down list
in the <guilabel>Actions</guilabel> column, select
<para>In the <guilabel>More</guilabel> list in the
<guilabel>Actions</guilabel> column, select
the state.</para>
<para>You can resize or rebuild an instance. You can
also choose to view the instance console log.
Depending on the current state of the instance,
you can choose to pause, resume, suspend, soft or
hard reboot, or terminate an instance.</para>
you can pause, resume, suspend, soft or hard
reboot, or terminate it.</para>
</step>
</procedure>
</section>

319
doc/user-guide/section_dashboard_launch_instances_from_image.xml
View File

@ -11,33 +11,49 @@
xml:id="dashboard_launch_instances_from_image">
<title>Launch an instance</title>
<?dbhtml stop-chunking?>
<para>When you launch an instance from an image, OpenStack creates
a local copy of the image on the compute node where the
instance starts.</para>
<para>When you launch an instance from an image, OpenStack creates a local
copy of the image on the compute node where the instance starts.</para>
<para>When you launch an instance from a volume, note the following
steps:</para>
<itemizedlist>
<listitem>
<para>To select the volume to from which to launch, launch an
instance from an arbitrary image on the volume. The image that
you select does not boot. Instead, it is replaced by the image
on the volume that you choose in the next steps.</para>
<para>To boot a Xen image from a volume, the image you launch in
must be the same type, fully virtualized or paravirtualized, as
the one on the volume.</para>
</listitem>
<listitem>
<para>Select the volume or volume snapshot from which to boot. Enter
a device name. Enter <literal>vda</literal> for KVM images or
<literal>xvda</literal> for Xen images.</para>
</listitem>
</itemizedlist>
<procedure>
<step>
<para>Log in to the dashboard, choose a project,
and click the <guilabel>Images &amp;
Snapshot</guilabel> category.</para>
<para>The dashboard shows the images that have been
uploaded to OpenStack Image Service and are available
for this project.</para>
<para>Log in to the dashboard, choose a project, and click
<guilabel>Images &amp; Snapshot</guilabel>.</para>
<para>The dashboard shows the images that have been uploaded to
OpenStack Image Service and are available for this
project.</para>
<para>For details on creating images, see <link
xlink:href="http://docs.openstack.org/image-guide/content/ch_creating_images_manually.html">
Creating images manually</link> in the <citetitle>OpenStack Virtual
Machine Image Guide</citetitle>.</para>
xlink:href="http://docs.openstack.org/image-guide/content/ch_creating_images_manually.html"
>Creating images manually</link> in the <citetitle>OpenStack
Virtual Machine Image Guide</citetitle>.</para>
</step>
<step>
<para>Select an image and click
<guibutton>Launch</guibutton>.</para>
<guibutton>Launch</guibutton>.</para>
</step>
<step>
<para>In the <guilabel>Launch Instance</guilabel> window,
specify the following values:</para>
<informaltable rules="all" width="75%">
<col width="30%"/>
<col width="70%"/>
<thead>
<para>In the Launch Instance dialog box, specify the following
values:</para>
<informaltable rules="all" width="75%">
<col width="30%"/>
<col width="70%"/>
<thead>
<tr>
<th colspan="2" align="center"
><guilabel>Details</guilabel> tab</th>
@ -45,185 +61,182 @@
</thead>
<tbody>
<tr>
<td><para><guilabel>Availability Zone</guilabel></para></td>
<td><para><guilabel>Availability
Zone</guilabel></para></td>
<td>
<para>By default, this value is set to the availability
zone given by the cloud provider (for example,
<literal>us-west</literal> or <literal>apac-south</literal>).
Though, it could be <literal>nova</literal> for most cases.
</para>
<para>By default, this value is set to the
availability zone given by the cloud provider
(for example, <literal>us-west</literal> or
<literal>apac-south</literal>). For most
cases, it could be
<literal>nova</literal>.</para>
</td>
</tr>
<tr>
<td><para><guilabel>Instance Name</guilabel></para></td>
<td><para>The name to assign to the virtual machine.
</para>
<note>
<para>The name you assign here becomes the initial host
name of the server. After the server is built, if you
change the server name in the API or change the host
name directly, the names are not updated in the dashboard.</para>
<para>Server names are not guaranteed to be unique when
created so you could have two instances with the same
host name.</para>
</note>
<td><para>Assign a name to the virtual machine.</para>
<note>
<para>The name you assign here becomes the
initial host name of the server. After the
server is built, if you change the server
name in the API or change the host name
directly, the names are not updated in the
dashboard.</para>
<para>Server names are not guaranteed to be
unique when created so you could have two
instances with the same host name.</para>
</note>
</td>
</tr>
<tr>
<td>
<para><guilabel>Flavor</guilabel></para></td>
<td><para>The size of the virtual machine to
<td><para>Specify the size of the instance to
launch.</para></td>
</tr>
<tr>
<td><para><guilabel>Instance
Count</guilabel></para></td>
<td><para>To launch multiple instances, enter
a value greater than 1. Default is 1.
</para></td>
Count</guilabel></para></td>
<td><para>To launch multiple instances, enter a value
greater than 1. The default is 1.</para></td>
</tr>
<tr>
<td>
<para>
<guilabel>Instance Boot Source</guilabel>
</para>
</td>
<td><para>Your options are:</para>
<itemizedlist>
<listitem>
<para>
<guilabel>Boot from image</guilabel> - If you choose
this option, a new field for <guilabel>Image Name</guilabel>
displays. You can select the image from the
dropdown list.
</para>
</listitem>
<listitem>
<para>
<guilabel>Boot from snapshot</guilabel> - If you
choose this option, a new field for <guilabel>Instance Snapshot</guilabel>
displays. You can select the snapshot from
the dropdown list.
</para>
</listitem>
<listitem>
<para>
<guilabel>Boot from volume</guilabel> - If you
choose this option, a new field for <guilabel>Volume</guilabel>
displays. You can select the volume from the
dropdown list.
</para>
</listitem>
<listitem>
<para>
<guilabel>Boot from image (creates a new volume)
</guilabel> - With this option, you can boot from
an image and create a volume by entering the <guilabel>Device Size</guilabel>
and <guilabel>Device Name</guilabel> for your
volume.
</para>
</listitem>
<listitem>
<para>
<guilabel>Boot from volume snapshot (creates a new
volume)</guilabel> - Using this option, you can
boot from a volume snapshot and create a new
volume by choosing <guilabel>Volume Snapshot</guilabel>
from a dropdown list and adding a <guilabel>Device Name</guilabel>
for your volume.
</para>
</listitem>
</itemizedlist>
<para>Since you are launching an instance from an image,
<guilabel>Boot from image</guilabel> is chosen by
default.</para>
</td>
<td>
<para>
<guilabel>Instance Boot Source</guilabel>
</para>
</td>
<td><para>Your options are:</para>
<itemizedlist>
<listitem>
<para>
<guilabel>Boot from
image</guilabel>&mdash;If you choose
this option, a new field for
<guilabel>Image Name</guilabel>
displays. You can select the image from
the list.</para>
</listitem>
<listitem>
<para>
<guilabel>Boot from
snapshot</guilabel>&mdash;If you choose
this option, a new field for
<guilabel>Instance Snapshot</guilabel>
displays. You can select the snapshot
from the list.</para>
</listitem>
<listitem>
<para>
<guilabel>Boot from
volume</guilabel>&mdash;If you choose
this option, a new field for
<guilabel>Volume</guilabel> displays.
You can select the volume from the
list.</para>
</listitem>
<listitem>
<para>
<guilabel>Boot from image (creates a new
volume) </guilabel>&mdash;With this
option, you can boot from an image and
create a volume by entering the
<guilabel>Device Size</guilabel> and
<guilabel>Device Name</guilabel> for
your volume.</para>
</listitem>
<listitem>
<para>
<guilabel>Boot from volume snapshot
(creates a new volume)</guilabel>&mdash;
Using this option, you can boot from a
volume snapshot and create a new volume
by choosing <guilabel>Volume
Snapshot</guilabel> from a list and
adding a <guilabel>Device
Name</guilabel> for your volume.</para>
</listitem>
</itemizedlist>
<para>Since you are launching an instance from an
image, <guilabel>Boot from image</guilabel> is
chosen by default.</para>
</td>
</tr>
<tr>
<td>
<para>
<guilabel>Image Name</guilabel>
</para>
</td>
<td>
<para>This field changes based on your previous selection.
Since you have chosen to launch an instance using an image,
the <guilabel>Image Name</guilabel> field displays.
Select the image name from the dropdown list.</para>
</td>
<td>
<para>
<guilabel>Image Name</guilabel>
</para>
</td>
<td>
<para>This field changes based on your previous
selection. Since you have chosen to launch an
instance using an image, the <guilabel>Image
Name</guilabel> field displays. Select the
image name from the dropdown list.</para>
</td>
</tr>
<tr>
<th colspan="2" align="center"
><guilabel>Access &amp;
<th colspan="2" align="center"><guilabel>Access &amp;
Security</guilabel> tab</th>
</tr>
<tr>
<td><para><guilabel>Keypair</guilabel></para></td>
<td><para>Select a keypair from the dropdown list.</para>
<para>In case an image uses a static root
password or a static key set (neither
is recommended), you do not need to
provide a keypair to launch the
<td><para>Specify a key pair.</para>
<para>If the image uses a static root password or a
static key set (neither is recommended), you do
not need to provide a key pair to launch the
instance.</para></td>
</tr>
<tr>
<td><para><guilabel>Security
Groups</guilabel></para></td>
<td><para>Activate the security groups that
you want to assign to the
instance.</para>
<para>Security groups are a kind of cloud
firewall that define which incoming
network traffic is forwarded to
instances. For details, see <xref
linkend="security_groups_add_rule"
/>.</para>
<para>If you have not created any security
groups, you can assign only the
default security group to the
instance.</para></td>
Groups</guilabel></para></td>
<td><para>Activate the security groups that you want to
assign to the instance.</para>
<para>Security groups are a kind of cloud firewall
that define which incoming network traffic is
forwarded to instances. For details, see <xref
linkend="security_groups_add_rule"/>.</para>
<para>If you have not created any security groups,
you can assign only the default security group
to the instance.</para></td>
</tr>
<tr>
<th colspan="2" align="center"
><guilabel>Networking</guilabel>
tab</th>
><guilabel>Networking</guilabel> tab</th>
</tr>
<tr>
<td><para><guilabel>Selected Networks</guilabel></para></td>
<td><para><guilabel>Selected
Networks</guilabel></para></td>
<td><para>To add a network to the instance, click the
<guibutton>+</guibutton> in the <guilabel>Available
Networks</guilabel> field.</para></td>
<guibutton>+</guibutton> in the
<guilabel>Available Networks</guilabel>
field.</para></td>
</tr>
<tr>
<th colspan="2" align="center"
><guilabel>Post-Creation</guilabel>
tab</th>
><guilabel>Post-Creation</guilabel> tab</th>
</tr>
<tr>
<td><para><guilabel>Customization
Script</guilabel></para></td>
<td><para>A customization script that runs after your
instance launches.</para></td>
Script</guilabel></para></td>
<td><para>Specify a customization script that runs after
your instance launches.</para></td>
</tr>
</tbody>
</informaltable>
</step>
<step>
<para>Click <guibutton>Launch</guibutton>. The instance
starts on a compute node in the cloud.</para>
</step>
<step>
<para>The <guilabel>Instances</guilabel> category shows
the instance name, its private and public IP
addresses, size, status, task, and power state.</para>
</step>
<step>
<para>If you did not provide a keypair, security groups,
or rules so far, users can only access the instance
from inside the cloud through VNC. Even pinging the
instance is not possible. To access the instance
through a VNC console, see <xref
linkend="instance_console"/>.</para>
<para>Click <guibutton>Launch</guibutton>.</para>
<para>The instance starts on a compute node in the cloud.</para>
</step>
</procedure>
<para>The <guilabel>Instances</guilabel> tab shows the instance's name, its
private and public IP addresses, size, status, task, and power
state.</para>
<para>If you did not provide a key pair, security groups, or rules, users
can access the instance only from inside the cloud through VNC. Even
pinging the instance is not possible without an ICMP rule configured. To
access the instance through a VNC console, see <xref
linkend="instance_console"/>.</para>
</section>

57
doc/user-guide/section_dashboard_manage_containers.xml
View File

@ -5,67 +5,70 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="dashboard_manage_containers">
<title>Create and manage object containers</title>
<?dbhtml stop-chunking?>
<para>Container service is one of the services provided by the Object Storage Service.</para>
<para>A container is a storage compartment for your data and provides a
way for you to organize your data. It is similar to the concept as a
Linux file directory but cannot be nested.</para>
<para>OpenStack Object Storage provides a distributed,
API-accessible storage platform that can be integrated directly
into an application or used to store any type of file, including
VM images, backups, archives, or media files. In the OpenStack
Dashboard, you can only manage containers and objects.</para>
<para>In OpenStack Object Storage, containers provide storage
for objects in a manner similar to a Windows folder or Linux file
directory, though they cannot be nested. An object in OpenStack
consists of the file to be stored in the container and any
accompanying metadata.</para>
<section xml:id="create_container">
<title>Create a container</title>
<procedure>
<step>
<para>Log in to the dashboard.</para>
<para>Log in to the dashboard, choose a project, and click
<guilabel>Containers</guilabel>.</para>
</step>
<step>
<para>On the <guilabel>Project</guilabel> tab, click the
<guilabel>Containers</guilabel> category.</para>
<para>Click <guibutton>Create Container</guibutton>.</para>
</step>
<step>
<para>Click the <guibutton>Create Container</guibutton> button. The
<guilabel>Create Container</guilabel> window is displayed.</para>
</step>
<step>
<para>Enter a name for the container. Click the <guibutton>Create Container</guibutton>
button.</para>
<para>In the Create Container dialog box, enter a name for
the container, and then click<guibutton>Create
Container</guibutton>.</para>
</step>
</procedure>
<para>You have successfully created a container.</para>
<note><para>To delete a container, click the <guibutton>More</guibutton>
dropdown button and select the <guilabel>Delete Container</guilabel> option.</para>
button and select <guilabel>Delete
Container</guilabel>.</para>
</note>
</section>
<section xml:id="upload_object">
<title>Upload an object</title>
<procedure>
<step>
<para>Log in to the dashboard.</para>
</step>
<step>
<para>On the <guilabel>Project</guilabel> tab, click the
<guilabel>Containers</guilabel> category.</para>
<para>Log in to the dashboard, choose a projecet, and click
<guilabel>Containers</guilabel>.</para>
</step>
<step>
<para>Select the container in which you want to store your object.</para>
</step>
<step>
<para>Click the <guibutton>Upload Object</guibutton> button. The
<guilabel>Upload Object To Container: <replaceable>CONTAINER_NAME
</replaceable></guilabel> window is displayed.</para>
<para><replaceable>CONTAINER_NAME</replaceable> is replaced by the
name of the container to which you are uploading the object.</para>
<para>Click <guibutton>Upload Object</guibutton>.</para>
<para>The Upload Object To Container:
<replaceable>&lt;name></replaceable> dialog box is
displayed. <replaceable>&lt;name></replaceable> is the name
of the container to which you are uploading the
object.</para>
</step>
<step>
<para>Enter a name for the object.</para>
</step>
<step>
<para>Browse and select the file you want to upload.</para>
<para>Browse to and select the file that you want to
upload.</para>
</step>
<step>
<para>Click the <guibutton>Upload Object</guibutton> button.</para>
<para>Click <guibutton>Upload Object</guibutton>.</para>
</step>
</procedure>
<para>You have successfully uploaded an object to the container.</para>
<note><para>To delete an object, click the <guibutton>More</guibutton>
dropdown button and select the <guilabel>Delete Object</guilabel> option.</para>
button and select <guilabel>Delete Object</guilabel>.</para>
</note>
</section>
</section>

223
doc/user-guide/section_dashboard_manage_images.xml
View File

@ -3,43 +3,47 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="dashboard_manage_images">
<title>Create and manage images</title>
<para>The cloud operator assigns roles to users. Roles determine
who can upload and manage images. Operators might restrict the
upload and management of images to cloud administrators or
operators only.</para>
<para>If you have admin privileges, you can use the dashboard to
create and manage images in the <guilabel>admin</guilabel>
project.</para>
<title>Upload and manage images</title>
<para>A virtual machine image, referred to in this document simply
as an image, is a single file that contains a virtual disk that
has a bootable operating system installed on it. Images are used
to create virtual machine instances within the cloud. For
information about creating image files, see the <link
xlink:href="http://docs.openstack.org/image-guide/content/"
><citetitle>OpenStack Virtual Machine Image
Guide</citetitle></link>.</para>
<para>Depending on your role, you may have permission to upload and
manage virtual machine images. Operators might restrict the upload
and management of images to cloud administrators or operators
only. If you have the appropriate privileges, you can use the
dashboard to upload and manage images in the
<guilabel>admin</guilabel> project.</para>
<note>
<title>Manage images by using clients and APIs</title>
<para>You can also use the <command>glance</command> and
<command>nova</command> command-line clients or the Image
Service and Compute APIs to manage images. See <xref
linkend="cli_manage_images"/>.</para>
</note>
<section xml:id="dashboard_create_images">
<title>Create images</title>
<para>For details about image creation, see the <link
xlink:href="http://docs.openstack.org/image-guide/content/"
><citetitle>Virtual Machine Image
Guide</citetitle></link>.</para>
<title>Upload an image</title>
<para>Follow this procedure to upload an image to a
project.</para>
<procedure>
<step>
<para>Log in to the dashboard.</para>
<para>Choose the <guilabel>admin</guilabel> project from the
<guilabel>CURRENT PROJECT</guilabel> drop-down
list.</para>
</step>
<step>
<para>On the <guilabel>Project</guilabel> tab, click the
<guilabel>Images &amp; Snapshots</guilabel>
category.</para>
<para>From the <guilabel>CURRENT PROJECT</guilabel> on the
<guilabel>Project</guilabel> tab, select the appropriate
project.</para>
</step>
<step>
<para>Click <guibutton>Create Image</guibutton>. The
<guilabel>Create An Image</guilabel> window
appears:</para>
<para>On the <guilabel>Project</guilabel> tab, click
<guilabel>Images &amp; Snapshots</guilabel>.</para>
</step>
<step>
<para>Click <guibutton>Create Image</guibutton>.</para>
<para>The Create An Image dialog box appears.</para>
<informalfigure>
<mediaobject>
<imageobject>
@ -51,63 +55,88 @@
</informalfigure>
</step>
<step>
<para>In the <guilabel>Create An Image</guilabel> window,
enter or select the following values:</para>
<para>Enter the following values:</para>
<informaltable rules="all" width="75%">
<col width="25%"/>
<col width="75%"/>
<tbody>
<tr>
<td><para><guilabel>Name</guilabel></para></td>
<td><para>Enter a name for the image.</para></td>
<td>
<para><guilabel>Name</guilabel></para>
</td>
<td>
<para>Enter a name for the image.</para>
</td>
</tr>
<tr>
<td><para><guilabel>Description</guilabel></para></td>
<td><para>Enter a brief description about the
image.</para></td>
<td>
<para><guilabel>Description</guilabel></para>
</td>
<td>
<para>Optionally, enter a brief description of the
image.</para>
</td>
</tr>
<tr>
<td><para><guilabel>Image
Source</guilabel></para></td>
<td>
<para>Choose the image source from the dropdown list. Your
choices are <guilabel>Image Location</guilabel> and
<td>
<para><guilabel>Image Source</guilabel></para>
</td>
<td>
<para>Choose the image source from the list. Your
choices are <guilabel>Image Location</guilabel> and
<guilabel>Image File</guilabel>.</para>
</td>
</tr>
<tr>
<td>
<para>
<guilabel>Image File</guilabel> or
<guilabel>Image Location</guilabel></para></td>
<td>
<para>Based on your selection, there is an
<guilabel>Image File</guilabel> or <guilabel>Image Location</guilabel>
field. You can include the location URL or browse to the
image file on your file system and add it.</para>
</td>
</tr>
<tr>
<td><para><guilabel>Format</guilabel></para></td>
<td><para>Select the correct type from the drop-down menu
(for example, QCOW2).</para>
</td>
</tr>
<tr>
<td><para><guilabel>Minimum Disk (GB)</guilabel> and
<guilabel>Minimum RAM (MB)</guilabel></para></td>
<td><para>Leave these fields empty.</para>
<td>
<para>
<guilabel>Image File</guilabel> or <guilabel>Image
Location</guilabel></para>
</td>
<td>
<para>Based on your selection for <guilabel>Image
Source</guilabel>, you either enter the location
URL of the image in the <guilabel>Image
Location</guilabel> field. or browse to the image
file on your system and add it.</para>
</td>
</tr>
<tr>
<td><para><guilabel>Public</guilabel></para></td>
<td><para>Select this option to make the image public to
all users.</para></td>
<td>
<para><guilabel>Format</guilabel></para>
</td>
<td>
<para>Select the correct format (for example, QCOW2)
for the image.</para>
</td>
</tr>
<tr>
<td><para><guilabel>Protected</guilabel></para></td>
<td><para>Select this option to ensure that only users
with permissions can delete it.</para></td>
<td>
<para><guilabel>Minimum Disk (GB)</guilabel> and
<guilabel>Minimum RAM (MB)</guilabel></para>
</td>
<td>
<para>Leave these optional fields empty.</para>
</td>
</tr>
<tr>
<td>
<para><guilabel>Public</guilabel></para>
</td>
<td>
<para>Select this check box to make the image public
to all users with access to the current
project.</para>
</td>
</tr>
<tr>
<td>
<para><guilabel>Protected</guilabel></para>
</td>
<td>
<para>Select this check box to ensure that only users
with permissions can delete the image.</para>
</td>
</tr>
</tbody>
</informaltable>
@ -115,35 +144,49 @@
<step>
<para>Click <guibutton>Create Image</guibutton>.</para>
<para>The image is queued to be uploaded. It might take some
time before the status changes from queued to active.</para>
time before the status changes from Queued to Active.</para>
</step>
</procedure>
</section>
<section xml:id="dashboard_update_images">
<title>Update images</title>
<title>Update an image</title>
<para>Follow this procedure to update an existing image.</para>
<procedure>
<step>
<para>Log in to the dashboard.</para>
<para>Choose the <guilabel>admin</guilabel> project from the
<guilabel>CURRENT PROJECT</guilabel> drop-down
list.</para>
</step>
<step>
<para>On the <guilabel>Project</guilabel> tab, click the
<guilabel>Images &amp; Snapshots</guilabel>
category.</para>
<para>From the <guilabel>CURRENT PROJECT</guilabel> on the
<guilabel>Project</guilabel> tab, select the appropriate
project.</para>
</step>
<step>
<para>Select the image that you want to edit. In the
<guilabel>More</guilabel> drop-down list, click
<guilabel>Edit</guilabel>.</para>
<para>On the <guilabel>Project</guilabel> tab, click
<guilabel>Images &amp; Snapshots</guilabel>.</para>
</step>
<step>
<para>In the <guilabel>Update Image</guilabel> window, you can
change the name for the image. Select the
<guilabel>Public</guilabel> check box to make the image
public. Clear this check box to make the image
private.</para>
<para>Select the image that you want to edit.</para>
</step>
<step>
<para>In the <guilabel>Actions</guilabel> column, click
<guilabel>More</guilabel> and then select
<guilabel>Edit</guilabel> from the list.</para>
</step>
<step>
<para>In the Update Image dialog box, you can perform the
following actions: <itemizedlist>
<listitem>
<para>Change the name of the image.</para>
</listitem>
<listitem>
<para>Select the <guilabel>Public</guilabel> check box
to make the image public.</para>
</listitem>
<listitem>
<para>Clear the <guilabel>Public</guilabel> check box to
make the image private.</para>
</listitem>
</itemizedlist></para>
</step>
<step>
<para>Click <guibutton>Update Image</guibutton>.</para>
@ -151,18 +194,22 @@
</procedure>
</section>
<section xml:id="dashboard_delete_images">
<title>Delete images</title>
<title>Delete an image</title>
<para>Deletion of images is permanent and <emphasis role="bold"
>cannot</emphasis> be reversed. Only users with the
appropriate permissions can delete images.</para>
<procedure>
<step>
<para>Log in to the dashboard.</para>
<para>Choose the <guilabel>admin</guilabel> project from the
<guilabel>CURRENT PROJECT</guilabel> drop-down
list.</para>
</step>
<step>
<para>On the <guilabel>Project</guilabel> tab, click the
<guilabel>Images &amp; Snapshots</guilabel>
category.</para>
<para>From the <guilabel>CURRENT PROJECT</guilabel> on the
<guilabel>Project</guilabel> tab, select the appropriate
project.</para>
</step>
<step>
<para>On the <guilabel>Project</guilabel> tab, click
<guilabel>Images &amp; Snapshots</guilabel>.</para>
</step>
<step>
<para>Select the images that you want to delete.</para>
@ -171,9 +218,9 @@
<para>Click <guibutton>Delete Images</guibutton>.</para>
</step>
<step>
<para>In the <guilabel>Confirm Delete Image</guilabel> window,
click <guibutton>Delete Images</guibutton> to confirm the
deletion. You cannot undo this action.</para>
<para>In the Confirm Delete Image dialog box, click
<guibutton>Delete Images</guibutton> to confirm the
deletion.</para>
</step>
</procedure>
</section>

127
doc/user-guide/section_dashboard_manage_volumes.xml
View File

@ -24,12 +24,12 @@
<!-- <title>To create or delete a volume</title> -->
<step>
<para>Log in to the dashboard, choose a project, and
click the <guibutton>Volumes</guibutton>
category.</para>
click <guibutton>Volumes</guibutton>.</para>
</step>
<step>
<para>Click <guibutton>Create Volume</guibutton>.</para>
<para>In the window that opens, enter or select the following values.</para>
<para>In the dialog box that opens, enter or select
the following values.</para>
<informaltable rules="all" width="75%">
<col width="30%"/>
<col width="70%"/>
@ -41,7 +41,8 @@
</para>
</td>
<td>
<para>A name to identify the volume.</para>
<para>Specify a name for the
volume.</para>
</td>
</tr>
<tr>
@ -51,7 +52,8 @@
</para>
</td>
<td>
<para>A brief description for the volume.</para>
<para>Optionally, provide a brief
description for the volume.</para>
</td>
</tr>
<tr>
@ -71,7 +73,8 @@
</para>
</td>
<td>
<para>The size of the volume in GB.</para>
<para>The size of the volume in
gigabytes.</para>
</td>
</tr>
<tr>
@ -81,21 +84,20 @@
</para>
</td>
<td>
<para>Options are:</para>
<para>Select one of the following
options:</para>
<itemizedlist>
<listitem>
<para><guilabel>No source, empty volume</guilabel>
- Choose this option to create an empty volume.</para>
<note>
<para>An empty volume does not contain either a file
system or a partition table.</para>
</note>
<para><guilabel>No source, empty
volume</guilabel>: creates an empty
volume.</para><para>Note: An empty volume does not contain a file system or a
partition table.</para>
</listitem>
<listitem>
<para>
<guilabel>Image</guilabel> - Choose this option
to create a volume from an image. Select the image
from the dropdown list.</para>
<guilabel>Image</guilabel>: creates
a volume from an image. Select the
image from the list.</para>
</listitem>
</itemizedlist>
</td>
@ -104,69 +106,60 @@
</informaltable>
</step>
<step>
<para>Click the <guibutton>Create Volume</guibutton> button to
confirm your changes.</para>
</step>
<step>
<para>The dashboard shows the volume in the <guilabel>Volumes</guilabel>
category.</para>
<para>Click <guibutton>Create
Volume</guibutton>.</para>
</step>
</procedure>
<para>The dashboard shows the volume on the
<guilabel>Volumes</guilabel> tab.</para>
</section>
<section xml:id="attach_volumes_to_instances">
<title>Attach volumes to instances</title>
<title>Attach a volume to an instance</title>
<para>After you create one or more volumes, you can attach
them to instances.</para>
them to instances. You can attach a volume to one instance
at a time.</para>
<procedure>
<!--<title>To attach volumes to instances</title>-->
<step>
<para>Log in to the dashboard, choose a project, and
click the <guibutton>Volumes</guibutton>
category.</para>
click <guibutton>Volumes</guibutton>.</para>
</step>
<step>
<para>Select the volume to add to an instance and
click <guibutton>Edit Attachments</guibutton>.</para>
</step>
<step>
<para>In the <guilabel>Manage Volume
Attachments</guilabel> window, select an
<para>In the Manage Volume
Attachments dialog box, select an
instance.</para>
</step>
<step>
<para>Enter the name of the device from where the
volume should be accessible on the virtual
machine.</para>
<para>Enter the name of the device from which the
volume is accessible by the instance.</para>
<note>
<para>The actual device name might differ due to
hypervisor settings.</para>
<para>The actual device name might differ from the
volume name because of hypervisor
settings.</para>
</note>
</step>
<step>
<para>Click <guibutton>Attach Volume</guibutton> to
confirm your changes. The dashboard shows the
instance to which the volume is now attached and
the device name. You can attach a volume to one
instance at a time.</para>
</step>
<step>
<para>View the status of a volume in the
<guilabel>Volumes</guilabel> category of the dashboard.
The volume is either available or In-Use.</para>
</step>
<step>
<para>Now you can log in to the instance and mount,
format, and use the disk.</para>
<para>Click <guibutton>Attach Volume</guibutton>.</para>
<para>The dashboard shows the instance to which the
volume is now attached and the device name.</para>
</step>
</procedure>
<para>You can view the status of a volume in the
<guilabel>Volumes</guilabel> tab of the dashboard. The
volume is either Available or In-Use.</para>
<para>Now you can log in to the instance and mount,
format, and use the disk.</para>
</section>
<section xml:id="dashboard_detach_volume">
<title>Detach a volume from an instance</title>
<procedure>
<step>
<para>Log in to the dashboard, choose a project, and
click the <guibutton>Volumes</guibutton>
category.</para>
click <guibutton>Volumes</guibutton>.</para>
</step>
<step>
<para>Select the volume and click <guibutton>Edit
@ -176,58 +169,52 @@
<para>Click <guibutton>Detach Volume</guibutton> and
confirm your changes.</para>
</step>
<step>
</procedure>
<para>A message indicates whether the action was
successful.</para>
</step>
</procedure>
</section>
<section xml:id="create_volume_snapsnots">
<title>Create volume snapshots</title>
<title>Create a snapshot from a volume</title>
<procedure>
<step>
<para>Log in to the dashboard, choose a project, and
click the <guilabel>Volumes</guilabel> category.</para>
click <guilabel>Volumes</guilabel>.</para>
</step>
<step>
<para>Select a volume from which to create a snapshot.</para>
</step>
<step>
<para>From the <guilabel>More</guilabel> drop-down
list, select <guilabel>Create Snapshot</guilabel>.</para>
<para>From the <guilabel>More</guilabel> list, select
<guilabel>Create Snapshot</guilabel>.</para>
</step>
<step>
<para>In the window that opens, enter a snapshot name
and a brief description.</para>
<para>In the dialog box that opens, enter a snapshot
name and a brief description.</para>
</step>
<step>
<para>Confirm your changes.</para>
<para>The dashboard shows the new volume snapshot in
the <guilabel>Images &amp; Snapshots</guilabel>
category.</para>
<guilabel>Images &amp;
Snapshots</guilabel>.</para>
</step>
</procedure>
</section>
<section xml:id="dashboard_delete_volume">
<title>Delete volumes</title>
<para>When you delete an instance, the data of its attached
<title>Delete a volume</title>
<para>When you delete an instance, the data in its attached
volumes is not destroyed.</para>
<procedure>
<step>
<para>Log in to the dashboard, choose a project, and
click the <guibutton>Volumes</guibutton>
category.</para>
click <guibutton>Volumes</guibutton>.</para>
</step>
<step>
<para>Activate the check boxes in front of the volumes
that you want to delete.</para>
<para>Select the check boxes for the volumes that you
want to delete.</para>
</step>
<step>
<para>Click <guibutton>Delete Volumes</guibutton> and
confirm your choice in the pop-up that
appears.</para>
</step>
<step>
confirm your choice.</para>
<para>A message indicates whether the action was
successful.</para>
</step>

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

@ -11,19 +11,21 @@
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>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
allow creation of most OpenStack resource types such as
instances, floating IPs, volumes, security groups, and
users.</para>
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"
@ -36,8 +38,8 @@
<step>
<para>Log in to the dashboard, choose a project, and
click <guibutton>Stacks</guibutton> in the
<guilabel>Orchestration</guilabel>
category.</para>
<guilabel>Orchestration</guilabel> category on
the <guilabel>Projects</guilabel> tab.</para>
</step>
<step>
<para>Click <guibutton>Launch
@ -45,20 +47,16 @@
<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>
<para>In the Select Template dialog box, choose the
source of the template from the list.</para>
</step>
<step>
<para>Enter the URL, browse to the file location, or
directly include the template based on your
previous selection.</para>
<para>Depending on the source that you selected, enter
the URL, browse to the file location, or directly
include the template.</para>
</step>
<step>
<para>In the <guilabel>Launch Stack</guilabel> window,
<para>In the Launch Stack dialog box,
specify the following values.</para>
<informaltable rules="all" width="75%">
<col width="30%"/>
@ -67,58 +65,56 @@
<tr>
<td><para><guilabel>Stack
Name</guilabel></para></td>
<td><para>A name to identify the
stack.</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>Creation Timeout in
minutes.</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>Check this option if you want
Heat to rollback on
failure.</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>Password for the user logged
in.</para></td>
<td><para>Specify the password that the default user will use when the
stack is created.</para></td>
</tr>
<tr>
<td><para><guilabel>DBUsername</guilabel></para></td>
<td><para>Database user name.</para></td>
<td><para>Specify the name of the database user.</para></td>
</tr>
<tr>
<td><para><guilabel>LinuxDistribution</guilabel></para></td>
<td><para>Linux Distribution used in the
stacks.</para></td>
<td><para>Specify the Linux distribution that will be used in the
stack.</para></td>
</tr>
<tr>
<td><para><guilabel>DBRootPassword</guilabel></para></td>
<td><para>Database root
password.</para></td>
<td><para>Specify the root password for the database.</para></td>
</tr>
<tr>
<td><para><guilabel>KeyName</guilabel></para></td>
<td><para>Name of the keypair.</para></td>
<td><para>Specify the name of the key pair that will be used to log into
the stack.</para></td>
</tr>
<tr>
<td><para><guilabel>DBName</guilabel></para></td>
<td><para>Database name.</para></td>
<td><para>Specify the name of the database.</para></td>
</tr>
<tr>
<td><para><guilabel>DBPassword</guilabel></para></td>
<td><para>Database password.</para></td>
<td><para>Specify the password for the database.</para></td>
</tr>
<tr>
<td><para><guilabel>InstanceType</guilabel></para></td>
<td><para>Flavor of the
instance.</para></td>
<td><para>Specify the flavor for the instance.</para></td>
</tr>
</tbody>
</informaltable>
@ -128,30 +124,24 @@
stack.</para>
</step>
<step>
<para>The dashboard shows the stack in the
<guilabel>Stacks</guilabel> category.</para>
<para>The dashboard shows the stack on the
<guilabel>Stacks</guilabel> tab.</para>
</step>
</procedure>
<para>After the stack is created, click on the stack name to
see these details:</para>
see the following details:</para>
<variablelist>
<varlistentry>
<term><guilabel>Topology</guilabel></term>
<listitem>
<para>The topology of the stack created.</para>
<para>The topology of the stack.</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>
<para>The parameters and details of the
stack.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -169,14 +159,13 @@
</variablelist>
</section>
<section xml:id="dashboard_delete_stacks">
<title>Delete stacks</title>
<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.</para>
</step>
<step>
<para>On the <guilabel>Project</guilabel> tab, click
the <guilabel>Stacks</guilabel> category.</para>
<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>
@ -186,10 +175,9 @@
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>
<para>In the confirmation dialog box, click
<guibutton>Delete Stack</guibutton> to confirm
the deletion.</para>
</step>
</procedure>
</section>