docs/release-notes/projects/ovsdb.rst

   1 =============
   2 OVSDB Project
   3 =============
   4
   5 Major Features
   6 ==============
   7
   8 odl-ovsdb-southbound-api
   9 ------------------------
  10
  11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=southbound/southbound-features/features/src/main/features/features.xml
  12 * **Feature Description:**  This feature provides the YANG models for northbound users to configure the OVSDB device.
  13   These YANG models are designed based on the `OVSDB schema <http://openvswitch.org/ovs-vswitchd.conf.db.5.pdf>`_. This
  14   feature does not provide the implementation of YANG models. If user/developer prefer to write their own implementation
  15   they can use this feature to load the YANG models in the controller.
  16 * **Top Level:** Yes
  17 * **User Facing:** Yes
  18 * **Experimental:** No
  19 * **CSIT Test:**
  20
  21   * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-all-carbon/
  22   * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-only-carbon/
  23   * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-3node-upstream-clustering-only-carbon/
  24
  25 odl-ovsdb-southbound-impl
  26 -------------------------
  27
  28 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=southbound/southbound-features/features/src/main/features/features.xml
  29 * **Feature Description:**  This feature is the main feature of the OVSDB Southbound plugin. This plugin handle the OVS
  30   device that supports the `OVSDB schema <http://openvswitch.org/ovs-vswitchd.conf.db.5.pdf>`_ and uses the
  31   `OVSDB protocol <https://tools.ietf.org/html/rfc7047>`_. This feature provides the implementation of the defined YANG
  32   models. Developers developing the in-controller application and want to leverage OVSDB for device configuration can
  33   add dependency on this feature and it will load all the required modules.
  34 * **Top Level:** Yes
  35 * **User Facing:** No
  36 * **Experimental:** No
  37 * **CSIT Test:**
  38
  39   * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-all-carbon/
  40   * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-only-carbon/
  41   * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-3node-upstream-clustering-only-carbon/
  42
  43 odl-ovsdb-southbound-impl-rest
  44 ------------------------------
  45
  46 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=southbound/southbound-features/features/src/main/features/features.xml
  47 * **Feature Description:**  This feature is the wrapper feature that installs the odl-ovsdb-southbound-api &
  48   odl-ovsdb-southbound-impl feature with other required features for restconf access to provide a functional OVSDB
  49   southbound plugin. Users, who want to develop application that manages the OVSDB supported devices but want to runs
  50   the application outside of the OpenDaylight controller must install this feature.
  51 * **Top Level:** Yes
  52 * **User Facing:** Yes
  53 * **Experimental:** No
  54 * **CSIT Test:**
  55
  56   * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-all-carbon/
  57   * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-only-carbon/
  58   * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-3node-upstream-clustering-only-carbon/
  59
  60
  61 odl-ovsdb-hwvtepsouthbound-api
  62 ------------------------------
  63
  64 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=hwvtepsouthbound/hwvtepsouthbound-features/features/src/main/features/features.xml
  65 * **Feature Description:**  This feature provides the YANG models for northbound users to configure the device
  66   that supports OVSDB Hardware vTEP schema. These YANG models are designed based on the
  67   `OVSDB Hardware vTEP schema <http://openvswitch.org/docs/vtep.5.pdf>`_. This feature does not provide the
  68   implementation of YANG models. If user/developer prefer to write their own implementation of the defined YANG
  69   model, they can use this feature to install the  YANG models in the controller.
  70 * **Top Level:** Yes
  71 * **User Facing:** Yes
  72 * **Experimental:** Yes
  73 * **CSIT Test:** Currently no CSIT Tests are available, but work is in progress and will be available by nitrogen
  74   release.
  75
  76 odl-ovsdb-hwvtepsouthbound
  77 --------------------------
  78
  79 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=hwvtepsouthbound/hwvtepsouthbound-features/features/src/main/features/features.xml
  80 * **Feature Description:**  This feature is the main feature of the OVSDB Hardware vTep Southbound plugin. This plugin
  81   handle the OVS device that supports the `OVSDB Hardware vTEP schema <http://openvswitch.org/docs/vtep.5.pdf>`_ and
  82   uses the `OVSDB protocol <https://tools.ietf.org/html/rfc7047>`_. This feature provides the implementation of the
  83   defined YANG  models. Developers developing the in-controller application and want to leverage OVSDB Hardware vTEP
  84   plugin for device configuration can add dependency on this feature and it will load all the required modules.
  85 * **Top Level:** Yes
  86 * **User Facing:** No
  87 * **Experimental:** Yes
  88 * **CSIT Test:** Currently no CSIT Tests are available, but work is in progress and will be available by nitrogen
  89   release.
  90
  91 odl-ovsdb-hwvtepsouthbound-rest
  92 -------------------------------
  93
  94 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=hwvtepsouthbound/hwvtepsouthbound-features/features/src/main/features/features.xml
  95 * **Feature Description:**  This feature is the wrapper feature that installs the odl-ovsdb-hwvtepsouthbound-api &
  96   odl-ovsdb-hwvtepsouthbound feature with other required features for restconf access to provide a functional OVSDB
  97   Hardware vTEP plugin. Users, who want to develop application that manages the hardware vTEP supported devices but want
  98   to runs the application outside of the OpenDaylight controller must install this feature.
  99 * **Top Level:** Yes
 100 * **User Facing:** Yes
 101 * **Experimental:** Yes
 102 * **CSIT Test:** Currently no CSIT Tests are available, but work is in progress and will be available by nitrogen
 103   release.
 104
 105 odl-ovsdb-library
 106 -----------------
 107
 108 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=ovsdb.git;a=blob;f=library/features/features/src/main/features/features.xml
 109 * **Feature Description:**  Encode/decoder library for OVSDB and Hardware vTEP schema.
 110 * **Top Level:** Yes
 111 * **User Facing:** No
 112 * **Experimental:** No
 113 * **CSIT Test:**
 114
 115   * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-all-carbon/
 116   * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-1node-upstream-southbound-only-carbon/
 117   * https://jenkins.opendaylight.org/releng/view/ovsdb/job/ovsdb-csit-3node-upstream-clustering-only-carbon/
 118
 119 Documentation
 120 =============
 121
 122 * **User Guide(s):**
 123
 124   * :doc:`OVSDB User Guide <../../user-guide/ovsdb-user-guide>`
 125
 126 * **Developer Guide(s):**
 127
 128   * :doc:`OVSDB Developer Guide <../../developer-guide/ovsdb-developer-guide>`
 129
 130 Security Considerations
 131 =======================
 132
 133 * Do you have any external interfaces other than RESTCONF? Yes, Southbound Connection to OVSDB/Hardware vTEP devices.
 134
 135 * Other security issues?
 136
 137   Plugin's connection to device is by default unsecured. User need to explicitly enable the TLS support through ovsdb
 138   library configuration file. User can refer to the wiki page
 139   `here <https://wiki.opendaylight.org/view/OVSDB_Integration:TLS_Communication>`_ for the instructions.
 140
 141 Quality Assurance
 142 =================
 143
 144 * `Link to Sonar Report <https://sonar.opendaylight.org/overview/coverage?id=org.opendaylight.ovsdb%3Aovsdb>`_ (57%)
 145 * `Link to CSIT Jobs <https://jenkins.opendaylight.org/releng/view/ovsdb/>`_
 146 *
 147 * OVSDB southbound plugin is extensively tested through Unit Tests, IT test and system tests. OVSDB southbound plugin
 148   is tested in both single node setup as well as three node cluster setup. Hardware vTEP plugin is currently tested
 149   through (1) Unit testing (2) NetVirt project L2 Gateway features CSIT tests and (3) Manual Testing.
 150   (2) https://jenkins.opendaylight.org/releng/view/netvirt/job/netvirt-csit-hwvtep-1node-openstack-newton-nodl-v2-upstream-stateful-carbon
 151
 152 Migration
 153 ---------
 154
 155 * Is is possible migrate from the previous release? If so, how?
 156   Yes. User facing features and interfaces are not changed, only enhancements are done.
 157
 158 Compatibility
 159 -------------
 160
 161 * Is this release compatible with the previous release? No
 162 * Any API changes? No changes in the YANG models from previous release. Only one minor enhancement is being done.
 163   https://git.opendaylight.org/gerrit/#/c/50993/
 164
 165 * Any configuration changes? No
 166
 167 Bugs Fixed
 168 ----------
 169
 170 * List of bugs fixed since the previous release
 171   https://bugs.opendaylight.org/buglist.cgi?chfieldfrom=2016-08-09&chfieldto=2017-05-25&list_id=78767&product=ovsdb&query_format=advanced&resolution=FIXED
 172
 173 Known Issues
 174 ------------
 175
 176 * List key known issues with workarounds
 177   None
 178 * `Link to Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_severity=blocker&bug_severity=critical&bug_severity=major&bug_severity=normal&bug_severity=minor&bug_severity=trivial&bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=IN_PROGRESS&bug_status=WAITING_FOR_REVIEW&list_id=78768&product=ovsdb&query_format=advanced&resolution=--->`_
 179
 180 End-of-life
 181 ===========
 182
 183 * List of features/APIs which are EOLed, deprecated, and/or removed in thisrelease
 184
 185   None
 186
 187 Standards
 188 =========
 189
 190 * `Open vSwitch Database Management Protocol <https://tools.ietf.org/html/rfc7047>`_
 191 * `OVSDB Schema <http://openvswitch.org/ovs-vswitchd.conf.db.5.pdf>`_
 192 * `Hardware vTep Schema <http://openvswitch.org/docs/vtep.5.pdf>`_
 193
 194 Release Mechanics
 195 =================
 196
 197 * `Link to release plan <https://wiki.opendaylight.org/view/OpenDaylight_OVSDB:Carbon_Release_Plan>`_
 198 * Describe any major shifts in release schedule from the release plan
 199
 200   We planned to do some exploratory work to improve the performance, scalability and robustness, but it didn't make the
 201   expected progress in this release. Project will continue this effort in the next release.