diff options
Diffstat (limited to 'docs/release/release-notes/releasenotes.rst')
| -rw-r--r-- | docs/release/release-notes/releasenotes.rst | 151 |
1 files changed, 26 insertions, 125 deletions
diff --git a/docs/release/release-notes/releasenotes.rst b/docs/release/release-notes/releasenotes.rst index 32953313..22ae740e 100644 --- a/docs/release/release-notes/releasenotes.rst +++ b/docs/release/release-notes/releasenotes.rst @@ -5,26 +5,24 @@ Abstract ======== -This document compiles the release notes for the Euphrates release of +This document compiles the release notes for the Hunter release of OPNFV SFC Important notes =============== These notes provide release information for the use of SFC with the -Apex installer and xci tools for the Euphrates release of OPNFV. +Apex installer and xci tool for the Hunter release of OPNFV. Summary ======= -The goal of the SFC Euphrates release is to integrate the OpenDaylight -SFC project into an OPNFV environment, with either the Apex installer or -xci tools. In subsequent releases, we expect Compass4NFV to integrate -the SFC scenarios too. +The goal of the SFC release is to integrate the OpenDaylight SFC project +into an OPNFV environment, with either the Apex installer or xci tool. More information about OpenDaylight and SFC can be found here. -- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Nitrogen SR1" +- `OpenDaylight <http://www.opendaylight.org>`_ version "Fluorine SR1" - `Service function chaining <https://wiki.opnfv.org/display/sfc/Service+Function+Chaining+Home>`_ @@ -33,11 +31,9 @@ More information about OpenDaylight and SFC can be found here. - Overall OPNFV documentation - - `Design document <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/development/design/index.html>`_ - - - `User Guide <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/release/userguide/index.html>`_ - - - `Installation Instructions <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/release/configguide/index.html>`_ + - :ref:`Design document <sfc-design>` + - :ref:`User Guide <sfc-userguide>` + - :ref:`Installation Instructions <sfc-configguide>` - Release Notes (this document) @@ -49,18 +45,16 @@ Release Data | **Project** | sfc | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | euphrates 1.0 | +| **Repo/tag** | opnfv-8.0.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Euphrates base release | +| **Release designation** | Hunter 8.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | 6th October 2017 | +| **Release date** | May 10th, 2019 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Integrate neutron networking-sfc | -| | and use the latest tacker code. Move | -| | to OpenStack ocata and ODL Nitrogen | +| **Purpose of the delivery** | Project maintenance | +--------------------------------------+--------------------------------------+ Version change @@ -70,22 +64,20 @@ Module version changes ~~~~~~~~~~~~~~~~~~~~~~ This release of OPNFV sfc is based on following upstream versions: -- OpenStack Ocata release +- OpenStack Rocky release -- OpenDaylight Nitrogen SR1 release +- OpenDaylight Fluorine SR1 release -- Open vSwitch 2.6.1 with Yi Yang NSH patch +- Open vSwitch 2.9.2 Document changes ~~~~~~~~~~~~~~~~ -This is the first tracked version of OPNFV SFC Euphrates. It comes with +This is the first tracked version of OPNFV SFC Hunter. It comes with the following documentation: -- `Design document <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/development/design/index.html>`_ - -- `User Guide <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/release/userguide/index.html>`_ - -- `Installation Instructions <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/release/configguide/index.html>`_ +- :ref:`Design document <sfc-design>` +- :ref:`User Guide <sfc-userguide:>` +- :ref:`Installation Instructions <sfc-configguide:>` - Release notes (This document) @@ -95,51 +87,23 @@ Reason for version Feature additions ~~~~~~~~~~~~~~~~~ -- `Integration with neutron networking-sfc` -- `Moved to latest tacker code` -- `Started using forwarding graphs as a way to configure SFC` -- `Created compatibility with latest functest (based on Alpine containers)` - Bug corrections ~~~~~~~~~~~~~~~ -**JIRA TICKETS:** - -`Bug-fixes <https://jira.opnfv.org/browse/SFC-103>`_ -`Bug-fixes <https://jira.opnfv.org/browse/SFC-104>`_ -`Bug-fixes <https://jira.opnfv.org/browse/SFC-105>`_ -`Bug-fixes <https://jira.opnfv.org/browse/SFC-106>`_ -`Bug-fixes <https://jira.opnfv.org/browse/SFC-107>`_ -`Bug-fixes <https://jira.opnfv.org/browse/SFC-108>`_ -`Bug-fixes <https://jira.opnfv.org/browse/SFC-109>`_ -`Bug-fixes <https://jira.opnfv.org/browse/SFC-110>`_ -`Bug-fixes <https://jira.opnfv.org/browse/SFC-111>`_ -`Bug-fixes <https://jira.opnfv.org/browse/SFC-112>`_ -`Bug-fixes <https://jira.opnfv.org/browse/SFC-113>`_ -`Bug-fixes <https://jira.opnfv.org/browse/SFC-114>`_ -`Bug-fixes <https://jira.opnfv.org/browse/SFC-116>`_ -`Bug-fixes <https://jira.opnfv.org/browse/SFC-117>`_ - -Apart from the OPNFV bug fixes, there were some bugs in ODL and Tacker which -were fixed as well. - Deliverables ------------ Software deliverables ~~~~~~~~~~~~~~~~~~~~~ -No specific deliverables are created, as SFC is included with Apex. +No specific deliverables are created, as SFC is included with Apex Documentation deliverables ~~~~~~~~~~~~~~~~~~~~~~~~~~ -- `Design document <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/development/design/index.html>`_ - -- `User Guide <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/release/userguide/index.html>`_ - -- `Installation Instructions <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/release/configguide/index.html>`_ - +- :ref:`Design document <sfc-design>` +- :ref:`User Guide <sfc-userguide:>` +- :ref:`Installation Instructions <sfc-configguide:>` - Release notes (This document) Known Limitations, Issues and Workarounds @@ -148,75 +112,18 @@ Known Limitations, Issues and Workarounds System Limitations ------------------ -The Euphrates 3.0 release has a few limitations: - -1 - The testcase sfc_two_chains_SSH_and_HTTP is disabled in this release due to -bugs in ODL, Tacker and networking-sfc: - -https://bugs.opendaylight.org/show_bug.cgi?id=9221 -https://bugs.launchpad.net/tacker/+bug/1719839 -https://bugs.launchpad.net/tacker/+bug/1719876 -https://bugs.launchpad.net/networking-sfc/+bug/1719835 -https://bugs.launchpad.net/networking-sfc/+bug/1719883 - -2 - The topology CLIENT_SERVER_SAME_HOST does not work due to a bug in the -vxlan_tool. This tool is part of the ODL-SFC repo and provides support for -non-NSH-aware SFs: - -https://bugs.opendaylight.org/show_bug.cgi?id=9219 - -3 - The topologies CLIENT_SERVER_DIFFERENT_HOST_SPLIT_VNF and -CLIENT_SERVER_SAME_HOST_SPLIT_VNF do not work because of a ODL bug: - -https://bugs.opendaylight.org/show_bug.cgi?id=9220 - - Known issues ------------ -1 - OpenDaylight SFC relies on a version of Open vSwitch (OVS) with -Network Service Headers (NSH). A version of OVS with NSH currently -exists, but it is in a branched version of OVS. Extensive upstream -work has been done to merge the NSH patches into mainstream OVS, -but the work is still not complete. More information about this -can be found in the OPNFV SFC design document (link provided above). - -2 - Due to a bug in tacker: - -https://bugs.launchpad.net/tacker/+bug/1719841 - -it is not possible to run the SFC scenarios in openstack environments -which require SSL connections to public endpoints and use self-signed -certificates - Workarounds ----------- -There is a way to avoid the known issue number 2 when using xci. Once -the deployment is successfully done, go to tacker server and modify -line 242 of the file: - -/openstack/venvs/tacker-15.1.7/lib/python2.7/site-packages/keystoneauth1/session.py - -So that instead of having: - -self.verify = verify - -It has: - -self.verify = False - -Forcing tacker to not check the certificates - - Test results ============ -The Euphrates release of SFC has undergone QA test runs -with Functest tests on the Apex installer and xci utility References ========== -For more information on the OPNFV Euphrates release, please see: +For more information on the OPNFV Hunter release, please see: OPNFV ----- @@ -225,12 +132,12 @@ OPNFV 2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_ -3) `OPNFV Danube release <http://wiki.opnfv.org/releases/euphrates>`_ +3) `OPNFV Hunter release <https://docs.opnfv.org/en/latest/index.html>`_ OpenStack --------- -4) `OpenStack Newton Release artifacts <http://www.openstack.org/software/ocata>`_ +4) `OpenStack Rocky Release artifacts <http://www.openstack.org/software/rocky>`_ 5) `OpenStack documentation <http://docs.openstack.org>`_ @@ -238,9 +145,3 @@ OpenDaylight ------------ 6) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_ - -Open vSwitch with NSH ---------------------- - -7) https://github.com/yyang13/ovs_nsh_patches - |