Welcome to the ONOS documentation pages! This page links to the most up-to date tutorials and documentation for ONOS. 

Getting Started

If you are new to ONOS, the Tutorials and the FAQs are great places to start.

The ONOS Guides

The ONOS guides provide comprehensive information, and are divided into several categories. It is highly recommended that you work through the tutorials before taking a look at the ONOS guides.

• User's Guide - How to install, configure, and use ONOS and its applications, and its current use cases
• Developer's Guide - How to develop on and/or contribute to ONOS, and the tools and procedures involved
• Architecture Guide - The design and implementation of ONOS, its major subsystems, and sample use cases

We also provide Javadocs for the ONOS APIs.

Some Conventions

There are a few conventions that we use throughout these docs. Further conventions, if any, are described where relevant. 

Unix shell commands begin with '$' or '#' :

$ sudo -s
#

ONOS CLI commands begin with 'onos>' :

onos> summary

Both shell and CLI commands may be inlined in sentences in monospace font, e.g. ls or topology