User's Guide

Welcome to the ONOS User's Guide! This guide is aimed at those who wish to understand the details involved in deploying and administering standalone and clustered ONOS instances.

As in the case with any on-going project, these docs may fall out of sync with the project, but we’ll try our best to keep them accurate. If you are interested in helping us keep these documents up-to-date, please take a look at Contributing to the ONOS Guides.

1. Overview 
2. Getting Started
   • Prerequisites
   • Getting ONOS
   • Installation
   • Running ONOS
3. Interacting with ONOS
   • ONOS CLI
     • application management
     • configuring and displaying networks
   • ONOS GUI
   • REST API
4. Distributed ONOS
   • Overview
   • Configuring clustering
5. Applications and Use Cases
   • Applications
   • Use cases (what they do/configuration/starting them up)
     • Packet optical
     • Calendaring
     • SDN-IP
     • Segment routing
     • NFV/Central Office
     • (anything I am forgetting?)

Appendix A : CLI commands
Appendix B : Advanced troubleshooting

1. • Working with Karaf and bundles 
   • webconsole