Update fuel plugin repo Latest documentation changes

Change-Id: I4241e9b90b829b21fd03bfc0fefd1149d2d984bc
Co-Authored-By: Chaithanya Kopparthi<chaithanyak@biarca.com>
This commit is contained in:
Pradip Rawat 2016-12-12 15:11:39 +05:30
parent 8a27d6fcde
commit 64765d5812
8 changed files with 88 additions and 66 deletions

View File

@ -82,9 +82,10 @@ define config($add_backend,$storage_protocol,$backend_name,$storage_user,$storag
}
if $enable_multipath == true {
package { sg3-utils: ensure => 'installed' }
package { multipath-tools: ensure => 'installed' }
cinder_config {
"${sec_name}/use_multipath_for_image_xfer" : value => 'True';
"${sec_name}/enforce_multipath_for_image_xfer" : value => 'True';
}
}
if $suppress_logs == true {

View File

@ -3,12 +3,13 @@
Overview of the Kaminario Cinder plugin
=======================================
The Kaminario cinder fuel plugin helps configure Kaminario iSCSI and FC cinder drivers for Kaminario K2 All-Flash arrays in Mirantis Fuel OpenStack setup.It enables configuration of one or many Kaminario K2 backends. It installs the “krest” python library on cinder-volume node which is prerequisite for Kaminario iSCSI and FC cinder drivers.It enables configuration of various cinder and Kaminario specific options.
The Kaminario Cinder Plugin for Fuel assists in the configuration of the Kaminario Cinder driver for Kaminario K2 All-Flash array. The plugin enables configuration of one or many Kaminario K2 back-ends by installing the “krest” python library on cinder-volume node which is prerequisite for Kaminario iSCSI and FC cinder drivers.
Software prerequisites
----------------------
To use the Kaminario Cinder plugin, verify that your environment meets the following prerequisites:
To use the Kaminario Cinder plugin for Fuel, verify that your environment meets the following prerequisites:
============================ ======================================
Prerequisites Version/Comment
@ -18,9 +19,10 @@ Kaminario K2 All Flash Array K2 rest api version should be >= 2.2.0
============================ ======================================
* The Kaminario K2 All-Flash array should be configured with data and management path to the cinder volume nodes and data path to the nova compute nodes.
* For replication, replication peer should be configured
* To enable replication, a replication peer must be configured.
Limitations
-----------

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

View File

@ -7,7 +7,6 @@
Guide to the <PLUGIN NAME> plugin ver. <6-digit format>
=======================================================
Contents:
.. toctree::
:maxdepth: 2

View File

@ -1,9 +1,9 @@
Install Kaminario Cinder Plugin
===============================
Install Kaminario Cinder Plugin For Fuel
========================================
Before you install Kaminario Cinder Plugin ensure that you have installed and configured the Fuel Master node. Typically, you install a Fuel plugin before you deploy an OpenStack environment.
Before you install Kaminario Cinder Plugin for Fuel ensure that you have installed and configured the Fuel Master node. Typically, you need to install a Fuel plugin before you deploy an OpenStack environment.
**To install Kaminario Cinder Plugin:**

View File

@ -2,103 +2,112 @@
Plugin configuration
--------------------
**To configure Kaminario K2 Cinder plugin:**
**To configure Kaminario K2 Cinder plugin for Fuel:**
#. Create an OpenStack environment as described in the `Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment.html>`_:
* As part of the Create New OpenStack Environment wizard, click Storage Backends (fourth step in the wizard). The following screen appears:
#. As part of the **Create New OpenStack Environment** wizard, click **Storage Backends** (fourth step in the wizard). The following screen appears:
.. image:: ./images/new_openstack_environment.png
:width: 400pt
:alt: New Openstack Environment
* Under Block Storage, select the Kaminario checkbox.
* Click Next twice to finish the OpenStack Environment setup.
#. Under **Block Storage**, select the **Kaminario** checkbox.
#. Click **Next** twice to finish the OpenStack Environment setup.
.. image:: ./images/openstack_settings.png
:width: 400pt
:alt: OpenStack Settings
* In the Fuel environment click the Settings tab.
#. In the Fuel environment, click the **Settings** tab.
* In the navigation pane, click Storage snd scroll down to the Kaminario K2 for Cinder section.
#. In the navigation pane, click **Storage** snd scroll down to the **Kaminario K2 for Cinder** section.
.. image:: ./images/plugin_full_UI.png
:width: 400pt
:alt: OpenStack UI Full
* Under Storage Connection Types, Select ISCSI for Kaminario K2 iSCSI array or Fiber Channel for Kaminario K2 Fiber Channel array.
#. Under **Storage Connection Types**, select **ISCSI** for Kaminario K2 iSCSI array or **Fiber Channel** for Kaminario K2 Fiber Channel array.
* In the Cinder Volume Node field, enter the name of the Fuel node with Cinder role.
#. In the **Cinder Volume Node** field, enter the name of the Fuel node with Cinder role.
* In the Volume Backend Name field, enter a name for the backend storage.
#. In the **Volume Backend Name** field, enter a name for the backend storage.
* In the K2 Management IP field, enter the manaagement IP address for the K2 backend storage system.
#. In the **K2 Management IP** field, enter the manaagement IP address for the K2 backend storage system.
* In the username field, enter the username for accessing the K2 management.
#. In the **username** field, enter the username for accessing the K2 management.
* In the password field, enter the password for accessing the K2 management.
#. In the **password** field, enter the password for accessing the K2 management.
* In the Enable Replication checkbox, select the check box if you wish to enable replication for the K2 array.
#. In the **Enable Replication** checkbox, select the check box if you wish to enable replication for the K2 array. Please refer to the section `Configuring Replication`_
* In te Enable Multipath checkbox, select the check box if you wish to enable the multipath option.
#. In te **Enable Multipath** checkbox, select the check box if you wish to enable the multipath option.
* In the Surpress SSL Warnings checkbox, select the if you wish to suppress requests library SSL certificate warnings.
#. In the **Surpress SSL Warnings** checkbox, select the check box if you wish to suppress requests library SSL certificate warnings.
* In the Report Discard Supported checkbox if you wish to enable trim/unmap.
#. In the **Report Discard Supported** select the checkbox if you wish to enable trim/unmap.
* In the Filter Function field, enter a limit on total number of volumes that will be created on the K2 array.
#. In the **Filter Function** field, enter a limit on total number of volumes that will be created on the K2 array.
* In the Over-Subscription checkbox, configure the provisioning settings. If you don't select the checkbox the system will use the default value of x20;
example: "capabilities.total_volumes < 250"
Selecting the checkbox, calculates the reduction rate based on the existing data.
#. In the **Over-Subscription Ratio** checkbox, if you dont select the checkbox the system will use the default value of x20; Selecting the checkbox, calculates the reduction rate based on the existing data.
**Adding a new backend**
Adding a new backend
--------------------
If you want to configure multiple K2 backends, follow the steps below.
To add a new backend
**To add a new backend:**
* Select the Add a New Backend checkbox.
1. Select the **Add a New Backend** checkbox.
New fields appear for the second backend
New fields appear for the second backend
* Fill in the new backend fields by repeating the steps mentioned above.
.. image:: ./images/add_new_backend.png
:width: 400pt
:alt: Add New Backend
**Adding a new volume type**
2. Fill in the new backend fields by repeating the steps mentioned above.
You can define a new volume type. Volume types will be associated with specific backends. The volume back-end names can be any user-defined name. For each volume type, you should specify an attribute that will determine if the volume type includes deduplication and/or replication.
Adding a new volume type
------------------------
The system includes the following default settings:
You can define a new volume type. Volume types will be associated with specific backends through the Volume Backend Name. For each volume type, you can specify attributes that will determine if the volume type includes deduplication and/or replication.
Deduplication is enabled
**The system includes the following default settings:**
Replication is disabled
* Deduplication is enabled
* Replication is disabled
.. image:: ./images/add_new_volume.png
:width: 400pt
:alt: New Volume Type
* Select the Add New Volume Type checkbox.
1. Select the **Add New Volume Type** checkbox.
New fields appear for configuring the new volume type.
New fields appear for configuring the new volume type.
* In the Volume Type Name field, enter a user-defined and unique name for the volume type.
2. In the **Volume Type Name** field, enter a user-defined and unique name for the volume type.
* In the Volume Backend Name, enter the name of the backend that will be associated with this volume type.
3. In the **Volume Backend Name** field, enter the name of the backends that will be associated with this volume type.
* If the volume type should include replication, select the Enable Replication checkbox.
4. If the volume type should include replication, select the **Enable Replication** checkbox.
* If the volume type should not include deduplication, select the Enable Deduplication checkbox.
5. If the volume type should not include deduplication, de-select the **Enable Deduplication** checkbox.
* If you want to make this volume type the defualt volume type (Cinder will use this volume type when no other volume type have been specified), select the Default Type checkbox.
6. If you want to make this volume type the default volume type (Cinder will use this volume type when no other volume type have been specified), select the **Default Type** checkbox.
* To create additional volume types, select the Add New Volume Type checkbox and repeat the steps above.
7. To create additional volume types, select the **Add New Volume Type** checkbox and repeat the steps above.
**Configuring Replication**
.. _`Configuring Replication`:
Configuring Replication
-----------------------
As part of the configuration of the backend storage, you can configure replication.
@ -107,21 +116,21 @@ As part of the configuration of the backend storage, you can configure replicati
:alt: Replication
To configure replication:
**To configure replication:**
* Select the Enable Replication checkbox.
1. Select the **Enable Replication** checkbox.
New fields appear for configuring the replication target.
New fields appear for configuring the replication target.
* In the Replication Target IP field, enter the replication target management IP address.
2. In the **Replication Target IP** field, enter the replication target management IP address.
* In the Username field, enter the username for accessing the replication target.
3. In the **Username** field, enter the username for accessing the replication target.
* In the Password field, enter the password for accessing the replication target.
4. In the **Password** field, enter the password for accessing the replication target.
* In the RPO field, enter the recovery objective point in seconds. The value must be either 60 or multiples of 300 seconds.
5. In the **RPO** field, enter the recovery objective point in seconds. The value must be either 60 or multiples of 300 seconds.
If you have completed the configuration, click Save Settings.
If you have completed the configuration, click **Save Settings**.

View File

@ -1,9 +1,11 @@
Verification
============
Log in to the controller node from the Fuel-master node:
**To verify the deployment:**
1. Verify the status of cinder-volume service for Kaminario backend
1. Log in to the controller node from the Fuel-master node:
2. Verify the status of cinder-volume service for Kaminario backend
.. code-block:: console
@ -15,7 +17,7 @@ Log in to the controller node from the Fuel-master node:
2. Create a volume. Verify the volume and volume group from the Kaminario K2 all-flash array dashboard.
3. Create a volume. Verify the volume and volume group from the Kaminario K2 all-flash array dashboard.
.. code-block:: console
@ -31,7 +33,7 @@ Log in to the controller node from the Fuel-master node:
*Note:* The volume name is **cv-<cinder-volume-id>** and volume group name is **cvg-<cinder-volume-id>**.
3. Run the OpenStack Test Framework (OSTF). From the Fuel web UI:
4. Run the OpenStack Test Framework (OSTF). From the Fuel web UI:
* Click the **Health Check** tab
* Select the **Select All** checkbox
@ -62,9 +64,9 @@ Check the status of cinder volume service for Kaminario K2 backend.
The failures may be caused due to many causes, the following are few of them:
1. Kaminario rest-api version is lower than 2.2.0.
2. Kaminario K2 all-flash array version is lower than 5.8.
3. Data path between the Fuel nodes (having cinder and compute role) and the Kaminario K2 all-flash array is not present or inaccessible:
* Kaminario rest-api version is lower than 2.2.0.
* Kaminario K2 all-flash array version is lower than 5.8.
* Data path between the Fuel nodes (having cinder and compute role) and the Kaminario K2 all-flash array is not present or inaccessible:
.. image:: ./images/FC_HBA.png
:width: 400pt
@ -80,8 +82,7 @@ The failures may be caused due to many causes, the following are few of them:
4. Management IP of the Kaminario backend is not correct or inaccessible from the Fuel node having the Cinder role.
5. Wrong credentials (username and password) used for the Kaminario backend.
6. Improper configuration of the Kaminario Fuel plugin configuration options for; creating volume type and setting default volume type.
7. Improper use of Kaminario Fuel plugin configuration options like Filter Function, Goodness Function, Scheduler weighers and Scheduler filters.
8. Others.
* Management IP of the Kaminario backend is not correct or inaccessible from the Fuel node having the Cinder role.
* Wrong credentials (username and password) used for the Kaminario backend.
* Improper configuration of the Kaminario Fuel plugin configuration options for; creating volume type and setting default volume type.
* Others.

View File

@ -213,6 +213,16 @@ attributes:
- condition: "settings:cinder_kaminario.add_backend_1.value != true"
action: 'hide'
storage_password_1:
value: ""
label: 'Password'
description: 'The password for accessing K2 management'
weight: 120
type: "password"
restrictions:
- condition: "settings:cinder_kaminario.add_backend_1.value != true"
action: 'hide'
enable_replication_1:
value: false
label: 'Enable Replication'