Browse Source

Update fuel plugin repo Latest documentation changes

Change-Id: I4241e9b90b829b21fd03bfc0fefd1149d2d984bc
Co-Authored-By: Chaithanya Kopparthi<chaithanyak@biarca.com>
Pradip Rawat 2 years ago
parent
commit
64765d5812

+ 2
- 1
deployment_scripts/puppet/modules/kaminario/manifests/init.pp View File

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

+ 5
- 3
doc/plugin guide/source/description.rst View File

@@ -3,12 +3,13 @@
3 3
 Overview of the Kaminario Cinder plugin
4 4
 =======================================
5 5
 
6
-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.
6
+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.
7 7
 
8 8
 Software prerequisites 
9 9
 ----------------------
10 10
 
11
-To use the Kaminario Cinder plugin, verify that your environment meets the following prerequisites:
11
+To use the Kaminario Cinder plugin for Fuel, verify that your environment meets the following prerequisites:
12
+
12 13
 
13 14
 ============================  ======================================
14 15
 Prerequisites                 Version/Comment
@@ -18,9 +19,10 @@ Kaminario K2 All Flash Array  K2 rest api version should be >= 2.2.0
18 19
 ============================  ======================================
19 20
 
20 21
 
22
+
21 23
 * 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.
22 24
 
23
-* For replication, replication peer should be configured
25
+* To enable replication, a replication peer must be configured. 
24 26
 
25 27
 Limitations
26 28
 -----------

BIN
doc/plugin guide/source/images/add_new_backend.png View File


+ 0
- 1
doc/plugin guide/source/index.rst View File

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

+ 3
- 3
doc/plugin guide/source/installation.rst View File

@@ -1,9 +1,9 @@
1 1
 
2 2
 
3
-Install Kaminario Cinder Plugin
4
-===============================
3
+Install Kaminario Cinder Plugin For Fuel
4
+========================================
5 5
 
6
-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.   
6
+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.   
7 7
 
8 8
 **To install Kaminario Cinder Plugin:**
9 9
 

+ 55
- 46
doc/plugin guide/source/plugin_configuration.rst View File

@@ -2,103 +2,112 @@
2 2
 Plugin configuration
3 3
 --------------------
4 4
 
5
-**To configure Kaminario K2 Cinder plugin:**
5
+**To configure Kaminario K2 Cinder plugin for Fuel:**
6 6
 
7 7
 #. 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>`_:
8 8
 
9 9
 
10
-* As part of the Create New OpenStack Environment wizard, click Storage Backends (fourth step in the wizard). The following screen appears: 
10
+#. As part of the **Create New OpenStack Environment** wizard, click **Storage Backends** (fourth step in the wizard). The following screen appears: 
11 11
 
12 12
    .. image:: ./images/new_openstack_environment.png
13 13
       :width: 400pt
14 14
       :alt: New Openstack Environment
15 15
  
16
-* Under Block Storage, select the Kaminario checkbox. 
17
-* Click Next twice to finish the OpenStack Environment setup. 
16
+#. Under **Block Storage**, select the **Kaminario** checkbox. 
17
+#. Click **Next** twice to finish the OpenStack Environment setup. 
18 18
 
19 19
    .. image:: ./images/openstack_settings.png
20 20
       :width: 400pt
21 21
       :alt: OpenStack Settings
22 22
  
23
-* In the Fuel environment click the Settings tab. 
23
+#. In the Fuel environment, click the **Settings** tab. 
24 24
 
25
-* In the navigation pane, click Storage snd scroll down to the Kaminario K2 for Cinder section. 
25
+#. In the navigation pane, click **Storage** snd scroll down to the **Kaminario K2 for Cinder** section. 
26 26
 
27 27
    .. image:: ./images/plugin_full_UI.png
28 28
       :width: 400pt
29 29
       :alt: OpenStack UI Full
30 30
 
31 31
 
32
-* Under Storage Connection Types, Select ‘ISCSI‘ for Kaminario K2 iSCSI array or Fiber Channel for Kaminario K2 Fiber Channel array.
32
+#. Under **Storage Connection Types**, select **ISCSI** for Kaminario K2 iSCSI array or **Fiber Channel** for Kaminario K2 Fiber Channel array.
33 33
 
34
-* In the Cinder Volume Node field, enter the name of the Fuel node with Cinder role. 
34
+#. In the **Cinder Volume Node** field, enter the name of the Fuel node with Cinder role. 
35 35
 
36
-* In the Volume Backend Name field, enter a name for the backend storage.
36
+#. In the **Volume Backend Name** field, enter a name for the backend storage.
37 37
 
38
-* In the K2 Management IP field, enter the manaagement IP address for the K2 backend storage system.
38
+#. In the **K2 Management IP** field, enter the manaagement IP address for the K2 backend storage system.
39 39
 
40
-* In the username field, enter the username for accessing the K2 management.  
40
+#. In the **username** field, enter the username for accessing the K2 management.  
41 41
 
42
-* In the password field, enter the password for accessing the K2 management.
42
+#. In the **password** field, enter the password for accessing the K2 management.
43 43
 
44
-* In the Enable Replication checkbox, select the check box if you wish to enable replication for the K2 array. 
44
+#. 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`_
45 45
 
46
-* In te Enable Multipath checkbox, select the check box if you wish to enable the multipath option.
46
+#. In te **Enable Multipath** checkbox, select the check box if you wish to enable the multipath option.
47 47
 
48
-* In the Surpress SSL Warnings checkbox, select the if you wish to suppress requests library SSL certificate warnings.
48
+#. In the **Surpress SSL Warnings** checkbox, select the check box if you wish to suppress requests library SSL certificate warnings.
49 49
 
