summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHamdy Khader <hamdyk@mellanox.com>2016-11-09 15:41:40 +0200
committerNoam Angel <noama@mellanox.com>2016-11-10 09:42:12 +0000
commit244325118c336be72df8bbd47cb3302aafe8d319 (patch)
tree80af12e9756e40f9fb16658eb1742f8a7e0abca6
parentf6a6cb4a4e76606c9864a319d1218c8885940911 (diff)
Added "Limitations" section, change version to 3.2.1 in docs
Notes
Notes (review): Code-Review+1: Noam Angel <noama@mellanox.com> Code-Review+1: Hamdy Khader <hamdyk@mellanox.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: Sun, 18 Dec 2016 18:50:39 +0000 Reviewed-on: https://review.openstack.org/395597 Project: openstack/fuel-plugin-mellanox Branch: refs/heads/master
-rw-r--r--doc/source/conf.py4
-rw-r--r--doc/source/index.rst2
-rw-r--r--doc/source/installation.rst7
-rw-r--r--doc/source/overview.rst6
-rw-r--r--doc/source/supported_images.rst2
5 files changed, 13 insertions, 8 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index bf9de10..d0b5d0f 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -57,7 +57,7 @@ copyright = u'2016, mellanox'
57# The short X.Y version. 57# The short X.Y version.
58version = '3.2' 58version = '3.2'
59# The full version, including alpha/beta/rc tags. 59# The full version, including alpha/beta/rc tags.
60release = '3.2-3.2.0-1' 60release = '3.2-3.2.1-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.
@@ -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-4 plugin ver. 3.2-3.2.0-1 for Fuel 8', 241 ('index', 'fuel-plugin-mellanox', u'Guide to the Mellanox ConnectX-4 plugin ver. 3.2-3.2.1-1 for Fuel 8',
242 [u'Mellanox'], 1) 242 [u'Mellanox'], 1)
243] 243]
244 244
diff --git a/doc/source/index.rst b/doc/source/index.rst
index e0d893a..ce3191f 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-4 Plugin ver. 3.2-3.2.0-1 for Fuel 7Guide to the Mellanox ConnectX-4 Plugin ver. 3.2-3.2.1-1 for Fuel
8===================================================================== 8=====================================================================
9 9
10User documentation 10User documentation
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
index 681e14e..ccb6d1d 100644
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -11,19 +11,19 @@ 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.2-3.2.0-1.noarch.rpm root@<Fuel_Master_ip>:/tmp 14 # scp mellanox-plugin-3.2-3.2.1-1.noarch.rpm root@<Fuel_Master_ip>:/tmp
15 15
16#. Install the plugin:: 16#. Install the plugin::
17 17
18 # cd /tmp 18 # cd /tmp
19 # fuel plugins --install mellanox-plugin-3.2-3.2.0-1.noarch.rpm 19 # fuel plugins --install mellanox-plugin-3.2-3.2.1-1.noarch.rpm
20 20
21#. 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::
22 22
23 # fuel plugins 23 # fuel plugins
24 # id | name | version | package_version 24 # id | name | version | package_version
25 # ---|-------------------|---------|---------------- 25 # ---|-------------------|---------|----------------
26 # 1 | mellanox-plugin | 3.2.0 | 3.0.0 26 # 1 | mellanox-plugin | 3.2.1 | 3.0.0
27 27
28#. Define bootstrap discovery parameters to be burnt on Mellanox Adapters cards: 28#. Define bootstrap discovery parameters to be burnt on Mellanox Adapters cards:
29 29
@@ -170,4 +170,3 @@ To install Mellanox plugin, follow these steps:
170#. When using SR-IOV you can set the number of virtual NICs (virtual functions) to up to 31 170#. When using SR-IOV you can set the number of virtual NICs (virtual functions) to up to 31
171 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).
172 In any case of SR-IOV hardware limitation, the installation will try to fallback a VF number to the default of 16 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.
173
diff --git a/doc/source/overview.rst b/doc/source/overview.rst
index 591db5c..49e553b 100644
--- a/doc/source/overview.rst
+++ b/doc/source/overview.rst
@@ -47,3 +47,9 @@ Requirements
47 (e.g. SN2700 (ETH), SB7700 (IB)). The switch ports should be configured specifically to use 100 Gb speed. No 47 (e.g. SN2700 (ETH), SB7700 (IB)). The switch ports should be configured specifically to use 100 Gb speed. No
48 additional configuration is required on the adapter side. 48 additional configuration is required on the adapter side.
49 49
50Limitations
51-----------
52| 1. when using iSER and bonding, the storage interface will be a virtual function under the first
53 port, and will not support failover.
54| 2. when using SR-IOV and bonding, the virtual functions will be created and allocated from the
55 first interface, and failover is not supported.
diff --git a/doc/source/supported_images.rst b/doc/source/supported_images.rst
index 49bec3c..be885b7 100644
--- a/doc/source/supported_images.rst
+++ b/doc/source/supported_images.rst
@@ -15,4 +15,4 @@ Supported images
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.2-3.2.0-1 is using MLNX_OFED_LINUX version 3.3-1.5.0. 18This Fuel Mellanox plugin ver. 3.2-3.2.1-1 is using MLNX_OFED_LINUX version 3.3-1.5.0.