Update Release Notes for Gambia 7.1 Release
[sdnvpn.git] / docs / release / release-notes / release-notes.rst
index 4fc01e3..a5b671c 100644 (file)
@@ -1,31 +1,36 @@
-==========================================================================
-OPNFV Release Note for the Danube.1.0 release of OPNFV for SDN VPN feature
-==========================================================================
+.. _-os-odl-bgpvpn-noha:
 
-License
-=======
+.. _-os-odl-bgpvpn-ha:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. (c) Periyasamy Palanisamy <periyasamy.palanisamy@ericsson.com> and others
+
+=====================
+SDN VPN Release Notes
+=====================
 
-This work is licensed under a Creative Commons Attribution 4.0 International
-License. .. http://creativecommons.org/licenses/by/4.0 ..
-(c) Tim Irnich (Ericsson) and others
 
 Abstract
 ========
 
-This document comprises the release notes for the SDN VPN feature contained in the Danube
+This document comprises the release notes for the SDN VPN feature contained in the Gambia
 release of OPNFV.
 
 Important notes
 ===============
 
-In the Danube release, SDN VPN only supports ODL as a backend. Make sure to always deploy
-SDN VPN and ODL together. Make use of deployment scenarios including the SDNVPN feature.
+In the Gambia release, SDN VPN only supports ODL as a backend. Make sure to always deploy
+SDN VPN and ODL together. Make use of deployment scenarios including the SDNVPN feature such
+as os_odl_bgpvpn_{ha|noha}.
 
 Summary
 =======
 
-SDN VPN adds the possibility to create and associate BGP/MPLS based Virtual Private Networks (VPNs)
-through the OpenStack Neutron BGPVPN API extension.
+SDN VPN adds the possibility to create and associate BGP/MPLS based
+Virtual Private Networks (VPNs) through the OpenStack Neutron BGPVPN API
+extension. See the scenario description and the user guide for details.
+
 
 Release Data
 ============
@@ -34,36 +39,28 @@ Release Data
 | **Project**                          | sdnvpn                                    |
 |                                      |                                           |
 +--------------------------------------+-------------------------------------------+
-| **Repo/tag**                         | Danube.2.0                                |
+| **Repo/tag**                         | opnfv-7.1.0                               |
 |                                      |                                           |
 +--------------------------------------+-------------------------------------------+
-| **Release designation**              | Danube 2.0 follow-up release              |
+| **Release designation**              | Gambia 7.1                                |
 |                                      |                                           |
 +--------------------------------------+-------------------------------------------+
-| **Release date**                     | May 4 2017                                |
+| **Release date**                     | Dec 14, 2018                              |
 |                                      |                                           |
 +--------------------------------------+-------------------------------------------+
-| **Purpose of the delivery**          | Including BGP stack - 6WIND Zrpcd/Quagga  |
-|                                      | Fuel 10.0 baseline + bug fixes            |
-|                                      | Deployment with Apex                      |
-|                                      | Integration with Boron SR2.0 and bugfixes |
-|                                      | 4 new e2e testcases for Functest          |
-|                                      | Horizon integration for networking-bgpvpn |
+| **Purpose of the delivery**          | OPNFV Gambia 7.1 release                  |
 |                                      |                                           |
 +--------------------------------------+-------------------------------------------+
 
 Version change
 --------------
 
-Compared to the Colorado release, a new version of ODL including
-several critical bugfixes is deployed. Together with the new BGP
-stack, integration with Apex, the Horizon dashboards and bugfixes the
-user has even more features available. New testcases were added to
-functest to guarantee functionality.
+Compared to the Fraser release, functest testcases were enriched to guarantee functionality.
+Also several enhancements were added to improve testing efficiency.
 
 Module version changes
 ~~~~~~~~~~~~~~~~~~~~~~
-ODL has been upgraded to Boron SR2.
+.. ODL has been upgraded to Nitrogen.
 
 Document changes
 ~~~~~~~~~~~~~~~~
