Merge "doc: drop horizon-plugins' content from user/admin guide"

This commit is contained in:
Zuul 2018-01-25 21:25:21 +00:00 committed by Gerrit Code Review
commit fbbab68777
7 changed files with 0 additions and 718 deletions

View File

@ -19,7 +19,6 @@ Dashboard, see the :doc:`/install/index` for your operating system.
manage-instances.rst
manage-flavors.rst
manage-volumes.rst
manage-shares.rst
set-quotas.rst
manage-services.rst
manage-host-aggregates.rst

View File

@ -1,149 +0,0 @@
=============================
Manage shares and share types
=============================
Shares are file storage that instances can access. Users can
allow or deny a running instance to have access to a share at any time.
For information about using the Dashboard to create and manage shares as
an end user, see the
:doc:`OpenStack End User Guide </user/manage-shares>`.
As an administrative user, you can manage shares and share types for users
in various projects. You can create and delete share types, and view
or delete shares.
.. _create-a-share-type:
Create a share type
~~~~~~~~~~~~~~~~~~~
#. Log in to the Dashboard and choose the :guilabel:`admin`
project from the drop-down list.
#. On the :guilabel:`Admin` tab, open the :guilabel:`System` tab
and click the :guilabel:`Shares` category.
#. Click the :guilabel:`Share Types` tab, and click
:guilabel:`Create Share Type` button. In the
:guilabel:`Create Share Type` window, enter or select the
following values.
:guilabel:`Name`: Enter a name for the share type.
:guilabel:`Driver handles share servers`: Choose True or False
:guilabel:`Extra specs`: To add extra specs, use key=value.
#. Click :guilabel:`Create Share Type` button to confirm your changes.
.. note::
A message indicates whether the action succeeded.
Update share type
~~~~~~~~~~~~~~~~~
#. Log in to the Dashboard and choose the :guilabel:`admin` project from
the drop-down list.
#. On the :guilabel:`Admin` tab, open the :guilabel:`System` tab
and click the :guilabel:`Shares` category.
#. Click the :guilabel:`Share Types` tab, select the share type
that you want to update.
#. Select :guilabel:`Update Share Type` from Actions.
#. In the :guilabel:`Update Share Type` window, update extra specs.
:guilabel:`Extra specs`: To add extra specs, use key=value.
To unset extra specs, use key.
#. Click :guilabel:`Update Share Type` button to confirm your changes.
.. note::
A message indicates whether the action succeeded.
Delete share types
~~~~~~~~~~~~~~~~~~
When you delete a share type, shares of that type are not deleted.
#. Log in to the Dashboard and choose the :guilabel:`admin` project from
the drop-down list.
#. On the :guilabel:`Admin` tab, open the :guilabel:`System` tab
and click the :guilabel:`Shares` category.
#. Click the :guilabel:`Share Types` tab, select the share type
or types that you want to delete.
#. Click :guilabel:`Delete Share Types` button.
#. In the :guilabel:`Confirm Delete Share Types` window, click the
:guilabel:`Delete Share Types` button to confirm the action.
.. note::
A message indicates whether the action succeeded.
Delete shares
~~~~~~~~~~~~~
#. Log in to the Dashboard and choose the :guilabel:`admin` project
from the drop-down list.
#. On the :guilabel:`Admin` tab, open the :guilabel:`System` tab
and click the :guilabel:`Shares` category.
#. Select the share or shares that you want to delete.
#. Click :guilabel:`Delete Shares` button.
#. In the :guilabel:`Confirm Delete Shares` window, click the
:guilabel:`Delete Shares` button to confirm the action.
.. note::
A message indicates whether the action succeeded.
Delete share server
~~~~~~~~~~~~~~~~~~~
#. Log in to the Dashboard and choose the :guilabel:`admin` project
from the drop-down list.
#. On the :guilabel:`Admin` tab, open the :guilabel:`System` tab
and click the :guilabel:`Share Servers` category.
#. Select the share that you want to delete.
#. Click :guilabel:`Delete Share Server` button.
#. In the :guilabel:`Confirm Delete Share Server` window, click the
:guilabel:`Delete Share Server` button to confirm the action.
.. note::
A message indicates whether the action succeeded.
Delete share networks
~~~~~~~~~~~~~~~~~~~~~
#. Log in to the Dashboard and choose the :guilabel:`admin` project
from the drop-down list.
#. On the :guilabel:`Admin` tab, open the :guilabel:`System` tab
and click the :guilabel:`Share Networks` category.
#. Select the share network or share networks that you want to delete.
#. Click :guilabel:`Delete Share Networks` button.
#. In the :guilabel:`Confirm Delete Share Networks` window, click the
:guilabel:`Delete Share Networks` button to confirm the action.
.. note::
A message indicates whether the action succeeded.

