Browse Source

Add documentation, fixed a typo, bumped to 1.0.0

Funs 2 years ago
parent
commit
6931adfe75

+ 113
- 0
doc/TestReportForFuelPluginDateraCinder-1.0.0.rst View File

@@ -0,0 +1,113 @@
1
+Test Report for Datara-cinder-1.0.0 Fuel Plugin
2
+===============================================
3
+
4
+.. contents::
5
+    :depth: 2
6
+
7
+Revision history
8
+================
9
+
10
++---------------+---------------------+--------------------------------------------------------------------------+----------------------------------------------+
11
+| **Version**   | **Revision date**   | **Editor**                                                               | **Comment**                                  |
12
++---------------+---------------------+--------------------------------------------------------------------------+----------------------------------------------+
13
+| 0.1           | 23.01.2015          | Irina Povolotskaya                                                       | Created the template structure.              |
14
+|               |                     |                                                                          |                                              |
15
+|               |                     | (`*ipovolotskaya@mirantis.com* <mailto:ipovolotskaya@mirantis.com>`__)   |                                              |
16
++---------------+---------------------+--------------------------------------------------------------------------+----------------------------------------------+
17
+| 1.0           | 06.06.2016          | Funs Kessen <`*ftk@datera.io* <mailto:ttk@datera.io>`__>                 | Fuel Plugin Datera Cinder 1.0.0 Test Report. |
18
++---------------+---------------------+--------------------------------------------------------------------------+----------------------------------------------+
19
+
20
+Document purpose
21
+================
22
+This document provides the test run result for all of Datera-cinder-1.0.0 Fuel Plugin on Mirantis Openstack 7.0 and Mirantis Openstack 8.0.
23
+
24
+Test environment
25
+================
26
+The test environment were a total of 13 VMs, where the Datera EDF sim was reused to serve both Mirantis Openstack 7.0 as well as Mirantis Openstack 8.0 at the same time.
27
+
28
+Test Environment Mirantis Fuel 7.0
29
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
30
+
31
++----------+-------------------------+------------+-----------+------------------+-----------------+
32
+| **VM**   | **Description**         | **vCPU**   | **RAM**   | **HD**           | **OS**          |
33
++----------+-------------------------+------------+-----------+------------------+-----------------+
34
+| 1        | Fuel 7.0 Master         | 2          | 4 GB      | 100 GB           | CentOS 6.5      |
35
++----------+-------------------------+------------+-----------+------------------+-----------------+
36
+| 3        | Openstack Controllers   | 2          | 4 GB      | 80 GB            | Ubuntu          |
37
++----------+-------------------------+------------+-----------+------------------+-----------------+
38
+| 2        | Openstack Compute       | 2          | 4 GB      | 80 GB            | Ubuntu          |
39
++----------+-------------------------+------------+-----------+------------------+-----------------+
40
+| 1        | Datera EDF Sim.         | 2          | 3 GB      | 64 GB + 100 GB   | DaterOS 1.0.1   |
41
++----------+-------------------------+------------+-----------+------------------+-----------------+
42
+
43
+Test Environment Mirantis Fuel 8.0
44
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
45
+
46
++----------+------------------------+------------+-----------+------------------+-----------------+
47
+| **VM**   | **Description**        | **vCPU**   | **RAM**   | **HD**           | **OS**          |
48
++----------+------------------------+------------+-----------+------------------+-----------------+
49
+| 1        | Fuel 8.0 Master        | 2          | 4 GB      | 75 GB            | CentOS 7.1      |
50
++----------+------------------------+------------+-----------+------------------+-----------------+
51
+| 3        | Openstack Controller   | 2          | 4 GB      | 3x50 GB          | Ubuntu          |
52
++----------+------------------------+------------+-----------+------------------+-----------------+
53
+| 2        | Openstack Compute      | 2          | 4 GB      | 3x50 GB          | Ubuntu          |
54
++----------+------------------------+------------+-----------+------------------+-----------------+
55
+| 1        | Datera EDF Sim.        | 2          | 4 GB      | 64 GB + 100 GB   | DaterOS 1.0.1   |
56
++----------+------------------------+------------+-----------+------------------+-----------------+
57
+
58
+Test coverage and metrics
59
+-------------------------
60
+The correct installation of the Datera EDF Cinder driver, the addition of the correct lines in the cinder.conf and with 100% coverage.
61
+
62
+Test results summary
63
+====================
64
+All test passed, the configuration lines were correctly inserted in the cinder.conf and the succesfull OSTF storage related operations were all visible in the Datera EDF user log while all tests passed.
65
+
66
+
67
+Type of testing
68
+===============
69
+**Coverage of features**
70
+
71
++--------------------------------------------+-------+
72
+| Parameters                                 | Value |
73
++--------------------------------------------+-------+
74
+| Total quantity of executed test cases      | 5     |
75
++--------------------------------------------+-------+
76
+| Total quantity of not executed test cases  | 0     |
77
++--------------------------------------------+-------+
78
+| Quantity of automated test cases           | 5     |
79
++--------------------------------------------+-------+
80
+| Quantity of not automated test cases       | 0     |
81
++--------------------------------------------+-------+
82
+
83
+Details test run results
84
+~~~~~~~~~~~~~~~~~~~~~~~~
85
+
86
++---------+--------------------------------+--------+--------+---------+--------------------------------------+
87
+| #       | Test Case ID                   | Passed | Failed | Skipped | Comment                              |
88
++---------+--------------------------------+--------+--------+---------+--------------------------------------+
89
+| 1       | datera_plugin_deploy_env       | ✓      |        |         |                                      |
90
++---------+--------------------------------+--------+--------+---------+--------------------------------------+
91
+| 2       | datera_plugin_modify_env       | ✓      |        |         |                                      |
92
++---------+--------------------------------+--------+--------+---------+--------------------------------------+
93
+| 3       | datera_plugin_modify_env_1     | ✓      |        |         |                                      |
94
++---------+--------------------------------+--------+--------+---------+--------------------------------------+
95
+| 4       | datera_plugin_deployed_remove  | ✓      |        |         |                                      |
96
++---------+--------------------------------+--------+--------+---------+--------------------------------------+
97
+| 5       | datera_plugin_remove           | ✓      |        |         |                                      |
98
++---------+--------------------------------+--------+--------+---------+--------------------------------------+
99
+| Total   |                                | 5      |        |         |                                      |
100
++---------+--------------------------------+--------+--------+---------+--------------------------------------+
101
+| Total % |                                | 100    |        |         |                                      |
102
++---------+--------------------------------+--------+--------+---------+--------------------------------------+
103
+
104
+Known issues
105
+------------
106
+In the datera_plugin_modify_env and datera_plugin_modify_env_1 there is an exception for one OSTF test due to a problem with Fuel. The respective test is the 'Check that the required services are running`. This bug has been present since 6.0 and is described in launchpad under Fuel bug number `1457515 <https://bugs.launchpad.net/fuel/+bug/1457515>`_.
107
+
108
+Appendix
109
+========
110
+* `Datera EDF <http://www.datera.io/>`_
111
+* `Mirantis Fuel Plugins <https://www.mirantis.com/validated-solution-integrations/fuel-plugins/>`_
112
+* `Datera EDF Fuel Tests <https://github.com/snuf/fuel-devops-datera/blob/master/plugin_datera/test_plugin_datera.py>`_
113
+

