UPDATE: SPRING-OPEN has not been supported since 2016. Please refer to docs.trellisfabric.org for a similar offering. Links on this page may no longer work
SPRING-OPEN is not built on the latest version of ONOS (Avocet). It is built on the previous (internal) release of ONOS (Sept 2014). The source code for this project is available from the url below. To try out the prototype, you will need this version of ONOS, and you will also need the CLI that works with this version of the controller. For the switches, you have the choice of using software or hardware segment-routers. The software routers are built from a version of the CPqD OF 1.3 software switch. The hardware routers are built with Dell 4810 switches.
To get started we recommend downloading the pre-built VM from the link below. This VM has the specific version of ONOS (and its dependencies), the specific CLI, and the specific version of the CPqD OF1.3 software switch required for this project. It includes the Mininet network emulator required to run the software switches in a network topology of your choice. It also includes the recommended Wireshark dissector for OF1.3.4 protocol messages from the loxigen project.
If you do not wish to use this pre-built VM, you can download from source, and follow the installation directions below.
Download the pre-built VM (2.4 GB) from the URL: http://downloads.onosproject.org/spring-open/SPRING-OPEN.ova
Get a recent version of VirtualBox to import and run the VM.
You can login to the VM with login:mininet and password:mininet. Then ifconfig to note the IP address assigned to the VM (if you used Bridged-mode and DHCP in the VM's network settings).
You should now be able to ssh into the mininet VM and follow the Getting Started Tutorial
ONOS for SPRING-OPEN
If you wish to build from source, download the SPRING-OPEN version of the ONOS controller source code. We are assuming you are running in an Ubuntu linux environment.
You will also need Zookeeper 3.4.6: http://apache.arvixe.com/zookeeper/stable/
Download the tar file, and untar it in your home directory.
Run the controller Setup
Compile the Controller code.
To run the controller
To see the controller logs
Note that ONOS needs to be configured to run a segment routed network. See Configuring ONOS (spring-open) for more details.
To stop the controller
CLI for SPRING-OPEN
The CLI used for this project is a modified version of the CLI originally submitted to open-source here: https://github.com/opendaylight/net-virt-platform/tree/master/cli
Download a basic functioning build environment plus a few build-time dependencies.
Download the source code
Build the code
To run the CLI, make sure you have the latest code. From the spring-open-cli folder
By default the CLI tries to connect to the controller on localhost and expects the controller to be listening on port 8080 (127.0.0.1:8080). To make the CLI connect to a controller on a different host, use
Dell Hardware Switches
Once you have the switches, you will need to load the Force10 OS (FTOS) version the binary for which can be freely downloaded below
Dell platforms supported by this build are the 4810/4820t.
This FTOS version is solely for the purpose of features that are part of this project. It is not meant to be used in production and Dell support will not respond to any queries for this version. Dell will not support any bugs solely on the basis of downloading the binary.
Download (~48MB): http://downloads.onosproject.org/spring-open/FTOS-SE-1-0-0-3516.bin
The Dell hardware will be preloaded with a different version of FTOS. Here are few things we need to do before we load the FTOS version for the project. These include configuring the management interface to your management network specifics. Note that the controller needs to be accessible via the management interface for OpenFlow communication between the controllers and switches. We also need to provide ssh access into the switch. Use the console port (and a terminal emulator) for the configuration below.
Once the above configuration is complete, the switch should be accessible via ssh. Copy the downloaded FTOS version to the switch using scp from your local machine.
Now login to the switch using ssh to enter the following commands to load the binary you just copied over. First check that you can see the file in the flash.
Upgrade the OS. It takes a few minutes.
Once the upgrade is done, reload the box. You will of course lose your ssh session. But once it is back, login again to configure the OpenFlow instance.
CPqD Software Switch
A little history: The goal of this project was to demonstrate SDN control of segment routing on switching hardware that exists today. We did that with the Dell 4810 switches. However, during controller development we mostly relied on a software switch that could emulate the Hardware Abstraction Layer that the Dell team was building the FTOS to support. In other words, we needed a software switch that we could put in Mininet, and point to the controller to pretend to be a segment routed network. But more importantly the software switch had to emulate the hardware pipeline, so that when we actually moved to hardware switches, there would be minimal changes in the controller.
In reality the hardware switching ASIC has tens of tables. The controller does not need to know all the tables, registers etc. Many of the tables can be abstracted away by creating the right Hardware Abstraction Layer. Think of it as the contract between the controller and the switch – the switch supports the HAL and the controller programs the switch according to the HAL. In OpenFlow terms such a HAL is known as a Typed Table Pipeline (TTP). The ONF's Forwarding Abstractions WG is working on this topic. For our project we developed our own TTP known as the SPRING-OPEN TTP.
And so, in our project we needed a switch we could use to support the SPRING-OPEN TTP. At the time we started the project (May 2014) the only software switch that supported OF 1.3 was the CPqD software switch. Around the August timeframe OVS released v2.3.0 which also supported OF1.3. However we chose to continue to use the CPqD switch for the following reasons:
- We needed the software switch to support the TTP - part of the TTP required the use of an OpenFlow feature called 'group-chaining', where one group points to another group which in turn could point to a third group or an outgoing-port. Support for this feature is optional as per the OF 1.3.4 specification. OVS v2.3.0 does not support this optional feature. The CPqD switch does.
- Performance of the software switch dataplane (eg. packets switched per second) was not an issue for us in this project. The job of the software switch was to help in controller development for which switching performance is not critical. OVS is a production quality switch; CPqD is not. But this did not matter as ultimately we work on hardware switches which forwards packets at wire-speed.
- Because of the tight timelines in this project, if we found bugs in the switch, we wanted to quickly fix the bugs ourselves instead of depending on a third party to fix the bugs for us. The CPqD switch is a simpler switch than OVS and so its easier to fix bugs.
Having said that, we do have to jump through some hoops to get the switch to work from source. Again this is only necessary if you did not download the pre-built VM above (the VM has the CPqD switch ready to run).
Download the source code. If you already have Mininet installed in your system, run the following script - it will download the CPqD software switch and try to install it.
Or you can download from the CPqD github repo. Check if you can compile it. It may fail ...
If your compile step failed go to this page fix this issue. Once you can successfully compile, go to the next step.
Once the switch compiles, we are unfortunately not done yet. There are some bugs in the switch, which we have fixed. So we need to patch the code with these fixes. Why patch? Why did we not just submit our fixes upstream so everyone can benefit from our fixes? Well the answer is that while we have made fixes, we have made them in a hacky way - we have taken shortcuts just to make things work and move on because of the tight deadlines in this project. Hopefully these issues will be fixed in a clean way by the switch maintainers. For now, we need to patch the code. To start with we need to go back to the specific checkin on which the patch applies. In the ofsoftswitch13 folder, enter
Now when you do 'git log' you should see this
Download the following patch: patchfile-cpqd
You can apply the patch with the command
Now if you do 'git status', you should see something like
Finally, compile again
Now you are ready to use the switch in Mininet. See Configuring CPqD Software Switches.