Update release notes for Danube

JIRA: SDNVPN-96
Change-Id: I0bb0d7f065bdd0f356b995f24374eb32f77344d1
Signed-off-by: Romanos Skiadas <rski@intracom-telecom.com>

3 files changed, 97 insertions, 91 deletions

diff --git a/docs/release-notes/release-notes.rst b/docs/release-notes/release-notes.rst
index 17fef44..fe0fbbe 100644
--- a/docs/release-notes/release-notes.rst
+++ b/docs/release-notes/release-notes.rst
@@ -1,6 +1,6 @@
-===============================================================================
-OPNFV Release Note for the Colorado.1.0 release of OPNFV for SDN VPN feature
-===============================================================================
+==========================================================================
+OPNFV Release Note for the Danube.1.0 release of OPNFV for SDN VPN feature
+==========================================================================
 
 License
 =======
@@ -12,13 +12,13 @@ License. .. http://creativecommons.org/licenses/by/4.0 ..
 Abstract
 ========
 
-This document comprises the release notes for the SDN VPN feature contained in the Colorado
+This document comprises the release notes for the SDN VPN feature contained in the Danube
 release of OPNFV.
 
 Important notes
 ===============
 
-In the Colorado release, SDN VPN only supports ODL as a backend. Make sure to always deploy
+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.
 
 Summary
@@ -30,43 +30,43 @@ through the OpenStack Neutron BGPVPN API extension.
 Release Data
 ============
 
-+--------------------------------------+--------------------------------------+
-| **Project**                          | sdnvpn                               |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Repo/tag**                         | Colorado.1.0                         |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release designation**              | Colorado 1.0 follow-up release       |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release date**                     | September 22 2016                    |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery**          | Including BGP stack - Quagga         |
-|                                      | Fuel 9.0 baseline + Bug-fixes        |
-|                                      | HEAT integration                     |
-|                                      | 2 new e2e testcases for Functest     |
-|                                      | Documentation                        |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
++--------------------------------------+-------------------------------------------+
+| **Project**                          | sdnvpn                                    |
+|                                      |                                           |
++--------------------------------------+-------------------------------------------+
+| **Repo/tag**                         | Danube.1.0                                |
+|                                      |                                           |
++--------------------------------------+-------------------------------------------+
+| **Release designation**              | Danube 1.0 follow-up release              |
+|                                      |                                           |
++--------------------------------------+-------------------------------------------+
+| **Release date**                     | March 23 2016                             |
+|                                      |                                           |
++--------------------------------------+-------------------------------------------+
+| **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 |
+|                                      |                                           |
++--------------------------------------+-------------------------------------------+
 
 Version change
 --------------
 
-Compared to the Brahmaputra release, a new version of ODL including several critical
-bugfixes is deployed. Together with the new BGP stack and HEAT integration the user
-can use now full stack bgp. New testcases to functest were added to guarantee
-functionality.
+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.
 
 Module version changes
 ~~~~~~~~~~~~~~~~~~~~~~
-ODL has been upgraded to Beryllium SR3.
+ODL has been upgraded to Boron SR2.
 
 Document changes
 ~~~~~~~~~~~~~~~~
-The amount documentation is increased substantially. E2E deployment docu and examples to use bgpvpn
-is added.
 
 Reason for version
 ------------------
@@ -74,14 +74,27 @@ Reason for version
 Feature additions
 ~~~~~~~~~~~~~~~~~
 
-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.
+
+A new installer based on Apex is provided.
 
+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.
+- 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
 ------------
@@ -90,8 +103,13 @@ Software deliverables
 ~~~~~~~~~~~~~~~~~~~~~
 
 - Fuel plugin for OpenStack BGPVPN
-- Changes to ODL Fuel plugin to activate VPN Service Karaf feature
-- Integration of VPN Service functional tests and BGPVPN API tests into Functest framework
+- 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.
 
 Documentation deliverables
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -102,7 +120,7 @@ Documentation deliverables
 
 - User guide
 
-- Release noes (this document)
+- Release notes (this document)
 
 Known Limitations, Issues and Workarounds
 =========================================
@@ -110,49 +128,35 @@ Known Limitations, Issues and Workarounds
 System Limitations
 ------------------
 
