Mellanox OFED (MLNX_OFED) is a tested and packaged version of OFED and
supports two interconnect types using the same RDMA (remote DMA) and kernel
bypass APIs called OFED verbs – InfiniBand and Ethernet.

Overview

The Mellanox charm installs the Mellanox Ethernet driver software and configures it to enable
maximum performance for a Mellanox Ethernet adapter. The charm will also program the adapter
firmware if the adapter is standard. If it is not standard one will need to program it outside
the charm for that you can download the Mellanox Firmware Tool at the following URL
Mellanox Firmware tools.

About Mellanox:

Mellanox Technologies (NASDAQ: MLNX) is a leading supplier of end-to-end InfiniBand and Ethernet
interconnect solutions and services for servers and storage. Mellanox interconnect solutions
increase data center efficiency by providing the highest throughput and lowest latency, delivering
data faster to applications and unlocking system performance capability. Mellanox offers a choice
of fast interconnect products: adapters, switches, software and silicon that accelerate application
runtime and maximize business results for a wide range of markets including high performance
computing, enterprise data centers, Web 2.0, cloud, storage and financial services. More information
is available at Mellanox.

Founded in 1999, Mellanox Technologies is headquartered in Sunnyvale, California and Yokneam, Israel.

Usage

Deploy the Mellanox charm from the Juju GUI or the command line:

juju deploy mellanox

Before the Mellanox software can be installed one must explicitly accept the Mellanox software
license (that can be found in the Mellanox_license.txt
in the charm directory). To accept the Mellanox license, set the configuration option
accept-mellanox-license to True. Changing the configuration options can be done from the Juju GUI
or from the command line:

juju set mellanox accept-mellanox-license=True

If the license is not accepted the Mellanox software will not be installed.

Intel hardware (x86)

The Mellanox charm can be configured to run on x86 hardware. To run on Intel
hardware set theofed-file and md5sum configuration values appropriately.
Go to "Downloads" section on the
Mellanox product webpage
to find the version and architecture of software that you wish to install.
For example:

juju set mellanox ofed-file=MLNX_OFED_LINUX-2.3-2.0.0-ubuntu14.04-x86_64.tgz
juju set mellanox md5sum=0985c1a6d991b1169e32bebe2c146980

Power hardware (ppc)

The Mellanox charm defaults to the PowerPC version in config.yaml file.
To change the version of popc64le Mellanox software installed you must change
the ofed-file and the md5sum configuration options:

juju set mellanox ofed-file=MLNX_OFE enteredD_LINUX-(version)-ubuntu14.04-ppc64le.tgz
juju set mellanox md5sum=(md5sum of the version)

Go to "Downloads" section on the
Mellanox product webpage
select the version and Ubuntu 14.04 to find the md5sum of each file.

Deploy using a configuration file

Alternately a configuration YAML file can be passed on deployment. Create a
YAML file that contains the following content:

mellanox:
  accept-mellanox-license: True
  ofed-file: "MLNX_OFED_LINUX-2.3-2.0.0-ubuntu14.04-x86_64.tgz"
  md5sum: "0985c1a6d991b1169e32bebe2c146980"

Then deploy the Mellanox charm with this configuration file:

juju deploy mellanox --config mellanox_x86.yaml

Relate the Mellanox charm to a container charm

Finally, the Mellanox charm must be related to another charm. The Mellanox
charm is what is known as a subordinate charm, meaning it does not get its
own container (or machine). For this charm to function correctly it must be
related to a container (machine) with a Mellanox Ethernet adpter.

juju add-relation mellanox <target-charm>

It is recommended to reboot the server after running the charm.

Known Limitations and Issues

The Mellanox software requires a Mellanox Ethernet adapter to fully operate.

Per server the configuration can change and additional tuning is required if
you can not get the full line performance measurements (e.g. ~40GbE).

Contact Information

Yael Leventer yaell@mellanox.com
Nurit Vilosny nuritv@mellanox.com

Mellanox

Configuration

ofed-file
(string)
                            This specifies the OFED version that should be installed.
The default file is for ppc. If you are using x86 please insert the 
filename:MLNX_OFED_LINUX-2.3-2.0.0-ubuntu14.04-x86_64.tgz 
for the same ofed version.
All file names can be found at:
http://www.mellanox.com/page/products_dyn?product_family=26

                        
MLNX_OFED_LINUX-2.3-2.0.0-ubuntu14.04-ppc64le.tgz
md5sum
(string)
                            The md5sum value for the ofed tar package of the version you specified.
This is available on the Mellanox website. http://www.mellanox.com/page/products_dyn?product_family=26

                        
56c36206d9fdfde8ae7deeb43a127b5f
accept-mellanox-license
(boolean)
                            The Mellanox software comes with special terms and conditions from
Mellanox and can only be used by accepting the terms and conditions.
Setting this option to True indicates that you have read and accept
the Mellanox OFED (MLNX_OFED) Software: End-User Agreement
found in the license file. The license file can be found in the root
directory of the charm source in the Mellanox-license.txt file.
**The Mellanox software cannot be installed until the terms and
contions are accepted.  The charm will not function correctly until
this configuration option is set to True.**