openstack/openstack-manuals
Code Issues Proposed changes

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

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

41
doc/common/section_conventions.xml
View File

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

153
doc/common/section_dashboard_access.xml
View File

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

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

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

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

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

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

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

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

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

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

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

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

@ -11,29 +11,45 @@
xml:id="dashboard_launch_instances_from_image"> xml:id="dashboard_launch_instances_from_image">
<title>Launch an instance</title> <title>Launch an instance</title>
<?dbhtml stop-chunking?> <?dbhtml stop-chunking?>
<para>When you launch an instance from an image, OpenStack creates <para>When you launch an instance from an image, OpenStack creates a local
a local copy of the image on the compute node where the copy of the image on the compute node where the instance starts.</para>
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> <procedure>
<step> <step>
<para>Log in to the dashboard, choose a project, <para>Log in to the dashboard, choose a project, and click
and click the <guilabel>Images &amp; <guilabel>Images &amp; Snapshot</guilabel>.</para>
Snapshot</guilabel> category.</para> <para>The dashboard shows the images that have been uploaded to
<para>The dashboard shows the images that have been OpenStack Image Service and are available for this
uploaded to OpenStack Image Service and are available project.</para>
for this project.</para>
<para>For details on creating images, see <link <para>For details on creating images, see <link
xlink:href="http://docs.openstack.org/image-guide/content/ch_creating_images_manually.html"> xlink:href="http://docs.openstack.org/image-guide/content/ch_creating_images_manually.html"
Creating images manually</link> in the <citetitle>OpenStack Virtual >Creating images manually</link> in the <citetitle>OpenStack
Machine Image Guide</citetitle>.</para> Virtual Machine Image Guide</citetitle>.</para>
</step> </step>
<step> <step>
<para>Select an image and click <para>Select an image and click
<guibutton>Launch</guibutton>.</para> <guibutton>Launch</guibutton>.</para>
</step> </step>
<step> <step>
<para>In the <guilabel>Launch Instance</guilabel> window, <para>In the Launch Instance dialog box, specify the following
specify the following values:</para> values:</para>
<informaltable rules="all" width="75%"> <informaltable rules="all" width="75%">
<col width="30%"/> <col width="30%"/>
<col width="70%"/> <col width="70%"/>
@ -45,42 +61,44 @@
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td><para><guilabel>Availability Zone</guilabel></para></td> <td><para><guilabel>Availability
Zone</guilabel></para></td>
<td> <td>
<para>By default, this value is set to the availability <para>By default, this value is set to the
zone given by the cloud provider (for example, availability zone given by the cloud provider
<literal>us-west</literal> or <literal>apac-south</literal>). (for example, <literal>us-west</literal> or
Though, it could be <literal>nova</literal> for most cases. <literal>apac-south</literal>). For most
</para> cases, it could be
<literal>nova</literal>.</para>
</td> </td>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>Instance Name</guilabel></para></td> <td><para><guilabel>Instance Name</guilabel></para></td>
<td><para>The name to assign to the virtual machine. <td><para>Assign a name to the virtual machine.</para>
</para>
<note> <note>
<para>The name you assign here becomes the initial host <para>The name you assign here becomes the
name of the server. After the server is built, if you initial host name of the server. After the
change the server name in the API or change the host server is built, if you change the server
name directly, the names are not updated in the dashboard.</para> name in the API or change the host name
<para>Server names are not guaranteed to be unique when directly, the names are not updated in the
created so you could have two instances with the same dashboard.</para>
host name.</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> </note>
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td>
<para><guilabel>Flavor</guilabel></para></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> launch.</para></td>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>Instance <td><para><guilabel>Instance
Count</guilabel></para></td> Count</guilabel></para></td>
<td><para>To launch multiple instances, enter <td><para>To launch multiple instances, enter a value
a value greater than 1. Default is 1. greater than 1. The default is 1.</para></td>
</para></td>
</tr> </tr>
<tr> <tr>
<td> <td>
@ -92,51 +110,56 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<guilabel>Boot from image</guilabel> - If you choose <guilabel>Boot from
this option, a new field for <guilabel>Image Name</guilabel> image</guilabel>&mdash;If you choose
displays. You can select the image from the this option, a new field for
dropdown list. <guilabel>Image Name</guilabel>
</para> displays. You can select the image from
the list.</para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<guilabel>Boot from snapshot</guilabel> - If you <guilabel>Boot from
choose this option, a new field for <guilabel>Instance Snapshot</guilabel> snapshot</guilabel>&mdash;If you choose
displays. You can select the snapshot from this option, a new field for
the dropdown list. <guilabel>Instance Snapshot</guilabel>
</para> displays. You can select the snapshot
from the list.</para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<guilabel>Boot from volume</guilabel> - If you <guilabel>Boot from
choose this option, a new field for <guilabel>Volume</guilabel> volume</guilabel>&mdash;If you choose
displays. You can select the volume from the this option, a new field for
dropdown list. <guilabel>Volume</guilabel> displays.
</para> You can select the volume from the
list.</para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<guilabel>Boot from image (creates a new volume) <guilabel>Boot from image (creates a new
</guilabel> - With this option, you can boot from volume) </guilabel>&mdash;With this
an image and create a volume by entering the <guilabel>Device Size</guilabel> option, you can boot from an image and
and <guilabel>Device Name</guilabel> for your create a volume by entering the
volume. <guilabel>Device Size</guilabel> and
</para> <guilabel>Device Name</guilabel> for
your volume.</para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<guilabel>Boot from volume snapshot (creates a new <guilabel>Boot from volume snapshot
volume)</guilabel> - Using this option, you can (creates a new volume)</guilabel>&mdash;
boot from a volume snapshot and create a new Using this option, you can boot from a
volume by choosing <guilabel>Volume Snapshot</guilabel> volume snapshot and create a new volume
from a dropdown list and adding a <guilabel>Device Name</guilabel> by choosing <guilabel>Volume
for your volume. Snapshot</guilabel> from a list and
</para> adding a <guilabel>Device
Name</guilabel> for your volume.</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<para>Since you are launching an instance from an image, <para>Since you are launching an instance from an
<guilabel>Boot from image</guilabel> is chosen by image, <guilabel>Boot from image</guilabel> is
default.</para> chosen by default.</para>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -146,84 +169,74 @@
</para> </para>
</td> </td>
<td> <td>
<para>This field changes based on your previous selection. <para>This field changes based on your previous
Since you have chosen to launch an instance using an image, selection. Since you have chosen to launch an
the <guilabel>Image Name</guilabel> field displays. instance using an image, the <guilabel>Image
Select the image name from the dropdown list.</para> Name</guilabel> field displays. Select the
image name from the dropdown list.</para>
</td> </td>
</tr> </tr>
<tr> <tr>
<th colspan="2" align="center" <th colspan="2" align="center"><guilabel>Access &amp;
><guilabel>Access &amp;
Security</guilabel> tab</th> Security</guilabel> tab</th>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>Keypair</guilabel></para></td> <td><para><guilabel>Keypair</guilabel></para></td>
<td><para>Select a keypair from the dropdown list.</para> <td><para>Specify a key pair.</para>
<para>In case an image uses a static root <para>If the image uses a static root password or a
password or a static key set (neither static key set (neither is recommended), you do
is recommended), you do not need to not need to provide a key pair to launch the
provide a keypair to launch the
instance.</para></td> instance.</para></td>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>Security <td><para><guilabel>Security
Groups</guilabel></para></td> Groups</guilabel></para></td>
<td><para>Activate the security groups that <td><para>Activate the security groups that you want to
you want to assign to the assign to the instance.</para>
instance.</para> <para>Security groups are a kind of cloud firewall
<para>Security groups are a kind of cloud that define which incoming network traffic is
firewall that define which incoming forwarded to instances. For details, see <xref
network traffic is forwarded to linkend="security_groups_add_rule"/>.</para>
instances. For details, see <xref <para>If you have not created any security groups,
linkend="security_groups_add_rule" you can assign only the default security group
/>.</para> to the instance.</para></td>
<para>If you have not created any security
groups, you can assign only the
default security group to the
instance.</para></td>
</tr> </tr>
<tr> <tr>
<th colspan="2" align="center" <th colspan="2" align="center"
><guilabel>Networking</guilabel> ><guilabel>Networking</guilabel> tab</th>
tab</th>
</tr> </tr>
<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 <td><para>To add a network to the instance, click the
<guibutton>+</guibutton> in the <guilabel>Available <guibutton>+</guibutton> in the
Networks</guilabel> field.</para></td> <guilabel>Available Networks</guilabel>
field.</para></td>
</tr> </tr>
<tr> <tr>
<th colspan="2" align="center" <th colspan="2" align="center"
><guilabel>Post-Creation</guilabel> ><guilabel>Post-Creation</guilabel> tab</th>
tab</th>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>Customization <td><para><guilabel>Customization
Script</guilabel></para></td> Script</guilabel></para></td>
<td><para>A customization script that runs after your <td><para>Specify a customization script that runs after
instance launches.</para></td> your instance launches.</para></td>
</tr> </tr>
</tbody> </tbody>
</informaltable> </informaltable>
</step> </step>
<step> <step>
<para>Click <guibutton>Launch</guibutton>. The instance <para>Click <guibutton>Launch</guibutton>.</para>
starts on a compute node in the cloud.</para> <para>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>
</step> </step>
</procedure> </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> </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"> xml:id="dashboard_manage_containers">
<title>Create and manage object containers</title> <title>Create and manage object containers</title>
<?dbhtml stop-chunking?> <?dbhtml stop-chunking?>
<para>Container service is one of the services provided by the Object Storage Service.</para> <para>OpenStack Object Storage provides a distributed,
<para>A container is a storage compartment for your data and provides a API-accessible storage platform that can be integrated directly
way for you to organize your data. It is similar to the concept as a into an application or used to store any type of file, including
Linux file directory but cannot be nested.</para> 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"> <section xml:id="create_container">
<title>Create a container</title> <title>Create a container</title>
<procedure> <procedure>
<step> <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>
<step> <step>
<para>On the <guilabel>Project</guilabel> tab, click the <para>Click <guibutton>Create Container</guibutton>.</para>
<guilabel>Containers</guilabel> category.</para>
</step> </step>
<step> <step>
<para>Click the <guibutton>Create Container</guibutton> button. The <para>In the Create Container dialog box, enter a name for
<guilabel>Create Container</guilabel> window is displayed.</para> the container, and then click<guibutton>Create
</step> Container</guibutton>.</para>
<step>
<para>Enter a name for the container. Click the <guibutton>Create Container</guibutton>
button.</para>
</step> </step>
</procedure> </procedure>
<para>You have successfully created a container.</para> <para>You have successfully created a container.</para>
<note><para>To delete a container, click the <guibutton>More</guibutton> <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> </note>
</section> </section>
<section xml:id="upload_object"> <section xml:id="upload_object">
<title>Upload an object</title> <title>Upload an object</title>
<procedure> <procedure>
<step> <step>
<para>Log in to the dashboard.</para> <para>Log in to the dashboard, choose a projecet, and click
</step> <guilabel>Containers</guilabel>.</para>
<step>
<para>On the <guilabel>Project</guilabel> tab, click the
<guilabel>Containers</guilabel> category.</para>
</step> </step>
<step> <step>
<para>Select the container in which you want to store your object.</para> <para>Select the container in which you want to store your object.</para>
</step> </step>
<step> <step>
<para>Click the <guibutton>Upload Object</guibutton> button. The <para>Click <guibutton>Upload Object</guibutton>.</para>
<guilabel>Upload Object To Container: <replaceable>CONTAINER_NAME <para>The Upload Object To Container:
</replaceable></guilabel> window is displayed.</para> <replaceable>&lt;name></replaceable> dialog box is
<para><replaceable>CONTAINER_NAME</replaceable> is replaced by the displayed. <replaceable>&lt;name></replaceable> is the name
name of the container to which you are uploading the object.</para> of the container to which you are uploading the
object.</para>
</step> </step>
<step> <step>
<para>Enter a name for the object.</para> <para>Enter a name for the object.</para>
</step> </step>
<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>
<step> <step>
<para>Click the <guibutton>Upload Object</guibutton> button.</para> <para>Click <guibutton>Upload Object</guibutton>.</para>
</step> </step>
</procedure> </procedure>
<para>You have successfully uploaded an object to the container.</para> <para>You have successfully uploaded an object to the container.</para>
<note><para>To delete an object, click the <guibutton>More</guibutton> <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> </note>
</section> </section>
</section> </section>

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

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

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

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

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

