Updating the release notes for SFC Colorado

- Patch Set 2: minor correction
- Patch Set 3: addressed code review comments
- Patch Set 4: more code review comments fixed
- Patch Set 6: improved the known issues/limitations section

Change-Id: I52c24fea48cb0a107c6aa36bc656148d6525f3ed
Signed-off-by: Brady Johnson <brady.allen.johnson@ericsson.com>
(cherry picked from commit 2d23ce74c368d6753485108a160f90fe6068ce05)

1 files changed, 62 insertions, 43 deletions

diff --git a/docs/releasenotes/releasenotes.rst b/docs/releasenotes/releasenotes.rst
index f239579f..4d36f9ea 100644
--- a/docs/releasenotes/releasenotes.rst
+++ b/docs/releasenotes/releasenotes.rst
@@ -1,41 +1,45 @@
-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
+.. 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
 
 Abstract
 ========
 
-This document compiles the release notes for the Brahmaputra release of
+This document compiles the release notes for the Colorado 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 Brahmaputra release of OPNFV.
+and Apex installer tools for the Colorado release of OPNFV.
 
 Summary
 =======
 
-The goal of the SFC Brahmaputra release is to integrate the OpenDaylight
+The goal of the SFC Colorado 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.
 
 More information about OpenDaylight and SFC can be found here.
 
-- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Berylium"
+- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Boron"
 
-- `Service function chaining <https://wiki.opnfv.org/service_function_chaining>`_
+- `Service function chaining <https://wiki.opnfv.org/display/sfc/Service+Function+Chaining+Home>`_
 
 
 - Documentation built by Jenkins
 
-  - overall OPNFV documentation
+  - Overall OPNFV documentation
 
-  - Design document
+  - `Design document <http://artifacts.opnfv.org/sfc/colorado/docs/design/index.html>`_
 
-  - this document (release notes)
+  - `User Guide <http://artifacts.opnfv.org/sfc/colorado/docs/userguide/index.html>`_
+
+  - `Installation Instructions <http://artifacts.opnfv.org/sfc/colorado/docs/installationprocedure/index.html>`_
+
+  - Release Notes (this document)
 
 
 Release Data
@@ -45,16 +49,20 @@ Release Data
 | **Project**                          | sfc                                  |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Repo/tag**                         | brahmaputra.1.0                      |
+| **Repo/tag**                         | colorado.1.0                         |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release designation**              | Brahmaputra base release             |
+| **Release designation**              | Colorado base release                |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release date**                     | February 25 2016                     |
+| **Release date**                     | September 22 2016                    |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Purpose of the delivery**          | Brahmaputra base release             |
+| **Purpose of the delivery**          | Improve functionality provided in    |
+|                                      | Brahmaputra release. Increased test  |
+|                                      | coverage with new Funtest cases.     |
+|                                      | Make SFC/Tacker work on multiple     |
+|                                      | compute nodes                        |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
@@ -63,21 +71,25 @@ Version change
 
 Module version changes
 ~~~~~~~~~~~~~~~~~~~~~~
-This is the first tracked release of OPNFV sfc. It is based on
+This is the second tracked release of OPNFV sfc. It is based on
 following upstream versions:
 
-- OpenStack Liberty release
+- OpenStack Mitaka release
 
-- OpenDaylight Beryllium release
+- OpenDaylight Boron release
 
-- Open vSwitch
+- Open vSwitch 2.5.90 with Yi Yang NSH patch
 
 Document changes
 ~~~~~~~~~~~~~~~~
-This is the first tracked version of OPNFV SFC. It comes with
+This is the second tracked version of OPNFV SFC. It comes with
 the following documentation:
 
-- Design document
+- `Design document <http://artifacts.opnfv.org/sfc/colorado/docs/design/index.html>`_
+
+- `User Guide <http://artifacts.opnfv.org/sfc/colorado/docs/userguide/index.html>`_
+
+- `Installation Instructions <http://artifacts.opnfv.org/sfc/colorado/docs/installationprocedure/index.html>`_
 
 - Release notes (This document)
 
@@ -89,14 +101,14 @@ Feature additions
 
 **JIRA TICKETS:**
 
-`New features <https://jira.opnfv.org/issues/?filter=11002>`_ 'https://jira.opnfv.org/issues/?filter=11002'
+`JIRA EPIC with the new features in SFC Colorado <https://jira.opnfv.org/browse/SFC-33>`_
 
 Bug corrections
 ~~~~~~~~~~~~~~~
 
 **JIRA TICKETS:**
 
-`Bug-fixes <https://jira.opnfv.org/browse/FUEL-99?filter=11001>`_ 'https://jira.opnfv.org/browse/FUEL-99?filter=11001'
+`Bug-fixes <https://jira.opnfv.org/browse/SFC-34>`_
 
 Deliverables
 ------------
@@ -109,20 +121,17 @@ No specific deliverables are created, as SFC is included with Apex and Fuel.
 Documentation deliverables
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- Design document
+- `Design document <http://artifacts.opnfv.org/sfc/colorado/docs/design/index.html>`_
+
+- `User Guide <http://artifacts.opnfv.org/sfc/colorado/docs/userguide/index.html>`_
+
+- `Installation Instructions <http://artifacts.opnfv.org/sfc/colorado/docs/installationprocedure/index.html>`_
 
 - Release notes (This document)
 
 Known Limitations, Issues and Workarounds
 =========================================
 
-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 private branch. 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.
-
 System Limitations
 ------------------
 
@@ -131,37 +140,46 @@ No limitations beyond those in Fuel and Apex have been identified.
 Known issues
 ------------
 
-**JIRA TICKETS:**
-
-`Known issues <https://jira.opnfv.org/browse/SFC-27>`_ 'https://jira.opnfv.org/browse/SFC-27'
+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).
 
 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).
 
 Test results
 ============
-The Brahmaputra release of SFC has only undergone QA test runs with
-the Fuel installer and basic Yardstick tests, nothing SFC specific.
+The Colorado release of SFC has undergone QA test runs
+with Functest tests on the Fuel and Apex installers.
 
 References
 ==========
-For more information on the OPNFV Brahmaputra release, please see:
+For more information on the OPNFV Colorado release, please see:
 
 OPNFV
 -----
 
-1) `OPNFV Home Page <www.opnfv.org>`_
+1) `OPNFV Home Page <https://www.opnfv.org>`_
 
 2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_
 
-3) `OPNFV Brahmaputra release <http://wiki.opnfv.org/releases/brahmaputra>`_
+3) `OPNFV Colorado release <http://wiki.opnfv.org/releases/colorado>`_
 
 OpenStack
 ---------
 
-4) `OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
+4) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_
 
 5) `OpenStack documentation <http://docs.openstack.org>`_
 
@@ -170,7 +188,8 @@ OpenDaylight
 
 6) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
 
+Open vSwitch with NSH
+---------------------
 
-:Authors: Brady Johnson (brady.allen.johnson@ericsson.com)
-:Version: 1.0.0
+7) https://github.com/yyang13/ovs_nsh_patches