summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIgor Gajsin <igajsin@mirantis.com>2016-10-19 16:52:56 +0300
committerIgor Gajsin <igajsin@mirantis.com>2016-10-19 16:56:42 +0300
commiteb75277986f2610f23c62dbe0276d55a4434d9ed (patch)
treea3c22c2e295b0056e4e5f7701cfaa36def208fd1
parent3c208135f1ceff25b83672934977b4a39c2761e5 (diff)
add usage and troubleshooting sections to the UserGuide
Notes
Notes (review): Code-Review+2: Igor Gajsin <igajsin@mirantis.com> Workflow+1: Igor Gajsin <igajsin@mirantis.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Wed, 19 Oct 2016 13:58:35 +0000 Reviewed-on: https://review.openstack.org/388715 Project: openstack/fuel-plugin-manila Branch: refs/heads/master
-rw-r--r--doc/user_guide/source/index.rst2
-rw-r--r--doc/user_guide/source/static/add_rule.pngbin0 -> 20923 bytes
-rw-r--r--doc/user_guide/source/static/admin.pngbin0 -> 108491 bytes
-rw-r--r--doc/user_guide/source/static/create_network.pngbin0 -> 29365 bytes
-rw-r--r--doc/user_guide/source/static/create_snapshot.pngbin0 -> 30389 bytes
-rw-r--r--doc/user_guide/source/static/edit_share.pngbin0 -> 34928 bytes
-rw-r--r--doc/user_guide/source/static/project.pngbin0 -> 88624 bytes
-rw-r--r--doc/user_guide/source/troubleshooting.rst51
-rw-r--r--doc/user_guide/source/using_manila.rst59
9 files changed, 112 insertions, 0 deletions
diff --git a/doc/user_guide/source/index.rst b/doc/user_guide/source/index.rst
index c3ec3fe..271b7a5 100644
--- a/doc/user_guide/source/index.rst
+++ b/doc/user_guide/source/index.rst
@@ -26,4 +26,6 @@ Use Manila plugin for Fuel
26.. toctree:: 26.. toctree::
27 :maxdepth: 1 27 :maxdepth: 1
28 28
29 using_manila
30 troubleshooting
29 appendix 31 appendix
diff --git a/doc/user_guide/source/static/add_rule.png b/doc/user_guide/source/static/add_rule.png
new file mode 100644
index 0000000..ed81db2
--- /dev/null
+++ b/doc/user_guide/source/static/add_rule.png
Binary files differ
diff --git a/doc/user_guide/source/static/admin.png b/doc/user_guide/source/static/admin.png
new file mode 100644
index 0000000..ae08e66
--- /dev/null
+++ b/doc/user_guide/source/static/admin.png
Binary files differ
diff --git a/doc/user_guide/source/static/create_network.png b/doc/user_guide/source/static/create_network.png
new file mode 100644
index 0000000..0b83934
--- /dev/null
+++ b/doc/user_guide/source/static/create_network.png
Binary files differ
diff --git a/doc/user_guide/source/static/create_snapshot.png b/doc/user_guide/source/static/create_snapshot.png
new file mode 100644
index 0000000..6d29dcc
--- /dev/null
+++ b/doc/user_guide/source/static/create_snapshot.png
Binary files differ
diff --git a/doc/user_guide/source/static/edit_share.png b/doc/user_guide/source/static/edit_share.png
new file mode 100644
index 0000000..618e1f7
--- /dev/null
+++ b/doc/user_guide/source/static/edit_share.png
Binary files differ
diff --git a/doc/user_guide/source/static/project.png b/doc/user_guide/source/static/project.png
new file mode 100644
index 0000000..c675c40
--- /dev/null
+++ b/doc/user_guide/source/static/project.png
Binary files differ
diff --git a/doc/user_guide/source/troubleshooting.rst b/doc/user_guide/source/troubleshooting.rst
new file mode 100644
index 0000000..7b0f54e
--- /dev/null
+++ b/doc/user_guide/source/troubleshooting.rst
@@ -0,0 +1,51 @@
1Troubleshooting
2---------------
3
4This section contains a guidance on how to ensure that the Manila plugin is up
5and running on your deployed environment.
6
7**To find logs**
8
9The Manila places its log by convinient path. On controller:
10
11* ``/var/log/manila/manila-api.log``
12* ``/var/log/manila/manila-scheduler.log``
13
14On a manila-share node:
15
16* ``/var/log/manila/manila-share.log``
17
18On a manilsa-data node
19
20* ``/var/log/manila/manila-data.log``
21
22**To verify Manila configuragion files**
23
24Check that ``/etc/manila`` directory contains following files:
25
26* ``-rw-r--r-- 1 manila manila 1.8K Oct 19 02:35 api-paste.ini``
27* ``-rw-r--r-- 1 manila manila 1.3K Oct 19 02:35 logging_sample.conf``
28* ``-rw-r--r-- 1 root root 2.6K Oct 19 03:44 manila.conf``
29* ``-rw-r--r-- 1 manila manila 5.2K Oct 19 02:35 policy.json``
30* ``-rw-r--r-- 1 root root 989 Oct 19 02:35 rootwrap.conf``
31* ``drwxr-xr-x 2 manila manila 4.0K Oct 19 02:35 rootwrap.d``
32
33**To verify Manila services**
34
35Check output of the commands on any controller node:
36
37 .. code-block:: console
38
39 # . /root/openrc
40 # manila service-list
41
42All services should be in the *up* stage.
43
44**In case of using self signed certificates**
45
46Use the ``--insecure`` option for all console commands. For example:
47
48 .. code-block:: console
49
50 # manila --insecure list
51 # manila --insecure type-create some_share_type True
diff --git a/doc/user_guide/source/using_manila.rst b/doc/user_guide/source/using_manila.rst
new file mode 100644
index 0000000..6b03455
--- /dev/null
+++ b/doc/user_guide/source/using_manila.rst
@@ -0,0 +1,59 @@
1Using File Share as a Service possibility with Manila plugin for Fuel
2---------------------------------------------------------------------
3
4Once you deploy an OpenStack environment with Manila plugin for Fuel, you can
5start using it both from CLI and Horizon. The topic of CLI usage is too big to
6put it into this User Guide and it well described `here
7<http://docs.openstack.org/cli-reference/manila.html>`_.
8
9The Horizon usage is very obvious. You can notice that two new tabs appears
10on the Admin and Project/Compute sections:
11
12 .. figure:: static/admin.png
13 :width: 90%
14
15 .. raw:: latex
16
17 \pagebreak
18
19 .. figure:: static/project.png
20 :width: 90%
21
22 .. raw:: latex
23
24 \pagebreak
25
26Let's go over the basic usage of Manila:
27
28#. Firstly we have to create a share network for access to new share:
29
30 .. figure:: static/create_network.png
31 :width: 75%
32
33 .. raw:: latex
34
35 \pagebreak
36
37#. After that we can create new share:
38
39 .. figure:: static/create_share.png
40 :width: 75%
41
42 .. raw:: latex
43
44 \pagebreak
45
463. When the share becomes available it should be configured for future usage.
47At least necessary to add new rule in order to allow mounting new share.
48
49 .. figure:: static/edit_share.png
50 :width: 90%
51
52 .. figure:: static/add_rule.png
53 :width: 90%
54
55After that new share could be consumed in your environment.
56
57 .. raw:: latex
58
59 \pagebreak