Skip to content
Open Network Operating System
Java JavaScript TypeScript Starlark Python CSS Other
Branch: master
Clone or download

Latest commit

SeanCondon [ONOS-8094] GUI2 Topo details fails to show localized messages for En…
…glish

Change-Id: I6bd9d64350358fb66afbc0d46a6fd31b5e499af0
Latest commit 4de9b92 Jun 1, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add warning to GitHub PR template Jun 8, 2018
apps Adding features to Node Diagnosis Application May 28, 2020
cli [ONOS-8093] Purge Meter API May 13, 2020
core Updated toString methods May 28, 2020
deps Fix deps link of perfmark Apr 28, 2020
docs Go to the defining package to import a variable May 15, 2019
drivers [VOL-3016] OLTPipeline removes empty next group if the last group was… May 22, 2020
models Removed Microsemi EA1000 driver and YANG models - obsolete Jan 14, 2020
pipelines Rewrite the SPGW P4 pipeline. May 29, 2020
protocols [ONOS-8098][VOL-3128] Implement multipart PORT_DESC processing in ACT… May 28, 2020
providers
tools Removing flow modification during sink/source addition/removal. Mar 26, 2020
utils Add support to propagate ONOS log to Kafka with KafkaAppender in log4j2 Feb 14, 2020
web [ONOS-8094] GUI2 Topo details fails to show localized messages for En… Jun 1, 2020
.bazelrc GUI2 add a karma.conf.js for unit tests Apr 15, 2020
.bazelversion GUI2 add a karma.conf.js for unit tests Apr 15, 2020
.dockerignore Build ONOS exclusively with Bazel-provided remote JDK Jun 18, 2019
.gitignore GUI2 add a karma.conf.js for unit tests Apr 15, 2020
.gitreview Fix gitreview on master branch Feb 13, 2017
BUILD Add support to propagate ONOS log to Kafka with KafkaAppender in log4j2 Feb 14, 2020
CODE_OF_CONDUCT.md Adding code of conduct as per DevRel Nov 22, 2019
Dockerfile Allow passing 'profile' argument to docker build Feb 25, 2020
LICENSE.txt Updating Copyright line to Open Networking Foundation Aug 4, 2017
README.md Replace references to old versions of Bazel with 1.0 Nov 22, 2019
RELEASES.md Add RELEASES.md document. Jan 9, 2020
WORKSPACE Upgraded to Angular 9.1.0 and rules_nodejs to 1.6 Apr 13, 2020

README.md

ONOS : Open Network Operating System

What is ONOS?

ONOS is the only SDN controller platform that supports the transition from legacy “brown field” networks to SDN “green field” networks. This enables exciting new capabilities, and disruptive deployment and operational cost points for network operators.

Top-Level Features

  • High availability through clustering and distributed state management.
  • Scalability through clustering and sharding of network device control.
  • Performance that is good for a first release, and which has an architecture that will continue to support improvements.
  • Northbound abstractions for a global network view, network graph, and application intents.
  • Pluggable southbound for support of OpenFlow, P4Runtime, and new or legacy protocols.
  • Graphical user interface to view multi-layer topologies and inspect elements of the topology.
  • REST API for access to Northbound abstractions as well as CLI commands.
  • CLI for debugging.
  • Support for both proactive and reactive flow setup.
  • SDN-IP application to support interworking with traditional IP networks controlled by distributed routing protocols such as BGP.
  • IP-Optical use case demonstration.

Getting started

Dependencies

The following packages are required:

  • git
  • zip
  • curl
  • unzip
  • python2.7
  • python3 (needed by Bazel)

Build ONOS from source

ONOS is built with Bazel, an open-source build tool developed by Google. We suggest downloading and installing Bazel using the official instructions.

The minimum required Bazel version is 1.0.0

  1. Clone the code from the ONOS Gerrit repository
$ git clone https://gerrit.onosproject.org/onos
  1. Optionally, you can add the ONOS developer environment to your bash profile. This will provide access to a number of handy commands to run, test and debug ONOS. No need to do this step again if you had done this before:
$ cd onos
$ cat << EOF >> ~/.bash_profile
export ONOS_ROOT="`pwd`"
source $ONOS_ROOT/tools/dev/bash_profile
EOF
$ . ~/.bash_profile
  1. Build ONOS with Bazel
$ cd $ONOS_ROOT
$ bazel build onos

Start ONOS on local machine

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

$ bazel run onos-local [-- [clean] [debug]]

Or simpler one, if you have added the ONOS developer environment to your bash profile:

$ ok [clean] [debug]

The above command will create a local installation from the ONOS tarbal (re-building 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, removing any state from previous executions. The debug option means that the default debug port 5005 will be available for attaching a remote debugger.

Interacting with ONOS

To access ONOS UI, use a browser to open:

http://localhost:8181/onos/ui

Or simpler, use the onos-gui localhost command.

The default username and password is onos/rocks.

To attach to the ONOS CLI console, run:

$ onos localhost

Unit Tests

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

$ bazel query 'tests(//...)' | xargs bazel test

Or better yet, to run code Checkstyle and all unit tests use the following convenience alias:

$ ot

Contributing

ONOS code is hosted and maintained using Gerrit.

Code on GitHub is only a mirror. The ONOS project does NOT accept code through pull requests on GitHub.

To contribute to ONOS, please refer to Sample Gerrit Workflow. It should includes most of the things you'll need to get your contribution started!

More information

For more information, please check out our wiki page or mailing lists:

License

ONOS (Open Network Operating System) is published under Apache License 2.0

You can’t perform that action at this time.