diff options
Diffstat (limited to 'docs/release')
| -rw-r--r-- | docs/release/installation/index.rst | 29 | ||||
| -rw-r--r-- | docs/release/release-notes/release-notes.rst | 61 | ||||
| -rw-r--r-- | docs/release/scenarios/os-odl-bgpvpn/scenario.description.rst | 33 |
3 files changed, 57 insertions, 66 deletions
diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst index 2625ef9..ded6a78 100644 --- a/docs/release/installation/index.rst +++ b/docs/release/installation/index.rst @@ -1,8 +1,6 @@ -.. _sdnvpn-installation: - .. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Tim Irnich, (tim.irnich@ericsson.com) and others +.. SPDX-License-Identifier: CC-BY-4.0 +.. (c) OPNFV, Ericsson AB and others. ============================ SDN VPN feature installation @@ -71,8 +69,8 @@ install the following packages: fuseiso genisoimage blackbox xterm python-pip \ python-git python-dev python-oslo.config \ python-pip python-dev libffi-dev libxml2-dev \ - libxslt1-dev libffi-dev libxml2-dev libxslt1-dev \ - expect curl python-netaddr p7zip-full + libxslt1-dev libffi-dev libxml2-dev libxslt1-dev \ + expect curl python-netaddr p7zip-full sudo pip install GitPython pyyaml netaddr paramiko lxml scp \ python-novaclient python-neutronclient python-glanceclient \ @@ -87,17 +85,14 @@ First of all the opnfv-fuel repository needs to be cloned: git clone ssh://<user>@gerrit.opnfv.org:29418/fuel -To check out a specific -version of OPNFV, checkout the appropriate branch: +To check out a specific version of OPNFV, checkout the appropriate branch: :: cd fuel - git checkout stable/<colorado|danube|euphrates|fraser> + git checkout stable/gambia Now download the corresponding OPNFV Fuel ISO into an appropriate folder from -the website -:: - https://www.opnfv.org/software/downloads/release-archives +the website https://www.opnfv.org/software/downloads/release-archives Have in mind that the fuel repo version needs to map with the downloaded artifact. Note: it is also possible to build the Fuel image using the @@ -226,19 +221,21 @@ Virtual deployment using Apex installer ======================================= Prerequisites -^^^^^^^^^^^^^ +------------- + For Virtual Apex deployment a host with Centos 7 is needed. This installation was tested on centos-release-7-2.1511.el7.centos.2.10.x86_64 however any other Centos 7 version should be fine. Build and Deploy -^^^^^^^^^^^^^^^^ -Download the Apex repo from opnfv gerrit and checkout stable/danube: +---------------- + +Download the Apex repo from opnfv gerrit and checkout stable/gambia: :: git clone ssh://<user>@gerrit.opnfv.org:29418/apex cd apex - git checkout stable/danube + git checkout stable/gambia In apex/contrib you will find simple_deploy.sh: :: diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index 1a3e9a5..54ada98 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -3,31 +3,26 @@ .. _-os-odl-bgpvpn-ha: .. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 +.. 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 Fraser +This document comprises the release notes for the SDN VPN feature contained in the Gambia release of OPNFV. Important notes =============== -In the Fraser 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 ======= @@ -44,13 +39,13 @@ Release Data | **Project** | sdnvpn | | | | +--------------------------------------+-------------------------------------------+ -| **Repo/tag** | opnfv-6.2.0 | +| **Repo/tag** | opnfv-7.0.0 | | | | +--------------------------------------+-------------------------------------------+ -| **Release designation** | Fraser 6.2 | +| **Release designation** | Gambia 7.0 | | | | +--------------------------------------+-------------------------------------------+ -| **Release date** | June 29 2018 | +| **Release date** | Nov 02 2018 | | | | +--------------------------------------+-------------------------------------------+ | **Purpose of the delivery** | New test cases | @@ -60,12 +55,12 @@ Release Data Version change -------------- -Compared to the Euphrates release, 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 Nitrogen. +.. ODL has been upgraded to Nitrogen. Document changes ~~~~~~~~~~~~~~~~ @@ -96,23 +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. -- Intra Datacenter ECMP (Equal Cost Multi Pathing) Testcase. -- OpenDaylight and Open vSwitch Resynchronization Testcase. -- Improved quality and stability of Testcase runs in CI environment. -- External BGPVPN scenario added for XCI based deployment for BGPVPN scenarios. +- 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 ~~~~~~~~~~~~~~~~~~~~~~~~~~ -- Configuration guide - -- User guide - +- Installation guide - Release notes (this document) +- Overview +- Test scenario description Known Limitations, Issues and Workarounds ========================================= @@ -127,12 +122,12 @@ 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] and [2]. +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 @@ -159,6 +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.opendaylight.org/browse/NETVIRT-932 +.. [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
\ No newline at end of file diff --git a/docs/release/scenarios/os-odl-bgpvpn/scenario.description.rst b/docs/release/scenarios/os-odl-bgpvpn/scenario.description.rst index 5d6c06d..8d1cb9c 100644 --- a/docs/release/scenarios/os-odl-bgpvpn/scenario.description.rst +++ b/docs/release/scenarios/os-odl-bgpvpn/scenario.description.rst @@ -1,5 +1,5 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 +.. SPDX-License-Identifier: CC-BY-4.0 .. (c) Periyasamy Palanisamy <periyasamy.palanisamy@ericsson.com> and others Introduction @@ -21,9 +21,8 @@ deployment scenarios, which is derived from the baseline os-odl-nofeature scenario. 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. In a -nutshell, the blueprint defines a BGPVPN object and a number of ways how +according to the `OpenStack BGPVPN blueprint <https://blueprints.launchpad.net/neutron/+spec/neutron-bgp-vpn>`_. +In a nutshell, the blueprint defines a BGPVPN object and a number of ways 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 @@ -72,23 +71,23 @@ Scenario usage overview Configuring SDNVPN features --------------------------- -Apex installer has specific procedures to deploy the OPNFV platform so that the SDNVPN feature is enabled. +Apex installer has specific procedures to deploy the OPNFV platform so that the SDNVPN feature is +enabled. -APEX installer configuration -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +APEX installer configuration and BGPVPN deployment +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -To install the SDNVPN feature using the APEX installer, follow the APEX installation guide -(https://wiki.opnfv.org/display/apex/Integration+Guide) and activate the SDNVPN feature when prompted (step "# Now execute a deployment") +To install the SDNVPN feature using the APEX installer, follow the `APEX installation guide <(https://wiki. +opnfv.org/display/apex/Integration+Guide)>`_ . When prompted activate the SDNVPN feature based on +openstack configuration: -For os-odl-bgpvpn-noha deployment: ----------------------------------- +* For os-odl-bgpvpn-noha deployment: -python3 deploy.py -v -n ../config/network/network_settings.yaml -d ../config/deploy/os-odl-bgpvpn-noha.yaml --deploy-dir ../build --lib-dir ../lib --image-dir ../.build --virtual-computes 2 --virtual-default-ram 16 + python3 deploy.py -v -n ../config/network/network_settings.yaml -d ../config/deploy/os-odl-bgpvpn-noha.yaml --deploy-dir ../build --lib-dir ../lib --image-dir ../.build --virtual-computes 2 --virtual-default-ram 16 -For os-odl-bgpvpn-ha deployment: --------------------------------- +* For os-odl-bgpvpn-ha deployment: -python3 deploy.py -v -n ../config/network/network_settings.yaml -d ../config/deploy/os-odl-bgpvpn-ha.yaml --deploy-dir ../build --lib-dir ../lib --image-dir ../.build --virtual-computes 2 --virtual-default-ram 16 + python3 deploy.py -v -n ../config/network/network_settings.yaml -d ../config/deploy/os-odl-bgpvpn-ha.yaml --deploy-dir ../build --lib-dir ../lib --image-dir ../.build --virtual-computes 2 --virtual-default-ram 16 Limitations, Issues and Workarounds =================================== @@ -107,5 +106,5 @@ Integration with data center gateway will not work due to missing OVS patches fo References ========== -For more information on the OPNFV Fraser release, please visit -https://www.opnfv.org/software +For more information on the OPNFV latest stable release, please visit +https://www.opnfv.org/software
\ No newline at end of file |