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

   1 =====================
   2 SDN VPN Release Notes
   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 Euphrates
  16 release of OPNFV.
  17
  18 Important notes
  19 ===============
  20
  21 In the Euphrates 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 such as os_odl_bgpvpn_{ha|noha}.
  23
  24 Summary
  25 =======
  26
  27 SDN VPN adds the possibility to create and associate BGP/MPLS based
  28 Virtual Private Networks (VPNs) through the OpenStack Neutron BGPVPN API
  29 extension. See the scenario description and the user guide for details.
  30
  31
  32 Release Data
  33 ============
  34
  35 +--------------------------------------+-------------------------------------------+
  36 | **Project**                          | sdnvpn                                    |
  37 |                                      |                                           |
  38 +--------------------------------------+-------------------------------------------+
  39 | **Repo/tag**                         | Euhprates 1.0                             |
  40 |                                      |                                           |
  41 +--------------------------------------+-------------------------------------------+
  42 | **Release designation**              | Euphrates 1.0 - initial release           |
  43 |                                      |                                           |
  44 +--------------------------------------+-------------------------------------------+
  45 | **Release date**                     | Oct 20 2017                               |
  46 |                                      |                                           |
  47 +--------------------------------------+-------------------------------------------+
  48 | **Purpose of the delivery**          | Rebased to new upstream versions          |
  49 |                                      | Removed Fuel deployment scenario          |
  50 |                                      | Couple of new test cases                  |
  51 |                                      |                                           |
  52 +--------------------------------------+-------------------------------------------+
  53
  54 Version change
  55 --------------
  56
  57 Compared to the Colorado release, a new version of ODL including
  58 several critical bugfixes is deployed. Together with the new BGP
  59 stack, integration with Apex, the Horizon dashboards and bugfixes the
  60 user has even more features available. New testcases were added to
  61 functest to guarantee functionality.
  62
  63 Module version changes
  64 ~~~~~~~~~~~~~~~~~~~~~~
  65 ODL has been upgraded to Carbon SR2.
  66
  67 Document changes
  68 ~~~~~~~~~~~~~~~~
  69 The previous monolithic user guide, which was also covering install and
  70 config, has been broken up into multiple documents.
  71
  72
  73 Reason for version
  74 ------------------
  75
  76 Feature additions
  77 ~~~~~~~~~~~~~~~~~
  78
  79 SDN VPN adds the possibility to create and associate BGP/MPLS based
  80 Virtual Private Networks (VPNs) through the OpenStack Neutron BGPVPN
  81 API extension.
  82
  83 There has been no functional scope change in the Euphrates release, the
  84 main deliverable is newer upstream versions and additional test
  85 coverage.
  86
  87
  88 Bug corrections
  89 ~~~~~~~~~~~~~~~
  90
  91 - Several bugs in ODL VPN Service have been fixed in this release.
  92
  93 Deliverables
  94 ------------
  95
  96 Software deliverables
  97 ~~~~~~~~~~~~~~~~~~~~~
  98
  99 - Changes to Apex to enable a BGPVPN deployment and integration of Quagga BGP.
 100 - Integration of VPN Service functional tests and BGPVPN API tests into Functest framework.
 101 - Enabling performance tests in Yardstick.
 102 - Changes to 6Wind Zrpcd to enable integration with Apex.
 103
 104 Documentation deliverables
 105 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 106
 107 - Paragraph on SDN VPN feature for platform overview
 108
 109 - Configuration guide
 110
 111 - User guide
 112
 113 - Release notes (this document)
 114
 115 Known Limitations, Issues and Workarounds
 116 =========================================
 117
 118
 119 System Limitations
 120 ------------------
 121
 122 Known issues
 123 ------------
 124
 125 Moving to the new NetVirt has caused a regression in which a subnet
 126 cannot be both attached to a Router and Network associated to a VPN.
 127 This has been worked around in the tests and the upstream bug is being
 128 tracked [0].
 129
 130 NAT for a VM which is in a private neutron network does not work. Instances
 131 created in subnets that are connected to the public network via a gateway
 132 should have external connectivity. This does not work and can be worked
 133 around by assigning a Floating IP to the instance [1].
 134
 135 Currently we observe non-deterministic failures of individual tests within the
 136 SDNVPN section of the Functest suite, which are not reproducible in the development
 137 environment. In a development environment all Functest tests are successful.
 138 Sporadic failures have been observed in test cases 1,4 and 8. Furthermore, the
 139 check of bgpd service running on Controller node, in test case 3, has a constant
 140 failure trend for Apex environment. Also for Apex environment we observe constant
 141 failure in refstack, during the server action test_reboot_server_hard [2].
 142
 143 Workarounds
 144 -----------
 145
 146 The router/network association mutual exclusivity is worked around
 147 by not network associating subnets attached to routers.
 148
 149 The NAT issues are worked around by assigning floating IPs to VMs that require
 150 external connectivity.
 151
 152 For the failures observed in CI, no workaround is required since the faults were
 153 not reproducible in live deployments.[3]
 154
 155 Test results
 156 ============
 157
 158 The deployment scenarios have successfully deployed in OPNFV CI many
 159 times and all Functest tests (general and feature specific) are passing,
 160 with the exceptions described above.
 161
 162 References
 163 ==========
 164 [0] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-94
 165 [1] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-99
 166 [2] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-172
 167 [3] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-170