Browse Source

Update fuel plugin repo Latest documentation

Change-Id: Ib0262d6bbed46b74af7ff23a56dcc510426f9630
Co-Authored-By: Chaithanya Kopparthi<chaithanyak@biarca.com>
Pradip Rawat 2 years ago
parent
commit
8a27d6fcde

+ 0
- 12
doc/plugin guide/source/configure.rst View File

@@ -1,12 +0,0 @@
1
-.. _pg-configure:
2
-
3
-Configure Kaiminario Cinder Plugin
4
-==================================
5
-
6
-Configuring the Kaminario plugin. 
7
-
8
-**To configure  Kaiminario Cinder Plugin:**
9
-
10
-#. 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>`_:
11
-
12
-#. Configure Kaminario K2 All Flash arrays

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

@@ -3,7 +3,7 @@
3 3
 Overview of the Kaminario Cinder plugin
4 4
 =======================================
5 5
 
6
-The Kaminario cinder fuel plugin helps in configuring Kaminario iSCSI and FC cinder drivers for Kaminario K2 All-Flash arrays in Mirantis Fuel OpenStack setup.It allows to configure and scale multiple Kaminario backends.It installs the “krest” python library on cinder-volume node which is prerequisite for Kaminario iSCSI and FC cinder drivers.It allows to configure various cinder and Kaminario specific option.
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.
7 7
 
8 8
 Software prerequisites 
9 9
 ----------------------
@@ -25,5 +25,4 @@ Kaminario K2 All Flash Array  K2 rest api version should be >= 2.2.0
25 25
 Limitations
26 26
 -----------
27 27
 
28
-No limitaitions
29
-
28
+No limitations.

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


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


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


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


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


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


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


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

@@ -3,7 +3,7 @@
3 3
 Install Kaminario Cinder Plugin
4 4
 ===============================
5 5
 
6
-Before you install Kaminario Cinder Plugin. You must have the Fuel Master node installed and configured before you can install the plugin. Typically, you install a Fuel plugin before you deploy an OpenStack environment.   
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.   
7 7
 
8 8
 **To install Kaminario Cinder Plugin:**
9 9
 
@@ -17,7 +17,7 @@ Before you install Kaminario Cinder Plugin. You must have the Fuel Master node i
17 17
 
18 18
       # scp cinder_kaminario-1.0-1.0.0-1.noarch.rpm root@fuel-master:/tmp
19 19
 
20
-#. Log into Fuel Master node CLI as root.
20
+#. Log in to Fuel Master node CLI as root.
21 21
 #. Install the plugin by typing:
22 22
 
23 23
    .. code-block:: console

+ 78
- 45
doc/plugin guide/source/plugin_configuration.rst View File

@@ -2,93 +2,126 @@
2 2
 Plugin configuration
3 3
 --------------------
4 4
 
5
-**To configure Kaminario Cinder plugin:**
5
+**To configure Kaminario K2 Cinder plugin:**
6 6
 
7
-* create environment in Fuel web UI by enabling kaminario option which is in Storage Backends tab.
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
+
9
+
10
+* As part of the Create New OpenStack Environment wizard, click Storage Backends (fourth step in the wizard). The following screen appears: 
8 11
 
9 12
    .. image:: ./images/new_openstack_environment.png
10 13
       :width: 400pt
11 14
       :alt: New Openstack Environment
12
-   
13
-
14
-* To configure the plugin go to settings tab and click on storage tab. 
15
+ 
16
+* Under Block Storage, select the Kaminario checkbox. 
17
+* Click Next twice to finish the OpenStack Environment setup. 
15 18
 
16 19
    .. image:: ./images/openstack_settings.png
17 20
       :width: 400pt
18 21
       :alt: OpenStack Settings
22
+ 
23
+* In the Fuel environment click the Settings tab. 
19 24
 
20
-* Following  are the basic options to configure the Kaminario Cinder Fuel Plugin 
25
+* In the navigation pane, click Storage snd scroll down to the Kaminario K2 for Cinder section. 
21 26
 
22
-   .. image:: ./images/basic_options.png
27
+   .. image:: ./images/plugin_full_UI.png
23 28
       :width: 400pt
24
-      :alt: Basic Settings
29
+      :alt: OpenStack UI Full
25 30
 
