Jump to: navigation, search

Difference between revisions of "Mellanox-Quantum"

(Manual installation - for other OS.)
 
(41 intermediate revisions by 2 users not shown)
Line 1: Line 1:
  
 
+
This page is no longer available, refer to https://wiki.openstack.org/wiki/Mellanox-Neutron
= Overview =
 
== Mellanox Quantum Plugin ==
 
The Openstack Mellanox Quantum plugin supports Mellanox embedded switch functionality as part of the VPI (Ethernet/InfiniBand) HCA.
 
Mellanox Quantum Plugin allows hardware vNICs (based on SR-IOV virtual functions) per each Virtual Machine vNIC to have its unique
 
connectivity, security, and QoS attributes. Hardware vNICs can be mapped to the guest VMs through para-virtualization (using a Tap device), or directly as a Virtual PCI device to the guest, allowing higher performance and advanced features such as RDMA (remote direct memory access).
 
 
 
Hardware-based switching, provides better performance, functionality, and security/isolation for virtual cloud environments.
 
Future versions of the plug-in will include OpenFlow API to control and monitor the embedded switch and vNICs functionality
 
 
 
This plugin is implemented according to Plugin-Agent pattern.
 
 
 
 
 
            +-----------------+                      +--------------+
 
                  | Controller node |                      | Compute node |
 
        +-----------------------------------+    +-----------------------------------+
 
        |  +-----------+      +----------+  |    |  +----------+      +----------+  |
 
        |  |          |      |          |  |    |  |          |  zmq  |          |  |
 
        |  | Openstack | v2.0 | Mellanox |  | RPC |  | Mellanox |REQ/REP| Mellanox |  |
 
        |  | Quantum  +------+ Quantum  +-----------+ Quantum  +-------+ Embedded |  |
 
        |  |          |      | Plugin  |  |    |  | Agent    |      | Switch  |  |
 
        |  |          |      |          |  |    |  |          |      | (NIC)    |  |
 
        |  +-----------+      +----------+  |    |  +----------+      +----------+  |
 
        +-----------------------------------+    +-----------------------------------+
 
 
* Openstack Mellanox Quantum Plugin implements the Quantum v2.0 API.
 
* Mellanox Quantum Plugin processes the Quantum API calls and manages network segmentation ID allocation.
 
* The plugin uses databases to store configuration and allocation mapping.
 
* The plugin maintains compatibility to Linux Bridge Plugin, supports DHCP and L3 Agents by running L2 Linux Bridge Agent on Network Node.
 
* Mellanox Openstack Quantum Agent (L2 Agent) runs on each compute node.
 
* Agent should apply VIF connectivity based on mapping between a VIF (VM vNIC) and Embedded Switch port.
 
 
 
==  Mellanox Nova VIF Driver ==
 
The Mellanox Nova VIF driver should be used when running Mellanox Quantum Plugin. This driver supports the VIF plugin by binding vNIC (para-virtualized or SR-IOV  with optional RDMA guest access) to the embedded switch port.
 
 
 
== Prerequisites ==
 
'''The following are the Mellanox Quantum Plugin prerequisites:'''
 
 
 
