GUI Overview

The ONOS GUI is a single-page web-application, providing a visual interface to the ONOS controller (or cluster of controllers).

For documentation on how applications running on ONOS can inject content to the GUI at runtime, see (TBD).

For documentation on the design of the GUI, see the GUI Architecture page.

GUI Configuration Notes

GUI Session Notes

Note that the current version of the GUI does not support the concept of users, nor require login credentials. These enhancements will be added in a later release.

On launching the GUI you should see a screen that looks something like this:

The gray bar at the top is the Masthead, which provides a location for general GUI controls. In the current version (1.2.0 "Cardinal") the masthead contains:

 (In future versions, the masthead will include session controls, such as user ID, user preferences, logout 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.

 

GUI Navigation
Other views can be "navigated to" by clicking on the Navigation Menu Button in the masthead, then selecting an item from the dropdown menu:

 

GUI Views

The GUI is capable of supporting multiple views and 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 being developed. This will allow, for example, an ONOS App developer to create GUI content that works specifically with his application. The content will be dynamically injected into the GUI when the app is installed, and automatically removed from the GUI when the app is uninstalled. For more details on this feature, see (TBD).

The views included with the base release are:

ViewDescription
Topology ViewThe Topology View provides an interactive visualization of the network topology, including an indication of which devices (switches) are mastered by each ONOS controller instance.
DevicesThe Device View* provides a top level listing of the devices in the network.
LinksThe Link View* provides a top level listing of all the links in the network.
HostsThe Host View* provides a top level listing of all the hosts in the network.
IntentsThe Intent View* provides a top level listing of all the intents in the network.
ApplicationsThe Application View* provides a listing of applications installed, as well as interaction with them on the network.
Cluster NodesThe Cluster Node View* provides a top level listing of all the cluster nodes, or instances, in the network.

*Tabular View: The GUI has multiple "tabular views" that are similar in look and interaction, but display different information. For a general overview of tabular usage, see the Tabular View page. For specifics on each view, follow the links in the above table.

Release Notes

This section provides a reverse-chronological listing of changes to the GUI for each release.

Cardinal – 1.2.0

Blackbird – 1.1.0

Avocet – 1.0.0

 

 

 

 

 

 

 


Previous : The ONOS CLI
Next : Distributed ONOS