-Floating ip will come with the Boron release so yardstick testcases cannot be run
-and the user is only able to access the node through tenat network. Boron is targeted
-for Colorado 2.0.
-Due to lacking support for floating IPs in ODL VPNService (which replaces Netvirt as
-Neutron backend in the SDN VPN scenarios), the following test suites have some restrictions
-and are not executed:
-- Tempest:
- tempest.api.compute.servers.test_create_server.ServersTestJSON
- tempest.api.compute.servers.test_create_server.ServersTestManualDisk
- tempest.api.compute.servers.test_server_actions.ServerActionsTestJSON
- tempest.scenario.test_network_basic_ops.TestNetworkBasicOps.test_network_basic_ops
- tempest.scenario.test_server_basic_ops.TestServerBasicOps.test_server_basic_ops
- tempest.scenario.test_volume_boot_pattern.TestVolumeBootPattern.test_volume_boot_pattern
- tempest.scenario.test_volume_boot_pattern.TestVolumeBootPatternV2.test_volume_boot_pattern
-
-Yardstick uses the floating ip mechanism to connect to the instances using SSH.
-Therefore, the default test cases have been replaced by the ones running tests on the
-bare-metal servers. Feature specific Yardstick test cases have not been implemented,
-we plan to add these in Colorado 2.0.
-
-It is known that the performance of management operations is quite low. To work around
-the overall timeout of functest, the performance tool Rally was excluded from the
-test list. For Colorado 2.0 a much higher performance is expected and Rally it is
-expected to be included again.
-
-A timeout in promise occurs. This timeout was set from 5 to 10 seconds for all scenarios
-a jira ticket was written to change it back
-in Colorado 2.0: https://jira.opnfv.org/browse/PROMISE-79.
-
-Parser testcase was removed from functest due to low performance. In Colorado 2.0
-a big performance improvement is forseen and Parser will then be added again.
-
 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].
+
+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].
+
 Workarounds
 -----------
 
+The router/network association mutual exclusivity is worked around
+by not network associating subnets attached to routers.
+
+The NAT issues are worked around by assigning floating IPs to VMs that require
+external connectivity.
+
 Test results
 ============
 
-The deployment scenarios have successfully deployed in OPNFV CI many times and all Functest tests
-(general and feature specific) are passing.
+The deployment scenarios have successfully deployed in OPNFV CI many
+times and all Functest tests (general and feature specific) are
+passing.
 
 References
 ==========
+[0] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-94
+[1] https://jira.opnfv.org/projects/SDNVPN/issues/SDNVPN-99
diff --git a/docs/scenarios/os-odl_l2-bgpvpn/scenario.description.rst b/docs/scenarios/os-odl_l2-bgpvpn/scenario.description.rst
index 67c79a1..e552bcf 100644
--- a/docs/scenarios/os-odl_l2-bgpvpn/scenario.description.rst
+++ b/docs/scenarios/os-odl_l2-bgpvpn/scenario.description.rst
@@ -33,9 +33,9 @@ has a quite large number of backend drivers (Bagpipe, OpenContrail,
 Nuage and OpenDaylight currently). In OPNFV, currently only the OpenDaylight driver
 is supported.
 
-The BGPVPN ODL driver maps the BGPVPN API onto the OpenDaylight VPNService, which exposes the data
+The BGPVPN ODL driver maps the BGPVPN API onto the OpenDaylight NetVirt service, which exposes the data
 center overlay like a virtual router to which Neutron Networks and Routers (and in the future also Ports)
-are connected. The VPNService has access to the state of the Neutron API through the OpenDaylight
+are connected. NetVirt has access to the state of the Neutron API through the OpenDaylight
 Neutron Northbound Interface module, which has been enhanced to support the BGPVPN API extension.
 It uses an internal mesh of VxLAN tunnels to interconnect the vSwitches on the data
 center compute nodes. For the purpose of BGP based route exchange with other BGP speakers the ODL
@@ -83,7 +83,7 @@ Limitations, Issues and Workarounds
 .. some insight at this point.
 
 Currently, in OPNFV only ODL is supported as a backend for BGPVPN. API calls are
-mapped onto the ODL VPN Service REST API through the BGPVPN ODL driver and the
+mapped onto the ODL NetVirt REST API through the BGPVPN ODL driver and the
 ODL Neutron Northbound module.
 
 No DPDK-enabled vhost user ports are supported.