1. The software package python-zmq ([https://github.com/zeromq/pyzmq github]) must be installed. EPEL repository can be used as well.
 
 
 
2. python-setuptools (use "yum install python-setuptools")
 
 
 
3. python-pip (use "yum install python-pip")
 
 
 
'''Prerequisites only for Compute Servers :'''
 
 
 
1. RH 6.3 or above.
 
 
 
2. Compute nodes should be equiped with Mellanox ConnectX®-3 Network Adapter ([http://www.mellanox.com/page/infiniband_cards_overview link])
 
 
 
3. Mellanox OFED 2.0.3 is installed. Contact [mailto:openstack@mellanox.com?subject=MLNX_OFED2.0  openstack@mellanox.com] to retreive this version.
 
Refer to Mellanox website for the latest OFED documentation ([http://www.mellanox.com/page/products_dyn?product_family=26 link])
 
 
 
4. Enable SR-IOV on ConnectX-3 card. Refer to [http://community.mellanox.com/community/develop/cloud-developers/blog/2013/04/07/mellanox-ofed-driver-installation-with-sr-iov Mellanox Community]
 
 
 
5. The software package iproute2 - ([http://www.linuxgrill.com/anonymous/iproute2/ Code] [http://www.policyrouting.org/iproute2.doc.html Documentation]) must be installed. Reuired only to be installed on compute nodes
 
 
 
6. The software package ethtool ([http://www.kernel.org/pub/software/network/ethtool/ Code]) must be installed (version 3.8 or higher). Reuired only to be installed on compute nodes.
 
 
 
7. oslo.config (use "pip-python install oslo.config"). Reuired only to be installed on compute nodes.
 
 
 
== Code Structure ==
 
 
 
Mellanox Quantum Plugin and the Nova VIF driver are located at [http://community.mellanox.com/docs/DOC-1187 Mellanox OpenStack RPMs]
 
 
 
1. Quantum Plugin package structure:
 
  quantum/etc/quantum/plugins/mlnx -plugin configuration
 
  mlnx_conf.ini - sample plugin configuration
 
 
 
  quantum/quantum/plugins/mlnx -  plugin code
 
  /agent - Agent code
 
  /common - common  code
 
  /db - plugin persistency model and wrapping methods
 
  mlnx_plugin.py - Mellanox Openstack Plugin
 
  rpc_callbacks.py - RPC handler for received messages
 
  agent_notify_api.py - Agent RPC notify methods
 
 
 
Mellanox Quantum Plugin is located under /quantum/quantum/plugins/.
 
 
 
2. Nova VIF driver package structure is:
 
  nova/nova/mlnx - nova vif driver code
 
 
 
Mellanox Nova VIF driver is located under /nova/virt/libvirt/.
 
 
 
= Mellanox Quantum Plugin Installation (for Grizzly) =
 
== On the Quantum Server Node ==
 
 
 
=== Creating MySQL database for Quantum Server ===
 
Quantum server uses MySQL database. Make sure you have running MySQL database for quantum.
 
 
 
If Quantum server is already running, you should stop it.
 
  #/etc/init.d/quantum-server stop
 
 
 
If you want to use a database that was created you have to drop it and create another one. For example:
 
  mysql -u root -ppassword <<EOF
 
  drop database if exists quantum;
 
  create database quantum;
 
  EOF
 
 
 
If you want to create a new one:
 
 
 
  mysql -u root -ppassword <<EOF
 
  drop database if exists quantum;
 
  create database quantum;
 
  GRANT ALL PRIVILEGES ON quantum.* TO 'quantum'@'localhost' IDENTIFIED BY 'password';
 
  GRANT ALL PRIVILEGES ON quantum.* TO 'quantum' IDENTIFIED BY 'password';
 
  FLUSH PRIVILEGES;
 
  EOF
 
 
 
=== Installation via RPMs - for RH6.3 and above ===
 
 
 
1. Download the RPMs from Mellanox Community [http://community.mellanox.com/docs/DOC-1187 OpenStack PRMs for Grizzly]
 
 
 
2. Install the required RPMs for the Quantum server:
 
  #yum localinstall python-quantum-2013.1.2-3.el6.noarch.rpm
 
  #yum localinstall openstack-quantum-2013.1.2-3.el6.noarch.rpm
 
  #yum localinstall openstack-quantum-mlnx-2013.1.2-3.el6.noarch.rpm
 
 
 
3. Modify the /etc/quantum/quantum.conf file.
 
  core_plugin = quantum.plugins.mlnx.mlnx_plugin.MellanoxEswitchPlugin
 
 
 
4. Modify the /etc/quantum/plugins/mlnx/mlnx_conf.ini file to reflect your environment.  Click [[Mellanox-Quantum#Mellanox_Quantum_Plugin_Configuration | here]] for configuration options.
 
 
 
 
 
5. Change the soft link to the plugin configuration (plugin.ini)
 
/etc/quantum/plugin.ini -> /etc/quantum/plugins/openvswitch/ovs_quantum_plugin.ini
 
 
 
  #unlink /etc/quantum/plugin.ini
 
  #ln -s /etc/quantum/plugins/mlnx/mlnx_conf.ini /etc/quantum/plugin.ini
 
 
 
6. Start the quantum server
 
  #/etc/init.d/quantum-server start
 
 
 
=== Manual installation - for other OS. ===
 
 
 
1. Make sure the Quantum server is installed and is stopped
 
  #/etc/init.d/quantum-server stop
 
 
 
2. Copy Mellanox OpenStack plugin to the installed quantum plugin directory (usually /usr/lib/python2.7/dist-packages/quantum/plugins).
 
  #git clone https://github.com/mellanox-openstack/mellanox-quantum-plugin
 
  #cd mellanox-quantum-plugin
 
  #git checkout v0.3
 
  #cp -a quantum/quantum/plugins/mlnx /usr/lib/python2.7/dist-packages/quantum/plugins
 
 
 
3. Modify the /etc/quantum/quantum.conf file.
 
  core_plugin = quantum.plugins.mlnx.mlnx_plugin.MellanoxEswitchPlugin
 
 
 
4. Copy the Mellanox plugin configuration.
 
  #mkdir -p /etc/quantum/plugins/mlnx
 
  #cp quantum/etc/quantum/plugins/mlnx/mlnx_conf.ini /etc/quantum/plugins/mlnx
 
 
 
5. Modify the /etc/quantum/plugins/mlnx/mlnx_conf.ini file to reflect your environment. Click [[Mellanox-Quantum#Mellanox_Quantum_Plugin_Configuration | here]] for configuration options.
 
 
 
6. If you run the Quantum server using init script - change the quantum server configuration to point to Mellanox Quantum Plugin
 
 
 
For example, In Ubuntu change /etc/default/quantum-server
 
QUANTUM_PLUGIN_CONFIG="/etc/quantum/plugins/mlnx/mlnx_conf.ini"
 
 
 
7 . Run the server.
 
  #quantum-server --config-file /etc/quantum/quantum.conf --config-file /etc/quantum/plugins/mlnx/mlnx_conf.ini
 
or
 
  #/etc/init.d/quantum-server start
 
 
 
==  On Compute Nodes ==
 
 
 
=== The eswitchd Daemon ===
 
 
 
Refer to Mellanox Community for the eSwitchd RPMs (click [http://community.mellanox.com/docs/DOC-1187 here]) and for the eSwitchd instllation ( click  [http://community.mellanox.com/docs/DOC-1126 here])
 
 
 
=== Nova-compute ===
 
 
 
1. Make sure nova is installed on your server.
 
   
 
2. Download and copy the Nova Mellanox VIF driver.
 
    #git clone https://github.com/mellanox-openstack/mellanox-quantum-plugin
 
    #cd mellanox-quantum-plugin
 
    #git checkout v0.3
 
    #cp -a nova/nova/virt/libvirt/mlnx /usr/lib/python2.6/site-packages/nova/virt/libvirt
 
 
 
or
 
 
 
  #wget https://github.com/mellanox-openstack/mellanox-quantum-plugin/archive/v0.3.tar.gz
 
  #tar zxvf v0.3
 
  #cp –a mellanox-quantum-plugin-0.3/nova/nova/virt/libvirt/mlnx /usr/lib/python2.6/site-packages/nova/virt/libvirt
 
 
 
3. Modify /etc/nova/nova.conf
 
    compute_driver=nova.virt.libvirt.driver.LibvirtDriver
 
    libvirt_vif_driver=nova.virt.libvirt.mlnx.vif.MlxEthVIFDriver
 
    fabric=default - specifies physical network for vNICs (currently support one fabric per node)
 
 
 
4. Restart Nova.
 
  #/etc/init.d/openstack-nova-compute restart
 
 
 
=== Quantum Agent ===
 
 
 
Installation via RPMs - for RH6.3 and above
 
 
 
1. Download the RPMs from Mellanox Community [http://community.mellanox.com/docs/DOC-1187 OpenStack PRMs for Grizzly]
 
 
 
2. Install the required RPMs for the Quantum agent:
 
  #yum localinstall python-quantum-2013.1.2-3.el6.noarch.rpm
 
  #yum localinstall openstack-quantum-2013.1.2-3.el6.noarch.rpm
 
  #yum localinstall openstack-quantum-mlnx-2013.1.2-3.el6.noarch.rpm
 
 
 
3. Copy the  /etc/quantum/quantum.conf file from the Quantum server, and adjust it if needed.
 
 
 
4. Modify the /etc/quantum/plugins/mlnx/mlnx_conf.ini file to reflect your environment.  Click [[Mellanox-Quantum#Mellanox_Quantum_Plugin_Configuration | here]] for configuration options.
 
 
 
5. Start the quantum agent
 
  #/etc/init.d/quantum-mlnx-agent start
 
 
 
= Mellanox Quantum Plugin Configuration =
 
== Quantum Configuration ==
 
1. Make the Mellanox plugin the current quantum plugin by editing quantum.conf and changing core_plugin.
 
  core_plugin = quantum.plugins.mlnx.mlnx_plugin.MellanoxEswitchPlugin
 
 
 
2. Database configuration: Install MySQL on the central server. Create a database named "quantum".
 
 
 
3. Plugin configuration:
 
Edit the configuration file: /etc/quantum/plugins/mlnx/mlnx_conf.ini
 
 
 
On central server node
 
 
 
  [DATABASE]
 
  '''sql_connection''' - The parameter should be changed to the connection of the Quantum DB used by the plugin.
 
                    It must match the mysql configuration. For example:
 
                    "mysql://quantum:password@127.0.0.1:3306/quantum"
 
  '''reconnect_interval''' = 2 (default)
 
 
 
 
 
  [MLNX]
 
  '''tenant_network_type''' - must be set on of supported tenant network types. 
 
                        Possible values: 'vlan' for Ethernet or 'ib' for Infiniband.'vlan' is the default.
 
  '''network_vlan_ranges''' - must be configured to specify the names of the physical networks
 
                        managed by the mellanox plugin, along with the ranges of VLAN IDs
 
                        available on each physical network for allocation to virtual networks.
 
                        Possible range is vlan range is 1-4093.
 
                        The default  is "default:1:100"
 
                        <fabric name >:<vlan range start>:<vlan end range>
 
 
On compute node(s)
 
 
 
  [AGENT]
 
  '''polling_interval''' - Polling interval (in seconds) for existing vNICs. The default is 2 seconds.
 
  '''rpc'''  - must be set to 'True'
 
 
 
  [ESWITCH]
 
  '''physical_interface_mapping''' -  the network_interface_mappings maps each physical network name to the physical interface (on top of Mellanox Adapter) connecting the node to that physical network. The format of this paramter is:    <fabric name>:< PF name> (Only releavant on Compute node). PF Name can either be the PF (Physical Function) Name or 'autoeth' for automatic Ethernet configuration,'autoib' for automatic Infiniband configuration.The default is  "default:autoeth". 
 
  '''vnic_type''' - type of VM network interface: 'direct' or 'hostdev' according to libvirt terminology.
 
        hostdev: this is the traditional method of assigning any generic PCI device to a guest (SR-IOV).
 
        direct: this is a method to provide macvtap device on top of the PCI device (default).
 
        bridge:  - When using Linux Bridge Plugin on top of eIPoIB device
 
  '''daemon_endpoint''' - eswitch daemon end point connection (URL) (default value='tcp://127.0.0.1:5001')
 
  '''request_timeout''' - the number of milliseconds the agent will wait for response on request to daemon. (default=3000 msec)
 
 
 
For a plugin configuration file example (Grizzly), please refer to [https://github.com/mellanox-openstack/mellanox-quantum-plugin/blob/stable/grizzly/quantum/etc/quantum/plugins/mlnx/mlnx_conf.ini Mellanox config *ini file].
 
 
 
==  Nova Configuration (Compute Node(s))  ==
 
------------------------------------
 
Edit the nova.conf file.
 
1. Configure the vif driver, and libvirt/vif type
 
  compute_driver=nova.virt.libvirt.driver.LibvirtDriver
 
  connection_type=libvirt
 
  libvirt_vif_driver=nova.virt.libvirt.mlnx.vif.MlxEthVIFDriver
 
2.  Configure vnic_type ('direct' or 'hostdev'). This will be the default vNIC type when creating a new vNIC. (for example, when using the dashboard it to create new vNIC, this will be the default type.
 
  vnic_type= direct
 
3. Define the embedded switch-managed physical network (currently  single fabric on node).
 
  fabric=default - specifies physical network for vNICs
 
4. Enable DHCP server to allow VMs to acquire IPs.
 
  quantum_use_dhcp=true
 
 
 
= Network Node =
 
Network node equipped with Mellanox Connectx-3 adapter card should be configured as follows:
 
 
 
1. Install Mellanox OFED.
 
 
 
2. Install Quantum linux bridge plugin and Quantum dhcp l3-agent:
 
 
 
  #yum install openstack-quantum 
 
  #yum install openstack-quantum-linuxbridge
 
 
 
3. Change the following configuration of the ini file (/etc/quantum/plugins/linuxbridge/linuxbridge_conf.ini)
 
  physical_interface_mappings = default:eth2 (when eth2 is normally the name for Ethernet interface of Mellanox adapters)
 
 
 
4. Configure the DHCP server accodring to the following guidelines
 
 
 
http://docs.openstack.org/trunk/openstack-network/admin/content/adv_cfg_dhcp_agent.html
 
 
 
4. Start the DHCP server
 
  #/etc/init.d/quantum-dhcp-agent start
 
  #/etc/init.d/quantum-linuxbridge-agent start
 
 
 
= InfiniBand support =
 
 
 
== Configuring the Subnet Manager ==
 
=== Configuring Partitions ===
 
 
 
== Configuring Qunatum Server and Compute Nodes==
 
=== Para-Virtualized ===
 
=== SR-IOV ===
 
 
 
== Configuring Network Node ==
 
 
 
= Usage Examples =
 
* In order to create SR-IOV interface refer to [http://www.mellanox.com/sdn/stage/pdf/Mellanox-OpenStack-OpenFlow-Solution.pdf Mellanox OpenStack solution document "Creating an SR-IOV Instance" chapter]
 
* In order to create Para-Virtualized interface refer to [http://www.mellanox.com/sdn/stage/pdf/Mellanox-OpenStack-OpenFlow-Solution.pdf Mellanox OpenStack solution document "Creating a Para-Virtualized vNIC Instance" chapter]
 
 
 
= References =
 
1. [http://www.mellanox.com/openstack/ http://www.mellanox.com/openstack/]
 
 
 
2. [https://github.com/mellanox-openstack Source repository]
 
 
 
3. [http://www.mellanox.com/page/products_dyn?product_family=26 Mellanox OFED]
 
 
 
4. [http://www.mellanox.com/sdn/stage/pdf/Mellanox-OpenStack-OpenFlow-Solution.pdf Mellanox OpenStack Solution Reference Architecture]
 
 
 
For more details, please refer your question to  [mailto:openstack@mellanox.com openstack@mellanox.com]
 
 
 
Return to [https://wiki.openstack.org/wiki/Mellanox-OpenStack  Mellanox-OpenStack] wiki page.
 

Latest revision as of 11:26, 3 September 2013

This page is no longer available, refer to https://wiki.openstack.org/wiki/Mellanox-Neutron