Floodlight is Java-based and intended to run with standard JDK tools and ant and can optionally be run in Eclipse.
One can download dependencies using a package manager, such as apt-get. To download dependencies for Floodlight master and above:
sudo apt-get install build-essential openjdk-8-jdk ant python-dev eclipse |
To download dependencies for Floodlight v1.2 and below:
sudo apt-get install build-essential openjdk-7-jdk ant python-dev eclipse |
Note: Want to get started fast? You can use our VM here, which already includes the above dependencies for Floodlight v1.2 and below.
Floodlight is written in Java, so it should work in Windows; however, specific instructions are not provided. If you wish to use Windows, do so at your own risk or use our Floodlight Linux VM instead.
Floodlight is simple to download from Github and build.
$ git clone git://github.com/floodlight/floodlight.git $ cd floodlight $ ant $ sudo mkdir /var/lib/floodlight $ sudo chmod 777 /var/lib/floodlight |
| The above uses the master version of Floodlight. To use a specific version, specify the branch in the git step by appending -b <branch-name>. |
Assuming java is in your path, you can directly run the floodlight.jar file produced by ant from within the floodlight directory:
$ java -jar target/floodlight.jar |
Floodlight will start running and print log and debug output to your console. If you would like to save your log, you can redirect it to a file.
Its also possible to setup, develop and run Floodlight through Eclipse. Rather than setting up projects manually, its easily to use the Eclipse ant target.
$ ant eclipse |
This creates several files: Floodlight.launch, Floodlight_junit.launch, .classpath, and .project. From these you can setup a new Eclipse project.
You now have a working Eclipse project for Floodlight. You can run the project directly through Eclipse as well. Since we use a dynamic module loading system to run Floodlight, we must configure Eclipse to launch it in the correct manner.
Create the FloodlightLaunch target:
To then run Floodlight click on the drop-down arrow next to the Play button and select the proper target to run. These also work with debug targets.
Now that Floodlight is running, you need to attach it to an OpenFlow network. One of the best tools for this is Mininet, a network simulation tool.
$ sudo mn --controller=remote,ip=<controller ip>,port=6653 --switch ovsk,protocols=OpenFlow13 |
Optionally run wireshark over ssh. Listen on "eth0? and filter for packets with "of" names.
$ ssh -X floodlight@<vm-ip> $ sudo wireshark |
If you are finished the getting started guide, you may want to check out Floodlight for Developers, where you will find useful examples, tutorials, and information to help you get started as a Floodlight developer.