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 Fraser
  16 release of OPNFV.
  17
  18 Important notes
  19 ===============
  20
  21 In the Fraser 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**                         | Fraser 6.0                                |
  40 |                                      |                                           |
  41 +--------------------------------------+-------------------------------------------+
  42 | **Release designation**              | Fraser 6.0 - initial release              |
  43 |                                      |                                           |
  44 +--------------------------------------+-------------------------------------------+
  45 | **Release date**                     | Apr 20 2018                               |
  46 |                                      |                                           |
  47 +--------------------------------------+-------------------------------------------+
  48 | **Purpose of the delivery**          | New test cases                            |
  49 |                                      |                                           |
  50 +--------------------------------------+-------------------------------------------+
  51
  52 Version change
  53 --------------
  54
  55 Compared to the Euphrates release, new testcases were added to
  56 functest to guarantee functionality.
  57
  58 Module version changes
  59 ~~~~~~~~~~~~~~~~~~~~~~
  60 ODL has been upgraded to Nitrogen.
  61
  62 Document changes
  63 ~~~~~~~~~~~~~~~~
  64
  65 Reason for version
  66 ------------------
  67
  68 Feature additions
  69 ~~~~~~~~~~~~~~~~~
  70
  71 SDN VPN adds the possibility to create and associate BGP/MPLS based
  72 Virtual Private Networks (VPNs) through the OpenStack Neutron BGPVPN
  73 API extension.
  74
  75 There has been no functional scope change in the Fraser release, the
  76 main deliverable is newer upstream versions and additional test
  77 coverage.
  78
  79
  80 Bug corrections
  81 ~~~~~~~~~~~~~~~
  82
  83 - Several bugs in ODL VPN Service have been fixed in this release.
  84
  85 Deliverables
  86 ------------
  87
  88 Software deliverables
  89 ~~~~~~~~~~~~~~~~~~~~~
  90
  91 - Changes to Apex to enable a BGPVPN deployment and integration of Quagga BGP.
  92 - Integration of VPN Service functional tests and BGPVPN API tests into Functest framework.
  93 - Enabling performance tests in Yardstick.
  94 - Changes to 6Wind Zrpcd to enable integration with Apex.
  95
  96 Documentation deliverables
  97 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  98
  99 - Configuration guide
 100
 101 - User guide
 102
 103 - Release notes (this document)
 104
 105 Known Limitations, Issues and Workarounds
 106 =========================================
 107
 108
 109 System Limitations
 110 ------------------
 111
 112 Known issues
 113 ------------
 114
 115 Moving to the new NetVirt has caused a regression in which a subnet
 116 cannot be both attached to a Router and Network associated to a VPN.
 117 This has been worked around in the tests and the upstream bug is being
 118 tracked [0] and [2].
 119
 120 NAT for a VM which is in a private neutron network does not work. Instances
 121 created in subnets that are connected to the public network via a gateway
 122 should have external connectivity. This does not work and can be worked
 123 around by assigning a Floating IP to the instance [1].
 124
 125 Currently we observe non-deterministic failures of individual tests within the
 126 SDNVPN section of the Functest suite, which are not reproducible in the development
 127 environment. In a development environment all Functest tests are successful.
 128 Sporadic failures have been observed in test cases 4 and 8. Furthermore, the
 129 check of bgpd service running on Controller node, in test case 3, has a constant
 130 failure trend for Apex environment.
 131
 132 Workarounds
 133 -----------
 134
 135 The router/network association mutual exclusivity is worked around
 136 by not network associating subnets attached to routers.
 137
 138 The NAT issues are worked around by assigning floating IPs to VMs that require
 139 external connectivity.
 140
 141 Test results
 142 ============
 143
 144 The deployment scenarios have successfully deployed in OPNFV CI many
 145 times and all Functest tests (general and feature specific) are passing,
 146 with the exceptions described above.
 147
 148 References
 149 ==========
 150 [0] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-94
 151 [1] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-99
 152 [2] https://jira.opendaylight.org/browse/NETVIRT-932