Import user and admin guide from horizon
User and admin guide was moved accidentally from openstack-manuals to horizon during the doc-migration in Pike. This commit moves them from horizon to manila-ui repository for better future maintenance. Change-Id: I918dfcbb6d5498c2a2732c0ae7627da261bf4b87 Closes-Bug: #1741613
This commit is contained in:
parent
df7319b80d
commit
28a96c3577
|
@ -0,0 +1,146 @@
|
|||
====================
|
||||
Administration Guide
|
||||
====================
|
||||
|
||||
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:`User Guide </user/index>`.
|
||||
|
||||
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
|
||||
-------------------
|
||||
|
||||
#. 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.
|
|
@ -15,7 +15,8 @@ Contents
|
|||
|
||||
install/installation
|
||||
configuration/index
|
||||
user/usage
|
||||
user/index
|
||||
admin/index
|
||||
contributor/index
|
||||
|
||||
Indices and tables
|
||||
|
|
|
@ -0,0 +1,242 @@
|
|||
==========
|
||||
User Guide
|
||||
==========
|
||||
|
||||
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.
|
|
@ -1,7 +0,0 @@
|
|||
=====
|
||||
Usage
|
||||
=====
|
||||
|
||||
To use manila-ui in a project::
|
||||
|
||||
import manila_ui
|
Loading…
Reference in New Issue