From 6931adfe75f13077d15f200231e27c5d5da9a4af Mon Sep 17 00:00:00 2001 From: Funs Date: Fri, 10 Jun 2016 12:28:15 +0200 Subject: [PATCH] Add documentation, fixed a typo, bumped to 1.0.0 --- ...tReportForFuelPluginDateraCinder-1.0.0.rst | 113 +++++++++++++ doc/datera-cinder-guide.rst | 158 ++++++++++++++++++ environment_config.yaml | 2 +- metadata.yaml | 4 +- 4 files changed, 274 insertions(+), 3 deletions(-) create mode 100644 doc/TestReportForFuelPluginDateraCinder-1.0.0.rst create mode 100644 doc/datera-cinder-guide.rst diff --git a/doc/TestReportForFuelPluginDateraCinder-1.0.0.rst b/doc/TestReportForFuelPluginDateraCinder-1.0.0.rst new file mode 100644 index 0000000..6861fb7 --- /dev/null +++ b/doc/TestReportForFuelPluginDateraCinder-1.0.0.rst @@ -0,0 +1,113 @@ +Test Report for Datara-cinder-1.0.0 Fuel Plugin +=============================================== + +.. contents:: + :depth: 2 + +Revision history +================ + ++---------------+---------------------+--------------------------------------------------------------------------+----------------------------------------------+ +| **Version** | **Revision date** | **Editor** | **Comment** | ++---------------+---------------------+--------------------------------------------------------------------------+----------------------------------------------+ +| 0.1 | 23.01.2015 | Irina Povolotskaya | Created the template structure. | +| | | | | +| | | (`*ipovolotskaya@mirantis.com* `__) | | ++---------------+---------------------+--------------------------------------------------------------------------+----------------------------------------------+ +| 1.0 | 06.06.2016 | Funs Kessen <`*ftk@datera.io* `__> | Fuel Plugin Datera Cinder 1.0.0 Test Report. | ++---------------+---------------------+--------------------------------------------------------------------------+----------------------------------------------+ + +Document purpose +================ +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. + +Test environment +================ +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. + +Test Environment Mirantis Fuel 7.0 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + ++----------+-------------------------+------------+-----------+------------------+-----------------+ +| **VM** | **Description** | **vCPU** | **RAM** | **HD** | **OS** | ++----------+-------------------------+------------+-----------+------------------+-----------------+ +| 1 | Fuel 7.0 Master | 2 | 4 GB | 100 GB | CentOS 6.5 | ++----------+-------------------------+------------+-----------+------------------+-----------------+ +| 3 | Openstack Controllers | 2 | 4 GB | 80 GB | Ubuntu | ++----------+-------------------------+------------+-----------+------------------+-----------------+ +| 2 | Openstack Compute | 2 | 4 GB | 80 GB | Ubuntu | ++----------+-------------------------+------------+-----------+------------------+-----------------+ +| 1 | Datera EDF Sim. | 2 | 3 GB | 64 GB + 100 GB | DaterOS 1.0.1 | ++----------+-------------------------+------------+-----------+------------------+-----------------+ + +Test Environment Mirantis Fuel 8.0 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + ++----------+------------------------+------------+-----------+------------------+-----------------+ +| **VM** | **Description** | **vCPU** | **RAM** | **HD** | **OS** | ++----------+------------------------+------------+-----------+------------------+-----------------+ +| 1 | Fuel 8.0 Master | 2 | 4 GB | 75 GB | CentOS 7.1 | ++----------+------------------------+------------+-----------+------------------+-----------------+ +| 3 | Openstack Controller | 2 | 4 GB | 3x50 GB | Ubuntu | ++----------+------------------------+------------+-----------+------------------+-----------------+ +| 2 | Openstack Compute | 2 | 4 GB | 3x50 GB | Ubuntu | ++----------+------------------------+------------+-----------+------------------+-----------------+ +| 1 | Datera EDF Sim. | 2 | 4 GB | 64 GB + 100 GB | DaterOS 1.0.1 | ++----------+------------------------+------------+-----------+------------------+-----------------+ + +Test coverage and metrics +------------------------- +The correct installation of the Datera EDF Cinder driver, the addition of the correct lines in the cinder.conf and with 100% coverage. + +Test results summary +==================== +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. + + +Type of testing +=============== +**Coverage of features** + ++--------------------------------------------+-------+ +| Parameters | Value | ++--------------------------------------------+-------+ +| Total quantity of executed test cases | 5 | ++--------------------------------------------+-------+ +| Total quantity of not executed test cases | 0 | ++--------------------------------------------+-------+ +| Quantity of automated test cases | 5 | ++--------------------------------------------+-------+ +| Quantity of not automated test cases | 0 | ++--------------------------------------------+-------+ + +Details test run results +~~~~~~~~~~~~~~~~~~~~~~~~ + ++---------+--------------------------------+--------+--------+---------+--------------------------------------+ +| # | Test Case ID | Passed | Failed | Skipped | Comment | ++---------+--------------------------------+--------+--------+---------+--------------------------------------+ +| 1 | datera_plugin_deploy_env | ✓ | | | | ++---------+--------------------------------+--------+--------+---------+--------------------------------------+ +| 2 | datera_plugin_modify_env | ✓ | | | | ++---------+--------------------------------+--------+--------+---------+--------------------------------------+ +| 3 | datera_plugin_modify_env_1 | ✓ | | | | ++---------+--------------------------------+--------+--------+---------+--------------------------------------+ +| 4 | datera_plugin_deployed_remove | ✓ | | | | ++---------+--------------------------------+--------+--------+---------+--------------------------------------+ +| 5 | datera_plugin_remove | ✓ | | | | ++---------+--------------------------------+--------+--------+---------+--------------------------------------+ +| Total | | 5 | | | | ++---------+--------------------------------+--------+--------+---------+--------------------------------------+ +| Total % | | 100 | | | | ++---------+--------------------------------+--------+--------+---------+--------------------------------------+ + +Known issues +------------ +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 `_. + +Appendix +======== +* `Datera EDF `_ +* `Mirantis Fuel Plugins `_ +* `Datera EDF Fuel Tests `_ + diff --git a/doc/datera-cinder-guide.rst b/doc/datera-cinder-guide.rst new file mode 100644 index 0000000..7891ba7 --- /dev/null +++ b/doc/datera-cinder-guide.rst @@ -0,0 +1,158 @@ +de to the Datera Cinder Plugin version 1.0.0 for Fuel +******************************************************** + +This document provides instructions for installing, configuring and using +the Datera Cinder plugin for Fuel. + +Key terms, acronyms and abbreviations +===================================== + +Cluster Management VIP: + Management Virtual IP (MVIP) is the IP address (or hostname) of + the management interface to the Datera Elastic Data Fabric. + +Admin login: + The Cluster Admin or Openstack login on a Datera EDF. + +Datera Replication Factor: + The number of replicas of a volume will be made in the Datera EDF. + +Datera Cinder +============= + +The Datera Cinder Fuel plugin automates the addition of the required +lines to the cinder.conf file to leverage the Datera EDF. It also +installs the correct cinder driver. The Datera EDF API has moved to v2 +and prior to Mitaka only v1 is supported by the bundled Datera cinder +driver, v2 is not backwards compatible. +The Datera Fuel plugin also extends the UI and enables a user to provide +the necessary details to configure cinder correctly, + +License +------- + +======================= ================== +Component License type +======================= ================== +Datera Cinder Driver Apache 2.0 + +======================= ================== + +Requirements +------------ + +======================= ================== +Requirement Version/Comment +======================= ================== +Fuel 7.0 +----------------------- ------------------ +Fuel 8.0 +======================= ================== + +Prerequisites +-------------- + +* The Datera EDF should be conffigured and reachable for the compute and + controller+cinder nodes. + +* The EDF has to be configured and reachable prior to starting Cinder with + the Datera EDF configuration in place. + +============================================ + +Limitations +----------- + +* Fuel 7.0 does not support multiple storage backends in Cinder, + therefore the Datera Cinder Fuel plugin when applied to 7.0 does not + support multiple backends. + +* The Datera Cinder Fuel Plugin does support creating a multi-backend + configuration by selecting the checkbox in Fuel 8.0. + +Installation Guide +================== + + +Datera Cinder plugin installation +---------------------------------- + +#. Download the plugin from + `Fuel Plugins Catalog `_. + +#. Copy the plugin to Fuel Master node. If no Fuel master node is present + please follow the instructions of the Mirantis Fuel documentation: + + :: + + scp fuel-plugin-datera-cinder-1.0-1.0.0.noarch.rpm \ + root@:: + +#. Log into the Fuel Master node and install the plugin: + + :: + + fuel plugins --install fuel-plugin-datera-cinder-1.0-1.0.0.noarch.rpm + +Datera Cinder plugin configuration +----------------------------------- + +The configuration for both Fuel 7.0 and 8.0, differences will be marked. + +#. After the plugin is installed, create a new OpenStack environment following: + `The openstack creation guide for Mirantis Fuel 7.0 `_. or + `The quickstart guide for Mirantis Fuel 8.0 `_. + +#. Configure your environment following: + `The Mirantis Fuel 7.0 Configuration Documentation `_. or + `The Mirantis Fuel 8.0 Planning Documentation `_. + ** 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 ** + +#. In Fuel 7.0: Open the *Settings tab* of the Fuel web UI, scroll down, + select 'Fuel plugin to enable Datera driver in Cinder.' on the left. + + .. image:: figures/cinder-datera-plugin-1.0.0-7.0.png + :width: 100% + +#. In Fuel 8.0: Open the *Settings tab* of the Fuel web UI, scroll down + select 'storage' on the left and select the Datera Fuel plugin. + + .. image:: figures/cinder-datera-plugin-1.0.0-8.0.png + :width: 100% + +#. 'Multibackend enabled': + 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. + +#. 'Cluster Management VIP (san_ip)': + The IP or DNS name of the management VIP for the Datera EDF. + +#. 'Login for Admin account (san_login)': + 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. + +#. 'Password for Admin account (san_password)': + The password for the previously mentioned account. + +#. 'Data replication factor': + This setting dictates how many copies of an app-instance will be distributed over the Datera EDF using its smart placement policies. + +#. When configuration is complete the network check can be run and the + environment can be deployed. + +User Guide +========== + +Once Openstack is deployed by Fuel the Datera plugin provides no further +configuration or maintenance options. +The logs for the Datera EDF driver will output all the logging in the +cinder-volume log. + +Known issues +============ + +Due to Fuels lack of support for multiple cinder backends in Fuel 7.0, only a +single storage vendor backend may be automatically configured within Fuel +If multiple vendors are required the cinder.conf needs to be edited manually for +Fuel 7.0. + +Appendix +======== diff --git a/environment_config.yaml b/environment_config.yaml index b87bc99..800f4e9 100644 --- a/environment_config.yaml +++ b/environment_config.yaml @@ -31,6 +31,6 @@ attributes: datera_num_replicas: value: '2' label: 'Data replication factor' - description: 'Repliacte data X times over the cluster' + description: 'Replicate data X times over the cluster' weight: 50 type: "text" diff --git a/metadata.yaml b/metadata.yaml index e6a6d71..f860407 100644 --- a/metadata.yaml +++ b/metadata.yaml @@ -1,11 +1,11 @@ name: fuel-plugin-datera-cinder title: Fuel Datera driver for Cinder -version: '0.1.51' +version: '1.0.0' description: Installs and enables the Datera driver in Cinder fuel_version: ['7.0', '8.0'] licenses: ['Apache License Version 2.0'] authors: [ 'Funs Kessen ' ] -homepage: 'https://github.com/stackforge/fuel-plugin-datera-cinder' +homepage: 'https://github.com/openstack/fuel-plugin-datera-cinder' groups: ['storage::cinder'] releases: