docs/getting-started-guide/project-release-notes/neutron-northbound.rst

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