docs/release/release-notes/release-notes.rst

   1 ==========================================================================
   2 OPNFV Release Note for the Danube.1.0 release of OPNFV for SDN VPN feature
   3 ==========================================================================
   4
   5 License
   6 =======
   7
   8 This work is licensed under a Creative Commons Attribution 4.0 International
   9 License. .. http://creativecommons.org/licenses/by/4.0 ..
  10 (c) Tim Irnich (Ericsson) and others
  11
  12 Abstract
  13 ========
  14
  15 This document comprises the release notes for the SDN VPN feature contained in the Danube
  16 release of OPNFV.
  17
  18 Important notes
  19 ===============
  20
  21 In the Danube release, SDN VPN only supports ODL as a backend. Make sure to always deploy
  22 SDN VPN and ODL together. Make use of deployment scenarios including the SDNVPN feature.
  23
  24 Summary
  25 =======
  26
  27 SDN VPN adds the possibility to create and associate BGP/MPLS based Virtual Private Networks (VPNs)
  28 through the OpenStack Neutron BGPVPN API extension.
  29
  30 Release Data
  31 ============
  32
  33 +--------------------------------------+-------------------------------------------+
  34 | **Project**                          | sdnvpn                                    |
  35 |                                      |                                           |
  36 +--------------------------------------+-------------------------------------------+
  37 | **Repo/tag**                         | Danube.3.0                                |
  38 |                                      |                                           |
  39 +--------------------------------------+-------------------------------------------+
  40 | **Release designation**              | Danube 3.0 follow-up release              |
  41 |                                      |                                           |
  42 +--------------------------------------+-------------------------------------------+
  43 | **Release date**                     | June 23 2017                              |
  44 |                                      |                                           |
  45 +--------------------------------------+-------------------------------------------+
  46 | **Purpose of the delivery**          | Including BGP stack - 6WIND Zrpcd/Quagga  |
  47 |                                      | Fuel 10.0 baseline + bug fixes            |
  48 |                                      | Deployment with Apex                      |
  49 |                                      | Integration with Boron SR2.0 and bugfixes |
  50 |                                      | 4 new e2e testcases for Functest          |
  51 |                                      | Horizon integration for networking-bgpvpn |
  52 |                                      |                                           |
  53 +--------------------------------------+-------------------------------------------+
  54
  55 Version change
  56 --------------
  57
  58 Compared to the Colorado release, a new version of ODL including
  59 several critical bugfixes is deployed. Together with the new BGP
  60 stack, integration with Apex, the Horizon dashboards and bugfixes the
  61 user has even more features available. New testcases were added to
  62 functest to guarantee functionality.
  63
  64 Module version changes
  65 ~~~~~~~~~~~~~~~~~~~~~~
  66 ODL has been upgraded to Boron SR4.
  67
  68 Document changes
  69 ~~~~~~~~~~~~~~~~
  70
  71 Reason for version
  72 ------------------
  73
  74 Feature additions
  75 ~~~~~~~~~~~~~~~~~
  76
  77 SDN VPN adds the possibility to create and associate BGP/MPLS based
  78 Virtual Private Networks (VPNs) through the OpenStack Neutron BGPVPN
  79 API extension.
  80
  81 A new installer based on Apex is provided.
  82
  83 The Horizon dashboard for the OpenStack Neutron BGPVPN API extensions
  84 is available.
  85
  86 Bug corrections
  87 ~~~~~~~~~~~~~~~
  88
  89 - Several bugs in ODL VPN Service have been fixed in this release.
  90
  91 - Floating IP is now working and tested in functest, relevant Tempest
  92   tests have been enabled.
  93
  94 - Performance issues have been rectified and the relevant tests have
  95   been enabled again.
  96
  97 - Yardstick testcases have been enabled again.
  98
  99 Deliverables
 100 ------------
 101
 102 Software deliverables
 103 ~~~~~~~~~~~~~~~~~~~~~
 104
 105 - Fuel plugin for OpenStack BGPVPN
 106 - Changes to ODL Fuel plugin to activate the NetVirt Karaf features
 107   and to apply the appropriate configuration. Also changes to
 108   implement integration with 6Wind Zrpcd and Quagga.
 109 - Changes to Apex to enable a BGPVPN deployment.
 110 - Integration of VPN Service functional tests and BGPVPN API tests into Functest framework.
 111 - Enabling performance tests in Yardstick.
 112 - Changes to 6Wind Zrpcd to enable integration with Apex.
 113
 114 Documentation deliverables
 115 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 116
 117 - Paragraph on SDN VPN feature for platform overview
 118
 119 - Configuration guide
 120
 121 - User guide
 122
 123 - Release notes (this document)
 124
 125 Known Limitations, Issues and Workarounds
 126 =========================================
 127
 128
 129 System Limitations
 130 ------------------
 131
 132 Known issues
 133 ------------
 134
 135 Moving to the new NetVirt has caused a regression in which a subnet
 136 cannot be both attached to a Router and Network associated to a VPN.
 137 This has been worked around in the tests and the upstream bug is being
 138 tracked [0].
 139
 140 OpenStack NAT does not work. Instances created in subnets that are connected to
 141 the public network via a gateway should have external connectivity. This does
 142 not work and can be worked around by assigning a Floating IP to the instance [1].
 143
 144
 145 Workarounds
 146 -----------
 147
 148 The router/network association mutual exclusivity is worked around
 149 by not network associating subnets attached to routers.
 150
 151 The NAT issues are worked around by assigning floating IPs to VMs that require
 152 external connectivity.
 153
 154 Test results
 155 ============
 156
 157 The deployment scenarios have successfully deployed in OPNFV CI many
 158 times and all Functest tests (general and feature specific) are
 159 passing.
 160
 161 References
 162 ==========
 163 [0] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-94
 164 [1] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-99