1169c95d89
- notes on authentication of UI web socket connection. - new classes: UiSessionToken, UiTokenService. - UiExtensionManager now implements UiTokenService. - UiWebSocket now expects an authentication event from the client - websocket.js now sends authentication event as first event - (fix websocket Jasmine test) Change-Id: I4303c67f57fc618e911be244091f00bcc2823c91
ONOS Web UI - Views
Documentation for the Web UI main views.
Note that each of these views should have their own wiki page. For convenience, we are documenting them all here in a single document.
Platform Category Views
Application View
Overview
The application view provides a top level listing of, and basic interaction with, all installed applications. The applications are displayed in tabular form, where each row is a single application.
Selecting a row will display a detail panel, containing more information about the selected application, including:
- Basic properties:
- App ID
- State
- Category
- Version
- Origin
- Role
- URL -- to application documentation page
- Description
- Features, App dependencies, and Permissions (if any)
Note that the first column will contain a checkmark, if the application is currently active.
As with all table views, clicking on a column header will sort entries by that column.
Interacting with applications
An application can be installed simply by dragging and dropping
an .oar file onto the application page. The page border will highlight
when the "drop target" has been acquired.
Alternatively, pressing the "Install" (+) control button will bring up
a file selection dialog, with which you can select on .oar file.
The "Activate" (>) control button will start the selected application.
The "Deactivate" ([]) control button will stop the selected application.
The "Uninstall" (trashcan) button will uninstall the application.
In each case, a confirmation dialog will pop up, asking you to verify the action.
Settings View
Overview
The settings view lists all the tunable settings by component, showing for each:
- Component name
- Property name
- Property type
- Current value
- Description
Values that are not currently the default value will be shown in bold type.
Selecting a table row will display a detail panel for the corresponding setting.
Currently, this view is read-only; future versions of the UI may support adjusting settings from this view.
Note: the detail panel is where parameter editing would take place
Cluster Node View
Overview
The cluster node view lists the cluster members, showing basic information for each:
- active
- started
- identifier
- IP address
- TCP port
- Last updated
Selecting a table row will display a detail panel for the selected node, listing each of the devices for which this node currently holds "mastership".
Packet Processors View
Overview
The packet processors view lists each component that participates in the handling of incoming network packets, in the order that they are configured. Each entry shows:
- Priority
- Type {advisor|director|observer}
- Implementing class
- Packets processed
- Average processing time per packet (ms)
Table row entries are not selectable.
Paritions View
Overview
The partitions view shows how partitions are configured on the cluster, one table row per partition:
- Partition name
- Term
- Partition leader
- Partition members
Table row entries are not selectable.
Network Category Views
Topology View
Overview
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.)
See README.user.topo.md for details.
Topology 2 View
Overview
The topology 2 view ... (to be completed)
Devices View
Overview
The devices view ... (to be completed)
Flows View
Overview
The flows view ... (to be completed)
Ports View
Overview
The ports view ... (to be completed)
Groups View
Overview
The groups view ... (to be completed)
Meters View
Overview
The meters view ... (to be completed)
Links View
Overview
The links view ... (to be completed)
Hosts View
Overview
The hosts view ... (to be completed)
Intents View
Overview
The intents view ... (to be completed)
Tunnels View
Overview
The tunnels view ... (to be completed)