View File

@ -1,216 +0,0 @@
===========================
Create and manage databases
===========================
The Database service provides scalable and reliable cloud provisioning
functionality for both relational and non-relational database engines.
Users can quickly and easily use database features without the burden of
handling complex administrative tasks.
.. _dashboard_create_db_instance:
Create a database instance
~~~~~~~~~~~~~~~~~~~~~~~~~~
**Prerequisites.** Before you create a database instance, you need to
configure a default datastore and make sure you have an appropriate
flavor for the type of database instance you want.
#. **Configure a default datastore.**
Because the dashboard does not let you choose a specific datastore to
use with an instance, you need to configure a default datastore. The
dashboard then uses the default datastore to create the instance.
#. Add the following line to ``/etc/trove/trove.conf``:
.. code-block:: console
default_datastore = DATASTORE_NAME
Replace ``DATASTORE_NAME`` with the name that the administrative
user set when issuing the :command:`trove-manage` command to create the
datastore. You can use the trove :command:`datastore-list` command to
display the datastores that are available in your environment.
For example, if your MySQL data store name is set to ``mysql``,
your entry would look like this:
.. code-block:: console
default_datastore = mysql
#. Restart Database services on the controller node:
.. code-block:: console
# service trove-api restart
# service trove-taskmanager restart
# service trove-conductor restart
#. **Verify flavor.**
Make sure an appropriate flavor exists for the type of
database instance you want.
**Create database instance.** Once you have configured a default
datastore and verified that you have an appropriate flavor, you can
create a database instance.
#. 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:`Database` tab and
click :guilabel:`Instances` category. This lists the instances that
already exist in your environment.
#. Click :guilabel:`Launch Instance`.
#. In the :guilabel:`Launch Database` dialog box, specify the following values.
Details
:guilabel:`Database Name`: Specify a name for the database instance.
:guilabel:`Flavor`: Select an appropriate flavor for the instance.
:guilabel:`Volume Size`: Select a volume size. Volume size is expressed in
GB.
:guilabel:`Initialize Databases`: Initial Database
Optionally provide a comma separated list of databases to create, for
example:
``database1``, ``database2``, ``database3``
:guilabel:`Initial Admin User`: Create an initial admin user. This user will
have access to all the databases you create.
:guilabel:`Password`: Specify a password associated with the initial admin
user you just named.
:guilabel:`Host`: Optionally, allow the user to connect only from this host.
If you do not specify a host, this user will be allowed to connect from
anywhere.
#. Click the :guilabel:`Launch` button. The new database instance appears in
the databases list.
Backup and restore a database
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
You can use Database services to backup a database and store the backup
artifact in the Object Storage service. Later on, if the original
database is damaged, you can use the backup artifact to restore the
database. The restore process creates a database instance.
This example shows you how to back up and restore a MySQL database.
To backup the database instance
-------------------------------
#. 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:`Database` tab and
click :guilabel:`Instances` category. This displays the existing
instances in your system.
#. Click :guilabel:`Create Backup`.
#. In the :guilabel:`Backup Database` dialog box, specify the following
values:
Name
Specify a name for the backup.
Database Instance
Select the instance you want to back up.
#. Click :guilabel:`Backup`. The new backup appears in the backup list.
To restore a database instance
------------------------------
Now assume that your original database instance is damaged and you
need to restore it. You do the restore by using your backup to create
a new database instance.
#. 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:`Database` tab and
click :guilabel:`Backups` category. This lists the available backups.
#. Check the backup you want to use and click :guilabel:`Restore Backup`.
#. In the :guilabel:`Launch Database` dialog box, specify the values you
want for the new database instance.
#. Click the :guilabel:`Restore From Database` tab and make sure that this
new instance is based on the correct backup.
#. Click :guilabel:`Launch`.
The new instance appears in the database instances list.
Update a database instance
~~~~~~~~~~~~~~~~~~~~~~~~~~
You can change various characteristics of a database instance,
such as its volume size and flavor.
To change the volume size of an instance
----------------------------------------
#. 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:`Database` tab and
click :guilabel:`Instances` category. This displays the existing
instances in your system.
#. Check the instance you want to work with.
In the :guilabel:`Actions` column, expand the drop down menu
and select :guilabel:`Resize Volume`.
#. In the :guilabel:`Resize Database Volume` dialog box,
fill in the :guilabel:`New Size` field with an integer indicating
the new size you want for the instance. Express the size in GB, and
note that the new size must be larger than the current size.
#. Click :guilabel:`Resize Database Volume`.
To change the flavor of an instance
-----------------------------------
#. 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:`Database` tab and
click :guilabel:`Instances` category. This displays the existing
instances in your system.
#. Check the instance you want to work with. In the
:guilabel:`Actions` column, expand the drop down menu and
select :guilabel:`Resize Instance`.
#. In the :guilabel:`Resize Database Instance` dialog box,
expand the drop down menu in the :guilabel:`New Flavor` field.
Select the new flavor you want for the instance.
#. Click :guilabel:`Resize Database Instance`.

