openstack/openstack-manuals
Code Issues Proposed changes

[user-guides] Update dashboard navigation for Liberty

Browse Source 
This patch covers End User Guide only.
Admin User Guide is not included, which is covered at another patch.

Change-Id: I3a2f001cf655c29118c14d484c45c3ff2ee7104c
Closes-Bug: #1376365
Closes-Bug: #1524012
Implements: blueprint user-guides-reorganised
This commit is contained in:
KATO Tomoyuki 2015-12-10 10:57:01 +09:00
parent 78c7978ba4
commit b54d74068c
8 changed files with 83 additions and 110 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/common-rst/log_in_dashboard.rst
View File

@ -2,8 +2,7 @@
Log in to the dashboard
=======================
The dashboard is available on the node with the ``nova-dashboard``
server role.
The dashboard is generally installed on the controller node.
#. 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

22
doc/user-guide/source/configure_access_and_security_for_instances.rst
View File

@ -51,8 +51,7 @@ group rules to a project, if your cloud requires them.
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Compute` tab and
click :guilabel:`Access & Security` category. The
@ -67,6 +66,7 @@ group rules to a project, if your cloud requires them.
* **Rule**: ``SSH``
* **Remote**: ``CIDR``
* **CIDR**: ``0.0.0.0/0``
.. note:: To accept requests from a particular range of IP
addresses, specify the IP address block in the
@ -82,8 +82,9 @@ group rules to a project, if your cloud requires them.
#. In the :guilabel:`Add Rule` dialog box, enter the following values:
* **Rule**: ``All ICMP``
* **Remote**: ``Ingress``
* **Direction**: ``Ingress``
* **Remote**: ``CIDR``
* **CIDR**: ``0.0.0.0/0``
#. Click :guilabel:`Add`.
@ -99,8 +100,7 @@ Create at least one key pair for each project.
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Compute` tab and
click :guilabel:`Access & Security` category.
@ -123,8 +123,7 @@ Import a key pair
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Compute` tab and
click :guilabel:`Access & Security` category.
@ -180,8 +179,7 @@ and the association of that address with a specific instance.
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Compute` tab and
click :guilabel:`Access & Security` category.
@ -215,6 +213,4 @@ and the association of that address with a specific instance.
:guilabel:`Disassociate` button.
To release the floating IP address back into the pool of addresses,
click the :guilabel:`More` button and select the :guilabel:`Release
Floating IP` option.
the :guilabel:`Release Floating IP` option at the :guilabel:`Actions` column.

17
doc/user-guide/source/dashboard_create_networks.rst
View File

@ -18,8 +18,7 @@ Create a network
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Network` tab and
click :guilabel:`Networks` category.
@ -34,13 +33,13 @@ Create a network
:guilabel:`Admin State`: The state to start the network in.
:guilabel:`Subnet` tab
:guilabel:`Create Subnet`: Select this check box to create a subnet
You do not have to specify a subnet when you create a network, but if
you do not specify a subnet, any attached instance receives an Error status.
:guilabel:`Subnet` tab
:guilabel:`Subnet Name`: Specify a name for the subnet.
:guilabel:`Network Address`: Specify the IP address for the subnet.
@ -72,8 +71,7 @@ Create a router
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Network` tab and
click :guilabel:`Routers` category.
@ -81,15 +79,10 @@ Create a router
#. Click :guilabel:`Create Router`.
#. In the :guilabel:`Create Router` dialog box, specify a name for the router
and click :guilabel:`Create Router`.
and :guilabel:`External Network`, and click :guilabel:`Create Router`.
The new router is now displayed in the :guilabel:`Routers` tab.
#. Click the new router's :guilabel:`Set Gateway` button.
#. In the :guilabel:`External Network` field, specify the network to which the
router will connect, and then click :guilabel:`Set Gateway`.
#. To connect a private network to the newly created router, perform the
following steps:

34
doc/user-guide/source/dashboard_launch_instances.rst
View File