+ 158
- 0
doc/datera-cinder-guide.rst View File

@@ -0,0 +1,158 @@
1
+de to the Datera Cinder Plugin version 1.0.0 for Fuel
2
+********************************************************
3
+
4
+This document provides instructions for installing, configuring and using
5
+the Datera Cinder plugin for Fuel.
6
+
7
+Key terms, acronyms and abbreviations
8
+=====================================
9
+
10
+Cluster Management VIP:
11
+    Management Virtual IP (MVIP) is the IP address (or hostname) of
12
+    the management interface to the Datera Elastic Data Fabric.
13
+
14
+Admin login:
15
+    The Cluster Admin or Openstack login on a Datera EDF.
16
+
17
+Datera Replication Factor:
18
+    The number of replicas of a volume will be made in the Datera EDF.
19
+
20
+Datera Cinder
21
+=============
22
+
23
+The Datera Cinder Fuel plugin automates the addition of the required
24
+lines to the cinder.conf file to leverage the Datera EDF. It also
25
+installs the correct cinder driver. The Datera EDF API has moved to v2 
26
+and prior to Mitaka only v1 is supported by the bundled Datera cinder
27
+driver, v2 is not backwards compatible.
28
+The Datera Fuel plugin also extends the UI and enables a user to provide
29
+the necessary details to configure cinder correctly,
30
+
31
+License
32
+-------
33
+
34
+=======================   ==================
35
+Component                  License type
36
+=======================   ==================
37
+Datera Cinder Driver      Apache 2.0
38
+
39
+=======================   ==================
40
+
41
+Requirements
42
+------------
43
+
44
+======================= ==================
45
+Requirement             Version/Comment   
46
+======================= ==================
47
+Fuel                    7.0               
48
+----------------------- ------------------
49
+Fuel                    8.0               
50
+======================= ================== 
51
+
52
+Prerequisites
53
+--------------
54
+
55
+* The Datera EDF should be conffigured and reachable for the compute and 
56
+  controller+cinder nodes.
57
+  
58
+* The EDF has to be configured and reachable prior to starting Cinder with
59
+  the Datera EDF configuration in place.
60
+
61
+============================================
62
+
63
+Limitations
64
+-----------
65
+
66
+* Fuel 7.0 does not support multiple storage backends in Cinder,
67
+  therefore the Datera Cinder Fuel plugin when applied to 7.0 does not 
68
+  support multiple backends.
69
+
70
+* The Datera Cinder Fuel Plugin does support creating a multi-backend
71
+  configuration by selecting the checkbox in Fuel 8.0.
72
+
73
+Installation Guide
74
+==================
75
+
76
+
77
+Datera Cinder plugin installation
78
+----------------------------------
79
+
80
+#. Download the plugin from
81
+   `Fuel Plugins Catalog <https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/>`_.
82
+
83
+#. Copy the plugin to Fuel Master node. If no Fuel master node is present
84
+   please follow the instructions of the Mirantis Fuel documentation:
85
+
86
+   ::
87
+
88
+      scp fuel-plugin-datera-cinder-1.0-1.0.0.noarch.rpm \
89
+          root@:<the_Fuel_Master_node>:
90
+
91
+#. Log into the Fuel Master node and install the plugin:
92
+
93
+   ::
94
+
95
+        fuel plugins --install fuel-plugin-datera-cinder-1.0-1.0.0.noarch.rpm
96
+
97
+Datera Cinder plugin configuration
98
+-----------------------------------
99
+
100
+The configuration for both Fuel 7.0 and 8.0, differences will be marked.
101
+
102
+#. After the plugin is installed, create a new OpenStack environment following:
103
+    `The openstack creation guide for Mirantis Fuel 7.0 <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_. or 
104
+    `The quickstart guide for Mirantis Fuel 8.0 <https://docs.mirantis.com/openstack/fuel/fuel-8.0/quickstart-guide.html>`_.
105
+
106
+#. Configure your environment following:
107
+    `The Mirantis Fuel 7.0 Configuration Documentation <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#configure-your-environment>`_. or 
108
+    `The Mirantis Fuel 8.0 Planning Documentation <https://docs.mirantis.com/openstack/fuel/fuel-8.0/mos-planning-guide.html>`_.
109
+    ** Make sure to also add the Cinder role for the controllers, if the Cinder role is not selected the Datera EDF plugin will NOT configure Cinder **
110
+
111
+#. In Fuel 7.0: Open the *Settings tab* of the Fuel web UI, scroll down, 
112
+   select 'Fuel plugin to enable Datera driver in Cinder.' on the left.
113
+
114
+      .. image:: figures/cinder-datera-plugin-1.0.0-7.0.png
115
+         :width: 100%
116
+
117
+#. In Fuel 8.0: Open the *Settings tab* of the Fuel web UI, scroll down
118
+   select 'storage' on the left and select the Datera Fuel plugin.
119
+
120
+      .. image:: figures/cinder-datera-plugin-1.0.0-8.0.png
121
+         :width: 100%
122
+
123
+#. 'Multibackend enabled':
124
+    By default the Datera plugin will not use Multibackend as a configuration option. This means that the configuration options will be set in the 'default' context of the cinder.conf file. In Fuel 8.0 the 'Multibackend enabled' checkbox can be set to support  multiple backends in cinder, which will put the configuration options in it's own Datera context.
125
+
126
+#. 'Cluster Management VIP (san_ip)': 
127
+    The IP or DNS name of the management VIP for the Datera EDF.
128
+
129
+#. 'Login for Admin account (san_login)':
130
+    The username of the account that has the correct rights to provision storage, this can be the Openstack user, the admin user or a specific tenant user.
131
+
132
+#. 'Password for Admin account (san_password)':
133
+    The password for the previously mentioned account.
134
+
135
+#. 'Data replication factor': 
136
+    This setting dictates how many copies of an app-instance will be distributed over the Datera EDF using its smart placement policies.
137
+
138
+#. When configuration is complete the network check can be run and the 
139
+    environment can be deployed.
140
+
141
+User Guide
142
+==========
143
+
144
+Once Openstack is deployed by Fuel the Datera plugin provides no further 
145
+configuration or maintenance options.
146
+The logs for the Datera EDF driver will output all the logging in the 
147
+cinder-volume log.
148
+
149
+Known issues
150
+============
151
+
152
+Due to Fuels lack of support for multiple cinder backends in Fuel 7.0, only a 
153
+single storage vendor backend may be automatically configured within Fuel
154
+If multiple vendors are required the cinder.conf needs to be edited manually for
155
+Fuel 7.0.
156
+
157
+Appendix
158
+========

+ 1
- 1
environment_config.yaml View File

@@ -31,6 +31,6 @@ attributes:
31 31
   datera_num_replicas:
32 32
     value: '2'
33 33
     label: 'Data replication factor'
34
-    description: 'Repliacte data X times over the cluster'
34
+    description: 'Replicate data X times over the cluster'
35 35
     weight: 50
36 36
     type: "text"

+ 2
- 2
metadata.yaml View File

@@ -1,11 +1,11 @@
1 1
 name: fuel-plugin-datera-cinder
2 2
 title: Fuel Datera driver for Cinder
3
-version: '0.1.51'
3
+version: '1.0.0'
4 4
 description: Installs and enables the Datera driver in Cinder
5 5
 fuel_version: ['7.0', '8.0']
6 6
 licenses: ['Apache License Version 2.0']
7 7
 authors: [ 'Funs Kessen <funs@barred.org>' ]
8
-homepage: 'https://github.com/stackforge/fuel-plugin-datera-cinder'
8
+homepage: 'https://github.com/openstack/fuel-plugin-datera-cinder'
9 9
 groups: ['storage::cinder']
10 10
 
11 11
 releases:

Loading…
Cancel
Save