@@ -93,5 +93,5 @@ Integration with data center gateway will not work due to missing OVS patches fo
 References
 ==========
 
-For more information on the OPNFV Colorado release, please visit
-http://www.opnfv.org/colorado
+For more information on the OPNFV Danube release, please visit
+http://www.opnfv.org/danube
diff --git a/docs/userguide/feature.userguide.rst b/docs/userguide/feature.userguide.rst
index 0b45e28..4f16d3d 100644
--- a/docs/userguide/feature.userguide.rst
+++ b/docs/userguide/feature.userguide.rst
@@ -18,7 +18,7 @@ SDN VPN feature description
 A high-level description of the scenarios is provided in this section.
 For details of the scenarios and their provided capabilities refer to
 the scenario description document:
-http://artifacts.opnfv.org/colorado/sdnpvn/scenarios/os-odl_l2-bgpvpn/index.html
+http://artifacts.opnfv.org/danube/sdnpvn/scenarios/os-odl_l2-bgpvpn/index.html
 
 The BGPVPN feature enables creation of BGP VPNs on the Neutron API according to the OpenStack
 BGPVPN blueprint at https://blueprints.launchpad.net/neutron/+spec/neutron-bgp-vpn.
@@ -27,7 +27,7 @@ how to associate it with the existing Neutron object model, as well as a unique
 definition of the related semantics. The BGPVPN framework supports a backend
 driver model with currently available drivers for Bagpipe, OpenContrail, Nuage
 and OpenDaylight. The OPNFV scenario makes use of the OpenDaylight driver and backend
-implementation through the ODL VPNService project.
+implementation through the ODL NetVirt project.
 
 Hardware requirements
 =====================
@@ -64,10 +64,10 @@ See in Installation section below how to configure this.
 
 Preparing the host to install Fuel by script
 ============================================
-.. Not all of these options are relevant for all scenario's.  I advise following the
+.. Not all of these options are relevant for all scenarios.  I advise following the
 .. instructions applicable to the deploy tool used in the scenario.
 
-Before starting the installation of the <scenario> scenario some preparation of the
+Before starting the installation of the os-odl_l2-bgpnvp scenario some preparation of the
 machine that will host the Fuel VM must be done.
 
 Installation of required packages
@@ -98,20 +98,19 @@ First of all the opnfv-fuel repository needs to be cloned:
 
  git clone ssh://<user>@gerrit.opnfv.org:29418/fuel
 
-This command downloads the whole repository fuel. We need now to switch it to
-the stable Colorado branch:
+This command downloads the whole repository fuel. To checkout a specific
+version of OPNFV, checkout the appropriate branch:
 ::
 
  cd fuel
- git checkout stable/colorado
+ git checkout stable/<colorado|danube>
 
-Now download the appropriate OPNFV Fuel ISO into an appropriate folder:
+Now download the corresponding OPNFV Fuel ISO into an appropriate folder from
+the website
 ::
+ https://www.opnfv.org/software/downloads/release-archives
 
- wget http://artifacts.opnfv.org/fuel/colorado/opnfv-colorado.1.0.iso
-
-The exact name of the ISO image may change.
-Check https://www.opnfv.org/opnfv-colorado-fuel-users to get the latest ISO.
+Have in mind that the fuel repo version needs to map with the downloaded artifact.
 
 Simplified scenario deployment procedure using Fuel
 ===================================================
@@ -221,8 +220,11 @@ If plugins are installed and you want to update them use --force flag.
 
 Now the feature can be configured. Create a new environment with "Neutron with ML2 plugin" and
 in there "Neutron with tunneling segmentation".
-Then go to settings/other and check "OpenDaylight plugin", "Install Openvswitch with NSH/DPDK" and
-"BGPVPN plugin". Then you should be able to check "BGPVPN extensions" in OpenDaylight plugin section.
+Go to Networks/Settings/Other and check "Assign public network to all nodes". This is required for
+features such as floating IP, which require the Compute hosts to have public interfaces.
+Then go to settings/other and check "OpenDaylight plugin", "Use ODL to manage L3 traffic",
+"BGPVPN plugin" and set the OpenDaylight package version to "5.2.0-1". Then you should
+be able to check "BGPVPN extensions" in OpenDaylight plugin section.
 
 Now the deploy button on fuel dashboard can be used to deploy the environment.