Release notes update

This is an update of the release notes for the Euphrates release

Change-Id: Ia74839aceb53f6a647b4695c0cc3f7cf8d8e8282
Signed-off-by: Manuel Buil <mbuil@suse.com>

1 files changed, 98 insertions, 67 deletions

diff --git a/docs/release/release-notes/releasenotes.rst b/docs/release/release-notes/releasenotes.rst
index 73b09922..32953313 100644
--- a/docs/release/release-notes/releasenotes.rst
+++ b/docs/release/release-notes/releasenotes.rst
@@ -1,30 +1,30 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
-.. (c) Brady Johnson (Ericsson Inc.) and others
+.. (c) Manuel Buil (SuSe Linux) and others
 
 Abstract
 ========
 
-This document compiles the release notes for the Danube release of
+This document compiles the release notes for the Euphrates release of
 OPNFV SFC
 
 Important notes
 ===============
 
-These notes provide release information for the use of SFC with the Fuel
-and Apex installer tools for the Danube release of OPNFV.
+These notes provide release information for the use of SFC with the
+Apex installer and xci tools for the Euphrates release of OPNFV.
 
 Summary
 =======
 
-The goal of the SFC Danube release is to integrate the OpenDaylight
-SFC project into an OPNFV environment, with either the Fuel or Apex
-installer. In subsequent releases, other OPNFV installers will be
-considered.
+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.
 
 More information about OpenDaylight and SFC can be found here.
 
-- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Boron SR3"
+- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Nitrogen SR1"
 
 - `Service function chaining <https://wiki.opnfv.org/display/sfc/Service+Function+Chaining+Home>`_
 
@@ -33,11 +33,11 @@ More information about OpenDaylight and SFC can be found here.
 
   - Overall OPNFV documentation
 
-  - `Design document <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/development/design/index.html>`_
+  - `Design document <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/development/design/index.html>`_
 
-  - `User Guide <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/release/userguide/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-danube/submodules/sfc/docs/release/configguide/index.html>`_
+  - `Installation Instructions <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/release/configguide/index.html>`_
 
   - Release Notes (this document)
 
@@ -49,18 +49,18 @@ Release Data
 | **Project**                          | sfc                                  |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Repo/tag**                         | danube 3.0                           |
+| **Repo/tag**                         | euphrates 1.0                        |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release designation**              | Danube base release                  |
+| **Release designation**              | Euphrates base release               |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release date**                     | July 14 2017                         |
+| **Release date**                     | 6th October 2017                     |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Purpose of the delivery**          | Add two new test cases and improve   |
-|                                      | the old test case by using the new   |
-|                                      | functions coming in functest         |
+| **Purpose of the delivery**          | Integrate neutron networking-sfc     |
+|                                      | and use the latest tacker code. Move |
+|                                      | to OpenStack ocata and ODL Nitrogen  |
 +--------------------------------------+--------------------------------------+
 
 Version change
@@ -68,25 +68,24 @@ Version change
 
 Module version changes
 ~~~~~~~~~~~~~~~~~~~~~~
-This is the first tracked release of OPNFV sfc. It is based on
-following upstream versions:
+This release of OPNFV sfc is based on following upstream versions:
 
-- OpenStack Newton release
+- OpenStack Ocata release
 
-- OpenDaylight Boron SR3 release
+- OpenDaylight Nitrogen SR1 release
 
 - Open vSwitch 2.6.1 with Yi Yang NSH patch
 
 Document changes
 ~~~~~~~~~~~~~~~~
-This is the first tracked version of OPNFV SFC Danube. It comes with
+This is the first tracked version of OPNFV SFC Euphrates. It comes with
 the following documentation:
 
-- `Design document <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/development/design/index.html>`_
+- `Design document <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/development/design/index.html>`_
 
-- `User Guide <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/release/userguide/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-danube/submodules/sfc/docs/release/configguide/index.html>`_
+- `Installation Instructions <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/release/configguide/index.html>`_
 
 - Release notes (This document)
 
