Difference between revisions of "Neutron/NEC OpenFlow Plugin"
m (Amotoki moved page Quantum NEC OpenFlow Plugin to Neutron/NECOpenFlowPlugin: Renaming Quantum to Neutron) |
|||
Line 1: | Line 1: | ||
+ | = Neutron NEC OpenFlow plugin = | ||
+ | |||
== Abstract == | == Abstract == | ||
− | NEC [[OpenFlow]] plugin talks to [[OpenFlow]] Controller and each | + | NEC [[OpenFlow]] plugin talks to [[OpenFlow]] Controller and each Neutron would be mapped to an virtual layer-2 |
network slice on an [[OpenFlow]] enabled network. | network slice on an [[OpenFlow]] enabled network. | ||
− | The interface between the | + | The interface between the Neutron plugin and [[OpenFlow]] Controller is RESTful |
API. This API is supported by two implementations:Tream Sliceable Switch | API. This API is supported by two implementations:Tream Sliceable Switch | ||
(OSS) and NEC [[ProgrammableFlow]] Controller (NEC Commercial Product). | (OSS) and NEC [[ProgrammableFlow]] Controller (NEC Commercial Product). | ||
Line 9: | Line 11: | ||
This plugin consists of two components: "Plugin" and "Agent". | This plugin consists of two components: "Plugin" and "Agent". | ||
− | * '''Plugin''': It processes | + | * '''Plugin''': It processes Neutron API calls and controls [[OpenFlow]] controller to handle logical networks on [[OpenFlow]] enabled network. |
* '''Agent''': It runs on each compute node. It gathers a mapping beween a VIF and a switch port from local Open vSwitch and reports it to the plugin. | * '''Agent''': It runs on each compute node. It gathers a mapping beween a VIF and a switch port from local Open vSwitch and reports it to the plugin. | ||
Line 18: | Line 20: | ||
== Design == | == Design == | ||
− | [[File:quantum-nec-openflow-plugin-design.png|alt| | + | [[File:quantum-nec-openflow-plugin-design.png|alt|Neutron NEC OpenFlow] Plugin Design| width=600]] |
=== Communication between plugin and agent === | === Communication between plugin and agent === | ||
Line 24: | Line 26: | ||
This plugin uses "common-rpc" in openstack-common for the agents to | This plugin uses "common-rpc" in openstack-common for the agents to | ||
communicate with the plugin and will conform to the convention for scalable-agent-comms. | communicate with the plugin and will conform to the convention for scalable-agent-comms. | ||
− | The topic name for RPC will be set to " | + | The topic name for RPC will be set to "neutron.plugin" as proposed in the blueprint scalable-agent-comms. |
=== Integration with Nova === | === Integration with Nova === | ||
Line 33: | Line 35: | ||
== How to run this plugin == | == How to run this plugin == | ||
=== Using devstack === | === Using devstack === | ||
− | Devstack for this plugin is available at https://github.com/nec-openstack/devstack- | + | Devstack for this plugin is available at https://github.com/nec-openstack/devstack-neutron-nec-openflow . |
* This installs Tream Sliceable Switch (OSS [[OpenFlow]] Controller) and run devstack for this plugin. | * This installs Tream Sliceable Switch (OSS [[OpenFlow]] Controller) and run devstack for this plugin. | ||
Line 49: | Line 51: | ||
== How to get == | == How to get == | ||
− | * '''Folsom or later''' : Merged into the mainline of | + | * '''Folsom or later''' : Merged into the mainline of Neutron https://github.com/openstack/neutron |
* Previous releases (before merged into the mainline) are available at https://github.com/nec-openstack/quantum-openflow-plugin (essex and diablo) | * Previous releases (before merged into the mainline) are available at https://github.com/nec-openstack/quantum-openflow-plugin (essex and diablo) | ||
== Configuration == | == Configuration == | ||
=== Havana === | === Havana === | ||
− | |||
* neutron.conf | * neutron.conf |
Revision as of 13:16, 28 November 2013
Contents
Neutron NEC OpenFlow plugin
Abstract
NEC OpenFlow plugin talks to OpenFlow Controller and each Neutron would be mapped to an virtual layer-2 network slice on an OpenFlow enabled network. The interface between the Neutron plugin and OpenFlow Controller is RESTful API. This API is supported by two implementations:Tream Sliceable Switch (OSS) and NEC ProgrammableFlow Controller (NEC Commercial Product).
This plugin consists of two components: "Plugin" and "Agent".
- Plugin: It processes Neutron API calls and controls OpenFlow controller to handle logical networks on OpenFlow enabled network.
- Agent: It runs on each compute node. It gathers a mapping beween a VIF and a switch port from local Open vSwitch and reports it to the plugin.
Requirements
- OpenFlow Controller: Trema with Sliceable Switch (distributed under GPL2), or an OpenFlow Controller that has the same functionalities and REST API available at https://github.com/trema/apps/wiki/Sliceable-Network-Management-API .
Design
Communication between plugin and agent
This plugin uses "common-rpc" in openstack-common for the agents to communicate with the plugin and will conform to the convention for scalable-agent-comms. The topic name for RPC will be set to "neutron.plugin" as proposed in the blueprint scalable-agent-comms.
Integration with Nova
There are no need for additional features in Nova. This implementation utilizes a current libvirt VIF driver and linux-net interface driver.
How to run this plugin
Using devstack
Devstack for this plugin is available at https://github.com/nec-openstack/devstack-neutron-nec-openflow .
- This installs Tream Sliceable Switch (OSS OpenFlow Controller) and run devstack for this plugin.
- Sample localrc files are available in samples/nec-openflow:
- Controller node with OpenFlow controller : samples/nec-openflow/localrc
- Compute node : samples/nec-openflow/localrc-hv
- Branches
- folsom for stable/folsom release
- develop for trunk (next release)
Using Ubuntu packages
To be written.
How to get
- Folsom or later : Merged into the mainline of Neutron https://github.com/openstack/neutron
- Previous releases (before merged into the mainline) are available at https://github.com/nec-openstack/quantum-openflow-plugin (essex and diablo)
Configuration
Havana
- neutron.conf
# Neutron plugin provider module core_plugin = neutron.plugins.nec.nec_plugin.NECPluginV2
- Plugin specific configurations /etc/neutron/plugins/nec/nec.ini . Section "[OFC]" is particular configurations to NEC OpenFlow plugin.
[OFC] # OpenFlow Controller Host and Port to connect. host = 127.0.0.1 port = 8888 # Drivers are in neutron/plugins/nec/drivers/ . driver = trema # PacketFilter is available when it's enabled in this configuration # and supported by the driver. enable_packet_filter = true
- neutron plugin agent configuration : needs to use OVSInterfaceDriver to use DHCP agent (dhcp_agent.ini), L3 agent (l3_agent.ini) and other service agent (such as LBaaS HAProxy agent).
interface_driver = quantum.agent.linux.interface.OVSInterfaceDriver ovs_use_veth = True
- nova.conf : same as ML2 plugin
libvirt_vif_driver=nova.virt.libvirt.vif.LibvirtHybridOVSBridgeDriver
Grizzly
- Only difference from Folsom is 'interface_driver' in dhcp_agent.ini and l3_agent.ini. OVSVethInterfaceDriver is now merged into OVSInterfaceDriver.
interface_driver = quantum.agent.linux.interface.OVSInterfaceDriver ovs_use_veth = True
- Other configurations are same as Folsom.
Folsom
- quantum.conf
# Quantum plugin provider module core_plugin = quantum.plugins.nec.nec_plugin.NECPluginV2 # Path to the extensions. # It must be abosolute path (or relative path from the directory where quantum-server is invoked) api_extensions_path = /opt/stack/quantum/quantum/plugins/nec/extensions/
- Plugin specific configurations /etc/quantum/plugins/nec/nec.ini . Section "[OFC]" is particular configurations to NEC OpenFlow plugin.
[OFC] # OpenFlow Controller Host and Port to connect. host = 127.0.0.1 port = 8888 # Drivers are in quantum/plugins/nec/drivers/ . driver = trema # PacketFilter is available when it's enabled in this configuration # and supported by the driver. enable_packet_filter = true
- quantum agent configuration : needs to use OVSVethInterfaceDriver to use DHCP agent (dhcp_agent.ini), L3 agent (l3_agent.ini). It is a derivative of OVSInterfaceDriver that use veth netdev. It will be integrated into OVSInterfaceDriver.
interface_driver = quantum.agent.linux.interface.OVSVethInterfaceDriver
- nova.conf : same as OVS plugin
libvirt_vif_driver=nova.virt.libvirt.vif.LibvirtHybridOVSBridgeDriver
Essex
Essex version of Quantum NEC OpenFlow plugin is available at https://github.com/nec-openstack/quantum-openflow-plugin . Note that the implemetation of Essex version uses a dedicated VIF driver to gather a mapping beween a VIF and a switch port from local Open vSwitch. The proposed version of this plugin uses the agent for this purpose.
Related websites
- Github repositories of NEC OpenStack team : https://github.com/nec-openstack/
- Trema - Full-Stack OpenFlow Framework in Ruby and C : https://github.com/trema/trema
- Trema Sliceable Switch : https://github.com/trema/apps/tree/master/sliceable_switch
(Contact: Ryota Mibu, Akihiro Motoki, NEC)