odl-mdsal-cup-example

Warning

I have not updated this project in a while.

About

This is a clone of the MD-SAL toaster example but with Tea and Cups instead. The project has its own distribution of karaf included and the features are loaded automatically on startup.

Pre-requisite

• Java JDK 1.7+
• Maven 3.2.5+

Using the project

1. Compile the whole project
2. Once the compilation is finished, cd into the /cup-distribution/cup-karaf/target folder
3. Depending on your operating system, extract the cup-karaf-0.1.1-SNAPSHOT.tar.gz
4. Run the the cup-karaf-0.1.0-SNAPSHOT/bin/karaf binary
5. The feature odl-cup should be loaded automatically, you can check with (an x in the 3rd column indicates that the feature is installed):

opendaylight-user@root>feature:list | grep cup
odl-cup                         | 0.1.1-SNAPSHOT   | x         | odl-cup-0.1.1-SNAPSHOT                | OpenDaylight :: Cup

Aditionnal debugging tools

You can check the status of the bundles, logs and bundle diagnostic with these:

opendaylight-user@root>bundle:list | grep cup
198 | Active   |  80 | 0.1.1.SNAPSHOT                            | cup                                                                      
199 | Active   |  80 | 0.1.1.SNAPSHOT                            | cup-consumer                                                             
200 | Active   |  80 | 0.1.1.SNAPSHOT                            | cup-provider  

opendaylight-user@root>log:display

opendaylight-user@root>bundle:diag

Common gotchas

The two gotchas that I noticed when compiling the project:

• Compile controller/opendaylight/config (config-parent) separately.

• Compile controller/karaf/karaf-parent (karaf-parent) separately.

RESTConf Endpoints

The endpoints have been documented here:

Cup-Endpoints

I recomment using a Rest client such as Postman or Advanced Rest Client (both for google chrome).

Using JMX

To use JMX, run karaf with the jmx tag: karaf -jmx