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.
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 dark gray bar at the top is the Masthead, which provides a location for general GUI controls. In the current version (1.1.0 "Blackbird") this is where the "topology layer filter" radio buttons are placed. (In future versions, this will be where session controls – user ID, user preferences, logout etc. -- will be located.)
The remainder of the screen is the "view" – in this case the "Topology View" which gives a cluster-wide view of the network topology.
The ONOS Controller Instance Panel indicates the controllers in the cluster.
The ONOS Summary Panel gives a brief summary of properties of the network topology.
Navigating from one view to another is done by opening the navigation pane and clicking on a link ("nav item"). As of the current release (1.1.0 "Blackbird") this feature is still under development.
The GUI is capable of supporting multiple views, although this feature has not yet been fully developed. 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 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 Topology View provides an interactive visualization of the network topology, including an indication of which devices (switches) are mastered by each ONOS controller instance.
The Device View provides a top level listing of the devices in the network.
The Sample View provides a skeletal example of implementing a view.
This section provides a reverse-chronological listing of changes to the GUI for each release.
Previous : The ONOS CLI
Next : Distributed ONOS