Neutron/sdnapi

2014-05-15T19:31:43Z

Tinatsou:

This page is for SDN APIs between OpenStack and SDN Controller.

Neutron/sdnapi

2014-05-15T19:30:47Z

Tinatsou: Created page with "This page is for SDN API between OpenStack and SDN Controller."

This page is for SDN API between OpenStack and SDN Controller.

Neutron

2014-05-15T18:45:42Z

Tinatsou: /* Neutron/* */

= OpenStack Networking ("Neutron") =

{| border="1" cellpadding="2" cellspacing="0"
| [http://docs.openstack.org/admin-guide-cloud/content/ch_networking.html Administrator Guide ]
|-
| [http://docs.openstack.org/user-guide/content/neutron_client_sample_commands.html Neutron CLI Guide ]
|-
| [http://docs.openstack.org/api/openstack-network/2.0/content/ API Developer Doc (v2) ]
|-
| [https://github.com/openstack/quantum Source code ]
|-
| [https://bugs.launchpad.net/quantum Bug tracker ]
|-
| [https://blueprints.launchpad.net/quantum Blueprints ]
|}

== Related projects ==
* [https://launchpad.net/python-quantumclient Python Neutron client]
* Neutron Admin and API documentation in [https://launchpad.net/openstack-manuals OpenStack Manuals]
* Tempest testing project [http://docs.openstack.org/developer/tempest/ Tempest Manuals]. For the Icehouse cycle, the community is undertaking a focused effort to strengthen the suite of Tempest tests for Neutron. If you are interested on contributing to this effort, please go to [https://etherpad.openstack.org/p/icehouse-summit-qa-neutron Icehouse Neutron Tempest push] to see what is being done and to [https://wiki.openstack.org/wiki/Neutron/TempestAPITests TempestAPITests] for HOWTO instructions. Helping to develop Tempest tests (particularly API tests) is an excellent way for new contributors to learn Neutron.

== What is Neutron? ==

Neutron is an [https://wiki.openstack.org OpenStack] project to provide "networking as a service" between interface devices (e.g., vNICs) managed by other Openstack services (e.g., nova).

Starting in the Folsom release, Neutron is a core and supported part of the [https://wiki.openstack.org OpenStack] platform (for Essex, we were an "incubated" project, which means use is suggested only for those who really know what they're doing with Neutron).

If you're a networking geek and like to hack on [https://wiki.openstack.org OpenStack], please join!

More Info:
* [http://www.slideshare.net/danwent/openstack-quantum-intro-os-meetup-32612 Overview of Neutron] (slides) (3/12)
* [https://www.youtube.com/watch?v=_I1SrO2QBpg Neutron Project Overview + Update from Grizzly Summit] (video) (10/12)
* [http://www.infoq.com/presentations/Quantum-Virtual-Networks-for-OpenStack Video Neutron Overview] (3/12)
* [http://sdrv.ms/YdnQYS Slides on Technical Architecture of Neutron] (2013-03-14)

== Why Neutron? ==

* Give cloud tenants an API to build rich networking topologies, and configure advanced network policies in the cloud.
** Example: create multi-tier web application topology
* Enable innovation plugins (open and closed source) that introduce advanced network capabilities
** Example: use L2-in-L3 tunneling to avoid VLAN limits, provide end-to-end QoS guarantees, used monitoring protocols like [[NetFlow]].
* Let anyone build advanced network services (open and closed source) that plug into Openstack tenant networks.
** Examples: LB-aaS, VPN-aaS, firewall-aaS, IDS-aaS, data-center-interconnect-aaS.
* Horizon GUI support for:
** Neutron L2 and L3 network and subnet creation/deletion
** Booting VMs on specific Neutron networks.
* API Extensibility Framework, including extensions for:
** "provider network", which maps Neutron L2 networks to a specific VLAN in the physical data center

== Using Neutron ==

Follow the instructions in the [http://docs.openstack.org/admin-guide-cloud/content/ch_networking.html Neutron Administrator Guide], or use the installation documentation at http://docs.openstack.org to use Neutron with OpenStack Nova.

Forget documentation, I just want to get the code!: [https://launchpad.net/quantum/+download Neutron Downloads]

Detailed information for programming against v2.0 of the Neutron web services API is available in the [http://docs.openstack.org/api/openstack-network/2.0/content/ Neutron API Guide]

If you are looking for information on using Neutron with devstack, please see: [[NeutronDevstack]] .

Neutron lets you use a set of different backends called "plugins" that work with a growing variety of networking technologies. These plugins may be distributed as part of the main Neutron release, or separately.

The set of plugins included in the main Neutron distribution and supported by the Neutron community include:

* [http://www.openvswitch.org Open vSwitch] Plugin
* [http://wiki.openstack.org/cisco-quantum Cisco UCS/Nexus] Plugin
* [http://wiki.openstack.org/Quantum-Linux-Bridge-Plugin Linux Bridge] Plugin
* [http://wiki.openstack.org/Neutron/ML2 Modular Layer 2] Plugin
* [http://www.nicira.com Nicira Network Virtualization Platform (NVP)] Plugin
* [http://www.osrg.net/ryu/using_with_openstack.html Ryu OpenFlow Controller] Plugin
* [[Neutron/NEC OpenFlow Plugin|NEC OpenFlow]] Plugin
* [http://docs.projectfloodlight.org/display/floodlightcontroller/Quantum+REST+Proxy+Plugin Big Switch Controller Plugin]
* [http://www.cloudbase.it/quantum-hyper-v-plugin/ Cloudbase Hyper-V] Plugin
* [http://www.midokura.com MidoNet] Plugin
* [https://github.com/brocade/brocade Brocade Neutron Plugin] Brocade Neutron Plugin
* [http://www.plumgrid.com/ PLUMgrid] Plugin
* [https://wiki.openstack.org/wiki/Mellanox-Neutron Mellanox Neutron Plugin] Mellanox Neutron Plugin
* [https://wiki.openstack.org/wiki/Neutron/EmbraneNeutronPlugin Embrane Neutron Plugin]
* [https://wiki.openstack.org/wiki/IBM-Neutron IBM SDN-VE] Plugin

Additional plugins are available from other sources:
* [http://www.opencontrail.org OpenContrail] Plugin
* [http://www.extremenetworks.com Extreme Networks] Plugin
* [https://github.com/ruijie/rgos_quantum_plugin Ruijie Networks] Plugin
* [https://www.juniper.net/support/downloads/?p=qpluginopen#sw Juniper Networks] Neutron Plugin
If you have your own plugin, feel free to add it to this list.

== Havana Release and ML2 Plugin Update ==
Starting with Havana release, openvswitch and linuxbridge plugins are deprecated. Modular Layer 2 (ML2) plugin replaces these plugins.
L2 agents work with ML2 plugin and continue to work with the deprecated monolithic plugins.

ML2 plugin architecture facilitates the type drivers to support multiple networking technologies, and mechanism drivers to facilitate the access to the networking configuration in a transactional model. The details of these drivers is described [https://wiki.openstack.org/wiki/Neutron/ML2#ML2_Drivers here]. Long term goal is to transition all vendor specific plugins to the type and mechanism drivers.

Following [https://wiki.openstack.org/wiki/Neutron/ML2#Type_Drivers Type Drivers] are supported:
* Flat
* Local
* VLAN
* GRE
* VxLan

Following Vendor specific [https://wiki.openstack.org/wiki/Neutron/ML2#Mechanism_Drivers Mechanism Drivers] are supported:
* [https://wiki.openstack.org/wiki/Arista-neutron-ml2-driver Arista Driver]
* [https://wiki.openstack.org/wiki/Neutron/ML2/MechCiscoNexus Cisco Nexus Driver]
* [https://wiki.openstack.org/wiki/Neutron/ML2/Tail-f-NCS-neutron-ml2-driver Tail-f NCS Driver]

== Participate ==

To get code, ask questions, view blueprints, etc, see: [https://launchpad.net/quantum/ Neutron Launchpad Page]

See [[NeutronDevelopment]] for some (rough) guides on how to contribute code to Neutron, including how to add your own plugin.

If you would like to participate, please send mail to the main openstack-dev list: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

You can also attend our regular IRC meetings, which start one hour after the main openstack meeting, on the same #openstack-meeting channel: http://wiki.openstack.org/Network/Meetings

Check out [[NeutronStarterBugs]] for ideas on easy bugs or starter projects you might tackle. Or just start playing with [[NeutronDevstack]] and come up with your own ideas!

== Related pages ==
=== Neutron/* ===
{{API:SDNAPI/Neutron}}

=== Network/* ===
{{Special:PrefixIndex/Network}}

OpenStack - User contributions [en]

Neutron/sdnapi

Neutron/sdnapi

Neutron