docs/release-notes/projects/neutron-northbound.rst

   1 ==================
   2 Neutron Northbound
   3 ==================
   4
   5 Major Features
   6 ==============
   7
   8 * Tap-as-a-Service (TapAAS) for port mirroring
   9 * Minimum bandwidth QoS rule
  10 * Various code clean up(checkstyle, findbugs, and pom cleanup)
  11
  12 odl-neutron-service
  13 -------------------
  14
  15 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/odl-neutron-service/pom.xml;hb=refs/heads/stable/nitrogen
  16 * **Feature Description:** This is a top level feature to load Neutron
  17   northbound functionality.
  18 * **Top Level:** Yes
  19 * **User Facing:** Yes
  20 * **Experimental:** No
  21 * **CSIT Test:** no CSIT tests as test weiver had been requested.
  22   OpenStack CI results can be found from
  23   https://review.openstack.org/#/q/project:openstack/networking-odl
  24
  25 odl-neutron-northbound-api
  26 --------------------------
  27
  28 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/odl-neutron-northbound-api/pom.xml;hhb=refs/heads/stable/nitrogen
  29 * **Feature Description:** This feature provides REST API for
  30   OpenStack Neutron
  31 * **Top Level:** No
  32 * **User Facing:** No
  33 * **Experimental:** No
  34 * **CSIT Test:** no CSIT tests as test weiver had been requested.
  35   OpenStack CI results can be found from
  36   https://review.openstack.org/#/q/project:openstack/networking-odl
  37
  38
  39 odl-neutron-spi
  40 ---------------
  41
  42 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/odl-neutron-spi/pom.xml;hb=stable/nitrogen
  43 * **Feature Description:**  SPI for Neutron northbound feature
  44 * **Top Level:** No
  45 * **User Facing:** No
  46 * **Experimental:** No
  47 * **CSIT Test:** no CSIT tests as test weiver had been requested.
  48   OpenStack CI results can be found from
  49   https://review.openstack.org/#/q/project:openstack/networking-odl
  50
  51 odl-neutron-transcriber
  52 -----------------------
  53
  54 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/odl-neutron-transcriber/pom.xml;hb=stable/nitrogen
  55 * **Feature Description:** Data converter from/to REST API to/from
  56   MD-SAL YANG model
  57 * **Top Level:** No
  58 * **User Facing:** No
  59 * **Experimental:** No
  60 * **CSIT Test:** no CSIT tests as test weiver had been requested.
  61   OpenStack CI results can be found from
  62   https://review.openstack.org/#/q/project:openstack/networking-odl
  63
  64 odl-neutron-logger
  65 ------------------
  66
  67 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/odl-neutron-logger/pom.xml;hb=stable/nitrogen
  68 * **Feature Description:**  Logger on activity on Neutron YANG models
  69 * **Top Level:** No
  70 * **User Facing:** No
  71 * **Experimental:** No
  72 * **CSIT Test:** no CSIT tests as test weiver had been requested.
  73   OpenStack CI results can be found from
  74   https://review.openstack.org/#/q/project:openstack/networking-odl
  75
  76 odl-neutron-hostconfig-ovs
  77 --------------------------
  78
  79 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/odl-neutron-hostconfig-ovs/pom.xml;hb=stable/nitrogen
  80 * **Feature Description:** Helper library to support hostconfig for
  81   OpenStack service provider with Open vSwitch
  82 * **Top Level:** No
  83 * **User Facing:** No
  84 * **Experimental:** No
  85 * **CSIT Test:** no CSIT tests as test weiver had been requested.
  86   OpenStack CI results can be found from
  87   https://review.openstack.org/#/q/project:openstack/networking-odl
  88
  89 odl-neutron-hostconfig-vpp
  90 --------------------------
  91
  92 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/production/odl-neutron-hostconfig-vpp/pom.xml;hb=stable/nitrogen
  93 * **Feature Description:** Helper library to support hostconfig for
  94   OpenStack service provider with VPP
  95 * **Top Level:** No
  96 * **User Facing:** No
  97 * **Experimental:** No
  98 * **CSIT Test:** no CSIT tests as test weiver had been requested.
  99   OpenStack CI results can be found from
 100   https://review.openstack.org/#/q/project:openstack/networking-odl
 101
 102
 103 Documentation
 104 =============
 105
 106 * **User Guide(s):**
 107
 108   * :ref:`neutron-service-user-guide` is a guide for cloud admin who
 109     deploys OpenStack with OpenDaylight.
 110
 111 * **Developer Guide(s):**
 112
 113   * :ref:`neutron-northbound-developer-guide` is a guide for those who
 114     develops new Neutron Northbound API which OpenStack Neutron talks to.
 115   * :ref:`neutron-service-developer-guide` is a guide for those who
 116     develops new OpenStack Service Provider like netvirt,
 117     group-based-policy.
 118
 119 Security Considerations
 120 =======================
 121
 122 * Do you have any external interfaces other than RESTCONF?
 123
 124   Yes. REST API for OpenStack Neutron.
 125
 126   * If so, how are they secure?
 127     It's authenticated by AAA.
 128   * What port numbers do they use?
 129     8080 and 8181 by default. 8087 is also used by networking-odl/devstack.
 130
 131 * Other security issues?
 132
 133   None.
 134
 135 Quality Assurance
 136 =================
 137
 138 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=org.opendaylight.neutron%3Aproject-neutron>`_ (55.3%)
 139 * Link to CSIT Jobs N/A
 140 * Other manual testing and QA information
 141
 142   * OpenStack CI results can be found from
 143     https://review.openstack.org/#/q/project:openstack/networking-odl
 144   * failure rate of OpenStack CI
 145     http://grafana.openstack.org/dashboard/db/networking-odl-failure-rate
 146   * Other OpenDaylight projects which provides OpenStack Service
 147     (e.g. netvirt, group-based-policy and vtn etc..) have their own system
 148     tests which also exercise Neutron Norhtbound. Which give coverage.
 149
 150
 151 * Testing methodology. How extensive was it? What should be expected
 152   to work? What hasn't been tested as much?
 153
 154   * Unit test: coverage 53.4%
 155   * Integration test:
 156   * OpenStack CI
 157
 158 Migration
 159 ---------
 160
 161 * Is it possible to migrate from the previous release? If so, how?
 162
 163   No as incompatble change was introduced.
 164
 165 Compatibility
 166 -------------
 167
 168 * Is this release compatible with the previous release?
 169
 170   Yes.
 171
 172 * Any API changes?
 173
 174   New API (TapAAS, minimum bandwidth qos rule) were introduced. Not change
 175   to the existing API.
 176
 177 * Any configuration changes?
 178
 179   No.
 180
 181 Bugs Fixed
 182 ----------
 183
 184 * List of bugs fixed since the previous release
 185
 186   * `Link to Bugs fixed
 187     <https://jira.opendaylight.org/issues/?jql=project%20%3D%20NEUTRON%20AND%20issuetype%20%3D%20Bug%20AND%20status%20%3D%20Resolved%20AND%20fixVersion%20%3D%20Oxygen>`_
 188
 189
 190 Known Issues
 191 ------------
 192
 193 * List key known issues with workarounds
 194
 195   None
 196
 197 * `Link to Open Bugs
 198   <https://jira.opendaylight.org/projects/NEUTRON/>`_
 199
 200
 201 End-of-life
 202 ===========
 203
 204 * List of features/APIs which are EOLed, deprecated, and/or removed in this release
 205
 206   N/A
 207
 208 Standards
 209 =========
 210
 211 * List of standrads implemented and to what extent
 212
 213   `OpenStack Neutron API
 214   <https://developer.openstack.org/api-ref/networking/v2/>`_
 215   ODL Neutron Northbound REST API is based on OpenStack Neutron API
 216   and OpenStack Neutron implementation. So the two REST APIs are
 217   similar inherently, but different if necessary for technical
 218   reason. The goal of ODL Neutron Northbound project is to help
 219   OpenStack ODL driver for OpenStack Neutron (networking-odl) and ODL
 220   OpenStack Service Provider(netvirt, group-based-policy, and vtn
 221   etc...). Not re-implement OpenStack Neutron API.
 222
 223
 224 Release Mechanics
 225 =================
 226
 227 * `Link to release plan
 228   <https://wiki.opendaylight.org/view/NeutronNorthbound:Oxygen_Release_Plan>`_
 229 * Describe any major shifts in release schedule from the release plan
 230
 231   * Postponed YANG model change to drop tenant-id, make status
 232     operational to Fluorine cycle