View File

@ -17,7 +17,4 @@ sizes of server instances.
create-networks.rst
manage-containers.rst
manage-volumes.rst
manage-shares.rst
databases.rst
manage-lbaasv2.rst
browser_support

View File

@ -85,14 +85,6 @@ Compute tab
* :guilabel:`Key Pairs`: View, create, edit, import, and delete key pairs.
* :guilabel:`Shares`: Use the following tabs to complete these tasks:
* :guilabel:`Shares`: View, create, manage, and delete shares.
* :guilabel:`Snapshots`: View, manage, and delete volume snapshots.
* :guilabel:`Share Networks`: View, manage, and delete share networks.
Volume tab
-----------
@ -210,20 +202,6 @@ System tab
* :guilabel:`Network Agents`: View the network agents.
* :guilabel:`Shares`: Use the following tabs to complete these tasks:
* :guilabel:`Shares`: View, create, manage, and delete shares.
* :guilabel:`Snapshots`: View, manage, and delete volume snapshots.
* :guilabel:`Share Networks`: View, manage, and delete share networks.
* :guilabel:`Security Services`: View, manage, and delete security services.
* :guilabel:`Share Types`: View, create, manage, and delete share types.
* :guilabel:`Share Servers`: View, manage, and delete share servers.
.. _dashboard-identity-tab:
OpenStack dashboard — Identity tab

View File

