Browse Source

Merge "add usage and troubleshooting sections to the UserGuide"

Jenkins 2 years ago
parent
commit
29abcee77c

+ 2
- 0
doc/user_guide/source/index.rst View File

@@ -26,4 +26,6 @@ Use Manila plugin for Fuel
26 26
 .. toctree::
27 27
    :maxdepth: 1
28 28
 
29
+   using_manila
30
+   troubleshooting
29 31
    appendix

BIN
doc/user_guide/source/static/add_rule.png View File


BIN
doc/user_guide/source/static/admin.png View File


BIN
doc/user_guide/source/static/create_network.png View File


BIN
doc/user_guide/source/static/create_snapshot.png View File


BIN
doc/user_guide/source/static/edit_share.png View File


BIN
doc/user_guide/source/static/project.png View File


+ 51
- 0
doc/user_guide/source/troubleshooting.rst View File

@@ -0,0 +1,51 @@
1
+Troubleshooting
2
+---------------
3
+
4
+This section contains a guidance on how to ensure that the Manila plugin is up
5
+and running on your deployed environment.
6
+
7
+**To find logs**
8
+
9
+The 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
+
14
+On a manila-share node:
15
+
16
+* ``/var/log/manila/manila-share.log``
17
+
18
+On a manilsa-data node
19
+
20
+* ``/var/log/manila/manila-data.log``
21
+
22
+**To verify Manila configuragion files**
23
+
24
+Check 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
+
35
+Check output of the commands on any controller node:
36
+
37
+  .. code-block:: console
38
+
39
+     # . /root/openrc
40
+     # manila service-list
41
+
42
+All services should be in the *up* stage.
43
+
44
+**In case of using self signed certificates**
45
+
46
+Use 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

+ 59
- 0
doc/user_guide/source/using_manila.rst View File

@@ -0,0 +1,59 @@
1
+Using File Share as a Service possibility with Manila plugin for Fuel
2
+---------------------------------------------------------------------
3
+
4
+Once you deploy an OpenStack environment with Manila plugin for Fuel, you can
5
+start using it both from CLI and Horizon. The topic of CLI usage is too big to
6
+put it into this User Guide and it well described `here
7
+<http://docs.openstack.org/cli-reference/manila.html>`_.
8
+
9
+The Horizon usage is very obvious. You can notice that two new tabs appears
10
+on 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
+
26
+Let'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
+
46
+3. When the share becomes available it should be configured for future usage.
47
+At 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
+
55
+After that new share could be consumed in your environment.
56
+
57
+   .. raw:: latex
58
+
59
+      \pagebreak

Loading…
Cancel
Save