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