@ -1,85 +0,0 @@
=================================
View and manage load balancers v2
=================================
Load-Balancer-as-a-Service (LBaaS) enables networking to distribute incoming
requests evenly among designated instances. This distribution ensures that
the workload is shared predictably among instances and enables more effective
use of system resources. Use one of these load-balancing methods to distribute
incoming requests:
* Round robin: Rotates requests evenly between multiple instances.
* Source IP: Requests from a unique source IP address are consistently
directed to the same instance.
* Least connections: Allocates requests to the instance with the
least number of active connections.
As an end user, you can create and manage load balancers and related
objects for users in various projects. You can also delete load balancers
and related objects.
LBaaS v2 has several new concepts to understand:
Load balancer
The load balancer occupies a neutron network port and
has an IP address assigned from a subnet.
Listener
Each port that listens for traffic on a particular load balancer is
configured separately and tied to the load balancer. Multiple listeners can
be associated with the same load balancer.
Pool
A pool is a group of hosts that sits behind the load balancer and
serves traffic through the load balancer.
Member
Members are the actual IP addresses that receive traffic from
the load balancer. Members are associated with pools.
Health monitor
Members may go offline from time to time and health monitors
diverts traffic away from members that are not responding properly.
Health monitors are associated with pools.
View existing load balancers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#. Log in to the OpenStack dashboard.
#. On the :guilabel:`Project` tab, open the
:guilabel:`Network` tab, and click the
:guilabel:`Load Balancers` category.
This view shows the list of existing load balancers. To view details
of any of the load balancers, click on the specific load balancer.
Create a load balancer
~~~~~~~~~~~~~~~~~~~~~~
#. Log in to the OpenStack dashboard.
#. On the :guilabel:`Project` tab, open the
:guilabel:`Network` tab, and click the
:guilabel:`Load Balancers` category.
#. Click the :guilabel:`Create Load Balancer` button.
Use the concepts described in the overview section to fill in
the necessary information about the load balancer you want to create.
Keep in mind, the health checks routinely run against each instance
within a target load balancer and the result of the health check is
used to determine if the instance receives new connections.
.. note::
A message indicates whether the action succeeded.
Delete a load balancer
~~~~~~~~~~~~~~~~~~~~~~
#. Select the load balancer you want to delete
and click the :guilabel:`Delete Load Balancer` button.
To be deleted successfully, a load balancer must not
have any listeners or pools associated with
it. The delete action is also available in the
:guilabel:`Actions` column for the individual load balancers.

View File

