Welcome to the ONOS documentation pages! This page links to the most up-to date documentation for ONOS.
If you are new to ONOS, ONOS for Newcomers is a great places to start.
The ONOS guides provide comprehensive information, and are divided into several categories. To get the most out of the information, it is highly recommended that you work through the tutorials before taking a look at the ONOS guides.
We also provide Javadocs for the ONOS APIs, and a list of FAQs.
There are a few conventions that we use throughout these docs.
Unix shell commands begin with '$' or for superuser, '#' :
$ sudo -s # id uid=0(root) gid=0(root) groups=0(root)
ONOS CLI commands begin with 'onos>' :
Further conventions, if any, are described where relevant.
The contents of this wiki are contributed by various members of the ONOS Project.