379 lines
17 KiB
XML
379 lines
17 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE section [
|
|
<!ENTITY % openstack SYSTEM "entities/openstack.ent">
|
|
%openstack;
|
|
]>
|
|
<section xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
version="5.0"
|
|
xml:id="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"
|
|
>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—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>
|
|
<informaltable rules="all" width="75%">
|
|
<col width="30%"/>
|
|
<col width="70%"/>
|
|
<thead>
|
|
<tr>
|
|
<th colspan="2" align="center"><guilabel>Compute</guilabel> tab</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><para><guilabel>Overview</guilabel></para></td>
|
|
<td><para>View reports for the project.</para></td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Instances</guilabel></para></td>
|
|
<td><para>View, launch, create a snapshot from, stop, pause, or
|
|
reboot instances, or connect to them through VNC.</para></td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Volumes</guilabel></para></td>
|
|
<td><para>Use the following tabs to complete these
|
|
tasks:</para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><guilabel>Volumes</guilabel></term>
|
|
<listitem>
|
|
<para>View, create, edit, and delete volumes.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><guilabel>Volume Snapshots</guilabel></term>
|
|
<listitem>
|
|
<para>View, create, edit, and delete volume snapshots.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist></td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Images</guilabel></para></td>
|
|
<td><para>View images and instance 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></td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Access & Security</guilabel></para></td>
|
|
<td><para>Use the following tabs to complete these tasks:</para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><guilabel>Security Groups</guilabel></term>
|
|
<listitem><para>View, create, edit, and delete security
|
|
groups and security group rules.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><guilabel>Key Pairs</guilabel></term>
|
|
<listitem><para>View, create, edit, import, and delete key
|
|
pairs.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><guilabel>Floating IPs</guilabel></term>
|
|
<listitem>
|
|
<para>Allocate an IP address to or release it
|
|
from a project.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><guilabel>API Access</guilabel></term>
|
|
<listitem><para>View API endpoints.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist></td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2" align="center"><guilabel>Network</guilabel> tab</th>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Network Topology</guilabel></para></td>
|
|
<td><para>View the network topology.</para></td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Networks</guilabel></para></td>
|
|
<td><para>Create and manage public and private networks.</para></td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Routers</guilabel></para></td>
|
|
<td><para>Create and manage subnets.</para></td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2" align="center"><guilabel>Object Store</guilabel> tab</th>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Containers</guilabel></para></td>
|
|
<td><para>Create and manage containers and objects.</para></td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2" align="center"><guilabel>Orchestration</guilabel> tab</th>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Containers</guilabel></para></td>
|
|
<td><para>Use the REST API to orchestrate multiple
|
|
composite cloud applications.</para></td>
|
|
</tr>
|
|
</tbody>
|
|
</informaltable>
|
|
</section>
|
|
<section xml:id="dashboard_admin_tab">
|
|
<title>OpenStack dashboard—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>
|
|
<informaltable rules="all" width="75%">
|
|
<col width="30%"/>
|
|
<col width="70%"/>
|
|
<thead>
|
|
<tr>
|
|
<th colspan="2" align="center"><guilabel>System Panel</guilabel> tab</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><para><guilabel>Overview</guilabel></para></td>
|
|
<td><para>View basic reports.</para></td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Resource Usage</guilabel></para></td>
|
|
<td><para>Use the following tabs to view the following usages:</para>
|
|
<!--Lots of updates happening to the dashboard. Leaving these for
|
|
now. Know from talking to Devs that there are some big changes to
|
|
Resource Usage tab. Want to retain these for now. And remove once
|
|
confirmed that these options will not be retained anymore -->
|
|
<variablelist>
|
|
<!-- <varlistentry>
|
|
<term><guilabel>Global Disk Usage</guilabel></term>
|
|
<listitem>
|
|
<para>View the disk usage for all tenants as an average over
|
|
the last 30 days.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><guilabel>Global Network Traffic Usage</guilabel></term>
|
|
<listitem>
|
|
<para>View the network usage for all tenants as an average over
|
|
the last 30 days.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><guilabel>Global Object Storage Usage</guilabel></term>
|
|
<listitem>
|
|
<para>View the object storage usage for all tenants as an average
|
|
over the last 30 days.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><guilabel>Global Network Usage</guilabel></term>
|
|
<listitem>
|
|
<para>View the network usage for all tenants as an average
|
|
over the last 30 days.</para>
|
|
</listitem>
|
|
</varlistentry>-->
|
|
<varlistentry>
|
|
<term><guilabel>Daily Report</guilabel></term>
|
|
<listitem>
|
|
<para>View the daily report.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><guilabel>Stats</guilabel></term>
|
|
<listitem>
|
|
<para>View the statistics of all resources.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist></td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Hypervisors</guilabel></para></td>
|
|
<td><para>View the hypervisor summary.</para></td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Host Aggregates</guilabel></para></td>
|
|
<td><para>View, create, and edit host aggregates. View the list of
|
|
availability zones.</para></td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Instances</guilabel></para></td>
|
|
<td><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></td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Volumes</guilabel></para></td>
|
|
<td><para>View, create, edit, and delete volumes and
|
|
volume types.</para></td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Flavors</guilabel></para></td>
|
|
<td><para>View, create, edit, view extra specifications for, and
|
|
delete flavors. A flavor is size of an instance.</para></td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Images</guilabel></para></td>
|
|
<td><para>View, create, edit properties for, and delete custom
|
|
images.</para></td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Networks</guilabel></para></td>
|
|
<td><para>View, create, edit properties for, and delete networks.</para></td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Routers</guilabel></para></td>
|
|
<td><para>View, create, edit properties for, and delete routers.</para></td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>System Info</guilabel></para></td>
|
|
<td><para>Use the following tabs to view the service information:</para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><guilabel>Services</guilabel></term>
|
|
<listitem><para>View a list of the services.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><guilabel>Compute Services</guilabel></term>
|
|
<listitem><para>View a list of all Compute services.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><guilabel>Network Agents</guilabel></term>
|
|
<listitem><para>View the network agents.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><guilabel>Default Quotas</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>
|
|
</variablelist></td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2" align="center"><guilabel>Identity Panel</guilabel> tab</th>
|
|
<!--Lots of updates happening to the dashboard. Leaving these for now.-->
|
|
</tr>
|
|
<!-- <tr>
|
|
<td><para><guilabel>Domains</guilabel></para></td>
|
|
<td><para>View domains.</para></td>
|
|
</tr>-->
|
|
<tr>
|
|
<td><para><guilabel>Projects</guilabel></para></td>
|
|
<td><para>View, create, assign users to, remove users from, and
|
|
delete projects.</para></td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Users</guilabel></para></td>
|
|
<td><para>View, create, enable, disable, and delete users.</para></td>
|
|
</tr>
|
|
<!-- <tr>
|
|
<td><para><guilabel>Groups</guilabel></para></td>
|
|
<td>
|
|
<para>View, create, enable, disable, and delete groups.</para></td>
|
|
</tr>
|
|
<tr>
|
|
<td><para><guilabel>Roles</guilabel></para></td>
|
|
<td><para>View, create, enable, disable, and delete roles.</para></td>
|
|
</tr>-->
|
|
</tbody>
|
|
</informaltable>
|
|
</section>
|
|
</section>
|