• Stars
    star
    1,186
  • Rank 39,417 (Top 0.8 %)
  • Language
    Java
  • License
    Apache License 2.0
  • Created almost 10 years ago
  • Updated 5 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Open Network Operating System

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
  • 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 include 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

Acknowledgements

YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications. YourKit is the creator of YourKit Java Profiler, YourKit .NET Profiler and YourKit YouMonitor.

YourKit

More Repositories

1

ngsdn-tutorial

Hands-on tutorial to learn the building blocks of the Next-Gen SDN architecture
Java
319
star
2

flowvisor

FlowVisor - A network hypervisor
Java
164
star
3

onos-p4-tutorial

DEPRECATED - Please check the more recent NG-SDN tutorial (advanced branch): https://github.com/opennetworkinglab/ngsdn-tutorial/tree/advanced
Java
51
star
4

onos-app-samples

Sample applications for onos
Java
47
star
5

OnosSystemTest

Open Networking Lab Test Repository
Python
32
star
6

onos-kubernetes

Examples and other collateral for deploying ONOS clusters using Kubernetes.
Shell
23
star
7

routing

Mirror of https://gerrit.onosproject.org/#/admin/projects/routing
Python
21
star
8

p4mn-docker

P4Runtime-enabled Mininet Docker image that uses BMv2 simple_switch_grpc as the default switch
Python
19
star
9

aether-onramp

Makefile
17
star
10

int-host-reporter

User space agent and eBPF programs that provide INT support to end hosts
Go
15
star
11

fabric-p4test

PTF-based data plane tests for ONOS fabric.p4
Python
15
star
12

stratum-onos-demo

Stratum+ONOS demo @ ONF Connect 2019 & EuroP4 '19
Java
13
star
13

sdfabric-tutorial

Python
11
star
14

ODTN-emulator

Emulator for the ODTN project.
Python
8
star
15

mininet

Mininet - a network emulator for rapid SDN prototyping
6
star
16

spring-open

Java
6
star
17

onos-yang-tools

Java
5
star
18

aether-5gc

Makefile
5
star
19

micro-onos-demo

Scripts and various tools to run the ONF Connect µONOS demo
Shell
5
star
20

timesheetsdb

DARPA time-sheets app back-end
TypeScript
4
star
21

onos-operator

Operator for creating and managing ONOS clusters on Kubernetes
Go
4
star
22

trellis-control

Java
3
star
23

onos-stc

System Test Coordinator
Java
2
star
24

cord-config

Configuration files for CORD
HTML
2
star
25

sdfabric-onos

Shell
2
star
26

spring-open-cli

Python
2
star
27

flowvisor-test

FlowVisor Testing Framework
2
star
28

p4c-docker

Dockerfile
2
star
29

sdfabric-utils

Collection of utilities for running SD-Fabric
Python
2
star
30

jdvue

Java Package Dependency viewer
HTML
2
star
31

trellis-t3

Java
1
star
32

fabric-plumber

Simple application to automatically plumb host mesh connectivity using simple p4 fabric pipeline.
Java
1
star
33

onos-warden

Service for managing shared test cell resources within the lab; includes server and OSX client app utility.
Go
1
star
34

aether-sriov

Makefile
1
star
35

onos-loxi

Mirror of https://gerrit.onosproject.org/#/admin/projects/onos-loxi
Python
1
star
36

tassen

Next-generation BNG CUPS API based on P4Runtime, gNMI, and OpenConfig
Go
1
star
37

onos-apps-list

The repository contains a list of descriptions of the ONOS apps
1
star
38

timesheetsui

DARPA time-sheets UI
TypeScript
1
star
39

aether-k8s

Makefile
1
star
40

aether-amp

Makefile
1
star
41

aether-docs

Python
1
star