onos/web/gui/doc/README.user.md

ONOS Web UI - User Documentation

Note to Reader

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 README.user.*.md

Placeholders for screenshots / images are marked thusly:

Introduction

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 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.

---

Configuration Notes

• The onos-gui feature must be installed in ONOS
• The GUI listens on port 8181
• The base url is /onos/ui
  • for example, to access the GUI on localhost, use http://localhost:8181/onos/ui
• The GUI has been developed to work on Google Chrome. The GUI has been tested on Safari and Firefox and minor compatibility adjustments have been made; these and other browsers may work, but have not been extensively tested, and are not actively supported, at this time.
• The key bindings associated with any view will work on any keyboard. The "Cmd" (⌘) key on an Apple keyboard is bound to the same key as the "Windows" or "Alt" keys on Windows or other keyboards.

---

Session Notes

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 onos/rocks.

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_USER and $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:

• Navigation Menu Button
• ONOS logo and title
• Context help button (click to open web URL specific to view)
• User name (click to access logout action)

(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.

• The ONOS Cluster Node Panel indicates the cluster members (controller instances) in the cluster.
• The Summary Panel gives a brief summary of properties of the network topology.
• The Topology Toolbar (initially hidden) provides push-button / toggle-button actions that interact with the topology view.

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

---

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:

---

Views

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:

• Platform Category

  • Applications
    • The Application View provides a listing of installed applications, as well as the ability to install, start, stop and uninstall them.
  • Settings
    • The Settings View provides information about all configurable settings in the system. (Currently this is a readonly view, but future releases may provide setting adjustments from here).
  • Cluster Nodes
    • The Cluster Node View provides a top level listing of all the nodes (ONOS instances) in the cluster.
  • Packet Processors
    • The Packet Processors View shows the currently configured components that participate in the processing of packets sent to the controller.
  • Partitions
    • The Partitions View shows the cluster partitions.

• Network Category

  • Topology
    • 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.
  • Topology 2 (experimental)
    • The Topology 2 View is a "region aware" view of the topology which can take advantage of an administrator configuring the network into regions.
      • Note that this view is currently experimental
  • Devices
    • The Devices View provides a top level listing of the devices in the network. Note that when a device in the table is selected, additional views (not directly available from the navigation menu) become available for that device:
      • Flows: shows all flows for the selected device
      • Ports: shows all ports for the selected device
      • Groups: shows all groups for the selected device
      • Meters: shows all meters for the selected device
  • Links
    • The Links View provides a top level listing of all the links in the network.
  • Hosts
    • The Hosts View provides a top level listing of all the hosts in the network.
  • Intents
    • The Intents View provides a top level listing of all the intents in the network.
  • Tunnels
    • The Tunnels View provides a top level listing of all tunnels defined in the network.

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.

See README.user.views.md for view specific documentation.

---

Web UI Applications

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.

---

Release Nodes

Please see README.user.releases.md for a summary of UI features introduced at each release of ONOS.