openstack-manuals/doc/common/section_dashboard_access.xml
Karin Levenstein fca88670a4 Edits to the End User Guide dashboard chapter with corrections from Anne G
Change-Id: Ia9961bbdab446e15930d0b31176c37fe1d532b8f
2014-04-14 10:16:06 -05:00

392 lines
17 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section [
<!-- Some useful entities borrowed from HTML -->
<!ENTITY ndash "&#x2013;">
<!ENTITY mdash "&#x2014;">
<!ENTITY hellip "&#x2026;">
]>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:raxm="http://docs.rackspace.com/api/metadata" version="5.0"
xml:id="log_in_dashboard">
<?dbhtml stop-chunking?>
<title>Log in to the dashboard</title>
<para>The dashboard is available on the node with the
<literal>nova-dashboard</literal> server role.</para>
<procedure>
<step>
<para>Ask the cloud operator for the host name or public
IP address from which you can access the dashboard,
and for your user name and password.</para>
</step>
<step>
<para>Open a web browser that has JavaScript and cookies
enabled.</para>
<note>
<para>To use the Virtual Network Computing (VNC)
client for the dashboard, your browser must
support HTML5 Canvas and HTML5 WebSockets. The VNC
client is based on noVNC. For details, see <link
xlink:href="https://github.com/kanaka/noVNC/blob/master/README.md"
>noVNC: HTML5 VNC Client</link>. For a list of
supported browsers, see <link
xlink:href="https://github.com/kanaka/noVNC/wiki/Browser-support"
xlink:show="embed">Browser
support</link>.</para>
</note>
</step>
<step>
<para>In the address bar, enter the host name or IP
address for the dashboard.</para>
<screen><userinput>https://<replaceable>ipAddressOrHostName</replaceable>/</userinput></screen>
<note>
<para>If a certificate warning appears when you try to
access the URL for the first time, a self-signed
certificate is in use, which is not considered
trustworthy by default. Verify the certificate or
add an exception in the browser to bypass the
warning.</para>
</note>
</step>
<step>
<para>On the <guilabel>Log In</guilabel> page, enter your
user name and password, and click <guibutton>Sign
In</guibutton>.</para>
<para>The top of the window displays your user name. You
can also access <guilabel>Settings</guilabel> or sign
out of the dashboard.</para>
<para>The visible tabs and functions in the dashboard
depend on the access permissions, or <emphasis
role="italic">roles</emphasis>, of the user you
are logged in as.<itemizedlist>
<listitem><para>If you are logged in as an end user, the <link
linkend="dashboard_project_tab"
>Project</link> tab is
displayed.</para></listitem>
<listitem><para>If you are logged in as an administrator, the <link
linkend="dashboard_project_tab"
>Project</link> tab and <link
linkend="dashboard_admin_tab"
>Admin</link> tab are
displayed.</para></listitem>
</itemizedlist></para>
</step>
</procedure>
<section xml:id="dashboard_project_tab">
<title>OpenStack dashboard&mdash;Project tab</title>
<para>Projects are organizational units in the cloud, and are
also known as tenants or accounts. Each user is a member
of one or more projects. Within a project, a user creates
and manages instances.</para>
<para>From the <guilabel>Project</guilabel> tab, you can view and manage
the resources in a selected project, including instances and images.
You select the project from the <guilabel>CURRENT PROJECT</guilabel>
list at the top of the tab.</para>
<figure xml:id="dashboard_project_user">
<title>Project tab</title>
<mediaobject>
<imageobject>
<imagedata fileref="figures/dashboard-project-tab.png"
format="PNG" contentwidth="6in" width="6in"/>
</imageobject>
</mediaobject>
</figure>
<para>From the <guilabel>Project</guilabel> tab, you can
access the following tabs:</para>
<para><guilabel>Manage Compute</guilabel> tabs</para>
<variablelist>
<varlistentry>
<term><guilabel>Overview</guilabel></term>
<listitem>
<para>View reports for the project.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Instances</guilabel></term>
<listitem>
<para>View, launch, create a snapshot from, stop,
pause, or reboot instances, or connect to them
through VNC.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Volumes</guilabel></term>
<listitem>
<para>View, create, edit, and delete
volumes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Images &amp;
Snapshots</guilabel></term>
<listitem>
<para>View images, instance snapshots, and volume
snapshots created by project users, plus any
images that are publicly available. Create,
edit, and delete images, and launch instances
from images and snapshots.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Access &amp;
Security</guilabel></term>
<listitem>
<para>Use the following tabs to complete these
tasks:</para>
<formalpara>
<title><guilabel>Security
Groups</guilabel></title>
<para>View, create, edit, and delete security
groups and security group rules.</para>
</formalpara>
<formalpara>
<title><guilabel>Keypairs</guilabel></title>
<para>View, create, edit, import, and delete
key pairs.</para>
</formalpara>
<formalpara>
<title><guilabel>Floating
IPs</guilabel></title>
<para>Allocate an IP address to or release it
from a project.</para>
</formalpara>
<formalpara>
<title><guilabel>API Access</guilabel></title>
<para>View API endpoints.</para>
</formalpara>
</listitem>
</varlistentry>
</variablelist>
<para><guilabel>Manage Network</guilabel> tabs</para>
<variablelist>
<varlistentry>
<term><guilabel>Networks</guilabel></term>
<listitem>
<para>Create and manage public and private networks.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Routers</guilabel></term>
<listitem>
<para>Create and manage subnets.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Network Topology</guilabel></term>
<listitem>
<para>View the network topology.</para>
</listitem>
</varlistentry>
</variablelist>
<para><guilabel>Object Store</guilabel> tab</para>
<variablelist>
<varlistentry>
<term><guilabel>Containers</guilabel></term>
<listitem>
<para>Create and manage object storage.</para>
</listitem>
</varlistentry>
</variablelist>
<para><guilabel>Orchestration</guilabel> tab</para>
<variablelist>
<varlistentry>
<term><guilabel>Stacks</guilabel></term>
<listitem>
<para>Use the REST API to orchestrate multiple
composite cloud applications.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="dashboard_admin_tab">
<title>OpenStack dashboard&mdash;Admin tab</title>
<para>Administrative users can use the
<guilabel>Admin</guilabel> tab to view usage and to
manage instances, volumes, flavors, images, projects,
users, services, and quotas.</para>
<figure xml:id="dashboard_admin_project_tab">
<title>Admin tab</title>
<mediaobject>
<imageobject>
<imagedata
fileref="figures/dashboard-admin-tab.png"
format="PNG" contentwidth="6in" width="6in"/>
</imageobject>
</mediaobject>
</figure>
<para>Access the following categories to complete these tasks:</para>
<variablelist>
<varlistentry>
<term><guilabel>Overview</guilabel></term>
<listitem>
<para>View basic reports.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Resource Usage</guilabel></term>
<listitem>
<para>Use the following tabs to view the following usages:</para>
<formalpara>
<title><guilabel>Global Disk
Usage</guilabel></title>
<para>View the disk usage for all tenants as
an average over the last 30 days.</para>
</formalpara>
<formalpara>
<title><guilabel>Global Network Traffic
Usage</guilabel></title>
<para>View the network usage for all tenants
as an average over the last 30
days.</para>
</formalpara>
<formalpara>
<title><guilabel>Global Object Storage
Usage</guilabel></title>
<para>View the object storage usage for all
tenants as an average over the last 30
days.</para>
</formalpara>
<formalpara>
<title><guilabel>Global Network
Usage</guilabel></title>
<para>View the network usage for all tenants
as an average over the last 30
days.</para>
</formalpara>
<formalpara>
<title><guilabel>Stats</guilabel></title>
<para>View the statistics of all resources.</para>
</formalpara>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Hypervisors</guilabel></term>
<listitem>
<para>View the hypervisor summary.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Instances</guilabel></term>
<listitem>
<para>View, pause, resume, suspend, migrate, soft
or hard reboot, and delete running instances
that belong to users of some, but not all,
projects. Also, view the log for an instance
or access an instance through VNC.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Volumes</guilabel></term>
<listitem>
<para>View, create, edit, and delete volumes and
volume types.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Flavors</guilabel></term>
<listitem>
<para>View, create, edit, view extra
specifications for, and delete flavors. A
flavor is size of an instance.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Images</guilabel></term>
<listitem>
<para>View, create, edit properties for, and
delete custom images.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Networks</guilabel></term>
<listitem>
<para>View, create, edit properties for, and
delete networks.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Routers</guilabel></term>
<listitem>
<para>View, create, edit properties for, and
delete routers.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Defaults</guilabel></term>
<listitem>
<para>View default quota values. Quotas are
hard-coded in OpenStack Compute and define
the maximum allowable size and number of
resources.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>System Info</guilabel></term>
<listitem>
<para>Use the following tabs to view the service
information:</para>
<formalpara>
<title><guilabel>Services</guilabel></title>
<para>View a list of the services.</para>
</formalpara>
<formalpara>
<title><guilabel>Compute
Services</guilabel></title>
<para>View a list of all Compute services.</para>
</formalpara>
<formalpara>
<title><guilabel>Availability
Zones</guilabel></title>
<para>View the availability zones.</para>
</formalpara>
<formalpara>
<title><guilabel>Host
Aggregates</guilabel></title>
<para>View host aggregates.</para>
</formalpara>
<formalpara>
<title><guilabel>Network
Agents</guilabel></title>
<para>View the network agents.</para>
</formalpara>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Domains</guilabel></term>
<listitem>
<para>View domains.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Projects</guilabel></term>
<listitem>
<para>View, create, assign users to, remove users
from, and delete projects.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Users</guilabel></term>
<listitem>
<para>View, create, enable, disable, and delete
users.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Groups</guilabel></term>
<listitem>
<para>View, create, enable, disable, and delete
groups.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Roles</guilabel></term>
<listitem>
<para>View, create, enable, disable, and delete
roles.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>