This Quick Start describes a simple "local" workflow where you build and run ONOS on a single development machine.
Install Bazelisk and other dependencies
First of all, you should install Bazelisk (a wrapper for Bazel), both open-source build tools developed by Google. We will use Bazel to build and run ONOS. We suggest downloading and installing Bazelisk using the instructions at Installing required tools.
Some other dependencies are required as well. Use your package manager of choice to install these:
Java Development Kit (JDK)
Do I need to install a JDK? The short answer is NO
Starting with ONOS 2.2, we no longer require to install a JDK in your system to build and run ONOS when using Bazel, as we use a version of OpenJDK 11 that is shipped with Bazel.
However, you might still need to install a Java Runtime Environment (JRE) or JDK if you want to run some of the development tools (e.g. onos-lib-gen, etc.) or if you want to run ONOS without using Bazel. In this case, we suggest installing Amazon Corretto, a free, easy-to-install, production-grade OpenJDK build from Amazon:
If you plan to build and run a version of ONOS prior to 2.2, you should install JDK 8, otherwise, feel free to install the more recent JDK 11.
Get ONOS code
To get the source code and build ONOS, run the following commands from a Unix-like terminal (e.g. Linux, MacOS):
This will compile and assemble the installable
onos.tar.gz, which is located in the
To run ONOS locally on the development machine, simply run the following command:
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 Java debugger.
To attach to the ONOS CLI console, run:
Once connected, you can run various ONOS CLI and Apache Karaf commands. For example, to start up OpenFlow and ReactiveForwarding app, you could do the following:
To open your default browser on the ONOS GUI page, simply type:
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:
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:
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
Congratulations! 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: