A Quantum Plugin for an OpenFlow enabled Network.

The Quantum NEC OpenFlow Plugin maps L2 logical networks on Quantum to L2 networks virtualized on an OpenFlow enabled network. An OpenFlow Controller (OFC) provides L2 network isolation without VLAN, and this plugin controls the OFC through a REST API. Two OFC implementations have this API for now:

• Trema with Trema App - Sliceable Routing Switch (OSS)
• ProgrammableFlow Controller with REST API (NEC Commercial Product)

The NEC VIF Driver, to collaborate with OpenStack Nova, informs the OFC of a VIF - OpenFlow Port mapping via Quantum NEC Extension API (vifinfo), so that the OFC is automatically configured right after VM deployed.

Currently, this plugin co-works with Diablo version of OpenStack Nova and Quantum.

• Quantum: https://github.com/openstack/quantum
• OpenStack: http://www.openstack.org
• Trema: http://trema.github.com/trema
• Trema App - Sliceable Routing Switch: https://github.com/trema/apps/tree/master/sliceable_routing_switch

• Diablo version of OpenStack Nova and Quantum
• OpenFlow Controller: Trema with Trema App - Sliceable Routing Switch, ProgrammableFlow Controller with REST API, or an OFC that has the same functionalities and REST API as Sliceable Routing Switch has. For details see the implementation of Sliceable Routing Switch (https://github.com/trema/apps/tree/master/sliceable_routing_switch).
• OpenFlow Switch: Open vSwitch and/or physical switch supported by the OFC. You have to create a Network by connecting each OpenFlow switch including Open vSwitch on hypervisor node(s) with an exclusive line or GRE tunneling.

quantum-nec-of-plugin/
    nova/                      ... NEC VIF driver & NEC Extension client
    quantum/                   ... code for Quantum server
        extentions/            ... NEC Extensions
        quantum/plugins/nec/   ... Quantum NEC OpenFlow Plugin
    quickstart/                ... QuickStart Installer for Nova and Quantum

See [Manual Installation Guide][manual-install]. [manual-install]:https://github.com/nec-openstack/quantum-nec-of-plugin/blob/master/docs/manual_install.md

We also provide a quick-start installer which installs and configures Nova, Quantum and Trema on one machine. If you are not familiar with Nova or Trema, please try the quick-start installer or refer to the scripts in the quick-start installer. See [Quick Start Installer][quick-start] for more information. [quick-start]: https://github.com/nec-openstack/quantum-nec-of-plugin/blob/master/quickstart/README.md

With Quick Start Installer, you can build an OpenStack+OpenFlow environment and launch VM as follows:

    $ sudo apt-get install git-core
    $ git clone git://github.com/nec-openstack/quantum-nec-of-plugin.git
    $ cd quantum-nec-of-plugin/quickstart
    $ ./installer.sh
    $ source creds/novarc
    $ ./create-private-network.sh
    $ nova boot --image 3 --flavor 1 --meta key=usagi servera
    $ nova list
    Ping, SSH, etc...  Enjoy!

NOTE: Supported distribution is Ubuntu 11.04.

Copyright (C) 2012 NEC Corporation

This software is licensed under the [Apache License, Version 2.0][Apache]. [Apache]: http://www.apache.org/licenses/LICENSE-2.0

THIS SOFTWARE IS DISTRIBUTED WITHOUT SUPPORT AND ANY WARRANTY OF NEC Corporation; WITHOUT EVEN THE IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.