From d5de424ce1e836c9088ba3c76cfe19691f831cb3 Mon Sep 17 00:00:00 2001 From: Manuel Buil Date: Wed, 25 Apr 2018 17:22:45 +0200 Subject: Update docs for Fraser Change-Id: Ie53eb812c9111a2f75342470b10ef3376e43b5fb Signed-off-by: Manuel Buil --- docs/release/configguide/feature.configuration.rst | 4 +- docs/release/release-notes/releasenotes.rst | 145 ++++++--------------- .../os-odl-sfc-ha/scenario.description.rst | 12 +- .../os-odl-sfc-noha/scenario.description.rst | 25 ++-- .../os-odl-sfc_fdio-ha/scenario.description.rst | 55 +------- .../os-odl-sfc_fdio-noha/scenario.description.rst | 63 +-------- 6 files changed, 59 insertions(+), 245 deletions(-) (limited to 'docs/release') diff --git a/docs/release/configguide/feature.configuration.rst b/docs/release/configguide/feature.configuration.rst index 37f381d0..ad9725ed 100644 --- a/docs/release/configguide/feature.configuration.rst +++ b/docs/release/configguide/feature.configuration.rst @@ -12,9 +12,9 @@ SFC feature desciription For details of the scenarios and their provided capabilities refer to the scenario description documents: -- http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/release/scenarios/os-odl-sfc-ha/index.html +- http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/scenarios/os-odl-sfc-ha/index.html -- http://docs.opnfv.org/en/stable-euphrates/submodules/sfc/docs/release/scenarios/os-odl-sfc-noha/index.html +- http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/scenarios/os-odl-sfc-noha/index.html The SFC feature enables creation of Service Fuction Chains - an ordered list 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 `_ version "Nitrogen SR1" +- `OpenDaylight `_ version "Oxygen SR1" - `Service function chaining `_ @@ -33,11 +32,11 @@ More information about OpenDaylight and SFC can be found here. - Overall OPNFV documentation - - `Design document `_ + - `Design document `_ - - `User Guide `_ + - `User Guide `_ - - `Installation Instructions `_ + - `Installation Instructions `_ - 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 `_ +- `Design document `_ -- `User Guide `_ +- `User Guide `_ -- `Installation Instructions `_ +- `Installation Instructions `_ - 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 `_ -`Bug-fixes `_ -`Bug-fixes `_ -`Bug-fixes `_ -`Bug-fixes `_ -`Bug-fixes `_ -`Bug-fixes `_ -`Bug-fixes `_ -`Bug-fixes `_ -`Bug-fixes `_ -`Bug-fixes `_ -`Bug-fixes `_ -`Bug-fixes `_ -`Bug-fixes `_ - -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 `_ +- `Design document `_ -- `User Guide `_ +- `User Guide `_ -- `Installation Instructions `_ +- `Installation Instructions `_ - 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 `_ -3) `OPNFV Danube release `_ +3) `OPNFV Fraser release `_ OpenStack --------- -4) `OpenStack Newton Release artifacts `_ +4) `OpenStack Pike Release artifacts `_ 5) `OpenStack documentation `_ diff --git a/docs/release/scenarios/os-odl-sfc-ha/scenario.description.rst b/docs/release/scenarios/os-odl-sfc-ha/scenario.description.rst index 11b41434..3c728861 100644 --- a/docs/release/scenarios/os-odl-sfc-ha/scenario.description.rst +++ b/docs/release/scenarios/os-odl-sfc-ha/scenario.description.rst @@ -8,7 +8,7 @@ Introduction The os-odl-sfc-ha is intended to be used to install the OPNFV SFC project in a standard OPNFV High Availability mode. The OPNFV SFC project integrates the OpenDaylight SFC project -into the OPNFV environment. The OPNFV SFC Euphrates release uses the OpenDaylight Nitrogen SR1 release. +into the OPNFV environment. The OPNFV SFC Fraser release uses the OpenDaylight Oxygen SR1 release. Scenario components and composition =================================== @@ -74,17 +74,13 @@ Limitations, Issues and Workarounds .. faults or bugs. If the system design only provide some expected functionality then provide .. some insight at this point. -The *client* virtual machine needs to be located in a compute node where at least -one of the service functions (SFs) is placed. This is due to a limitation in OpenDaylight, -Nitrogen, which only installs the traffic classifier in the compute nodes where the SFs are. - Specific version of OVS ----------------------- SFC needs changes in OVS to include the Network Service Headers (NSH) Service Chaining encapsulation. This OVS patch has been ongoing for quite a while (2 years+), and still has not been officially merged. Previously, SFC used NSH from a branched version of OVS -based on 2.3.90, called the "Pritesh Patch". In the OpenDaylight Nitrogen SR1 release, SFC was +based on 2.3.90, called the "Pritesh Patch". In the OpenDaylight Oxygen SR1 release, SFC was changed to use a newer, branched version of OVS based on 2.6.1, called the "Yi Yang Patch". @@ -101,6 +97,6 @@ https://wiki.opnfv.org/display/sfc/Service+Function+Chaining+Home https://wiki.opendaylight.org/view/Service_Function_Chaining:Main -For more information on the OPNFV Euphrates release, please visit: +For more information on the OPNFV Fraser release, please visit: -http://www.opnfv.org/euphrates +http://www.opnfv.org/fraser diff --git a/docs/release/scenarios/os-odl-sfc-noha/scenario.description.rst b/docs/release/scenarios/os-odl-sfc-noha/scenario.description.rst index e74e47c4..3c728861 100644 --- a/docs/release/scenarios/os-odl-sfc-noha/scenario.description.rst +++ b/docs/release/scenarios/os-odl-sfc-noha/scenario.description.rst @@ -6,10 +6,9 @@ Introduction ============ .. In this section explain the purpose of the scenario and the types of capabilities provided -The os-odl-sfc-noha is intended to be used to install the OPNFV SFC project in a standard -OPNFV Non-High Availability mode. The OPNFV SFC project integrates the OpenDaylight SFC -project into the OPNFV environment. The OPNFV SFC Euphrates release uses the OpenDaylight -Nitrogen SR1 release. +The os-odl-sfc-ha is intended to be used to install the OPNFV SFC project in a standard +OPNFV High Availability mode. The OPNFV SFC project integrates the OpenDaylight SFC project +into the OPNFV environment. The OPNFV SFC Fraser release uses the OpenDaylight Oxygen SR1 release. Scenario components and composition =================================== @@ -18,9 +17,8 @@ Scenario components and composition .. to communicate to the user the capabilities available in this scenario. This scenario installs everything needed to use the SFC OpenDaylight project in an OPNFV -environment. Since this scenario is Non-High Availability, then only one controller and -one compute node will be deployed. The classifier used in this scenario is implemented -by the Netvirt OpenDaylight project. +environment. The classifier used in this scenario is implemented by the Netvirt OpenDaylight +project. Following is a detailed list of what is included with this scenario: @@ -58,7 +56,7 @@ The VNF Manager In order to create a VM for each Service Function, a VNF Manager is needed. The OPNFV SFC project currently uses the Tacker OpenStack project as a VNF Manager. Tacker is installed on the controller node and manages VNF life cycle, and coordinates VM creation -with the OpenDaylight SFC project. +and SFC configuration with OpenStack and OpenDaylight SFC project. Scenario usage overview ======================= @@ -76,17 +74,13 @@ Limitations, Issues and Workarounds .. faults or bugs. If the system design only provide some expected functionality then provide .. some insight at this point. -The *client* virtual machine needs to be located in a compute node where at least -one of the service functions (SFs) is placed. This is due to a limitation in OpenDaylight, -Nitrogen, which only installs the traffic classifier in the compute nodes where the SFs are. - Specific version of OVS ----------------------- SFC needs changes in OVS to include the Network Service Headers (NSH) Service Chaining encapsulation. This OVS patch has been ongoing for quite a while (2 years+), and still has not been officially merged. Previously, SFC used NSH from a branched version of OVS -based on 2.3.90, called the "Pritesh Patch". In the OpenDaylight Nitrogen SR1 release, SFC was +based on 2.3.90, called the "Pritesh Patch". In the OpenDaylight Oxygen SR1 release, SFC was changed to use a newer, branched version of OVS based on 2.6.1, called the "Yi Yang Patch". @@ -103,7 +97,6 @@ https://wiki.opnfv.org/display/sfc/Service+Function+Chaining+Home https://wiki.opendaylight.org/view/Service_Function_Chaining:Main -For more information on the OPNFV Euphrates release, please visit: - -http://www.opnfv.org/euphrates +For more information on the OPNFV Fraser release, please visit: +http://www.opnfv.org/fraser diff --git a/docs/release/scenarios/os-odl-sfc_fdio-ha/scenario.description.rst b/docs/release/scenarios/os-odl-sfc_fdio-ha/scenario.description.rst index 39efcacd..b9d965a3 100644 --- a/docs/release/scenarios/os-odl-sfc_fdio-ha/scenario.description.rst +++ b/docs/release/scenarios/os-odl-sfc_fdio-ha/scenario.description.rst @@ -8,7 +8,7 @@ Introduction The os-odl-sfc_fdio-ha is intended to be used to install the OPNFV SFC project in a standard OPNFV High Availability mode. The OPNFV SFC project integrates the OpenDaylight SFC project -into the OPNFV environment. The OPNFV SFC Euphrates release uses the OpenDaylight Nitrogen SR1 release. +into the OPNFV environment. The OPNFV SFC Fraser release uses the OpenDaylight Oxygen SR1 release. Scenario components and composition =================================== @@ -16,48 +16,9 @@ Scenario components and composition .. what each component provides and why it has been included in order .. to communicate to the user the capabilities available in this scenario. -This scenario installs everything needed to use the SFC OpenDaylight project in an OPNFV -environment. The classifier used in this scenario is implemented by the Netvirt OpenDaylight -project. - -Following is a detailed list of what is included with this scenario: - OpenDaylight features installed ------------------------------- -The OpenDaylight SDN controller is installed in the controller node. - -The following are the SFC features that get installed: - -- odl-sfc-model -- odl-sfc-provider -- odl-sfc-provider-rest -- odl-sfc-ovs -- odl-sfc-openflow-renderer - -The following are the Netvirt features that get installed: - -- odl-netvirt-openstack -- odl-sfc-genius -- odl-neutron-service -- odl-neutron-northbound-api -- odl-neutron-spi -- odl-neutron-transcriber -- odl-ovsdb-southbound-impl-api -- odl-ovsdb-southbound-impl-impl -- odl-ovsdb-library - -By simply installing the odl-netvirt-sfc feature, all the dependant features -will automatically be installed. - -The VNF Manager ---------------- - -In order to create a VM for each Service Function, a VNF Manager is needed. The OPNFV -SFC project currently uses the Tacker OpenStack project as a VNF Manager. Tacker is -installed on the controller node and manages VNF life cycle, and coordinates VM creation -and SFC configuration with OpenStack and OpenDaylight SFC project. - Scenario usage overview ======================= .. Provide a brief overview on how to use the scenario and the features available to the @@ -74,10 +35,6 @@ Limitations, Issues and Workarounds .. faults or bugs. If the system design only provide some expected functionality then provide .. some insight at this point. -The *client* virtual machine needs to be located in a compute node where at least -one of the service functions (SFs) is placed. This is due to a limitation in OpenDaylight, -Nitrogen, which only installs the traffic classifier in the compute nodes where the SFs are. - Specific version of FD.IO ----------------------- @@ -85,13 +42,3 @@ TO BE ADDED References ========== - -For more information about SFC, please visit: - -https://wiki.opnfv.org/display/sfc/Service+Function+Chaining+Home - -https://wiki.opendaylight.org/view/Service_Function_Chaining:Main - -For more information on the OPNFV Euphrates release, please visit: - -http://www.opnfv.org/euphrates diff --git a/docs/release/scenarios/os-odl-sfc_fdio-noha/scenario.description.rst b/docs/release/scenarios/os-odl-sfc_fdio-noha/scenario.description.rst index 6ef8c4ba..b9d965a3 100644 --- a/docs/release/scenarios/os-odl-sfc_fdio-noha/scenario.description.rst +++ b/docs/release/scenarios/os-odl-sfc_fdio-noha/scenario.description.rst @@ -6,10 +6,9 @@ Introduction ============ .. In this section explain the purpose of the scenario and the types of capabilities provided -The os-odl-sfc_fdio-noha is intended to be used to install the OPNFV SFC project in a standard -OPNFV Non-High Availability mode. The OPNFV SFC project integrates the OpenDaylight SFC -project into the OPNFV environment. The OPNFV SFC Euphrates release uses the OpenDaylight -Nitrogen SR1 release. +The os-odl-sfc_fdio-ha is intended to be used to install the OPNFV SFC project in a standard +OPNFV High Availability mode. The OPNFV SFC project integrates the OpenDaylight SFC project +into the OPNFV environment. The OPNFV SFC Fraser release uses the OpenDaylight Oxygen SR1 release. Scenario components and composition =================================== @@ -17,49 +16,9 @@ Scenario components and composition .. what each component provides and why it has been included in order .. to communicate to the user the capabilities available in this scenario. -This scenario installs everything needed to use the SFC OpenDaylight project in an OPNFV -environment. Since this scenario is Non-High Availability, then only one controller and -one compute node will be deployed. The classifier used in this scenario is implemented -by the Netvirt OpenDaylight project. - -Following is a detailed list of what is included with this scenario: - OpenDaylight features installed ------------------------------- -The OpenDaylight SDN controller is installed in the controller node. - -The following are the SFC features that get installed: - -- odl-sfc-model -- odl-sfc-provider -- odl-sfc-provider-rest -- odl-sfc-ovs -- odl-sfc-openflow-renderer - -The following are the Netvirt features that get installed: - -- odl-netvirt-openstack -- odl-sfc-genius -- odl-neutron-service -- odl-neutron-northbound-api -- odl-neutron-spi -- odl-neutron-transcriber -- odl-ovsdb-southbound-impl-api -- odl-ovsdb-southbound-impl-impl -- odl-ovsdb-library - -By simply installing the odl-netvirt-sfc feature, all the dependant features -will automatically be installed. - -The VNF Manager ---------------- - -In order to create a VM for each Service Function, a VNF Manager is needed. The OPNFV -SFC project currently uses the Tacker OpenStack project as a VNF Manager. Tacker is -installed on the controller node and manages VNF life cycle, and coordinates VM creation -with the OpenDaylight SFC project. - Scenario usage overview ======================= .. Provide a brief overview on how to use the scenario and the features available to the @@ -76,26 +35,10 @@ Limitations, Issues and Workarounds .. faults or bugs. If the system design only provide some expected functionality then provide .. some insight at this point. -The *client* virtual machine needs to be located in a compute node where at least -one of the service functions (SFs) is placed. This is due to a limitation in OpenDaylight, -Nitrogen, which only installs the traffic classifier in the compute nodes where the SFs are. - Specific version of FD.IO ----------------------- TO BE ADDED - References ========== - -For more information about SFC, please visit: - -https://wiki.opnfv.org/display/sfc/Service+Function+Chaining+Home - -https://wiki.opendaylight.org/view/Service_Function_Chaining:Main - -For more information on the OPNFV Euphrates release, please visit: - -http://www.opnfv.org/euphrates - -- cgit 1.2.3-korg