summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRawan Herzallah <rherzallah@asaltech.com>2016-06-27 11:06:53 +0000
committerRawan Herzallah <rherzallah@asaltech.com>2016-07-04 12:46:10 +0000
commit0843ad6cac4ce111fde55d762c7526f675190311 (patch)
tree6100239e3f28c492c25813e5ef702c5739ba9e33
parentdf713aecadd454c6eb0156b44e7607ac10100e11 (diff)
ConnectX-4 RST user guide manual3.2.0-1
updated commit for RST user guide manual Change-Id: Icb680457a6b35e88b0fe07b9a16c5a20f61d946a
Notes
Notes (review): Code-Review+1: Andrii Konovka <akonovka@mirantis.com> Code-Review+2: Aviram Bar-Haim <aviramb@mellanox.com> Workflow+1: Aviram Bar-Haim <aviramb@mellanox.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Mon, 04 Jul 2016 15:50:15 +0000 Reviewed-on: https://review.openstack.org/330656 Project: openstack/fuel-plugin-mellanox Branch: refs/heads/master
-rw-r--r--doc/source/_static/kernal_parameters.pngbin0 -> 7313 bytes
-rw-r--r--doc/source/appendix.rst3
-rw-r--r--doc/source/conf.py18
-rw-r--r--doc/source/definitions.rst6
-rw-r--r--doc/source/guide.rst55
-rw-r--r--doc/source/index.rst3
-rw-r--r--doc/source/installation.rst87
-rw-r--r--doc/source/known_issues.rst24
-rw-r--r--doc/source/overview.rst21
-rw-r--r--doc/source/release_notes.rst7
-rw-r--r--doc/source/supported_images.rst6
-rw-r--r--metadata.yaml2
12 files changed, 148 insertions, 84 deletions
diff --git a/doc/source/_static/kernal_parameters.png b/doc/source/_static/kernal_parameters.png
new file mode 100644
index 0000000..9706f66
--- /dev/null
+++ b/doc/source/_static/kernal_parameters.png
Binary files differ
diff --git a/doc/source/appendix.rst b/doc/source/appendix.rst
index 5eb50f6..782da29 100644
--- a/doc/source/appendix.rst
+++ b/doc/source/appendix.rst
@@ -7,6 +7,9 @@ Appendix
7 7
8Mellanox site where users can read about possible configurations: 8Mellanox site where users can read about possible configurations:
9 9
10- `Mellanox ConnectX-4 <http://www.mellanox.com/page/products_dyn?product_family=201&mtag=connectx_4_vpi_card>`_
10- `Mellanox ConnectX-3 pro <http://www.mellanox.com/page/products_dyn?product_family=119&mtag=connectx_3_vpi>`_ 11- `Mellanox ConnectX-3 pro <http://www.mellanox.com/page/products_dyn?product_family=119&mtag=connectx_3_vpi>`_
11- `HowTo Install Mirantis Fuel OpenStack with Mellanox <https://community.mellanox.com/docs/DOC-2435>`_ 12- `HowTo Install Mirantis Fuel OpenStack with Mellanox <https://community.mellanox.com/docs/DOC-2435>`_
12- `Mellanox InfiniBand Switches <https://community.mellanox.com/docs/DOC-1164>`_ 13- `Mellanox InfiniBand Switches <https://community.mellanox.com/docs/DOC-1164>`_
14- `Mellanox NEO <http://www.mellanox.com/page/products_dyn?product_family=220&mtag=mellanox_neo>`_
15
diff --git a/doc/source/conf.py b/doc/source/conf.py
index a2fee16..bf9de10 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -47,7 +47,7 @@ source_suffix = '.rst'
47master_doc = 'index' 47master_doc = 'index'
48 48
49# General information about the project. 49# General information about the project.
50project = u'The Mellanox ConnectX-3 pro plugin for Fuel' 50project = u'The Mellanox ConnectX-4 plugin for Fuel'
51copyright = u'2016, mellanox' 51copyright = u'2016, mellanox'
52 52
53# The version info for the project you're documenting, acts as replacement for 53# The version info for the project you're documenting, acts as replacement for
@@ -55,9 +55,9 @@ copyright = u'2016, mellanox'
55# built documents. 55# built documents.
56# 56#
57# The short X.Y version. 57# The short X.Y version.
58version = '3.0' 58version = '3.2'
59# The full version, including alpha/beta/rc tags. 59# The full version, including alpha/beta/rc tags.
60release = '3.0-3.0.0-1' 60release = '3.2-3.2.0-1'
61 61
62# The language for content autogenerated by Sphinx. Refer to documentation 62# The language for content autogenerated by Sphinx. Refer to documentation
63# for a list of supported languages. 63# for a list of supported languages.
@@ -200,7 +200,7 @@ latex_elements = {
200# (source start file, target name, title, 200# (source start file, target name, title,
201# author, documentclass [howto, manual, or own class]). 201# author, documentclass [howto, manual, or own class]).
202latex_documents = [ 202latex_documents = [
203 ('index', 'fuel-plugin-mellanox.tex', u'The Mellanox ConnectX-3 pro Plugin for Fuel Documentation', 203 ('index', 'fuel-plugin-mellanox.tex', u'The Mellanox ConnectX-4 Plugin for Fuel Documentation',
204 u'Mellanox', 'manual'), 204 u'Mellanox', 'manual'),
205] 205]
206 206
@@ -238,7 +238,7 @@ latex_elements = { 'classoptions': ',openany,oneside', 'babel' : '\\usepackage[e
238# One entry per manual page. List of tuples 238# One entry per manual page. List of tuples
239# (source start file, name, description, authors, manual section). 239# (source start file, name, description, authors, manual section).
240man_pages = [ 240man_pages = [
241 ('index', 'fuel-plugin-mellanox', u'Guide to the Mellanox ConnectX-3 pro plugin ver. 3.0-3.0.0-1 for Fuel 8', 241 ('index', 'fuel-plugin-mellanox', u'Guide to the Mellanox ConnectX-4 plugin ver. 3.2-3.2.0-1 for Fuel 8',
242 [u'Mellanox'], 1) 242 [u'Mellanox'], 1)
243] 243]
244 244
@@ -252,8 +252,8 @@ man_pages = [
252# (source start file, target name, title, author, 252# (source start file, target name, title, author,
253# dir menu entry, description, category) 253# dir menu entry, description, category)
254texinfo_documents = [ 254texinfo_documents = [
255 ('index', 'fuel-plugin-mellanox', u'The Mellanox ConnectX-3 pro Plugin for Fuel Documentation', 255 ('index', 'fuel-plugin-mellanox', u'The Mellanox ConnectX-4 Plugin for Fuel Documentation',
256 u'Mellanox', 'fuel-plugin-mellanox', 'The Mellanox ConnectX-3 pro Plugin for Fuel Documentation', 256 u'Mellanox', 'fuel-plugin-mellanox', 'The Mellanox ConnectX-4 Plugin for Fuel Documentation',
257 'Miscellaneous'), 257 'Miscellaneous'),
258] 258]
259 259
@@ -269,7 +269,7 @@ texinfo_documents = [
269# If true, do not generate a @detailmenu in the "Top" node's menu. 269# If true, do not generate a @detailmenu in the "Top" node's menu.
270#texinfo_no_detailmenu = False 270#texinfo_no_detailmenu = False
271 271
272# Insert footnotes where they are defined instead of 272# Insert footnotes where they are defined instead of
273# at the end. 273# at the end.
274pdf_inline_footnotes = True 274pdf_inline_footnotes = True
275 275
@@ -278,7 +278,7 @@ pdf_inline_footnotes = True
278# -- Options for Epub output ---------------------------------------------- 278# -- Options for Epub output ----------------------------------------------
279 279
280# Bibliographic Dublin Core info. 280# Bibliographic Dublin Core info.
281epub_title = u'The Mellanox ConnectX-3 pro plugin' 281epub_title = u'The Mellanox ConnectX-4 plugin'
282epub_author = u'mellanox' 282epub_author = u'mellanox'
283epub_publisher = u'Mellanox' 283epub_publisher = u'Mellanox'
284epub_copyright = u'2016, Mellanox' 284epub_copyright = u'2016, Mellanox'
diff --git a/doc/source/definitions.rst b/doc/source/definitions.rst
index 88edde6..d136913 100644
--- a/doc/source/definitions.rst
+++ b/doc/source/definitions.rst
@@ -30,3 +30,9 @@ OpenSM
30 30
31PKey 31PKey
32 PKEY stands for partition key. It is a 16 bit field within the InfiniBand header called BTH (Base Transport Header). A collection of endnodes with the same PKey in their PKey Tables are referred to as being members of a partition. 32 PKEY stands for partition key. It is a 16 bit field within the InfiniBand header called BTH (Base Transport Header). A collection of endnodes with the same PKey in their PKey Tables are referred to as being members of a partition.
33
34ConnectX-4
35 `ConnectX-4 <http://www.mellanox.com/page/products_dyn?product_family=201&>`_ adapter cards with Virtual Protocol Interconnect (VPI), supporting EDR 100Gb/s InfiniBand and 100Gb/s Ethernet connectivity, provide the highest performance and most flexible solution for high-performance, Web 2.0, Cloud, data analytics, database, and storage platforms.
36
37NEO
38 Mellanox NEO™ is a powerful platform for managing scale-out computing networks. Mellanox NEO™ enables data center operators to efficiently provision, monitor and operate the modern data center fabric.
diff --git a/doc/source/guide.rst b/doc/source/guide.rst
index 9ceea46..9bed5b1 100644
--- a/doc/source/guide.rst
+++ b/doc/source/guide.rst
@@ -7,7 +7,8 @@ Mellanox plugin configuration
7 7
8If you plan to enable VM to VM RDMA and to use iSER storage transport you need to configure switching fabric to support the features. 8If you plan to enable VM to VM RDMA and to use iSER storage transport you need to configure switching fabric to support the features.
9 9
10**Ethernet network:** 10Ethernet network:
11-----------------
11 12
12#. Configure the required VLANs and enable flow control on the Ethernet switch ports. 13#. Configure the required VLANs and enable flow control on the Ethernet switch ports.
13#. All related VLANs should be enabled on the Mellanox switch ports (for relevant Fuel logical networks). 14#. All related VLANs should be enabled on the Mellanox switch ports (for relevant Fuel logical networks).
@@ -47,27 +48,47 @@ If you plan to enable VM to VM RDMA and to use iSER storage transport you need t
47 ... 48 ...
48 49
49 50
50**Infiniband network:** 51Infiniband network:
51If you use OpenSM you need to enable virtualization and allow all PKeys: 52-------------------
52 53
53#. Create a new opensm.conf file:: 54Mellanox **UFM** is a pre-requisite for using the Mellanox plugin for Fuel 8.0 with InfiniBand fabrics. Mellanox.s Unified Fabric Manager (UFM®) is a powerful platform for managing scale-out computing environments. UFM enables data center operators to monitor, efficiently provision, and operate the modern data center fabric. UFM is licensed per managed fabric node. For more information on how to obtain UFM, please visit Mellanox.com.
54 55
55 opensm -c /etc/opensm/opensm.conif 56Update OpenSM configurations on UFM node as follows:
56 57
57#. Enable virtualization by editing /etc/opensm/opensm.conf and changing the allow_both_pkeys value to TRUE.:: 58#. Update opensm.conf file and make sure of the following::
58 59
59 allow_both_pkeys TRUE 60 vim /opt/ufm/conf/opensm/opensm.conf
61 - virt_enabled 2
62 - no_partition_enforcement TRUE
63 - part_enforce off
64 - allow_both_pkeys FALSE
60 65
61#. Define the partition keys which are analog for Ethernet VLAN. Each VLAN will be mapped to one PK. Add/Change the following with the command :: 66#. Update the partitions.conf file::
62 67
63 vi /etc/opensm/partitions.conf file: 68 vim /opt/ufm/conf/partitions.conf.user_ext
64 (Example)
65 management=0x7fff,ipoib, sl=0, defmember=full : ALL, ALL_SWITCHES=full,SELF=full;
66 vlan1=0x1, ipoib, sl=0, defmember=full : ALL;
67 vlan2=0x2, ipoib, sl=0, defmember=full : ALL;
68 . . .
69 vlan100=0x64, ipoib, sl=0, defmember=full : ALL;
70 69
71#. Restart OpenSM:: 70 Example:
72 71
73 /etc/init.d/opensmd restart 72 vlan1=0x1, ipoib, sl=0, defmember=full: ALL_CAS;
73 vlan2=0x2, ipoib, sl=0, defmember=full: ALL_CAS;
74 vlan3=0x3, ipoib, sl=0, defmember=full: ALL_CAS;
75
76 vlan4=0x4, ipoib, sl=0, defmember=full: SELF;
77 vlan5=0x5, ipoib, sl=0, defmember=full: SELF;
78 vlan6=0x6, ipoib, sl=0, defmember=full: SELF;
79 vlan7=0x7, ipoib, sl=0, defmember=full: SELF;
80 vlan8=0x8, ipoib, sl=0, defmember=full: SELF;
81 vlan9=0x9, ipoib, sl=0, defmember=full: SELF;
82 . . .
83 vlan20=0x14, ipoib, sl=0, defmember=full: SELF;
84
85 **Note**: In this example
86
87 - Infra networks VLANs are 1-3 so VLAN2 is assigned to PK 0x2 and will be used for Openstack Management network and VLAN3 is assigned to PK 0x3 and will be used for Openstack Storage network.
88 - Private VLANs are 4-20 so VLANs 4 through 20 are assigned to PKs 0x4 to 0x14 will be used for Tenant networks.
89 - VLAN1 is defined, but not used for consistency with Ethernet setup installation.
90 - The maximum number of VLANs is 128.
91
92#. Restart ufmd::
93
94 /etc/init.d/ufmd restart
diff --git a/doc/source/index.rst b/doc/source/index.rst
index c8f547c..e0d893a 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -4,7 +4,7 @@
4 contain the root `toctree` directive. 4 contain the root `toctree` directive.
5 5
6===================================================================== 6=====================================================================
7Guide to the Mellanox ConnectX-3 pro Plugin ver. 3.0-3.0.0-1 for Fuel 7Guide to the Mellanox ConnectX-4 Plugin ver. 3.2-3.2.0-1 for Fuel
8===================================================================== 8=====================================================================
9 9
10User documentation 10User documentation
@@ -15,6 +15,7 @@ User documentation
15 15
16 definitions 16 definitions
17 overview 17 overview
18 release_notes
18 guide 19 guide
19 installation 20 installation
20 post_deployment 21 post_deployment
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
index c98ea52..681e14e 100644
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -11,22 +11,52 @@ To install Mellanox plugin, follow these steps:
11#. Download the plugin rpm file for MOS 8.0 from `Fuel Plugin Catalog <https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins>`_. 11#. Download the plugin rpm file for MOS 8.0 from `Fuel Plugin Catalog <https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins>`_.
12#. Copy the plugin on already installed Fuel Master. scp can be used for that.:: 12#. Copy the plugin on already installed Fuel Master. scp can be used for that.::
13 13
14 # scp mellanox-plugin-3.0-3.0.0-1.noarch.rpm root@<Fuel_Master_ip>:/tmp 14 # scp mellanox-plugin-3.2-3.2.0-1.noarch.rpm root@<Fuel_Master_ip>:/tmp
15
15#. Install the plugin:: 16#. Install the plugin::
16 17
17 # cd /tmp 18 # cd /tmp
18 # fuel plugins --install mellanox-plugin-3.0-3.0.0-1.noarch.rpm 19 # fuel plugins --install mellanox-plugin-3.2-3.2.0-1.noarch.rpm
19 20
20#. Verify the plugin was installed successfully by having it listed using ``fuel plugins`` command:: 21#. Verify the plugin was installed successfully by having it listed using ``fuel plugins`` command::
21 22
22 # fuel plugins 23 # fuel plugins
23 # id | name | version | package_version 24 # id | name | version | package_version
24 # ---|-------------------|---------|---------------- 25 # ---|-------------------|---------|----------------
25 # 1 | mellanox-plugin | 3.0.0 | 3.0.0 26 # 1 | mellanox-plugin | 3.2.0 | 3.0.0
27
28#. Define bootstrap discovery parameters to be burnt on Mellanox Adapters cards:
29
30 - **link_type** , available link_type values are:
31
32 - ``eth`` for changing link type to Ethernet
33 - ``ib`` for changing link type to Infiniband
34 - ``current`` for leaving link type as is
35
36 - **max_num_vfs** as integer, default is set to 16.
37
38#. Create Bootstrap discovery image for detecting Mellanox HW and support related configurations
39 with pre-defined parameters::
26 40
27#. Create new bootstrap image for supporting infiniband networks (``create_mellanox_vpi_bootstrap can be used``)::: 41 [root@fuel ~]# create_mellanox__bootstrap --link_type $link_type --max_num_vfs $max_num_vfs
42 [root@fuel ~]# create_mellanox_bootstrap --help
43
44 ::
45
46 usage: create_mellanox_bootstrap [-h] [--link_type {eth,ib,current}]
47 [--max_num_vfs MAX_NUM_VFS]
48 Available link_type values are:
49 -------------------------------
50 - eth for changing link type to Ethernet
51 - ib for changing link type to Infiniband
52 - current for leaving link type as is
53
54 optional arguments:
55 -h, --help show this help message and exit
56 --link_type {eth,ib,current}
57 --max_num_vfs MAX_NUM_VFS
58 an integer for the maximum number of vfs to be burned in bootstrap
28 59
29 [root@fuel ~]# create_mellanox_vpi_bootstrap
30 60
31 :: 61 ::
32 62
@@ -39,8 +69,24 @@ To install Mellanox plugin, follow these steps:
39 . . . 69 . . .
40 Bootstrap image f790e9f8-5bc5-4e61-9935-0640f2eed949 has been activated. 70 Bootstrap image f790e9f8-5bc5-4e61-9935-0640f2eed949 has been activated.
41 71
42#. In case of using the customized bootstrap image, you must reboot your target nodes with the new bootstrap image you just created. 72#. Reboot nodes after installing plugin::
43 If you already have discovered nodes you can either reboot them manually or use :bash: `reboot_bootstrap_nodes` command. Run :bash: `reboot_bootstrap_nodes -h` for help. 73
74 [root@fuel ~]# reboot_bootstrap_nodes -a
75 [root@fuel ~]# reboot_bootstrap_nodes -h
76
77 ::
78
79 Usage: reboot_bootstrap_nodes [-e environment_id] [-h] [-a]
80 This script is used to trigger reboot for nodes in 'discover' status,
81 of a given environment (if given) or of all environments.
82 Please wait for nodes to boot again after triggering this script.
83
84 Options:
85
86 -h Display the help message.
87 -e <env> Reboot all nodes in state 'discover' of the given environment.
88 -a Reboot all nodes in state 'discover' of all environments.
89
44 90
45#. Create an environment - for more information please see `how to create an environment <https://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html>`_. 91#. Create an environment - for more information please see `how to create an environment <https://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html>`_.
46 We support both main network configurations: 92 We support both main network configurations:
@@ -51,6 +97,12 @@ To install Mellanox plugin, follow these steps:
51 .. image:: ./_static/ml2_driver.png 97 .. image:: ./_static/ml2_driver.png
52 .. :alt: Network Configuration Type 98 .. :alt: Network Configuration Type
53 99
100#. Adjust the kernal parameters in the settings tab which is a condition for both iSER and SRIOV.
101 Open the Settings tab, select General section and then add ``intel_iommu=on`` at the beginning of the initial parameters.
102
103 .. image:: ./_static/kernal_parameters.png
104 .. :alt: Hypervisor Type
105
54#. Enable KVM hypervisor type. KVM is required to enable Mellanox Openstack features. 106#. Enable KVM hypervisor type. KVM is required to enable Mellanox Openstack features.
55 Open the Settings tab, select Compute section and then choose KVM hypervisor type. 107 Open the Settings tab, select Compute section and then choose KVM hypervisor type.
56 108
@@ -79,16 +131,6 @@ To install Mellanox plugin, follow these steps:
79 .. image:: ./_static/sriov.png 131 .. image:: ./_static/sriov.png
80 .. :alt: Enable SR-IOV 132 .. :alt: Enable SR-IOV
81 133
82 #. Support quality of service over VLAN networks with Mellanox SR-IOV direct ports (Neutron)
83 **Note**: Relevant for `VLAN segmentation` only
84 If selected, Neutron "Quality of service" (QoS) will be enabled for VLAN networks and ports over Mellanox HCAs.
85 **Note**: This feature is supported only if:
86
87 - Ethernet mode is used
88 - SR-IOV is enabled
89
90 .. image:: ./_static/qos.png
91 .. :alt: Enable QoS
92 134
93 #. Support NEO SDN controller auto VLAN Provisioning (Neutron) 135 #. Support NEO SDN controller auto VLAN Provisioning (Neutron)
94 **Note**: Relevant for `VLAN segmentation` only 136 **Note**: Relevant for `VLAN segmentation` only
@@ -102,13 +144,6 @@ To install Mellanox plugin, follow these steps:
102 144
103 Additional info about NEO can be found by link: https://community.mellanox.com/docs/DOC-2155 145 Additional info about NEO can be found by link: https://community.mellanox.com/docs/DOC-2155
104 146
105 #. Support VXLAN Offloading (Neutron)
106 **Note**: Relevant for `tunneling segmentation` only
107
108 If selected, Mellanox hardware will be used to achieve a better performance and significant CPU overhead reduction using VXLAN traffic offloading.
109
110 .. image:: ./_static/vxlan.png
111 .. :alt: Enable VXLAN offloading
112 147
113 #. iSER protocol for volumes (Cinder) 148 #. iSER protocol for volumes (Cinder)
114 **Note**: Relevant for both `VLAN segmentation` and `VLAN segmentation` deployments 149 **Note**: Relevant for both `VLAN segmentation` and `VLAN segmentation` deployments
@@ -132,7 +167,7 @@ To install Mellanox plugin, follow these steps:
132 167
133#. In Ethernet cloud, when using SR-IOV & iSER, one of the virtual NICs for SR-IOV will be reserved to the storage network. 168#. In Ethernet cloud, when using SR-IOV & iSER, one of the virtual NICs for SR-IOV will be reserved to the storage network.
134 169
135#. When using SR-IOV you can set the number of virtual NICs (virtual functions) to up to 62 170#. When using SR-IOV you can set the number of virtual NICs (virtual functions) to up to 31
136 if your hardware and system capabilities like memory and BIOS support it). 171 if your hardware and system capabilities like memory and BIOS support it).
137 In any case of SR-IOV hardware limitation, the installation will try to fallback a VF number to the default of 8 VFs. 172 In any case of SR-IOV hardware limitation, the installation will try to fallback a VF number to the default of 16 VFs.
138 173
diff --git a/doc/source/known_issues.rst b/doc/source/known_issues.rst
index f861d27..df7c1c2 100644
--- a/doc/source/known_issues.rst
+++ b/doc/source/known_issues.rst
@@ -6,11 +6,11 @@ Known issues
6============ 6============
7 7
8Issue 1 8Issue 1
9 - Description: For custom (OEM) adapter cards based on Mellanox ConnectX-3 / ConnectX-3 Pro ICs, adapter firmware must be manually burnt prior to the installation with SR-IOV support 9 - Description: For custom (OEM) adapter cards based on Mellanox ConnectX-4 ICs, adapter firmware must be manually burnt prior to the installation with SR-IOV support
10 - Workaround: See `the firmware installation instructions <http://www.mellanox.com/page/oem_firmware_download>`_. 10 - Workaround: See `the firmware installation instructions <http://www.mellanox.com/page/oem_firmware_download>`_.
11 11
12Issue 2 12Issue 2
13 - Description: The number of SR-IOV virtual functions supported by Mellanox adapters is up to 16 on ConnectX-3 adapters and up to 62 on ConnectX-3 Pro adapters (depends on your HW capabilities). 13 - Description: The number of SR-IOV virtual functions supported by Mellanox adapters is up to 31 on ConnectX-4 adapters (depends on your HW capabilities).
14 - Workaround: NA 14 - Workaround: NA
15 15
16Issue 3 16Issue 3
@@ -18,21 +18,21 @@ Issue 3
18 - Workaround: NA 18 - Workaround: NA
19 19
20Issue 4 20Issue 4
21 - Description: A single port HCA might not be supported for SRIOV and iSER over Ethernet network. 21 - Description: Changing port type in bootstrap stage over a single port HCA is not supported
22 - Workaround: NA 22 - Workaround: Create a bootstrap image with link type current, and change the port type manually.
23 23
24Issue 5 24Issue 5
25 - Description: SR-IOV QoS is supported only with updating SR-IOV existing ports with a policy. QoS-policy detach might result in non accurate bandwidth limit. (https://bugs.launchpad.net/neutron/+bug/1504165).
26 - Workaround: Delete port / instance and attach a new port.
27
28Issue 6
29 - Description: Starting large amount (>15) of IB VMs with normal port at once may result in some VMs not getting DHCP over InfiniBand networks. 25 - Description: Starting large amount (>15) of IB VMs with normal port at once may result in some VMs not getting DHCP over InfiniBand networks.
30 - Workaround: Reboot VMs that didn't get IP from DHCP on time or start VMs in smaller chunks (<10). 26 - Workaround: Reboot VMs that didn't get IP from DHCP on time or start VMs in smaller chunks (<10).
31 27
28Issue 6
29 - Description: Network verification for IB network is not supported over untagged networks or after deployment.
30 - Workaround: NA
31
32Issue 7 32Issue 7
33 - Description: After large InfinBand deployment of more than ~20 nodes at once with Controllers HA, it might take time for controllers services to stabilize. 33 - Description: When using NEO auto provisioning, network verification should fail for the private network VLANs
34 - Workaround: Restart openibd service on controller nodes after the deployment, or deploy with phases. 34 - Workaround: NA
35 35
36Issue 8 36Issue 8
37 - Description: Network verification for IB network is not supported over untagged networks or after deployment. 37 - Description: When deploying an Infiniband cluster with iSER over VLAN, all controllers should be deployed at once.
38 - Workaround: NA 38 - Workaround: Use untagged storage network when using Infiniband with iSER over VLAN, or deploy all controllers at once.
diff --git a/doc/source/overview.rst b/doc/source/overview.rst
index 56faec1..591db5c 100644
--- a/doc/source/overview.rst
+++ b/doc/source/overview.rst
@@ -8,8 +8,8 @@ Mellanox plugin
8| The Mellanox Fuel plugin is a bundle of scripts, packages and metadata that will extend Fuel 8| The Mellanox Fuel plugin is a bundle of scripts, packages and metadata that will extend Fuel
9 and add Mellanox features such as SR-IOV for networking and iSER protocol for storage. 9 and add Mellanox features such as SR-IOV for networking and iSER protocol for storage.
10 10
11| Fuel can configure `Mellanox ConnectX-3 Pro 11| Fuel can configure `Mellanox ConnectX-4
12 <http://www.mellanox.com/page/products_dyn?product_family=161&mtag=connectx_3_pro_vpi_card>`_ 12 <http://www.mellanox.com/page/products_dyn?product_family=201&mtag=connectx_4_vpi_card>`_
13 network adapters to accelerate the performance of compute and storage traffic. 13 network adapters to accelerate the performance of compute and storage traffic.
14 14
15This implements the following performance enhancements: 15This implements the following performance enhancements:
@@ -42,17 +42,8 @@ Requirements
42| Mirantis OpenStack compatibility | 8.0 | 42| Mirantis OpenStack compatibility | 8.0 |
43+-----------------------------------+-----------------+ 43+-----------------------------------+-----------------+
44 44
45| The Mellanox ConnectX-3 Pro adapters family supports up to 40/56 Gb. To reach 56 Gb speed in 45| The Mellanox ConnectX-4 adapters family supports up to 100 Gb/s. To reach 100 Gb/s speed in your
46 your network with ConnectX-3 Pro adapters, you must use Mellanox Ethernet / Infiniband switches 46 network with ConnectX-4 adapters, you must use Mellanox Ethernet / Infiniband switches supporting 100 Gb
47 supporting 56 Gb (e.g. SX1710, SX6710). The switch ports should be configured specifically to use 47 (e.g. SN2700 (ETH), SB7700 (IB)). The switch ports should be configured specifically to use 100 Gb speed. No
48 56 Gb speed. No additional configuration is required on the adapter side. For additional 48 additional configuration is required on the adapter side.
49 information about how to run in 56GbE speed, see `HowTo Configure 56GbE Link on Mellanox Adapters
50 and Switches <http://community.mellanox.com/docs/DOC-1460>`_.
51 49
52Limitations
53-----------
54
55- Mellanox SR-IOV is supported only when choosing Neutron with VLAN segmentation.
56- ConnectX-3 Pro adapters are required in order to enable VXLAN HW offload over Ethernet networks.
57- QoS feature is implemented only for Ethernet VLAN SR-IOV ports using ConnectX-3 Pro adapters.
58- Infiniband is configured by using OpenSM only.
diff --git a/doc/source/release_notes.rst b/doc/source/release_notes.rst
new file mode 100644
index 0000000..9448b7a
--- /dev/null
+++ b/doc/source/release_notes.rst
@@ -0,0 +1,7 @@
1.. raw:: pdf
2
3 PageBreak
4
5Release notes
6=============
7
diff --git a/doc/source/supported_images.rst b/doc/source/supported_images.rst
index bc07319..49bec3c 100644
--- a/doc/source/supported_images.rst
+++ b/doc/source/supported_images.rst
@@ -8,11 +8,11 @@ Supported images
8+-------+--------------------+---------------------------------+ 8+-------+--------------------+---------------------------------+
9| Issue | Supported OS | Tested kernel | 9| Issue | Supported OS | Tested kernel |
10+=======+====================+=================================+ 10+=======+====================+=================================+
11| 1 | CentOS7 | 3.10.0-229.14.1.el7.x86_64 | 11| 1 | CentOS7 | 3.10.0-327.13.1.e17.x86_64 |
12+-------+--------------------+---------------------------------+ 12+-------+--------------------+---------------------------------+
13| 2 | ubuntu14.04 | 3.13.0-67-generic | 13| 2 | ubuntu14.04 | 3.13.0-85-generic |
14+-------+--------------------+---------------------------------+ 14+-------+--------------------+---------------------------------+
15| 3 | Cirros Mellanox | 3.11.0-26-generic | 15| 3 | Cirros Mellanox | 3.11.0-26-generic |
16+-------+--------------------+---------------------------------+ 16+-------+--------------------+---------------------------------+
17 17
18This Fuel Mellanox plugin ver. 3.0-3.0.0-1 is using MLNX_OFED version 3.1-1.5.5. 18This Fuel Mellanox plugin ver. 3.2-3.2.0-1 is using MLNX_OFED_LINUX version 3.3-1.5.0.
diff --git a/metadata.yaml b/metadata.yaml
index 1e92dd0..8a5fe11 100644
--- a/metadata.yaml
+++ b/metadata.yaml
@@ -5,7 +5,7 @@ name: mellanox-plugin
5title: Mellanox ConnectX-4 Openstack Features 5title: Mellanox ConnectX-4 Openstack Features
6 6
7# Plugin version 7# Plugin version
8version: 3.1.18 8version: 3.2.0
9 9
10# Description 10# Description
11description: Enable features over Mellanox ConnectX-4 Adapters 11description: Enable features over Mellanox ConnectX-4 Adapters