@@ -96,24 +95,33 @@ Reason for version
 Feature additions
 ~~~~~~~~~~~~~~~~~
 
-- `Added two new test cases to the scenarios`
-- `Added a topology shuffler to the three test cases`
-- `Improved readability and modularity of test case`
-- `Integration with the new functest`
+- `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-67>`_
-`Bug-fixes <https://jira.opnfv.org/browse/SFC-74>`_
-`Bug-fixes <https://jira.opnfv.org/browse/SFC-79>`_
-`Bug-fixes <https://jira.opnfv.org/browse/SFC-79>`_
-`Bug-fixes <https://jira.opnfv.org/browse/SFC-85>`_
-`Bug-fixes <https://jira.opnfv.org/browse/SFC-87>`_
-`Bug-fixes <https://jira.opnfv.org/browse/SFC-88>`_
-`Bug-fixes <https://jira.opnfv.org/browse/SFC-89>`_
+`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
 ------------
@@ -121,16 +129,16 @@ Deliverables
 Software deliverables
 ~~~~~~~~~~~~~~~~~~~~~
 
-No specific deliverables are created, as SFC is included with Apex and Fuel.
+No specific deliverables are created, as SFC is included with Apex.
 
 Documentation deliverables
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- `Design document <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/development/design/index.html>`_
+- `Design document <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/development/design/index.html>`_
 
-- `User Guide <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/release/userguide/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-danube/submodules/sfc/docs/release/configguide/index.html>`_
+- `Installation Instructions <http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/release/configguide/index.html>`_
 
 - Release notes (This document)
 
@@ -140,52 +148,75 @@ Known Limitations, Issues and Workarounds
 System Limitations
 ------------------
 
-The Danube 3.0 release has two limitations:
+The Euphrates 3.0 release has a few limitations:
 
-1 - The symmetric test case only works when client, server and
-SFs are running in the same compute host. This is due to a missing
-functionality in Tacker
+1 - The testcase sfc_two_chains_SSH_and_HTTP is disabled in this release due to
+bugs in ODL, Tacker and networking-sfc:
 
-JIRA: https://jira.opnfv.org/browse/SFC-86
+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 test cases don't work in topologies where the client is not collocated
-with a SF in one compute. The reason is that ODL Boron only creates a
-classification rule in the computes with SFs. Therefore, the traffic from the
-client goes to the server as it would be done without SFC (SFC classifier is
-implemented only in the other compute). Having the SFs collocated with the
-server and the client alone in other server does not work either because the
-classification only classify traffic from local taps.
+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
 ------------
 
-OpenDaylight SFC relies on a version of Open vSwitch (OVS) with
+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
 -----------
 
-The way OpenStack handles VXLAN-GPE tunnels doesnt work well with
-SFC, since OpenStack terminates the VXLAN tunnels in the br-int
-bridge instead of the SF VM. Ideally, the tunnel should be terminated
-in the VM so the SF has access to the NSH header carried in the tunnel.
-A workaround was created to send the packets to the SF VM with the
-VXLAN-GPE headers intact and can be found in the OPNFV SFC design
-document (link provided above).
+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 Danube release of SFC has undergone QA test runs
-with Functest tests on the Fuel and Apex installers.
+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 Danube release, please see:
+For more information on the OPNFV Euphrates release, please see:
 
 OPNFV
 -----
@@ -194,12 +225,12 @@ OPNFV
 
 2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_
 
-3) `OPNFV Danube release <http://wiki.opnfv.org/releases/danube>`_
+3) `OPNFV Danube release <http://wiki.opnfv.org/releases/euphrates>`_
 
 OpenStack
 ---------
 
-4) `OpenStack Newton Release artifacts <http://www.openstack.org/software/newton>`_
+4) `OpenStack Newton Release artifacts <http://www.openstack.org/software/ocata>`_
 
 5) `OpenStack documentation <http://docs.openstack.org>`_