diff options
| -rw-r--r-- | docs/release/release-notes/releasenotes.rst | 97 |
1 files changed, 54 insertions, 43 deletions
diff --git a/docs/release/release-notes/releasenotes.rst b/docs/release/release-notes/releasenotes.rst index bf07e59a..3e37b6d7 100644 --- a/docs/release/release-notes/releasenotes.rst +++ b/docs/release/release-notes/releasenotes.rst @@ -5,26 +5,26 @@ Abstract ======== -This document compiles the release notes for the Colorado release of -OPNFV SFC. +This document compiles the release notes for the Danube 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 Colorado release of OPNFV. +and Apex installer tools for the Danube release of OPNFV. Summary ======= -The goal of the SFC Colorado release is to integrate the OpenDaylight +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. More information about OpenDaylight and SFC can be found here. -- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Boron" +- `OpenDaylight <http://www.opendaylight.org/software>`_ version "Boron SR2" - `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://artifacts.opnfv.org/sfc/colorado/docs/design/index.html>`_ + - `Design document <http://artifacts.opnfv.org/sfc/danube/docs/design/index.html>`_ - - `User Guide <http://artifacts.opnfv.org/sfc/colorado/docs/userguide/index.html>`_ + - `User Guide <http://artifacts.opnfv.org/sfc/danube/docs/userguide/index.html>`_ - - `Installation Instructions <http://artifacts.opnfv.org/sfc/colorado/docs/installationprocedure/index.html>`_ + - `Installation Instructions <http://artifacts.opnfv.org/sfc/danube/docs/installationprocedure/index.html>`_ - Release Notes (this document) @@ -49,21 +49,18 @@ Release Data | **Project** | sfc | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | colorado.2.0 | +| **Repo/tag** | danube 1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Colorado base release | +| **Release designation** | Danube base release | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | November 10 2016 | +| **Release date** | March 27 2017 | | | | +--------------------------------------+--------------------------------------+ -| **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 | -| | | +| **Purpose of the delivery** | Add two new test cases and improve | +| | the old test case by using the new | +| | functions coming in functest | +--------------------------------------+--------------------------------------+ Version change @@ -71,23 +68,23 @@ Version change Module version changes ~~~~~~~~~~~~~~~~~~~~~~ -This is the second tracked release of OPNFV sfc. It is based on +This is the first tracked release of OPNFV sfc. It is based on following upstream versions: -- OpenStack Mitaka release +- OpenStack Newton release -- OpenDaylight Boron release +- OpenDaylight Boron SR2 release -- Open vSwitch 2.5.90 with Yi Yang NSH patch +- Open vSwitch 2.6.1 with Yi Yang NSH patch Document changes ~~~~~~~~~~~~~~~~ -This is the second tracked version of OPNFV SFC. It comes with +This is the first tracked version of OPNFV SFC Danube. It comes with the following documentation: -- `Design document <http://artifacts.opnfv.org/sfc/colorado/docs/design/index.html>`_ +- `Design document <http://artifacts.opnfv.org/sfc/danube/docs/design/index.html>`_ -- `User Guide <http://artifacts.opnfv.org/sfc/colorado/docs/userguide/index.html>`_ +- `User Guide <http://artifacts.opnfv.org/sfc/danube/docs/userguide/index.html>`_ - `Installation Instructions <http://artifacts.opnfv.org/sfc/colorado/docs/installationprocedure/index.html>`_ @@ -99,16 +96,24 @@ Reason for version Feature additions ~~~~~~~~~~~~~~~~~ -**JIRA TICKETS:** - -`JIRA EPIC with the new features in SFC Colorado <https://jira.opnfv.org/browse/SFC-33>`_ +- `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` Bug corrections ~~~~~~~~~~~~~~~ **JIRA TICKETS:** -`Bug-fixes <https://jira.opnfv.org/browse/SFC-34>`_ +`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>`_ Deliverables ------------ @@ -121,11 +126,11 @@ No specific deliverables are created, as SFC is included with Apex and Fuel. Documentation deliverables ~~~~~~~~~~~~~~~~~~~~~~~~~~ -- `Design document <http://artifacts.opnfv.org/sfc/colorado/docs/design/index.html>`_ +- `Design document <http://artifacts.opnfv.org/sfc/danube/docs/design/index.html>`_ -- `User Guide <http://artifacts.opnfv.org/sfc/colorado/docs/userguide/index.html>`_ +- `User Guide <http://artifacts.opnfv.org/sfc/danube/docs/userguide/index.html>`_ -- `Installation Instructions <http://artifacts.opnfv.org/sfc/colorado/docs/installationprocedure/index.html>`_ +- `Installation Instructions <http://artifacts.opnfv.org/sfc/danube/docs/installationprocedure/index.html>`_ - Release notes (This document) @@ -135,16 +140,22 @@ Known Limitations, Issues and Workarounds System Limitations ------------------ -The Colorado 2.0 release has several limitations: +The Danube 1.0 release has one limitation: + +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 + +JIRA: https://jira.opnfv.org/browse/SFC-86 -1 - OPNFV SFC only works in non-HA environments with the Fuel installer. -There is a bug in ODL which is fixed in ODL Boron SR1 and will be part -of Colorado 3.0 +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 - Any VM (e.g. SFs) must have only one security group. -There is a bug in ODL Boron which only one security group is read. -The rest are silently ignored. This issue will be fixed in ODL -Boron SR1, which will be included in Colorado 3.0. Known issues ------------ @@ -169,12 +180,12 @@ document (link provided above). Test results ============ -The Colorado release of SFC has undergone QA test runs +The Danube release of SFC has undergone QA test runs with Functest tests on the Fuel and Apex installers. References ========== -For more information on the OPNFV Colorado release, please see: +For more information on the OPNFV Danube release, please see: OPNFV ----- @@ -183,12 +194,12 @@ OPNFV 2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_ -3) `OPNFV Colorado release <http://wiki.opnfv.org/releases/colorado>`_ +3) `OPNFV Danube release <http://wiki.opnfv.org/releases/danube>`_ OpenStack --------- -4) `OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_ +4) `OpenStack Newton Release artifacts <http://www.openstack.org/software/newton>`_ 5) `OpenStack documentation <http://docs.openstack.org>`_ |