Administrator Guide

Welcome to the ONOS Administrator'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.

• Abstractions and definitions
• Installing and running ONOS
  • Requirements
  • Installing on a single machine
  • Running ONOS as a service
  • Accessing the CLI and GUI
  • Forming a cluster
• Configuring ONOS
  • Managing ONOS applications
  • Configuring Authentication - CLI, GUI & REST API
  • Configuring OVS connection using SSL/TLS with self-signed certificates
  • The Network Configuration Service
  • Southbound protocols
  • How to log on external syslog servers
  • Configuring OVSDB connection using SSL/TLS with self-signed certificates
  • Command Line Interface Role-Based Access
  • Configuring TLS for inter-controller communication
  • Production Deployment Tuning
• Interacting with ONOS
  • The ONOS CLI
  • The ONOS Web GUI
• Appendix A : CLI commands
• Appendix B: REST-APIs
• ONOS Remote Admin Tools