@ -32,8 +32,7 @@ copy of the image on the compute node where the instance starts.
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Compute` tab and
click :guilabel:`Images` category.
@ -114,13 +113,26 @@ copy of the image on the compute node where the instance starts.
from image` is chosen by default.
Image Name
This field changes based on your previous selection. Since you have
This field changes based on your previous selection. If you have
chosen to launch an instance using an image, the :guilabel:`Image Name`
field displays. Select the image name from the dropdown list.
Instance Snapshot
This field changes based on your previous selection. If you have
chosen to launch an instance using a snapshot, the
:guilabel:`Instance Snapshot` field displays.
Select the snapshot name from the dropdown list.
Volume
This field changes based on your previous selection. If you have
chosen to launch an instance using a volume, the :guilabel:`Volume`
field displays. Select the volume name from the dropdown list.
If you want to delete the volume on instance terminate,
check the :guilabel:`Delete on Terminate` option.
:guilabel:`Access & Security` tab
Keypair
Key Pair
Specify a key pair.
If the image uses a static root password or a static key set
@ -144,7 +156,7 @@ copy of the image on the compute node where the instance starts.
:guilabel:`Post-Creation` tab
Customization Script
Customization Script Source
Specify a customization script that runs after your instance
launches.
@ -196,8 +208,7 @@ uptime for all your instances.
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Compute` tab and
click :guilabel:`Overview` category.
@ -212,8 +223,7 @@ Create an instance snapshot
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Compute` tab and
click the :guilabel:`Instances` category.
@ -235,16 +245,14 @@ Manage an instance
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Compute` tab and
click :guilabel:`Instances` category.
#. Select an instance.
#. In the :guilabel:`More` list in the :guilabel:`Actions` column, select the
state.
#. In the menu list in the :guilabel:`Actions` column, select the state.
You can resize or rebuild an instance. You can also choose to view
the instance console log, edit instance or the security groups.

35
doc/user-guide/source/dashboard_manage_containers.rst
View File

@ -18,8 +18,7 @@ Create a container
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Object Store` tab and
click :guilabel:`Containers` category.
@ -39,8 +38,7 @@ Upload an object
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Object Store` tab and
click :guilabel:`Containers` category.
@ -51,7 +49,7 @@ Upload an object
The :guilabel:`Upload Object To Container: <name>` dialog box
appears.
*``<name>``* is the name of the container to which you are uploading
``<name>`` is the name of the container to which you are uploading
the object.
#. Enter a name for the object.
@ -72,15 +70,14 @@ Manage an object
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Object Store` tab and
click :guilabel:`Containers` category.
#. Select the container in which you want to store your object.
#. Click :guilabel:`More` and choose :guilabel:`Edit` from the dropdown list.
#. Click the menu button and choose :guilabel:`Edit` from the dropdown list.
The :guilabel:`Edit Object` dialog box is displayed.
@ -88,22 +85,21 @@ Manage an object
#. Click :guilabel:`Update Object`.
.. note:: To delete an object, click the :guilabel:`More` button and select
.. note:: To delete an object, click the menu button and select
:guilabel:`Delete Object`.
**To copy an object from one container to another**
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Object Store` tab and
click :guilabel:`Containers` category.
#. Select the container in which you want to store your object.
#. Click :guilabel:`More` and choose :guilabel:`Copy` from the dropdown list.
#. Click the menu button and choose :guilabel:`Copy` from the dropdown list.
#. In the :guilabel:`Copy Object` launch dialog box, enter the following
values:
@ -126,8 +122,7 @@ metadata and URL info in advance.
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Object Store` tab and
click :guilabel:`Containers` category.
@ -136,10 +131,10 @@ metadata and URL info in advance.
#. Click :guilabel:`Upload Object`.
The :guilabel:`Upload Object To Container`: *``<name>``* dialog box is
The :guilabel:`Upload Object To Container`: ``<name>`` dialog box is
displayed.
*``<name>``* is the name of the container to which you are uploading
``<name>`` is the name of the container to which you are uploading
the object.
#. Enter a name for the object.
@ -154,8 +149,7 @@ name.
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Object Store` tab and
click :guilabel:`Containers` category.
@ -164,8 +158,8 @@ name.
#. Click :guilabel:`Create Pseudo-folder`.
The :guilabel:`Create Pseudo-Folder in Container` *``<name> ``* dialog box
is displayed. *``<name> ``* is the name of the container to which you
The :guilabel:`Create Pseudo-Folder in Container` ``<name>`` dialog box
is displayed. ``<name>`` is the name of the container to which you
are uploading the object.
#. Enter a name for the pseudo-folder.
@ -174,4 +168,3 @@ name.
Object Storage.
#. Click :guilabel:`Create`.

40
doc/user-guide/source/dashboard_manage_images.rst
View File

@ -15,9 +15,11 @@ 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 admin project.
.. note:: You can also use the :command:`glance` and :command:`nova`
command-line clients or the Image service and Compute APIs to
manage images.
.. note::
You can also use the :command:`openstack`, :command:`glance` and
:command:`nova` command-line clients or the Image service and Compute
APIs to manage images.
Upload an image
~~~~~~~~~~~~~~~
@ -26,8 +28,7 @@ Follow this procedure to upload an image to a project:
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Compute` tab and
click :guilabel:`Images` category.
@ -66,9 +67,9 @@ Follow this procedure to upload an image to a project:
| | architecture or ``x86_64`` for |
| | a 64-bit architecture. |
+-------------------------------+---------------------------------+
| :guilabel:`Minimum Disk (GB)` | Leave these fields empty. |
| and | |
| :guilabel:`Minimum RAM (MB)` | |
| :guilabel:`Minimum Disk (GB)` | Leave this field empty. |
+-------------------------------+---------------------------------+
| :guilabel:`Minimum RAM (MB)` | Leave this field empty. |
+-------------------------------+---------------------------------+
| :guilabel:`Copy Data` | Specify this option to copy |
| | image data to the Image service.|
@ -96,25 +97,19 @@ Follow this procedure to update an existing image.
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. On the :guilabel:`Project` tab, open the :guilabel:`Compute` tab and
click :guilabel:`Images` category.
#. Select the appropriate project from the drop down menu at the top left.
#. Select the image that you want to edit.
#. In the :guilabel:`Actions` column, click :guilabel:`More` and then
#. In the :guilabel:`Actions` column, click the menu button and then
select :guilabel:`Edit Image` from the list.
#. In the :guilabel:`Update Image` dialog box, you can perform the
following actions:
#. In the :guilabel:`Update Image` dialog box, you can perform various
actions. For example:
- Change the name of the image.
- Select the :guilabel:`Public` check box to make the image public.
- Clear the :guilabel:`Public` check box to make the image private.
* Change the name of the image.
* Select the :guilabel:`Public` check box to make the image public.
* Clear the :guilabel:`Public` check box to make the image private.
#. Click :guilabel:`Update Image`.
@ -126,8 +121,7 @@ with the appropriate permissions can delete images.
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Compute` tab and
click :guilabel:`Images` category.

33
doc/user-guide/source/dashboard_manage_volumes.rst
View File

@ -13,8 +13,7 @@ Create a volume
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Compute` tab and
click :guilabel:`Volumes` category.
@ -28,23 +27,23 @@ Create a volume
:guilabel:`Description`: Optionally, provide a brief description for the
volume.
:guilabel:`Type`: Leave this field blank.
:guilabel:`Size (GB)`: The size of the volume in gibibytes (GiB).
:guilabel:`Volume Source`: Select one of the following options:
* No source, empty volume: Creates an empty volume. An empty volume does
not contain a file system or a partition table.
* Image: If you choose this option, a new field for Use image as a source
displays. You can select the image from the list.
* Image: If you choose this option, a new field for :guilabel:`Use image
as a source` displays. You can select the image from the list.
* Volume: If you choose this option, a new field for
:guilabel:`Use volume as a source` displays. You can select the volume
from the list. Options to use a snapshot or a volume as the source for a
volume are displayed only if there are existing snapshots or volumes.
:guilabel:`Type`: Leave this field blank.
:guilabel:`Size (GB)`: The size of the volume in gibibytes (GiB).
:guilabel:`Availability Zone`: Select the Availability Zone from the list.
By default, this value is set to the availability zone given by the cloud
provider (for example, ``us-west`` or ``apac-south``). For some cases,
@ -62,8 +61,7 @@ You can attach a volume to one instance at a time.
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Compute` tab and
click :guilabel:`Volumes` category.
@ -94,8 +92,7 @@ Detach a volume from an instance
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Compute` tab and
click the :guilabel:`Volumes` category.
@ -111,15 +108,14 @@ Create a snapshot from a volume
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Compute` tab and
click :guilabel:`Volumes` category.
#. Select a volume from which to create a snapshot.
#. From the :guilabel:`More` list, select :guilabel:`Create Snapshot`.
#. In the :guilabel:`Actions` column, click :guilabel:`Create Snapshot`.
#. In the dialog box that opens, enter a snapshot name and a brief
description.
@ -133,8 +129,7 @@ Edit a volume
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Compute` tab and
click :guilabel:`Volumes` category.
@ -160,8 +155,7 @@ deleted.
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Compute` tab and
click :guilabel:`Volumes` category.
@ -171,4 +165,3 @@ deleted.
#. Click :guilabel:`Delete Volumes` and confirm your choice.
A message indicates whether the action was successful.

9
doc/user-guide/source/dashboard_stacks.rst
View File

@ -26,8 +26,7 @@ Launch a stack
~~~~~~~~~~~~~~
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Orchestration` tab and
click :guilabel:`Stacks` category.
#. Click :guilabel:`Launch Stack`.
@ -121,8 +120,7 @@ Manage a stack
~~~~~~~~~~~~~~
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Orchestration` tab and
click :guilabel:`Stacks` category.
#. Select the stack that you want to update.
@ -141,8 +139,7 @@ Delete a stack
When you delete a stack, you cannot undo this action.
#. Log in to the dashboard.
#. From the CURRENT PROJECT on the :guilabel:`Project` tab, select the
appropriate project.
#. Select the appropriate project from the drop down menu at the top left.
#. On the :guilabel:`Project` tab, open the :guilabel:`Orchestration` tab and
click :guilabel:`Stacks` category.
#. Select the stack that you want to delete.