This document provides an overview of the User Documentation for the ONOS Web UI.
(Wiki Page, including screenshots)
Further content (subsections) may be found in files named
Placeholders for screenshots / images are marked thusly:
The ONOS GUI is a single-page web application, providing a visual interface to the ONOS controller (or cluster of controllers).
For documentation on the design of the GUI, see Web UI Architecture in the Architecture Guide.
For documentation on how applications running on ONOS can inject content into the GUI at runtime, see the Web UI Tutorials page.
The Developer Guide includes documentation on the Web UI framework libraries (for both client-side and server-side modules), to help app developers re-use common coding patterns.
Note that the current version of the GUI does not fully support the concept of individual user accounts, however, login credentials are required.
On launching the GUI you should see the login screen:
Default username and password are
If ONOS was installed via
onos-install and configured by
onos-secure-ssh (developer / test tools), then the username / password may be different; examine the
$ONOS_WEB_PASS environment variables to discover what they are.
After a successful login, you should see a screen that looks like this:
The dark bar at the top is the Masthead, which provides a location for general GUI controls:
(In future versions, the masthead may include session controls such as user preferences, global search, etc.)
The remainder of the screen is the "view", which defaults to the Topology View when the GUI is first loaded – a cluster-wide view of the network topology.
For more detailed information about this view, see the Topology View page.
Other views can be "navigated to" by clicking on the Navigation Menu Button in the masthead, then selecting an item from the dropdown menu:
The GUI is cacapable of supporting multiple views. As new views are added to the base release, they will be documented here.
NOTE: The capability of adding views to the GUI dynamically at run-time is also available to developers, allowing, for example, an ONOS App developer to create GUI content that works specifically with their application. The content will be injected dynamically into the GUI when the app is installed, and removed automatically from the GUI when the app is uninstalled. For more details on this feature, see the Web UI tutorials.
The views currently included in the base release are:
Note that many of the views are table-based, and are similar in look and interaction. For a general overview of tabular usage, see the Tabular View page.
README.user.views.mdfor view specific documentation.
ONOS applications may contain Web UI components - either custom views or topology overlay behaviors. For documentation on application-specific behavior, please see the Web UI Application Index.
NOTE: For applications that are distributed with core ONOS, it is expected that the developer provides a wiki page for documentation, and provides a link in the index page.
README.user.releases.md for a summary of UI features introduced at each release of ONOS.