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

   1 .. _-os-odl-bgpvpn-noha:
   2
   3 .. _-os-odl-bgpvpn-ha:
   4
   5 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   6 .. SPDX-License-Identifier: CC-BY-4.0
   7 .. (c) Periyasamy Palanisamy <periyasamy.palanisamy@ericsson.com> and others
   8
   9 =====================
  10 SDN VPN Release Notes
  11 =====================
  12
  13
  14 Abstract
  15 ========
  16
  17 This document comprises the release notes for the SDN VPN feature contained in the Gambia
  18 release of OPNFV.
  19
  20 Important notes
  21 ===============
  22
  23 In the Gambia release, SDN VPN only supports ODL as a backend. Make sure to always deploy
  24 SDN VPN and ODL together. Make use of deployment scenarios including the SDNVPN feature such
  25 as os_odl_bgpvpn_{ha|noha}.
  26
  27 Summary
  28 =======
  29
  30 SDN VPN adds the possibility to create and associate BGP/MPLS based
  31 Virtual Private Networks (VPNs) through the OpenStack Neutron BGPVPN API
  32 extension. See the scenario description and the user guide for details.
  33
  34
  35 Release Data
  36 ============
  37
  38 +--------------------------------------+-------------------------------------------+
  39 | **Project**                          | sdnvpn                                    |
  40 |                                      |                                           |
  41 +--------------------------------------+-------------------------------------------+
  42 | **Repo/tag**                         | opnfv-7.0.0                               |
  43 |                                      |                                           |
  44 +--------------------------------------+-------------------------------------------+
  45 | **Release designation**              | Gambia 7.0                                |
  46 |                                      |                                           |
  47 +--------------------------------------+-------------------------------------------+
  48 | **Release date**                     | Nov 02 2018                               |
  49 |                                      |                                           |
  50 +--------------------------------------+-------------------------------------------+
  51 | **Purpose of the delivery**          | New test cases                            |
  52 |                                      |                                           |
  53 +--------------------------------------+-------------------------------------------+
  54
  55 Version change
  56 --------------
  57
  58 Compared to the Fraser release, functest testcases were enriched to guarantee functionality.
  59 Also several enhancements were added to improve testing efficiency.
  60
  61 Module version changes
  62 ~~~~~~~~~~~~~~~~~~~~~~
  63 .. ODL has been upgraded to Nitrogen.
  64
  65 Document changes
  66 ~~~~~~~~~~~~~~~~
  67
  68 Reason for version
  69 ------------------
  70
  71 Feature additions
  72 ~~~~~~~~~~~~~~~~~
  73
  74 SDN VPN adds the possibility to create and associate BGP/MPLS based
  75 Virtual Private Networks (VPNs) through the OpenStack Neutron BGPVPN
  76 API extension.
  77
  78 There has been no functional scope change in the Fraser release, the
  79 main deliverable is newer upstream versions and additional test
  80 coverage.
  81
  82
  83 Bug corrections
  84 ~~~~~~~~~~~~~~~
  85
  86 - Several bugs in ODL VPN Service have been fixed in this release.
  87
  88 Deliverables
  89 ------------
  90
  91 Software deliverables
  92 ~~~~~~~~~~~~~~~~~~~~~
  93
  94 - Orchestrate BGPVPN with Openstack HEAT templates
  95 - Verify BGP route exchange with a peer in both directions
  96 - Support for ECMP load balancing
  97 - Consolidate image creation in Apex and Fuel
  98 - Remove the dependency between not running quagga and created flows
  99 - Delete ODL configuration after each test case run
 100 - Add BGPVPN scenarios to XCI and enable SDNVPN tests
 101 - Enable and test ODL clustering for bgpvpn-ha scenario
 102
 103
 104 Documentation deliverables
 105 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 106
 107 - Installation guide
 108 - Release notes (this document)
 109 - Overview
 110 - Test scenario description
 111
 112 Known Limitations, Issues and Workarounds
 113 =========================================
 114
 115
 116 System Limitations
 117 ------------------
 118
 119 Known issues
 120 ------------
 121
 122 Moving to the new NetVirt has caused a regression in which a subnet
 123 cannot be both attached to a Router and Network associated to a VPN.
 124 This has been worked around in the tests and the upstream bug is being
 125 tracked [0]_ and [2]_.
 126
 127 NAT for a VM which is in a private neutron network does not work. Instances
 128 created in subnets that are connected to the public network via a gateway
 129 should have external connectivity. This does not work and can be worked
 130 around by assigning a Floating IP to the instance [1]_.
 131
 132 Currently we observe non-deterministic failures of individual tests within the
 133 SDNVPN section of the Functest suite, which are not reproducible in the development
 134 environment. In a development environment all Functest tests are successful.
 135 Sporadic failures have been observed in test cases 4 and 8. Furthermore, the
 136 check of bgpd service running on Controller node, in test case 3, has a constant
 137 failure trend for Apex environment.
 138
 139 Workarounds
 140 -----------
 141
 142 The router/network association mutual exclusivity is worked around
 143 by not network associating subnets attached to routers.
 144
 145 The NAT issues are worked around by assigning floating IPs to VMs that require
 146 external connectivity.
 147
 148 Test results
 149 ============
 150
 151 The deployment scenarios have successfully deployed in OPNFV CI many
 152 times and all Functest tests (general and feature specific) are passing,
 153 with the exceptions described above.
 154
 155 References
 156 ==========
 157 .. [0] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-94
 158 .. [1] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-99
 159 .. [2] https://jira.opendaylight.org/browse/NETVIRT-932