View Source

Introduction

Topology 2 is a "region aware" view of the topology, where the administrator can configure the network into regions and sub-regions.

In its default state (where no "regions" or "layouts" are defined), it should look and behave similarly to the "classic" Topology view.

Note that this view is currently "experimental".

Regions

The ONOS model of the network includes Region objects which can be configured with a collection of Devices (switches) "belonging" to that region.

Regions can be configured using a number of CLI commands:

region-add

To add a region to the model, the region-add command can be used..

region-add <region-id> <region-name> <region-type> <lat/Y> <long/X> <locType> <region-master>

where:

<region-id> is a unique identifier for the region
<region-name> is a human readable name for the region
<region-type> is one of the values defined in the Region.Type enumeration:
- CONTINENT, COUNTRY, METRO, CAMPUS, BUILDING, DATA_CENTER, FLOOR, ROOM, RACK, LOGICAL_GROUP
<lat/Y>, <long/X> are the latitude / longitude (for geo layouts) or Y-coord / X-coord (for grid layouts) to be assigned to the region when it is displayed as a node in its parent layout.
<locType> is either geo (for geographical (map) layout) or grid (for logical grid layout).
<region-master> is a list of sets of node-IDs for mastership of the devices (see RegionAddCommand for more details).

A couple of examples:

region-add rUK "United Kingdom" COUNTRY 52.206035 -1.310384 geo "192.168.56.101 / 192.168.56.102"
region-add rRack1 "Primary Rack" RACK 15.0 20.0 grid 10.0.0.5

Note that CLI commands are scriptable. One way of doing this is as follows:

#!/bin/bash
host=${1:-localhost}
 
onos ${host} <<-EOF
region-add rUK "United Kingdom" COUNTRY 52.206035 -1.310384 geo ${host}
region-add rIT "Italy"   COUNTRY 44.447951  11.093161 geo ${host}
region-add rFR "France"  COUNTRY 47.066264  2.711458 geo ${host}
EOF

region-add-devices

Devices can be assigned to regions with the region-add-devices command:

region-add-devices <region-id> <dev1> <dev2> ... <dev-n>

where

<region-id> is the region unique identifier
<dev-...> is a device identifier

For example:

region-add-devices rUK \
    of:0000000000000001 \
    of:0000000000000002 \    
    of:0000000000000003

Note that regions do not have any notion of hierarchy; they are simply "collections of devices". The hierarchy is expressed using Layouts.

Layouts

A Layout is a "UI construct" that has an associated region "backing" it. Layouts can define a specific layout as a parent, to construct a hierarchy.

This could be pictured as follows:

ONOS > GUI Topology 2 View > sample-layouts.jpeg

layout-add

Layouts can be added to the model with the layout-add command.

layout-add <layout-id> <bg-ref> <region-id> <parent-layout-id> <scale> <offset-x> <offset-y>

where

<layout-id> is a unique identifier for the layout
<bg-ref> is a reference to the background to display for this layout
<region-id> is the identifier of the backing region
<parent-layout-id> is the identifier of the parent layout
<scale>, <offset-x>, <offset-y> are custom values to define the initial pan/zoom of the background

Some examples:

layout-add root @europe . . 4.66 -2562.93 -412.56
 
layout-add lUK @europe rUK root 11.63 -6652.54 -938.04
layout-add lIT @europe rIT root 7.15 -4818.73 -1330.36
layout-add lFR @europe rFR root 8.98 -5378.99 -1334.77

layout-add lMilan +segmentRouting rMilan lIT 0.86 68.58 54.71