26
-*Storage Protocol*: Select ‘ISCSI‘ for Kaminario K2 All-Flash iSCSI array and ‘FC‘ forKaminario K2 All-Flash FC array
27 31
 
28
-*Cinder Node*: Specify the name of the cinder node to configure Kaminario backend
32
+* Under Storage Connection Types, Select ‘ISCSI‘ for Kaminario K2 iSCSI array or Fiber Channel for Kaminario K2 Fiber Channel array.
29 33
 
30
-*Kaminario storage IP*: Management IP for the Kaminario K2 All-Flash array
34
+* In the Cinder Volume Node field, enter the name of the Fuel node with Cinder role. 
31 35
 
32
-*Backend Name*: Specify the name for the Kaminario backend
36
+* In the Volume Backend Name field, enter a name for the backend storage.
33 37
 
34
-*Username*: Specify the username for the Kaminario K2 All-Flash array
38
+* In the K2 Management IP field, enter the manaagement IP address for the K2 backend storage system.
35 39
 
36
-*Password*: Specify the corresponding password for the user
40
+* In the username field, enter the username for accessing the K2 management.  
37 41
 
38
-* To add details of replication peer, check ‘Enable Replication‘ box and fill the following details
42
+* In the password field, enter the password for accessing the K2 management.
39 43
 
40
-   .. image:: ./images/replication.png
41
-      :width: 400pt
42
-      :alt: Replication
44
+* In the Enable Replication checkbox, select the check box if you wish to enable replication for the K2 array. 
43 45
 
44
-*IP address*: Specify the IP address for the replication peer
46
+* In te Enable Multipath checkbox, select the check box if you wish to enable the multipath option.
45 47
 
46
-*Username*: Specify the username for the replication peer
48
+* In the Surpress SSL Warnings checkbox, select the if you wish to suppress requests library SSL certificate warnings.
47 49
 
48
-*Password*: Specify the corresponding password for the user
50
+* In the Report Discard Supported checkbox if you wish to enable trim/unmap.
49 51
 
50
-*RPO*: Specify RPO value for replication, it should either 60 sec or multiples of 300 secs.
52
+* In the Filter Function field, enter a limit on total number of volumes that will be created on the K2 array.
51 53
 
52
-* To create a volume type check the ‘Create Volume Type‘ box and fill the following details
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; 
53 55
 
54
-   .. image:: ./images/create_volume_type.png
55
-      :width: 400pt
56
-      :alt: Create volume type
56
+  Selecting the checkbox, calculates the reduction rate based on the existing data.
57
+
58
+**Adding a new backend**
59
+
60
+If you want to configure multiple K2 backends, follow the steps below.
61
+
62
+To add a new backend
63
+
64
+* Select the Add a New Backend checkbox.
65
+
66
+New fields appear for the second backend
67
+
68
+* Fill in the new backend fields by repeating the steps mentioned above. 
69
+
70
+**Adding a new volume type**
57 71
 
58
-*Volume Type Name*: Specify a name for the volume type
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.
59 73
 
60
-*Advanced options*: To enable advanced functionalities like replication and nodedup check any one of three options
74
+The system includes the following default settings: 
61 75
 
62
-   .. image:: ./images/options.png
76
+Deduplication is enabled
77
+
78
+Replication is disabled
79
+
80
+   .. image:: ./images/add_new_volume.png
63 81
       :width: 400pt
64
-      :alt: Options
82
+      :alt: New Volume Type
83
+
84
+
85
+* Select the Add New Volume Type checkbox.
65 86
 
66
-*Default Type*: Check If the above-created volume type should be default volume type
87
+New fields appear for configuring the new volume type.
67 88
 
68
-*Enable Multipath*: Check this box in order to use multipath in cinder and nova
89
+* In the Volume Type Name field, enter a user-defined and unique name for the volume type. 
69 90
 
70
-*Suppress logs*: Check this box in order to suppress python ‘requests‘ library warnings.
91
+* In the Volume Backend Name, enter the name of the backend that will be associated with this volume type. 
71 92
 
72
-*Filter function*: Specify Filter function(optional)
93
+* If the volume type should include replication, select the Enable Replication checkbox. 
73 94
 
74
-*goodness function*: Specify goodness function(optional)
95
+* If the volume type should not include deduplication, select the Enable Deduplication checkbox.
75 96
 
