Note: This page applies almost equally to the legacy GUI and its replacement GUI2. Any new enhancements are added to GUI2 only. See GUI Release Notes for details of new features

GUI Overview

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

...

For more detailed information about this view, see the Topology View page.

Image RemovedImage Added

GUI Views

The GUI is capable of supporting multiple views. As new views are added to the base release, they will be documented here.

...

The views currently included in the base release are:

*Tabular Views: 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.

...

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.

Release Notes

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

Junco – 1.9.0

• Region-Aware Topology View:
  • Traffic Overlay (re-)implemented
  • Region transition animation added
  • Sprite layers added
• Partitions View added
• Table View Details Panel refactoring
• Support for Intent Viewing handled by currently active Topology view overlay

Ibis – 1.8.0

• Region-Aware Topology View:
  • Configurations added for Regions and TopoLayers
• "Resubmit Intent" action added to Intents View
• Topology view icons updated
• Cluster View details panel added
• Local filtering added to Flow, Port, Group, and Meter views

Hummingbird – 1.7.0

• Region-Aware Topology View:
  • Server-side modeling done
• "Brief" mode introduced to Intent, Group, and Flow views
• Continued work on re-theming UI

Goldeneye – 1.6.0

• Overhaul of the "Look-n-Feel" (re-skinned).
• Applications View:
  • Drag-n-drop of .oar files to install and activate, now supported.
  • Auto-prompt user to refresh the UI when components are added/removed
• Topology View:
  • "Cluster node ready" checkmark indicator added.
  • Geo-map selection dialog ('G' keystroke) added.
  • Support for topology overlays to provide custom link data.
• Dialog Service
  • Support for chained dialog operations added.
• Chart Service added.
• User preferences now persisted server side.
• Logged-in user name displayed in masthead.

Falcon – 1.5.0

• Topology View:
  • "Reset Node Locations" command ('X' keystroke) added.
  • Topology Overlay selection with F1, F2, F3... keystrokes added.
• Applications View
  • Confirmation dialog added for application activate/deactivate/uninstall.
  • Application model enhancements supported:
    • columns added for additional application attributes
    • details panel displayed when application row selected
  • Note: applications can now define custom icon and custom URL (link to documentation).
• Dialog Service:
  • Enter and Escape keys bound to OK and Cancel buttons.

Emu – 1.4.0

• Device View:
  
  • Friendly name can be set on a device from the device detail panel.
• Intent View:
  • Button added to navigate to Topology View and display the selected intent.
• Topology View:
  • Traffic Overlay now selected as default.
  • Topology overlays can now highlight devices and hosts with badges (small number/text/glyph).
  • Topology overlays can invoke a dialog box to interact with the user.
• ONOS-Branded "Loading..." animation.
• Sample application (org.onosproject.uiref) featuring UI content injection techniques.
• GUI Archetypes (ui, uitab, uitopo) facilitating rapid development of applications with custom UI content.

Drake – 1.3.0

• Authentication Enabled by default (Login screen; logout action)
• More tabular views added:
  • Settings
  • Tunnels
• Changes to Topology View:
  • Traffic re-implemented as an "overlay"
  • Overlay mechanism now programmable from ONOS Apps
    • highlighting/labeling topology links
    • full control over summary panel content
    • full control over details panel content

Cardinal – 1.2.0

• Websocket mechanism promoted to be framework-wide; a shared resource amongst the views.
• More tabular views added:
  • Links
  • Hosts
  • Intents
  • Applications
  • Cluster Nodes
  • Device Flows (hidden view)
  • Device Ports (hidden view)
  • Device Groups (hidden view)
• Changes to the Topology View:
  • links are now selectable.
  • toolbar added (note, keystroke commands still available)
    • node layer buttons moved from masthead to toolbar
  • sprite layer added
  • user selection choices persisted across sessions
  • summary and detail panels adjust size to window height
• Changes to the Device View:
  • slide out details panel appears when a device is clicked on
• Navigation Menu changes:
  • glyphs next to links for navigation
  • views organized into categories
• Note that the legacy (Avocet) GUI has been deprecated, and that the (Angular-based) GUI loads by default.

Blackbird – 1.1.0

...

• View-agnostic features refactored as Angular Services.

...

• Topology source code broken out into multiple source files.
• Port Highlighting on links added.

...

• Implemented as a simple table for now; one device per row, sortable by column header clicks.

...

.

...

• Press the 'T' key to toggle theme.

...

• By default, the Avocet GUI is launched; the base URL http://localhost:8181/onos/ui is mapped to http://localhost:8181/onos/ui/legacy/index.html#topo.
• The new Angular-based GUI can be launched by manually adjusting the URL to be:  http://localhost:8181/onos/ui/index.html#topo, (that is, remove "legacy/"). 

...

Avocet – 1.0.0

• GUI implemented using a home-grown framework. 
• Single view (Topology View) implemented, displaying network topology and providing a certain level of interaction to show traffic & flow information.
• Although the 'T' key-binding (toggle theme) is present, the "dark" theme has not been implemented.

Previous : The ONOS CLI
Next : Distributed ONOS

...

...