Fix README.md with ConnectX-4 release changes
Added required changes for README.md file based on latest ConnectX-4 release Change-Id: Ib6888d47d5745a1f7fadc0a6982fc39f11b53338
This commit is contained in:
parent
0843ad6cac
commit
8fd5a11650
50
README.md
50
README.md
|
@ -6,13 +6,12 @@ Mellanox plugin overview
|
|||
|
||||
The Mellanox Fuel plugin is a bundle of scripts, packages and metadata that will extend Fuel
|
||||
and add Mellanox features such as SR-IOV for networking and iSER protocol for storage.
|
||||
Fuel can configure Mellanox ConnectX-3 Pro network adapters to accelerate the performance of
|
||||
Fuel can configure Mellanox ConnectX-4 network adapters to accelerate the performance of
|
||||
compute and storage traffic.
|
||||
This implements the following performance enhancements:
|
||||
|
||||
- Compute nodes network enhancements:
|
||||
- SR-IOV based networking
|
||||
- QoS for VM traffic
|
||||
- VXLAN traffic offload
|
||||
- Cinder nodes use iSER block storage as the iSCSI transport rather than the default iSCSI over
|
||||
TCP.
|
||||
|
@ -36,20 +35,10 @@ Requirements
|
|||
|----------------------------------|-----------------|
|
||||
| Mirantis OpenStack compatibility | 8.0 |
|
||||
|
||||
The Mellanox ConnectX-3 Pro adapters family supports up to 40/56 Gb. To reach 56 Gb speed in
|
||||
your network with ConnectX-3 Pro adapters, you must use Mellanox Ethernet / Infiniband switches
|
||||
supporting 56 Gb (e.g. SX1710, SX6710). The switch ports should be configured specifically to use
|
||||
56 Gb speed. No additional configuration is required on the adapter side. For additional
|
||||
information about how to run in 56GbE speed, see [HowTo Configure 56GbE Link on Mellanox Adapters
|
||||
and Switches](http://community.mellanox.com/docs/DOC-1460).
|
||||
|
||||
Limitations
|
||||
-----------
|
||||
|
||||
- Mellanox SR-IOV is supported only when choosing Neutron with VLAN segmentation.
|
||||
- ConnectX-3 Pro adapters are required in order to enable VXLAN HW offload over Ethernet networks.
|
||||
- QoS feature is implemented only for Ethernet VLAN SR-IOV ports using ConnectX-3 Pro adapters.
|
||||
- Infiniband is configured by using OpenSM only.
|
||||
The Mellanox ConnectX-4 adapters family supports up to 100 Gb/s. To reach 100 Gb/s speed in your
|
||||
network with ConnectX-4 adapters, you must use Mellanox Ethernet / Infiniband switches supporting
|
||||
100 Gb (e.g. SN2700 (ETH), SB7700 (IB)). The switch ports should be configured specifically to
|
||||
use 100 Gb speed. No additional configuration is required on the adapter side.
|
||||
|
||||
Mellanox plugin configuration
|
||||
=============================
|
||||
|
@ -75,14 +64,14 @@ To install Mellanox plugin, follow these steps:
|
|||
3. Copy the plugin on already installed Fuel Master. scp can be used for that:
|
||||
|
||||
```
|
||||
# scp mellanox-plugin-3.0-3.0.0-1.noarch.rpm root@<Fuel_Master_ip>:/tmp
|
||||
# scp mellanox-plugin-3.2-3.2.0-1.noarch.rpm root@<Fuel_Master_ip>:/tmp
|
||||
```
|
||||
|
||||
4. Install the plugin:
|
||||
|
||||
```
|
||||
# cd /tmp
|
||||
# fuel plugins --install mellanox-plugin-3.0-3.0.0-1.noarch.rpm
|
||||
# fuel plugins --install mellanox-plugin-3.2-3.2.0-1.noarch.rpm
|
||||
```
|
||||
|
||||
5. Verify the plugin was installed successfully by having it listed using ``fuel plugins`` command:
|
||||
|
@ -91,14 +80,15 @@ To install Mellanox plugin, follow these steps:
|
|||
# fuel plugins
|
||||
# id | name | version | package_version
|
||||
# ---|-------------------|---------|----------------
|
||||
# 1 | mellanox-plugin | 3.0.0 | 3.0.0
|
||||
# 1 | mellanox-plugin | 3.2.0 | 3.0.0
|
||||
```
|
||||
|
||||
6. Create new bootstrap image for supporting infiniband networks ``create_mellanox_vpi_bootstrap``
|
||||
can be used
|
||||
Example:
|
||||
|
||||
```
|
||||
[root@fuel ~]# create_mellanox_vpi_bootstrap
|
||||
[root@fuel ~]# create_mellanox_bootstrap --link_type eth --max_num_vfs 31
|
||||
Try to build image with data:
|
||||
bootstrap:
|
||||
certs: null
|
||||
|
@ -107,13 +97,29 @@ can be used
|
|||
. . .
|
||||
. . .
|
||||
Bootstrap image f790e9f8-5bc5-4e61-9935-0640f2eed949 has been activated.
|
||||
|
||||
[root@fuel ~]# create_mellanox_bootstrap --help
|
||||
|
||||
usage: create_mellanox_bootstrap [-h] [--link_type {eth,ib,current}]
|
||||
[--max_num_vfs MAX_NUM_VFS]
|
||||
Available link_type values are:
|
||||
-------------------------------
|
||||
- eth for changing link type to Ethernet
|
||||
- ib for changing link type to Infiniband
|
||||
- current for leaving link type as is
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
--link_type {eth,ib,current}
|
||||
--max_num_vfs MAX_NUM_VFS
|
||||
an integer for the maximum number of vfs to be
|
||||
burned in bootstrap
|
||||
```
|
||||
|
||||
7. In case of using the customized bootstrap image, you must reboot your target nodes with the
|
||||
new bootstrap image you just created. If you already have discovered nodes you can either reboot
|
||||
them manually or use `reboot_bootstrap_nodes` command. Run `reboot_bootstrap_nodes -h` for help.
|
||||
|
||||
|
||||
User Guide
|
||||
==========
|
||||
|
||||
|
@ -133,3 +139,5 @@ Contributors
|
|||
* Amichay Polishuk <amichayp@mellanox.com> (QA engineer)
|
||||
* Noam Angel <noama@mellanox.com> (QA engineer)
|
||||
* Tamara Wari <tamarasu@mellanox.com> (Verification engineer)
|
||||
* Alexander Fridman <sasha@mellanox.com> (E2E engineer)
|
||||
* Igor Braginsky<igorbr@mellanox.com> (E2E engineer)
|
||||
|
|
Loading…
Reference in New Issue