@@ -78,53 +75,44 @@ SDN VPN adds the possibility to create and associate BGP/MPLS based
 Virtual Private Networks (VPNs) through the OpenStack Neutron BGPVPN
 API extension.
 
-A new installer based on Apex is provided.
+There has been no functional scope change in the Fraser release, the
+main deliverable is newer upstream versions and additional test
+coverage.
 
-The Horizon dashboard for the OpenStack Neutron BGPVPN API extensions
-is available.
 
 Bug corrections
 ~~~~~~~~~~~~~~~
 
 - Several bugs in ODL VPN Service have been fixed in this release.
 
-- Floating IP is now working and tested in functest, relevant Tempest
-  tests have been enabled.
-
-- Performance issues have been rectified and the relevant tests have
-  been enabled again.
-
-- Yardstick testcases have been enabled again.
-
 Deliverables
 ------------
 
 Software deliverables
 ~~~~~~~~~~~~~~~~~~~~~
 
-- Fuel plugin for OpenStack BGPVPN
-- Changes to ODL Fuel plugin to activate the NetVirt Karaf features
-  and to apply the appropriate configuration. Also changes to
-  implement integration with 6Wind Zrpcd and Quagga.
-- Changes to Apex to enable a BGPVPN deployment.
-- Integration of VPN Service functional tests and BGPVPN API tests into Functest framework.
-- Enabling performance tests in Yardstick.
-- Changes to 6Wind Zrpcd to enable integration with Apex.
+- Orchestrate BGPVPN with Openstack HEAT templates
+- Verify BGP route exchange with a peer in both directions
+- Support for ECMP load balancing
+- Consolidate image creation in Apex and Fuel
+- Remove the dependency between not running quagga and created flows
+- Delete ODL configuration after each test case run
+- Add BGPVPN scenarios to XCI and enable SDNVPN tests
+- Enable and test ODL clustering for bgpvpn-ha scenario
+
 
 Documentation deliverables
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- Paragraph on SDN VPN feature for platform overview
-
-- Configuration guide
-
-- User guide
-
+- Installation guide
 - Release notes (this document)
+- Overview
+- Test scenario description
 
 Known Limitations, Issues and Workarounds
 =========================================
 
+
 System Limitations
 ------------------
 
@@ -134,11 +122,19 @@ Known issues
 Moving to the new NetVirt has caused a regression in which a subnet
 cannot be both attached to a Router and Network associated to a VPN.
 This has been worked around in the tests and the upstream bug is being
-tracked [0].
+tracked [0]_ and [2]_.
+
+NAT for a VM which is in a private neutron network does not work. Instances
+created in subnets that are connected to the public network via a gateway
+should have external connectivity. This does not work and can be worked
+around by assigning a Floating IP to the instance [1]_.
 
-OpenStack NAT does not work. Instances created in subnets that are connected to
-the public network via a gateway should have external connectivity. This does
-not work and can be worked around by assigning a Floating IP to the instance [1].
+Currently we observe non-deterministic failures of individual tests within the
+SDNVPN section of the Functest suite, which are not reproducible in the development
+environment. In a development environment all Functest tests are successful.
+Sporadic failures have been observed in test cases 4 and 8. Furthermore, the
+check of bgpd service running on Controller node, in test case 3, has a constant
+failure trend for Apex environment.
 
 Workarounds
 -----------
@@ -153,10 +149,11 @@ Test results
 ============
 
 The deployment scenarios have successfully deployed in OPNFV CI many
-times and all Functest tests (general and feature specific) are
-passing.
+times and all Functest tests (general and feature specific) are passing,
+with the exceptions described above.
 
 References
 ==========
-[0] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-94
-[1] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-99
+.. [0] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-94
+.. [1] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-99
+.. [2] https://jira.opendaylight.org/browse/NETVIRT-932