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