.. 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 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 Danube 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. More information about OpenDaylight and SFC can be found here. - `OpenDaylight `_ version "Boron SR2" - `Service function chaining `_ - Documentation built by Jenkins - Overall OPNFV documentation - `Design document `_ - `User Guide `_ - `Installation Instructions `_ - Release Notes (this document) Release Data ============ +--------------------------------------+--------------------------------------+ | **Project** | sfc | | | | +--------------------------------------+--------------------------------------+ | **Repo/tag** | danube 1.0 | | | | +--------------------------------------+--------------------------------------+ | **Release designation** | Danube base release | | | | +--------------------------------------+--------------------------------------+ | **Release date** | March 31 2017 | | | | +--------------------------------------+--------------------------------------+ | **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 -------------- Module version changes ~~~~~~~~~~~~~~~~~~~~~~ This is the first tracked release of OPNFV sfc. It is based on following upstream versions: - OpenStack Newton release - OpenDaylight Boron SR2 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 the following documentation: - `Design document `_ - `User Guide `_ - `Installation Instructions `_ - Release notes (This document) 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` Bug corrections ~~~~~~~~~~~~~~~ **JIRA TICKETS:** `Bug-fixes `_ `Bug-fixes `_ `Bug-fixes `_ `Bug-fixes `_ `Bug-fixes `_ `Bug-fixes `_ `Bug-fixes `_ `Bug-fixes `_ Deliverables ------------ Software deliverables ~~~~~~~~~~~~~~~~~~~~~ No specific deliverables are created, as SFC is included with Apex and Fuel. Documentation deliverables ~~~~~~~~~~~~~~~~~~~~~~~~~~ - `Design document `_ - `User Guide `_ - `Installation Instructions `_ - Release notes (This document) Known Limitations, Issues and Workarounds ========================================= System 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 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. Known issues ------------ 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 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 Danube release, please see: OPNFV ----- 1) `OPNFV Home Page `_ 2) `OPNFV documentation- and software downloads `_ 3) `OPNFV Danube release `_ OpenStack --------- 4) `OpenStack Newton Release artifacts `_ 5) `OpenStack documentation `_ OpenDaylight ------------ 6) `OpenDaylight artifacts `_ Open vSwitch with NSH --------------------- 7) https://github.com/yyang13/ovs_nsh_patches