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. Welcome to ONOS !
2. Getting ONOS
   • ONOS Binaries and VMs
   • ONOS Source Code
3. Installing and Running ONOS
   • Prerequisites
   • Installing ONOS
   • Running ONOS 
   • [Alternative] Running the published Docker ONOS images
   • If Things go Wrong
4. ONOS CLI, GUI & REST API Security
   • Overview
   • Configuration
   • Authentication
   • HTTPS & Redirect
5. Interacting with ONOS
   • The ONOS CLI
   • The ONOS Web GUI
     
   • The Network Configuration Service
6. Distributed ONOS
   • Overview
   • Checking for Clustering
   • Enabling Clustering
   • Cluster Configuration and Management
7. Applications and Use Cases
8. Experimental and Proposed Features

Appendix A : CLI commands

Next : Welcome to ONOS !