@ -11,19 +11,21 @@
xml:id="dashboard_stacks"> xml:id="dashboard_stacks">
<title>Launch and manage stacks</title> <title>Launch and manage stacks</title>
<para>Use the Orchestration service to orchestrate multiple <para>OpenStack Orchestration is a service that you can use to
composite cloud applications. This service supports use of both orchestrate multiple composite cloud applications. This
the AWS CloudFormation template format through a Query API and service supports use of both the Amazon Web Services (AWS)
the OpenStack-native CloudFormation template format through both a Query API that
<glossterm>Heat Orchestration Template (HOT)</glossterm> format is compatible with CloudFormation and the native OpenStack
through a REST API.</para> <glossterm>Heat Orchestration Template (HOT)</glossterm>
format through a REST API.</para>
<para>These flexible template languages enable application <para>These flexible template languages enable application
developers to describe and automate the deployment of developers to describe and automate the deployment of
infrastructure, services, and applications. The templates infrastructure, services, and applications. The templates
allow creation of most OpenStack resource types such as enable creation of most OpenStack resource types, such as
instances, floating IPs, volumes, security groups, and instances, floating IP addresses, volumes, security groups,
users.</para> and users. The resources, once created, are referred to as
stacks.</para>
<para>The template languages are described in <para>The template languages are described in
<link <link
xlink:href="http://docs.openstack.org/developer/heat/template_guide/index.html" xlink:href="http://docs.openstack.org/developer/heat/template_guide/index.html"
@ -36,8 +38,8 @@
<step> <step>
<para>Log in to the dashboard, choose a project, and <para>Log in to the dashboard, choose a project, and
click <guibutton>Stacks</guibutton> in the click <guibutton>Stacks</guibutton> in the
<guilabel>Orchestration</guilabel> <guilabel>Orchestration</guilabel> category on
category.</para> the <guilabel>Projects</guilabel> tab.</para>
</step> </step>
<step> <step>
<para>Click <guibutton>Launch <para>Click <guibutton>Launch
@ -45,20 +47,16 @@
<para/> <para/>
</step> </step>
<step> <step>
<para>In the <guilabel>Select Template</guilabel> <para>In the Select Template dialog box, choose the
window, choose a template source option, source of the template from the list.</para>
<guilabel>URL</guilabel>,
<guilabel>File</guilabel>, or <guilabel>Direct
Input</guilabel>, from the drop-down
list.</para>
</step> </step>
<step> <step>
<para>Enter the URL, browse to the file location, or <para>Depending on the source that you selected, enter
directly include the template based on your the URL, browse to the file location, or directly
previous selection.</para> include the template.</para>
</step> </step>
<step> <step>
<para>In the <guilabel>Launch Stack</guilabel> window, <para>In the Launch Stack dialog box,
specify the following values.</para> specify the following values.</para>
<informaltable rules="all" width="75%"> <informaltable rules="all" width="75%">
<col width="30%"/> <col width="30%"/>
@ -67,58 +65,56 @@
<tr> <tr>
<td><para><guilabel>Stack <td><para><guilabel>Stack
Name</guilabel></para></td> Name</guilabel></para></td>
<td><para>A name to identify the <td><para>Enter a name to identify the stack.</para></td>
stack.</para></td>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>Creation Timeout <td><para><guilabel>Creation Timeout
(minutes)</guilabel></para></td> (minutes)</guilabel></para></td>
<td><para>Creation Timeout in <td><para>Specify the number of minutes that can elapse before the launch
minutes.</para></td> of the stack times out.</para></td>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>Rollback On <td><para><guilabel>Rollback On
Failure</guilabel></para></td> Failure</guilabel></para></td>
<td><para>Check this option if you want <td><para>Select this check box if you want if you want the service to
Heat to rollback on roll back changes if the stack
failure.</para></td> fails to launch.</para></td>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>Password for user <td><para><guilabel>Password for user
"demo"</guilabel></para></td> "demo"</guilabel></para></td>
<td><para>Password for the user logged <td><para>Specify the password that the default user will use when the
in.</para></td> stack is created.</para></td>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>DBUsername</guilabel></para></td> <td><para><guilabel>DBUsername</guilabel></para></td>
<td><para>Database user name.</para></td> <td><para>Specify the name of the database user.</para></td>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>LinuxDistribution</guilabel></para></td> <td><para><guilabel>LinuxDistribution</guilabel></para></td>
<td><para>Linux Distribution used in the <td><para>Specify the Linux distribution that will be used in the
stacks.</para></td> stack.</para></td>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>DBRootPassword</guilabel></para></td> <td><para><guilabel>DBRootPassword</guilabel></para></td>
<td><para>Database root <td><para>Specify the root password for the database.</para></td>
password.</para></td>
</tr> </tr>
<tr> <tr>
<td><para><guilabel>KeyName</guilabel></para></td> <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>
<tr> <tr>
<td><para><guilabel>DBName</guilabel></para></td> <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>
<tr> <tr>
<td><para><guilabel>DBPassword</guilabel></para></td> <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>
<tr> <tr>
<td><para><guilabel>InstanceType</guilabel></para></td> <td><para><guilabel>InstanceType</guilabel></para></td>
<td><para>Flavor of the <td><para>Specify the flavor for the instance.</para></td>
instance.</para></td>
</tr> </tr>
</tbody> </tbody>
</informaltable> </informaltable>
@ -128,30 +124,24 @@
stack.</para> stack.</para>
</step> </step>
<step> <step>
<para>The dashboard shows the stack in the <para>The dashboard shows the stack on the
<guilabel>Stacks</guilabel> category.</para> <guilabel>Stacks</guilabel> tab.</para>
</step> </step>
</procedure> </procedure>
<para>After the stack is created, click on the stack name to <para>After the stack is created, click on the stack name to
see these details:</para> see the following details:</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><guilabel>Topology</guilabel></term> <term><guilabel>Topology</guilabel></term>
<listitem> <listitem>
<para>The topology of the stack created.</para> <para>The topology of the stack.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><guilabel>Overview</guilabel></term> <term><guilabel>Overview</guilabel></term>
<listitem> <listitem>
<para>The parameters and details of the stack <para>The parameters and details of the
under the following headings: stack.</para>
<guilabel>Info</guilabel>,
<guilabel>Status</guilabel>,
<guilabel>Outputs</guilabel>,
<guilabel>Stack Parameters</guilabel>, and
<guilabel>Launch
Parameters</guilabel>.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -169,14 +159,13 @@
</variablelist> </variablelist>
</section> </section>
<section xml:id="dashboard_delete_stacks"> <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> <procedure>
<step> <step>
<para>Log in to the dashboard.</para> <para>Log in to the dashboard, choose a project, and
</step> click <guilabel>Stacks</guilabel>.</para>
<step>
<para>On the <guilabel>Project</guilabel> tab, click
the <guilabel>Stacks</guilabel> category.</para>
</step> </step>
<step> <step>
<para>Select the stack that you want to delete.</para> <para>Select the stack that you want to delete.</para>
@ -186,10 +175,9 @@
Stack</guibutton>.</para> Stack</guibutton>.</para>
</step> </step>
<step> <step>
<para>In the <guilabel>Confirm Delete Stack</guilabel> <para>In the confirmation dialog box, click
window, click <guibutton>Delete Stack</guibutton> <guibutton>Delete Stack</guibutton> to confirm
to confirm the deletion. You cannot undo this the deletion.</para>
action.</para>
</step> </step>
</procedure> </procedure>
</section> </section>