Documentation for the Web UI Topology View.
The topology view provides a visual (cluster-wide) overview of the network topology controlled by ONOS. When the topology view is instantiated it requests topology information from the server; on receipt of that information, the view renders a visualization of devices, hosts, and the links between them. The view uses the web-socket connection established by the UI framework to allow the server to drive updates to the view via topology events (such as addHost, updateDevice, etc.)
/ or backslash
\ will bring up the Quick Help panel. This gives an outline of the keystroke commands and mouse gestures available to you in the Topology View. Pressing either of these keys again (or pressing
Esc will dismiss the panel).
The key-bindings (listed in Quick Help) are also associated with buttons on the toolbar. (This facilitates using the UI on a smart tablet). The toolbar is initially hidden, but clicking on the arrow, or pressing dot (
.) will toggle its state.
The toolbar has three rows of buttons:
Hovering the mouse over a toolbar button will display a tooltip showing a description of the button, and listing the key binding, e.g.
Toggle Summary Panel (O).
note: wiki page should format this in a table, and include button icons
I- show/hide ONOS cluster instance panel
O- show/hide ONOS summary panel
D- disable/enable details panel
H- toggle host visibility
M- toggle offline-device visibility
P- Toggle port highlighting
B- Toggle background geo map
G- Select background geo map
S- Toggle sprite layer
The ONOS Web UI comes bundled with the Traffic Overlay, which provides traffic visualization functionality. Other applications running on ONOS may also register topology overlays, which can be used to provide alternate visualizations on the topology view.
F1will select "no overlay active";
F2will select the traffic overlay.
F4, ... will select additional overlays, if they are registered and appear in the toolbar.
(WIP --- to be completed)