76
-*Oversubscription Ratio*: If this is checked kaminario driver will calculate dynamically "max_over_subscription_ratio".
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.
77 98
 
78
-*Scheduler filters*: In order to enable scheduler filters explicitly, specify filter name separated by comma
99
+* To create additional volume types, select the Add New Volume Type checkbox and repeat the steps above. 
79 100
 
80
-*Scheduler weighers*: In order to enable scheduler weigher explicitly, specify weigher name separated by comma
101
+**Configuring Replication**
81 102
 
82
-*RPC Timeout*: Specify the rpc timeout, the default timeout is 60 sec
103
+As part of the configuration of the backend storage, you can configure replication. 
83 104
 
84
-   .. image:: ./images/new_backend.png
105
+   .. image:: ./images/replication.png
85 106
       :width: 400pt
86
-      :alt: New backend
107
+      :alt: Replication
108
+
87 109
 
88
-Check this option to add a new ‘Kaminario K2 All-Flash array‘ as a new backend or to scale the existing backend.
110
+To configure replication:
89 111
 
90
-* Specify new ‘volume_backend_name‘ to add a new backend 
112
+* Select the Enable Replication checkbox.
113
+
114
+New fields appear for configuring the replication target. 
115
+
116
+* In the Replication Target IP field, enter the replication target management IP address.
117
+
118
+* In the Username field, enter the username for accessing the replication target. 
119
+
120
+* In the Password field, enter the password for accessing the replication target. 
121
+
122
+* In the RPO field, enter the recovery objective point in seconds. The value must be either 60 or multiples of 300 seconds. 
123
+
124
+If you have completed the configuration, click Save Settings. 
125
+   
91 126
 
92
-* Use same ‘volume_backend_name‘ if scale an existing backend. This plugin supports the addition of 5 extra backends.
93 127
 
94
-This plugin is hot pluggable.One can deploy it again without disturbing the existing backends or existing setup.

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

@@ -1,7 +1,7 @@
1 1
 Verification
2 2
 ============
3 3
 
4
-Login into the controller node from the Fuel-master node:
4
+Log in to the controller node from the Fuel-master node:
5 5
 
6 6
 1. Verify the status of cinder-volume service for Kaminario backend
7 7
 
@@ -43,14 +43,14 @@ Login into the controller node from the Fuel-master node:
43 43
 Troubleshooting
44 44
 ===============
45 45
 
46
-On failure of the verification of Kaminario Fuel plugin or any Cinder volume operations related to the Kaminario backend, check the following log files for identifying the root cause of the failure:
46
+On failure of the verification of Kaminario Fuel plugin or any Cinder volume operations related to the Kaminario backend, check the following log files to identify the root cause of the failure:
47 47
 
48 48
 #. **/var/log/cinder/cinder-volume.log**
49 49
 #. **/var/log/cinder/cinder-api.log**
50 50
 #. **/var/log/cinder/cinder-scheduler.log**
51 51
 #. **/var/log/nova/nova-compute.log**
52 52
 
53
-Check the status of cinder volume service for Kaminario backend.
53
+Check the status of cinder volume service for Kaminario K2 backend.
54 54
 
55 55
    .. code-block:: console
56 56
 
@@ -60,10 +60,10 @@ Check the status of cinder volume service for Kaminario backend.
60 60
       :width: 400pt
61 61
       :alt: cinder_service_list
62 62
 
63
-The failures may be caused due to many possibilities, the following are few of them:
63
+The failures may be caused due to many causes, the following are few of them:
64 64
 
65
-1. Kaminario rest-api version is less than 2.2.0.
66
-2. Kaminario K2 all-flash array version is less than 5.8.
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 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:
68 68
 
69 69
    .. image:: ./images/FC_HBA.png
@@ -82,6 +82,6 @@ The failures may be caused due to many possibilities, the following are few of t
82 82
 
83 83
 4. Management IP of the Kaminario backend is not correct or inaccessible from the Fuel node having the Cinder role.
84 84
 5. Wrong credentials (username and password) used for the Kaminario backend.
85
-6. Not using the Kaminario Fuel plugin configuration options for; creating volume type and setting default volume type.
86
-7. No proper use of Kaminario Fuel plugin configuration options like Filter Function, Goodness Function, Scheduler weighers and Scheduler filters.
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 87
 8. Others.

Loading…
Cancel
Save