README.md

Overview

• OSDF Architecutre
• OSDF Policy Lanaguage Syntax

Getting Started

Installation

1. First, you should install and run ONOS on your local machine using the guideline that have been posted here: Developer Quick Start.

   • Note 1: You will need to export several environment variables. The ONOS source comes with a sample bash_profile that can set these variables for you. To do so, follow the instructions that have been posted here: Set Enivronment Variables

   • Note 2: Run onos-buck-publish-local to put onos artifcats in the .m2 repo.

2. Second, clone this repoistory and compile OSDF application using the following commands:

   • git clone https://github.com/OpenSDF/OSDF-REACTIVE-APP.git
   • cd osdf-reactive
   • mvn clean install

3. Third, after compiling the application successfully, you should install it as an ONOS app using the onos-app script as follows:

   • onos-app localhost install target/osdf-reactive-1.0-SNAPSHOT.oar

4. Forth, after installing the OSDF app successfully, you should activate it using the following command from onos cli.

   • onos 127.0.0.1
   • app activate org.osdfreactive

5- Now, OSDF is ready!

Examples

After installing ONOS and OSDF app successfully, you will be able to configure a network using high level abstractions that OSDF provides. To test OSDF application, we provide a set of examples as follows:

• Intra site routing (Example #1)
• Intra site routing (Example #2)
• Intra site routing (Example #3- Firewall)
• Inter site routing (Example #1)

Note 1: If you plan to use this application for your research, please cite our work:

https://github.com/OpenSDF/OSDF-REACTIVE-APP/wiki/Conference-papers

Note 2: Java doc link:

https://opensdf.github.io/OSDF-REACTIVE-APP/