Update Release Notes for Gambia 7.1 Release
[sdnvpn.git] / docs / release / release-notes / release-notes.rst
index 9f4ad21..a5b671c 100644 (file)
@@ -1,25 +1,28 @@
+.. _-os-odl-bgpvpn-noha:
+
+.. _-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
 =====================
 
-License
-=======
-
-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 Euphrates
+This document comprises the release notes for the SDN VPN feature contained in the Gambia
 release of OPNFV.
 
 Important notes
 ===============
 
-In the Euphrates 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}.
+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
 =======
@@ -36,39 +39,31 @@ Release Data
 | **Project**                          | sdnvpn                                    |
 |                                      |                                           |
 +--------------------------------------+-------------------------------------------+
-| **Repo/tag**                         | Euhprates 1.0                             |
+| **Repo/tag**                         | opnfv-7.1.0                               |
 |                                      |                                           |
 +--------------------------------------+-------------------------------------------+
-| **Release designation**              | Euphrates 1.0 - initial release           |
+| **Release designation**              | Gambia 7.1                                |
 |                                      |                                           |
 +--------------------------------------+-------------------------------------------+
-| **Release date**                     | Oct 20 2017                               |
+| **Release date**                     | Dec 14, 2018                              |
 |                                      |                                           |
 +--------------------------------------+-------------------------------------------+
-| **Purpose of the delivery**          | Rebased to new upstream versions          |
-|                                      | Removed Fuel deployment scenario          |
-|                                      | Couple of new test cases                  |
+| **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 Carbon SR2.
+.. ODL has been upgraded to Nitrogen.
 
 Document changes
 ~~~~~~~~~~~~~~~~
-The previous monolithic user guide, which was also covering install and
-config, has been broken up into multiple documents.
-
 
 Reason for version
 ------------------
@@ -80,7 +75,7 @@ SDN VPN adds the possibility to create and associate BGP/MPLS based
 Virtual Private Networks (VPNs) through the OpenStack Neutron BGPVPN
 API extension.
 
-There has been no functional scope change in the Euphrates release, the
+There has been no functional scope change in the Fraser release, the
 main deliverable is newer upstream versions and additional test
 coverage.
 
@@ -96,21 +91,23 @@ Deliverables
 Software deliverables
 ~~~~~~~~~~~~~~~~~~~~~
 
-- Changes to Apex to enable a BGPVPN deployment and integration of Quagga BGP.
-- 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
 =========================================
@@ -125,20 +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].
+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 1,4 and 8. Furthermore, the
+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. Also for Apex environment we observe constant
-failure in refstack, during the server action test_reboot_server_hard [2].
+failure trend for Apex environment.
 
 Workarounds
 -----------
@@ -149,9 +145,6 @@ by not network associating subnets attached to routers.
 The NAT issues are worked around by assigning floating IPs to VMs that require
 external connectivity.
 
-For the failures observed in CI, no workaround is required since the faults were
-not reproducible in live deployments.[3]
-
 Test results
 ============
 
@@ -161,7 +154,6 @@ 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
-[2] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-172
-[3] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-170
+.. [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