Developer Quick Start

This Quick Start describes a simple "local" workflow where you build and run ONOS on a single development machine.

First of all, you should install software dependencies, starting with Java. You can download, extract, and install Oracle Java 8 on most platforms.  

On Ubuntu/Debian, you can do the following:

Go to Oracle JDK download website, login and download the tar ball : jdk-8uxxx-linux-x64.tar.gz

for JavaCommand in java jar java2groovy javac javadoc javafxpackager javah javap javapackager javaws
do
    sudo update-alternatives --install /usr/bin/$JavaCommand $JavaCommand /your_path_extracted_jdk/bin/$JavaCommand 1
done

Some other dependencies are required as well. Use your package manager of choice to install these:

git
zip
curl
unzip # CentOS installations only
python # Version 2.7 is required
bzip2 # Needed by legacy GUI build

ONOS is built with Bazel, an open-source build tool developed by Google. It is also in use by number of well-known projects. By relying on explicit dependencies between targets and SHA hashes of files (rather than on timestamps), Bazel avoids unnecessary work by recognizing whether or not a target artifact requires a rebuild. This also helps to increase reproducibility of builds.

To get the source code and build ONOS, all you need to do it run the following commands from Unix-like terminal (e.g. Linux, MacOS):

git clone https://gerrit.onosproject.org/onos
cd onos
bazel build onos		# or use 'op' alias after you 'source tools/dev/bash_profile'

This will compile all source code assemble the installable onos.tar.gz, which is located in the bazel-bin directory. 

To run ONOS locally on the development machine, simply run the following command:

bazel run onos-local -- clean debug  # or use 'ok' alias
# 'clean' to delete all previous running status
# 'debug' to enable remote debugging


# --- The second method, only run ONOS in the background: ---
1. tar -zxvf $ONOS_ROOT/bazel-bin/onos.tar.gz (re-building ONOS if necessary) # e.g. unzip to /tmp
2. cd /tmp/onos-<your version>/apache-karaf-3.0.8/bin # e.g. onos-1.15.0-SNAPSHOT
3. ./start clean debug    # Start ONOS. 'clean' & 'debug' are optional parameters
4. ./client               # You can login ONOS CLI at any time. In CLI, type 'logout' to leave, and 'shutdown' to stop ONOS.
5. ./stop                 # Stop ONOS.

The above command will create a local installation from the onos.tar.gz file (re-building it if necessary) and will start the ONOS server in the background. In the foreground, it will display a continuous view of the ONOS (Apache Karaf) log file. Options following the double-dash (–) are passed through to the ONOS Apache Karaf and can be omitted. Here, the clean option forces a clean installation of ONOS and the debug option means that the default debug port 5005 will be available for attaching a remote debugger.

To attach to the ONOS CLI console, run:

tools/test/bin/onos localhost

Once connected, you can run various ONOS CLI and Apache Karaf commands. For example, to start up OpenFlow and reactive forwarding, you could do the following:

onos> app activate org.onosproject.openflow
onos> app activate org.onosproject.fwd

To open your default browser on the ONOS GUI page, simply type:

tools/test/bin/onos-gui localhost

or alternatively visit http://localhost:8181/onos/ui 

To start up a Mininet network controlled by an ONOS instance that is already running on your development machine, you can use a command like:

sudo mn --controller remote,ip=<ONOS IP address> --topo torus,3,3

Note that you should replace <ONOS IP address> with the IP address of your development machine where ONOS is running.

To execute ONOS unit tests, including code Checkstyle validation, run the following command:

bazel query 'tests(//...)' | xargs bazel test		# or use 'ot' alias

1. File → Setting → Plugin, install the Bazel plugin. (Or download from https://plugins.jetbrains.com/plugin/8609-bazel, and install manually.)
2. restart Intellij IDEA
3. File → Import Bazel Project...
4. choose $ONOS_ROOT for Workspace
5. choose "Generate from BUILD file", and $ONOS_ROOT/BUILD
6. check and click Finish

To get access to a number of aliases (such as those mentioned above) and in general to make your development environment setup more conveniently for ONOS development, please put the following two lines in your ~/.bash_profile or ~/.bash_aliases. 

export ONOS_ROOT=~/onos
source $ONOS_ROOT/tools/dev/bash_profile

The above should be enough to get you started. If you like more detailed instructions for importing the ONOS project into an IDE or contributing your changes back to the ONOS project, please consult the Development Environment Setup section.

Building ONOS behind a web proxy

Bazel supports building behind a web proxy. Here are the steps to build with a proxy:

export HTTPS_PROXY=https://<proxy address>:<proxy port>
export HTTP_PROXY=http://<proxy address>:<proxy port>


bazel build onos --action_env=HTTP_PROXY=$HTTP_PROXY