Mirror of the OpenDaylight netide gerrit project
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
api
applications
artifacts
config
features
impl
karaf
netide-it
netiplib
openflowjava-extension
parent
shim
.gitignore
.gitreview
README.md
pom.xml

README.md

The NetIDE Network Engine

The Network Engine follows the layered SDN controller approach proposed by the Open Networking Foundation. It comprises a client controller layer that executes the modules network applications are composed of and a server SDN controller layer that drives the underlying infrastructure.

The challenge is to integrate client and server controllers. A first idea is to connect a client’s South-bound Interface (SBI) to a server’s North-bound Interface (NBI). But as these interfaces do not match, adaptation is necessary. This adaptation has to cater for the idiosyncrasies of the controller frameworks and has to be implemented for each single one. For maximal reuse, we use separate adaptors for the clients’SBI – the Backend – and the server’s NBI – the Shim. This separation necessitates a protocol between them, the NetIDE Intermediate Protocol. While such a shim/backend structure connected by an intermediate protocol is feasible, it would still leave substantial adaptation logic in these modules. To overcome this shortcoming, we introduce a further intermediate layer, the Core: it hosts all logic and data structures that are independent of the particular controller frameworks and communicates with both shim and backend using the same NetIDE intermediate protocol. The core makes both shim and backend light-weight and easier to implement for new controllers. Moreover, it provides a convenient place to connect additional run-time tools using a standardized interface. The core introduces some overhead but makes the architecture much more flexible; for production, faster, tightly integrated implementations are easily conceivable.

Alt text

The NetIDE Intermediate protocol v1.0

The intermediate protocol serves several needs. It has to (i) carry control messages between the modules of the Network Engine (such as shim and backend), e.g., to start up/take down a particular module, providing unique identifiers for modules, (ii) carry event and action messages between shim and backend, properly demultiplexing such messages to the right module based on identifiers, (iii) encapsulate messages specific to a particular SBI protocol version (e.g., OF 1.X, NETCONF, etc.) towards the client controllers with proper information to recognize these messages as such.

In the first prototypes of the Network Engine, we lever- aged the protocol between Pyretic’s runtime system and the underlying OpenFlow client. Although this “Pyretic protocol” was sufficient to accomplish our preliminary proofs of concept, its current version limits the network applications running on top of the Network Engine to only use a subset of OF v1.0 messages and its definition does not provide the necessary functions required by the composition mechanism running in the core layer. Especially considering the latter limitation, we defined a new intermediate protocol fromscratch that ensures the delivery of control messages and that supports different SBI protocols. The protocol uses TCP as a transport and encapsulates the payload with the following header:

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|   netide_ver  |     type      |            length             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                              xid                              |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                           module_id                           |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                                                               |
+                          datapath_id                          |
|                                                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Where netide_ver is the version of the NetIDE protocol, length is the total length of the payload in bytes and type indicates the type of the message (e.g NETIDE_HELLO, NETIDE_OPENFLOW, etc.). datapath_id is a 64-bits field that uniquely identifies the network elements. module_id is a 32-bits field that uniquely identifies the application modules running on top of each client controller. The composition mechanism in the core leverages on this field to implement the correct execution flow of these modules. Finally, xid is the transaction identifier associated to the each message. Replies must use the same value to facilitate the pairing.