@ -1,242 +0,0 @@
=========================
Create and manage shares
=========================
Shares are file storage that you provide access to instances. You can allow
access to a share to a running instance or deny access to a share and allow
access to it to another instance at any time. You can also delete a share.
You can create snapshot from a share if the driver supports it. Only
administrative users can create share types.
Create a share
~~~~~~~~~~~~~~~
#. Log in to the dashboard, choose a project, and click :guilabel:`Shares`.
#. Click :guilabel:`Create Share`.
In the dialog box that opens, enter or select the following values.
:guilabel:`Share Name`: Specify a name for the share.
:guilabel:`Description`: Optionally, provide a brief description for the
share.
:guilabel:`Share Type`: Choose a share type.
:guilabel:`Size (GB)`: The size of the share in gibibytes (GiB).
:guilabel:`Share Protocol`: Select NFS, CIFS, GlusterFS, or HDFS.
:guilabel:`Share Network`: Choose a share network.
:guilabel:`Metadata`: Enter metadata for the share creation if needed.
#. Click :guilabel:`Create Share`.
The dashboard shows the share on the :guilabel:`Shares` tab.
Delete a share
~~~~~~~~~~~~~~~
#. Log in to the dashboard, choose a project, and click :guilabel:`Shares`.
#. Select the check boxes for the shares that you want to delete.
#. Click :guilabel:`Delete Shares` and confirm your choice.
A message indicates whether the action was successful.
Allow access
~~~~~~~~~~~~
#. Log in to the dashboard, choose a project, and click :guilabel:`Shares`.
#. Go to the share that you want to allow access and choose
:guilabel:`Manage Rules` from Actions.
#. Click :guilabel:`Add rule`.
:guilabel:`Access Type`: Choose ip, user, or cert.
:guilabel:`Access Level`: Choose read-write or read-only.
:guilabel:`Access To`: Fill in Access To field.
#. Click :guilabel:`Add Rule`.
A message indicates whether the action was successful.
Deny access
~~~~~~~~~~~
#. Log in to the dashboard, choose a project, and click :guilabel:`Shares`.
#. Go to the share that you want to deny access and choose
:guilabel:`Manage Rules` from Actions.
#. Choose the rule you want to delete.
#. Click :guilabel:`Delete rule` and confirm your choice.
A message indicates whether the action was successful.
Edit share metadata
~~~~~~~~~~~~~~~~~~~
#. Log in to the dashboard, choose a project, and click :guilabel:`Shares`.
#. Go to the share that you want to edit and choose
:guilabel:`Edit Share Metadata` from Actions.
#. :guilabel:`Metadata`: To add share metadata, use key=value. To unset
metadata, use key.
#. Click :guilabel:`Edit Share Metadata`.
A message indicates whether the action was successful.
Edit share
~~~~~~~~~~
#. Log in to the dashboard, choose a project, and click :guilabel:`Shares`.
#. Go to the share that you want to edit and choose :guilabel:`Edit Share` from
Actions.
#. :guilabel:`Share Name`: Enter a new share name.
#. :guilabel:`Description`: Enter a new description.
#. Click :guilabel:`Edit Share`.
A message indicates whether the action was successful.
Extend share
~~~~~~~~~~~~
#. Log in to the dashboard, choose a project, and click :guilabel:`Shares`.
#. Go to the share that you want to edit and choose :guilabel:`Extend Share`
from Actions.
#. :guilabel:`New Size (GB)`: Enter new size.
#. Click :guilabel:`Extend Share`.
A message indicates whether the action was successful.
Create share network
~~~~~~~~~~~~~~~~~~~~
#. Log in to the dashboard, choose a project, click :guilabel:`Shares`,
and click :guilabel:`Share Networks`.
#. Click :guilabel:`Create Share Network`.
In the dialog box that opens, enter or select the following values.
:guilabel:`Name`: Specify a name for the share network.
:guilabel:`Description`: Optionally, provide a brief description for the
share network.
:guilabel:`Neutron Net`: Choose a neutron network.
:guilabel:`Neutron Subnet`: Choose a neutron subnet.
#. Click :guilabel:`Create Share Network`.
The dashboard shows the share network on the :guilabel:`Share Networks` tab.
Delete a share network
~~~~~~~~~~~~~~~~~~~~~~
#. Log in to the dashboard, choose a project, click :guilabel:`Shares`, and
click :guilabel:`Share Networks`.
#. Select the check boxes for the share networks that you want to delete.
#. Click :guilabel:`Delete Share Networks` and confirm your choice.
A message indicates whether the action was successful.
Edit share network
~~~~~~~~~~~~~~~~~~
#. Log in to the dashboard, choose a project, click :guilabel:`Shares`, and
click :guilabel:`Share Networks`.
#. Go to the share network that you want to edit and choose
:guilabel:`Edit Share Network` from Actions.
#. :guilabel:`Name`: Enter a new share network name.
#. :guilabel:`Description`: Enter a new description.
#. Click :guilabel:`Edit Share Network`.
A message indicates whether the action was successful.
Create security service
~~~~~~~~~~~~~~~~~~~~~~~
#. Log in to the dashboard, choose a project, click :guilabel:`Shares`,
and click :guilabel:`Security Services`.
#. Click :guilabel:`Create Security Service`.
In the dialog box that opens, enter or select the following values.
:guilabel:`Name`: Specify a name for the security service.
:guilabel:`DNS IP`: Enter the DNS IP address.
:guilabel:`Server`: Enter the server name.
:guilabel:`Domain`: Enter the domain name.
:guilabel:`User`: Enter the user name.
:guilabel:`Password`: Enter the password.
:guilabel:`Confirm Password`: Enter the password again to confirm.
:guilabel:`Type`: Choose the type from Active Directory, LDAP, or Kerberos.
:guilabel:`Description`: Optionally, provide a brief description for the
security service.
#. Click :guilabel:`Create Security Service`.
The dashboard shows the security service on the :guilabel:`Security Services`
tab.
Delete a security service
~~~~~~~~~~~~~~~~~~~~~~~~~
#. Log in to the dashboard, choose a project, click :guilabel:`Shares`, and
click :guilabel:`Security Services`.
#. Select the check boxes for the security services that you want to delete.
#. Click :guilabel:`Delete Security Services` and confirm your choice.
A message indicates whether the action was successful.
Edit security service
~~~~~~~~~~~~~~~~~~~~~
#. Log in to the dashboard, choose a project, click :guilabel:`Shares`,
and click :guilabel:`Security Services`.
#. Go to the security service that you want to edit and choose
:guilabel:`Edit Security Service` from Actions.
#. :guilabel:`Name`: Enter a new security service name.
#. :guilabel:`Description`: Enter a new description.
#. Click :guilabel:`Edit Security Service`.
A message indicates whether the action was successful.