summaryrefslogtreecommitdiffstats
path: root/docs/release/release-notes/releasenotes.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/release/release-notes/releasenotes.rst')
-rw-r--r--docs/release/release-notes/releasenotes.rst145
1 files changed, 40 insertions, 105 deletions
diff --git a/docs/release/release-notes/releasenotes.rst b/docs/release/release-notes/releasenotes.rst
index 32953313..b380c81c 100644
--- a/docs/release/release-notes/releasenotes.rst
+++ b/docs/release/release-notes/releasenotes.rst
@@ -5,26 +5,25 @@
Abstract
========
-This document compiles the release notes for the Euphrates release of
+This document compiles the release notes for the Fraser 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, xci tool and Compass4NFV for the Fraser 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 Fraser release is to integrate the OpenDaylight
+SFC project into an OPNFV environment, with either the Apex installer,
+xci tools or Compass4NFV.
More information about OpenDaylight and SFC can be found here.
-- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Nitrogen SR1"
+- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Oxygen SR1"
- `Service function chaining <https://wiki.opnfv.org/display/sfc/Service+Function+Chaining+Home>`_
@@ -33,11 +32,11 @@ 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>`_
+ - `Design document <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/development/design/index.html>`_
- - `User Guide <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/release/userguide/index.html>`_
+ - `User Guide <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/userguide/index.html>`_
- - `Installation Instructions <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/release/configguide/index.html>`_
+ - `Installation Instructions <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/configguide/index.html>`_
- Release Notes (this document)
@@ -49,18 +48,18 @@ Release Data
| **Project** | sfc |
| | |
+--------------------------------------+--------------------------------------+
-| **Repo/tag** | euphrates 1.0 |
+| **Repo/tag** | opnfv-6.0.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release designation** | Euphrates base release |
+| **Release designation** | Fraser base release |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | 6th October 2017 |
+| **Release date** | 27th April 2018 |
| | |
+--------------------------------------+--------------------------------------+
-| **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** | Move to OpenStack Pike and ODL Oxygen|
+| | Support symmetric testcases |
+| | Support master branch of OpenStack |
+--------------------------------------+--------------------------------------+
Version change
@@ -70,22 +69,22 @@ Module version changes
~~~~~~~~~~~~~~~~~~~~~~
This release of OPNFV sfc is based on following upstream versions:
-- OpenStack Ocata release
+- OpenStack Pike release
-- OpenDaylight Nitrogen SR1 release
+- OpenDaylight Oxygen SR1 release
- Open vSwitch 2.6.1 with Yi Yang NSH patch
Document changes
~~~~~~~~~~~~~~~~
-This is the first tracked version of OPNFV SFC Euphrates. It comes with
+This is the first tracked version of OPNFV SFC Fraser. It comes with
the following documentation:
-- `Design document <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/development/design/index.html>`_
+- `Design document <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/development/design/index.html>`_
-- `User Guide <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/release/userguide/index.html>`_
+- `User Guide <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/userguide/index.html>`_
-- `Installation Instructions <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/release/configguide/index.html>`_
+- `Installation Instructions <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/configguide/index.html>`_
- Release notes (This document)
@@ -95,50 +94,29 @@ 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)`
+- `Using SNAPS as base for our tests`
+- `Increase test coverage with two extra test cases: symmetric and deletion`
+- `Reduced the footprint of the image we use for testing to reduce testing time`
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 and Compass4NFV.
Documentation deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~
-- `Design document <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/development/design/index.html>`_
+- `Design document <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/development/design/index.html>`_
-- `User Guide <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/release/userguide/index.html>`_
+- `User Guide <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/userguide/index.html>`_
-- `Installation Instructions <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/release/configguide/index.html>`_
+- `Installation Instructions <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/configguide/index.html>`_
- Release notes (This document)
@@ -148,75 +126,32 @@ Known Limitations, Issues and Workarounds
System Limitations
------------------
-The Euphrates 3.0 release has a few limitations:
+The Fraser 1.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
-
+a missing feature in ODL. We are unable to currently update a chain config
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
+1 - When tacker is deployed without Mistral, there is an ERROR in the logs and
+the VIM is always in 'PENDING' state because tacker cannot monitor its health.
+However, everything works and SFs can be created.
-it is not possible to run the SFC scenarios in openstack environments
-which require SSL connections to public endpoints and use self-signed
-certificates
+2 - When tacker is deployed without barbican, it cannot be in HA mode because
+barbican is the only way to fetch the fernet keys.
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
+The Fraser release of SFC has undergone QA test runs with Functest tests on the
+Apex and Compass installers and xci utility
References
==========
-For more information on the OPNFV Euphrates release, please see:
+For more information on the OPNFV Fraser release, please see:
OPNFV
-----
@@ -225,12 +160,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 Fraser release <http://wiki.opnfv.org/releases/fraser>`_
OpenStack
---------
-4) `OpenStack Newton Release artifacts <http://www.openstack.org/software/ocata>`_
+4) `OpenStack Pike Release artifacts <http://www.openstack.org/software/pike>`_
5) `OpenStack documentation <http://docs.openstack.org>`_