Contents

Design Overview

Genius contains four main components:

1. Interface Manager

2. Tunnel Manager

3. Aliveness Monitor

4. ID-Manager

these modules are developed as karaf features which can be independently installed. However, there is some dependency among these modules. The diagram below provides a dependency relationship of these modules.

Open

the central/main component of Genius is the Interface Manager which uses other modules for its operations. All these modules expose Yang based API which can be used to configure/interact with these modules and fetch services provided by these modules. Thus all these modules can be used/configured by other ODL modules and can also be accessed via REST interface.

Following sections provide details about each of these components.

Interface Manager

The Interface Manager (IFM) uses an MD-SAL based architecture, where different software components operate on, and interact via a set of data-models. Interface manager defines configuration data-stores where other opendaylight modules can write interface configurations and register for services. These configuration data-stores can also be accessed by external entities through REST interface. IFM listens to changes in these config data-stores and accordingly programs the data-plane. Data in Configuration data-stores remains persistent across controller restarts.

Operational data like network state and other service specific operational data are stored in operational data-stores. Change in network state is updated in southbound interfaces (OFplugin, OVSDB) data-stores. IFM listens to these updates and accordingly updates its own operational data-stores. Operational data stores are cleaned up after a controller restart.

Additionally, IFM also provides a set of RPCs to access IFM data-stores and provide other useful information. Following figure presents different IFM data-stores and its interaction with other modules.

Follwoing diagram provides a toplevel architecture of Interface Manager.

Open

In addition to these datamodels, it also implements several RPCs for accessing interface operational data. Details of these datamodels and RPCs are described in following sections. Interface Manager also uses ODL Inventory and Topology datastores to retrive southbound configurations and events. As described above Interface Manager uses other Genius modules for its operations. It mainly interacts with following other modules-

Modules used by InterfaceManager

1. Id Manager – For allocating dataplane interface-id (if-index)

2. Aliveness Monitor - For registering the interfaces for monitoring

3. MdSalUtil – For interactions with MD-SAL and other openflow operations

Code structure

Interface manager code is organized in following folders -

1. interfacemanager-api contains the interface yang data models and corresponding interface implementation.

2. interfacemanager-impl contains the interfacemanager implementation

3. interface-manager-shell contains Karaf CLI implementation for interfacemanager

interfacemanager-api

└───main ├───java │ └───org │ └───opendaylight │ └───genius │ └───interfacemanager │ ├───exceptions │ ├───globals │ └───interfaces └───yang

interfacemanager-impl

├───commons <--- contains common utility functions ├───listeners <--- Contains interfacemanager DCN listenenrs for differnt MD-SAL datastores ├───renderer <--- Contains different southbound renderers' implementation │ ├───hwvtep <--- HWVTEP specific renderer │ │ ├───confighelpers │ │ ├───statehelpers │ │ └───utilities │ └───ovs <--- OVS specific SBI renderer │ ├───confighelpers │ ├───statehelpers │ └───utilities ├───servicebindings <--- contains interface service binding DCN listener and corresponding implementation │ └───flowbased │ ├───confighelpers │ ├───listeners │ ├───statehelpers │ └───utilities ├───rpcservice <--- Contains interfacemanager RPCs' implementation ├───pmcounters <--- Contains PM counters gathering └───statusanddiag <--- contains status and diagnostics implementations

'interfacemanager-shell

Data-model

InterfaceManager mainly uses two Yang data models to accept configurations.

1. odl-interface datamodel () where verious type of interface can be configuted.

2. service-binding datamodel () where different applications can bind services to interfaces.

In addition to these datamodels, it also implements several RPCs for accessing interface operational data. Details of these datamodels and RPCs are described in following sections. Interface Manager also uses ODL Inventory and Topology datastores to retrive southbound configurations and events. As described above Interface Manager uses other Genius modules for its operations. It mainly interacts with following other modules-

Interface Config DS

IFM datamodel is defined in odl-interface.yang . It is based on ‘ietf-interfaces’ datamodel (imported in odl_interface.yang) with additional augmentations to it. Common interface configurations are –

• name (string) : this is the unique interface name/identifier.

• type (identityref:iana-if-type) : this configuration sets the interface type. Interface types are defined in iana-if-types data model. Odl-interfaces.yang data model adds augmentations to iana-if-types to define new interface types. Currently supported interface types are -

  • l2vlan (trunk, vlan classified sub-ports/trunk-member)

  • tunnel (OVS based VxLAN, GRE, MPLSoverGRE/MPLSoverUDP)

• enabled (Boolean) : this configuration sets the administrative state of the interface.

• parent-refs : this configuration specifies the parent of the interface, which feeds data/hosts this interface. It can be a physical switch port or a virtual switch port.

  • Parent-interface (string) : is the port name with which a network port in dataplane in that appearing on the southbound interface. E.g. neutron port. this can also be another interface, thus supporting a hierarchy of linked interfaces.

  • Node-identifier (topology_id, node_id) : is used for configuring parent node for HW nodes/VTEPs

Additional configuration parameters are defined for specific interface type. Please see the table below.