ONOS is built with Buck, an open-source build tool created by Facebook and inspired by Google. It is also in use by number of well-known projects, including all Facebook’s mobile apps, Gerrit, etc. By relying on explicit dependencies between targets and SHA hashes of files (rather than on timestamps), BUCK avoids unnecessary work by recognizing whether or not a target artifact requires a rebuild. This also helps to increase reproducibility of builds.

Bulding ONOS bits

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):

$ONOS_ROOT/tools/build/onos-buck build onos --show-output

This will compile all source code assemble the installable onos.tar.gz, which is located in the buck-out directory. Note the --show-output option, which can be omitted, will display the path to this file.

Execute unit tests

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

$ONOS_ROOT/tools/build/onos-buck test

Run ONOS locally

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

$ONOS_ROOT/tools/build/onos-buck run onos-local -- clean debug

The above command will create local installation from the onos.tar.gz file and will start it 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.

Attach to the ONOS console

To attach to the ONOS CLI console, run:

$ONOS_ROOT/tools/test/bin/onos localhost

Once connected, you can run various ONOS CLI and Apache Karaf commands.

Open the ONOS web GUI

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

$ONOS_ROOT/tools/test/bin/onos-gui localhost

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