OVSDB Project

Overview

The OVSDB Project provides the following functionality:

  • OVSDB Southbound Plugin handles the OVS device that supports the OVSDB schema and uses the OVSDB protocol. This feature provides the implementation of the defined YANG models. Developers developing the in-controller application and want to leverage OVSDB for device configuration can leverage this functionality.

  • HWvTep Southbound Plugin handles the OVS device that supports the OVSDB Hardware vTEP schema and uses OVSDB protocol. This feature provides the implementation of the project defined YANG models. Developers developing the in-controller application and want to leverage OVSDB Hardware vTEP plugin for device configuration can leverage this functionality.

Major Features

odl-ovsdb-southbound-api

  • Feature URL: Southbound API

  • Feature Description: This feature provides the YANG models for northbound users to configure the OVSDB device. These YANG models are designed based on the OVSDB schema. This feature does not provide the implementation of YANG models. If user/developer prefer to write their own implementation they can use this feature to load the YANG models in the controller.

  • Top Level: Yes

  • User Facing: Yes

  • Experimental: No

  • CSIT Test:

odl-ovsdb-southbound-impl

  • Feature URL: Southbound IMPL

  • Feature Description: This feature is the main feature of the OVSDB Southbound plugin. This plugin handles the OVS device that supports the OVSDB schema and uses the OVSDB protocol. This feature provides the implementation of the defined YANG models. Developers developing the in-controller application that want to leverage OVSDB for device configuration can add a dependency on this feature and all the required modules will be loaded.

  • Top Level: Yes

  • User Facing: No

  • Experimental: No

  • CSIT Test:

odl-ovsdb-southbound-impl-rest

  • Feature URL: Southbound IMPL Rest

  • Feature Description: This feature is the wrapper feature that installs the odl-ovsdb-southbound-api & odl-ovsdb-southbound-impl feature with other required features for restconf access to provide a functional OVSDB southbound plugin. Users who want to develop applications that manage the OVSDB supported devices but want to run the application outside of the OpenDaylight controller must install this feature.

  • Top Level: Yes

  • User Facing: Yes

  • Experimental: No

  • CSIT Test:

odl-ovsdb-hwvtepsouthbound-api

  • Feature URL: HWVT Southbound API

  • Feature Description: This feature provides the YANG models for northbound users to configure the device that supports OVSDB Hardware vTEP schema. These YANG models are designed based on the OVSDB Hardware vTEP schema. This feature does not provide the implementation of YANG models. If user/developer prefer to write their own implementation of the defined YANG model, they can use this feature to install the YANG models in the controller.

  • Top Level: Yes

  • User Facing: Yes

  • Experimental: Yes

  • CSIT Test: Minimal set of CSIT test is already in place. More work is in progress and will have better functional coverage in future release: CSIT

odl-ovsdb-hwvtepsouthbound

  • Feature URL: HWVTEP Southbound

  • Feature Description: This feature is the main feature of the OVSDB Hardware vTep Southbound plugin. This plugin handles the OVS device that supports the OVSDB Hardware vTEP schema and uses the OVSDB protocol. This feature provides the implementation of the defined YANG models. Developers developing the in-controller application that want to leverage OVSDB Hardware vTEP plugin for device configuration can add a dependency on this feature, and all the required modules will be loaded.

  • Top Level: Yes

  • User Facing: No

  • Experimental: Yes

  • CSIT Test: Minimal set of CSIT test is already in place. More work is in progress and will have better functional coverage in future release. CSIT

odl-ovsdb-hwvtepsouthbound-rest

  • Feature URL: HWVTEP Southbound Rest

  • Feature Description: This feature is the wrapper feature that installs the odl-ovsdb-hwvtepsouthbound-api & odl-ovsdb-hwvtepsouthbound features with other required features for restconf access to provide a functional OVSDB Hardware vTEP plugin. Users who want to develop applications that manage the Hardware vTEP supported devices but want to run the applications outside of the OpenDaylight controller must install this feature.

  • Top Level: Yes

  • User Facing: Yes

  • Experimental: Yes

  • CSIT Test: Minimal set of CSIT test is already in place. More work is in progress and will have better functional coverage in future release. CSIT

odl-ovsdb-library

  • Feature URL: Library

  • Feature Description: Encode/decoder library for OVSDB and Hardware vTEP schema.

  • Top Level: Yes

  • User Facing: No

  • Experimental: No

  • CSIT Test:

Documentation

  • N/A

Security Considerations

  • Do you have any external interfaces other than RESTCONF?

    • Yes, Southbound Connection to OVSDB/Hardware vTEP devices.

  • Other security issues?

    • Plugin’s connection to device is by default unsecured. Users need to explicitly enable the TLS support through ovsdb library configuration file. Users can refer to the wiki page here for the instructions.

Quality Assurance

  • Sonar Report (57%)

  • CSIT Jobs

  • OVSDB southbound plugin is extensively tested through Unit Tests, IT test and system tests. OVSDB southbound plugin is tested in both a single-node and three-node cluster setup. Hardware vTEP plugin is currently tested through:

    • Unit testing

    • CSIT testing

    • NetVirt project L2 Gateway features CSIT tests

    • Manual testing

Migration

  • Is it possible to migrate from the previous release? If so, how?

    • Yes. User facing features and interfaces are not changed, only enhancements are done.

Compatibility

  • Is this release compatible with the previous release?

    • Yes

  • Any API changes?

    • No changes in the YANG models from previous release.

  • Any configuration changes?

    • No

Bugs Fixed

  • There were no significant issues resolved in the sodium release.

Known Issues

End-of-life

  • List of features/APIs that were EOLed, deprecated, and/or removed from this release.

    • N/A

Release Mechanics