Quellcode durchsuchen

add usage and troubleshooting sections to the UserGuide

Change-Id: I8764472dc74ccce53958af08f1809ab21b04da9f
changes/15/388715/2
Igor Gajsin vor 3 Jahren
Ursprung
Commit
eb75277986
9 geänderte Dateien mit 112 neuen und 0 gelöschten Zeilen
  1. +2
    -0
      doc/user_guide/source/index.rst
  2. BIN
      doc/user_guide/source/static/add_rule.png
  3. BIN
      doc/user_guide/source/static/admin.png
  4. BIN
      doc/user_guide/source/static/create_network.png
  5. BIN
      doc/user_guide/source/static/create_snapshot.png
  6. BIN
      doc/user_guide/source/static/edit_share.png
  7. BIN
      doc/user_guide/source/static/project.png
  8. +51
    -0
      doc/user_guide/source/troubleshooting.rst
  9. +59
    -0
      doc/user_guide/source/using_manila.rst

+ 2
- 0
doc/user_guide/source/index.rst Datei anzeigen

@@ -26,4 +26,6 @@ Use Manila plugin for Fuel
.. toctree::
:maxdepth: 1

using_manila
troubleshooting
appendix

BIN
doc/user_guide/source/static/add_rule.png Datei anzeigen

Vorher Nachher
Breite: 719  |  Höhe: 365  |  Größe: 20KB

BIN
doc/user_guide/source/static/admin.png Datei anzeigen

Vorher Nachher
Breite: 967  |  Höhe: 710  |  Größe: 106KB

BIN
doc/user_guide/source/static/create_network.png Datei anzeigen

Vorher Nachher
Breite: 720  |  Höhe: 611  |  Größe: 29KB

BIN
doc/user_guide/source/static/create_snapshot.png Datei anzeigen

Vorher Nachher
Breite: 721  |  Höhe: 466  |  Größe: 30KB

BIN
doc/user_guide/source/static/edit_share.png Datei anzeigen

Vorher Nachher
Breite: 1683  |  Höhe: 354  |  Größe: 34KB

BIN
doc/user_guide/source/static/project.png Datei anzeigen

Vorher Nachher
Breite: 794  |  Höhe: 637  |  Größe: 87KB

+ 51
- 0
doc/user_guide/source/troubleshooting.rst Datei anzeigen

@@ -0,0 +1,51 @@
Troubleshooting
---------------

This section contains a guidance on how to ensure that the Manila plugin is up
and running on your deployed environment.

**To find logs**

The Manila places its log by convinient path. On controller:

* ``/var/log/manila/manila-api.log``
* ``/var/log/manila/manila-scheduler.log``

On a manila-share node:

* ``/var/log/manila/manila-share.log``

On a manilsa-data node

* ``/var/log/manila/manila-data.log``

**To verify Manila configuragion files**

Check that ``/etc/manila`` directory contains following files:

* ``-rw-r--r-- 1 manila manila 1.8K Oct 19 02:35 api-paste.ini``
* ``-rw-r--r-- 1 manila manila 1.3K Oct 19 02:35 logging_sample.conf``
* ``-rw-r--r-- 1 root root 2.6K Oct 19 03:44 manila.conf``
* ``-rw-r--r-- 1 manila manila 5.2K Oct 19 02:35 policy.json``
* ``-rw-r--r-- 1 root root 989 Oct 19 02:35 rootwrap.conf``
* ``drwxr-xr-x 2 manila manila 4.0K Oct 19 02:35 rootwrap.d``

**To verify Manila services**

Check output of the commands on any controller node:

.. code-block:: console

# . /root/openrc
# manila service-list

All services should be in the *up* stage.

**In case of using self signed certificates**

Use the ``--insecure`` option for all console commands. For example:

.. code-block:: console

# manila --insecure list
# manila --insecure type-create some_share_type True

+ 59
- 0
doc/user_guide/source/using_manila.rst Datei anzeigen

@@ -0,0 +1,59 @@
Using File Share as a Service possibility with Manila plugin for Fuel
---------------------------------------------------------------------

Once you deploy an OpenStack environment with Manila plugin for Fuel, you can
start using it both from CLI and Horizon. The topic of CLI usage is too big to
put it into this User Guide and it well described `here
<http://docs.openstack.org/cli-reference/manila.html>`_.

The Horizon usage is very obvious. You can notice that two new tabs appears
on the Admin and Project/Compute sections:

.. figure:: static/admin.png
:width: 90%

.. raw:: latex

\pagebreak

.. figure:: static/project.png
:width: 90%

.. raw:: latex

\pagebreak

Let's go over the basic usage of Manila:

#. Firstly we have to create a share network for access to new share:

.. figure:: static/create_network.png
:width: 75%

.. raw:: latex

\pagebreak

#. After that we can create new share:

.. figure:: static/create_share.png
:width: 75%

.. raw:: latex

\pagebreak

3. When the share becomes available it should be configured for future usage.
At least necessary to add new rule in order to allow mounting new share.

.. figure:: static/edit_share.png
:width: 90%

.. figure:: static/add_rule.png
:width: 90%

After that new share could be consumed in your environment.

.. raw:: latex

\pagebreak

Laden…
Abbrechen
Speichern