openstack-manuals/doc/common/section_dashboard_access.xml
Diane Fleming 64b6c9261e Folder rename, file rename, flattening of directories
Current folder name	New folder name	        Book title
----------------------------------------------------------
basic-install 	        DELETE
cli-guide	        DELETE
common	                common
NEW	                admin-guide-cloud	Cloud Administrators Guide
docbkx-example	        DELETE
openstack-block-storage-admin 	DELETE
openstack-compute-admin 	DELETE
openstack-config 	config-reference	OpenStack Configuration Reference
openstack-ha 	        high-availability-guide	OpenStack High Availabilty Guide
openstack-image	        image-guide	OpenStack Virtual Machine Image Guide
openstack-install 	install-guide	OpenStack Installation Guide
openstack-network-connectivity-admin 	admin-guide-network 	OpenStack Networking Administration Guide
openstack-object-storage-admin 	DELETE
openstack-security 	security-guide	OpenStack Security Guide
openstack-training 	training-guide	OpenStack Training Guide
openstack-user 	        user-guide	OpenStack End User Guide
openstack-user-admin 	user-guide-admin	OpenStack Admin User Guide
glossary	        NEW        	OpenStack Glossary

bug: #1220407

Change-Id: Id5ffc774b966ba7b9a591743a877aa10ab3094c7
author: diane fleming
2013-09-08 15:15:50 -07:00

246 lines
11 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 your user name and password.</para>
</step>
<step>
<para>Open a Web browser. Make sure that JavaScript and
cookies are 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, type the host name or IP address
for the dashboard:</para>
<screen><userinput>https://<replaceable>IP_ADDRESS_OR_HOSTNAME</replaceable>/</userinput></screen>
<note>
<title>Certificate Warning</title>
<para>If a certificate warning appears when you try to
access the URL for the first time, a self-signed
certificate is in use, which is not considered
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-level row shows your user name. You can also
access <guilabel>Settings</guilabel> or sign out of
the dashboard.</para>
<para>The visible tabs and functions in the dashboard
depend on the access permissions, or <emphasis
role="italic">roles</emphasis>, of the user you
are logged in as.</para>
<para>If you are logged in as an end user, the main screen
shows the <link linkend="dashboard_project_tab"
>Project</link> tab.</para>
<para>If you are logged in as an administrator, the main
screen shows the <link linkend="dashboard_project_tab"
>Project</link> tab and <link
linkend="dashboard_admin_tab">Admin</link>
tab.</para>
</step>
</procedure>
<section xml:id="dashboard_project_tab">
<title>OpenStack dashboard&mdash;Project tab</title>
<para>Select a project from the <guilabel>CURRENT
PROJECT</guilabel> drop-down list on the left side to
view and manage resources in that project.</para>
<para>The <guilabel>Project</guilabel> tab displays the
details of the selected project.</para>
<informalfigure xml:id="dashboard_project_user">
<mediaobject>
<imageobject>
<imagedata fileref="figures/dashboard-project.png"
format="PNG" contentwidth="6in" width="6in"/>
</imageobject>
</mediaobject>
</informalfigure>
<para>Access the following categories to complete these tasks:</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 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 these tabs to complete these
tasks:</para>
<formalpara>
<title><guilabel>Security Groups</guilabel>
tab</title>
<para>View, create, edit, and delete security
groups and security group rules.</para>
</formalpara>
<formalpara>
<title><guilabel>Keypairs</guilabel>
tab</title>
<para>View, create, edit, and import keypairs,
and delete keypairs.</para>
</formalpara>
<formalpara>
<title><guilabel>Floating IPs</guilabel>
tab</title>
<para>Allocate an IP address to or release it
from a project.</para>
</formalpara>
<formalpara>
<title><guilabel>API Access</guilabel>
tab</title>
<para>View API endpoints.</para>
</formalpara>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="dashboard_admin_tab">
<title>OpenStack dashboard&mdash;Admin tab</title>
<para>Enables administrative users to view usage and manage
instances, volumes, flavors, images, projects, users,
services, and quotas.</para>
<informalfigure xml:id="dashboard_admin_project_tab">
<mediaobject>
<imageobject>
<imagedata
fileref="figures/dashboard_admin_overview.png"
format="PNG" contentwidth="6in" width="6in"/>
</imageobject>
</mediaobject>
</informalfigure>
<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>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 specs for,
and delete flavors. A flavor is size for 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>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>System Info</guilabel></term>
<listitem>
<para>Access the following tabs to complete these tasks:</para>
<formalpara>
<title><guilabel>Services</guilabel>
tab</title>
<para>View services.</para>
</formalpara>
<formalpara>
<title><guilabel>Default Quotas</guilabel>
tab</title>
<para>View default quota values. Quotas are
hard-coded in OpenStack Compute and define
the maximum allowable size and number of
resources.</para>
</formalpara>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>