50
-* In the Report Discard Supported checkbox if you wish to enable trim/unmap.
50
+#. In the **Report Discard Supported** select the checkbox if you wish to enable trim/unmap.
51 51
 
52
-* In the Filter Function field, enter a limit on total number of volumes that will be created on the K2 array.
52
+#. In the **Filter Function** field, enter a limit on total number of volumes that will be created on the K2 array.
53 53
 
54
-* 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; 
54
+   example: "capabilities.total_volumes < 250"
55 55
 
56
-  Selecting the checkbox, calculates the reduction rate based on the existing data.
56
+#. In the **Over-Subscription Ratio** checkbox, if you don’t select the checkbox the system will use the default value of x20; Selecting the checkbox, calculates the reduction rate based on the existing data. 
57 57
 
58
-**Adding a new backend**
58
+Adding a new backend
59
+--------------------
59 60
 
60 61
 If you want to configure multiple K2 backends, follow the steps below.
61 62
 
62
-To add a new backend
63
+**To add a new backend:**
64
+
65
+1. Select the **Add a New Backend** checkbox.
63 66
 
64
-* Select the Add a New Backend checkbox.
67
+   New fields appear for the second backend
65 68
 
66
-New fields appear for the second backend
69
+   .. image:: ./images/add_new_backend.png
70
+      :width: 400pt
71
+      :alt: Add New Backend
67 72
 
68
-* Fill in the new backend fields by repeating the steps mentioned above. 
73
+2. Fill in the new backend fields by repeating the steps mentioned above. 
69 74
 
70
-**Adding a new volume type**
75
+Adding a new volume type
76
+------------------------
71 77
 
72
-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.
78
+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.
73 79
 
74
-The system includes the following default settings: 
80
+**The system includes the following default settings:** 
75 81
 
76
-Deduplication is enabled
82
+* Deduplication is enabled
77 83
 
78
-Replication is disabled
84
+* Replication is disabled
79 85
 
80 86
    .. image:: ./images/add_new_volume.png
81 87
       :width: 400pt
82 88
       :alt: New Volume Type
83 89
 
84 90
 
85
-* Select the Add New Volume Type checkbox.
91
+1. Select the **Add New Volume Type** checkbox.
92
+
93
+   New fields appear for configuring the new volume type.
86 94
 
87
-New fields appear for configuring the new volume type.
95
+2. In the **Volume Type Name** field, enter a user-defined and unique name for the volume type. 
88 96
 
89
-* In the Volume Type Name field, enter a user-defined and unique name for the volume type. 
97
+3. In the **Volume Backend Name** field, enter the name of the backends that will be associated with this volume type. 
90 98
 
91
-* In the Volume Backend Name, enter the name of the backend that will be associated with this volume type. 
99
+4. If the volume type should include replication, select the **Enable Replication** checkbox. 
92 100
 
93
-* If the volume type should include replication, select the Enable Replication checkbox. 
101
+5. If the volume type should not include deduplication, de-select the **Enable Deduplication** checkbox.
94 102
 
95
-* If the volume type should not include deduplication, select the Enable Deduplication checkbox.
103
+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.
96 104
 
97
-* 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.
105
+7. To create additional volume types, select the **Add New Volume Type** checkbox and repeat the steps above. 
98 106
 
99
-* To create additional volume types, select the Add New Volume Type checkbox and repeat the steps above. 
107
+.. _`Configuring Replication`:
100 108
 
101
-**Configuring Replication**
109
+Configuring Replication
110
+-----------------------
102 111
 
103 112
 As part of the configuration of the backend storage, you can configure replication. 
104 113
 
@@ -107,21 +116,21 @@ As part of the configuration of the backend storage, you can configure replicati
107 116
       :alt: Replication
108 117
 
109 118
 
110
-To configure replication:
119
+**To configure replication:**
111 120
 
112
-* Select the Enable Replication checkbox.
121
+1. Select the **Enable Replication** checkbox.
113 122
 
114
-New fields appear for configuring the replication target. 
123
+   New fields appear for configuring the replication target. 
115 124
 
116
-* In the Replication Target IP field, enter the replication target management IP address.
125
+2. In the **Replication Target IP** field, enter the replication target management IP address.
117 126
 
118
-* In the Username field, enter the username for accessing the replication target. 
127
+3. In the **Username** field, enter the username for accessing the replication target. 
119 128
 
120
-* In the Password field, enter the password for accessing the replication target. 
129
+4. In the **Password** field, enter the password for accessing the replication target. 
121 130
 
122
-* In the RPO field, enter the recovery objective point in seconds. The value must be either 60 or multiples of 300 seconds. 
131
+5. In the **RPO** field, enter the recovery objective point in seconds. The value must be either 60 or multiples of 300 seconds. 
123 132
 
124
-If you have completed the configuration, click Save Settings. 
133
+If you have completed the configuration, click **Save Settings**. 
125 134
    
126 135
 
127 136
 

+ 13
- 12
doc/plugin guide/source/troubleshooting.rst View File

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

+ 10
- 0
environment_config.yaml View File

@@ -213,6 +213,16 @@ attributes:
213 213
        - condition: "settings:cinder_kaminario.add_backend_1.value != true"
214 214
          action: 'hide'
215 215
 
216
+  storage_password_1:
217
+    value: ""
218
+    label: 'Password'
219
+    description: 'The password for accessing K2 management'
220
+    weight: 120
221
+    type: "password"
222
+    restrictions:
223
+       - condition: "settings:cinder_kaminario.add_backend_1.value != true"
224
+         action: 'hide'
225
+
216 226
   enable_replication_1:
217 227
     value: false
218 228
     label: 'Enable Replication'

Loading…
Cancel
Save