diff options
Diffstat (limited to 'docs/release')
9 files changed, 84 insertions, 217 deletions
diff --git a/docs/release/configguide/feature.configuration.rst b/docs/release/configguide/feature.configuration.rst index ad9725ed..4cf2718f 100644 --- a/docs/release/configguide/feature.configuration.rst +++ b/docs/release/configguide/feature.configuration.rst @@ -12,10 +12,8 @@ SFC feature desciription For details of the scenarios and their provided capabilities refer to the scenario description documents: -- http://docs.opnfv.org/en/stable-fraser/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-noha/index.html - +- :ref:`<os-odl-sfc-ha>` +- :ref:`<os-odl-sfc-noha>` The SFC feature enables creation of Service Fuction Chains - an ordered list of chained network funcions (e.g. firewalls, NAT, QoS) diff --git a/docs/release/release-notes/releasenotes.rst b/docs/release/release-notes/releasenotes.rst index 7b3e0987..22ae740e 100644 --- a/docs/release/release-notes/releasenotes.rst +++ b/docs/release/release-notes/releasenotes.rst @@ -5,25 +5,24 @@ Abstract ======== -This document compiles the release notes for the Fraser release of +This document compiles the release notes for the Hunter release of OPNFV SFC Important notes =============== These notes provide release information for the use of SFC with the -Apex installer, xci tool and Compass4NFV for the Fraser release of OPNFV. +Apex installer and xci tool for the Hunter release of OPNFV. Summary ======= -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. +The goal of the SFC release is to integrate the OpenDaylight SFC project +into an OPNFV environment, with either the Apex installer or xci tool. More information about OpenDaylight and SFC can be found here. -- `OpenDaylight <http://www.opendaylight.org>`_ version "Oxygen SR1" +- `OpenDaylight <http://www.opendaylight.org>`_ version "Fluorine SR1" - `Service function chaining <https://wiki.opnfv.org/display/sfc/Service+Function+Chaining+Home>`_ @@ -32,11 +31,9 @@ More information about OpenDaylight and SFC can be found here. - Overall OPNFV documentation - - `Design document <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/development/design/index.html>`_ - - - `User Guide <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/userguide/index.html>`_ - - - `Installation Instructions <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/configguide/index.html>`_ + - :ref:`Design document <sfc-design>` + - :ref:`User Guide <sfc-userguide>` + - :ref:`Installation Instructions <sfc-configguide>` - Release Notes (this document) @@ -48,18 +45,16 @@ Release Data | **Project** | sfc | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | opnfv-6.1.0 | +| **Repo/tag** | opnfv-8.0.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Fraser 6.1 | +| **Release designation** | Hunter 8.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | 25th May 2018 | +| **Release date** | May 10th, 2019 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Move to OpenStack Pike and ODL Oxygen| -| | Support symmetric testcases | -| | Support master branch of OpenStack | +| **Purpose of the delivery** | Project maintenance | +--------------------------------------+--------------------------------------+ Version change @@ -69,22 +64,20 @@ Module version changes ~~~~~~~~~~~~~~~~~~~~~~ This release of OPNFV sfc is based on following upstream versions: -- OpenStack Pike release +- OpenStack Rocky release -- OpenDaylight Oxygen SR1 release +- OpenDaylight Fluorine SR1 release -- Open vSwitch 2.6.1 with Yi Yang NSH patch +- Open vSwitch 2.9.2 Document changes ~~~~~~~~~~~~~~~~ -This is the first tracked version of OPNFV SFC Fraser. It comes with +This is the first tracked version of OPNFV SFC Hunter. It comes with the following documentation: -- `Design document <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/development/design/index.html>`_ - -- `User Guide <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/userguide/index.html>`_ - -- `Installation Instructions <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/configguide/index.html>`_ +- :ref:`Design document <sfc-design>` +- :ref:`User Guide <sfc-userguide:>` +- :ref:`Installation Instructions <sfc-configguide:>` - Release notes (This document) @@ -94,10 +87,6 @@ Reason for version Feature additions ~~~~~~~~~~~~~~~~~ -- `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 ~~~~~~~~~~~~~~~ @@ -107,17 +96,14 @@ Deliverables Software deliverables ~~~~~~~~~~~~~~~~~~~~~ -No specific deliverables are created, as SFC is included with Apex and Compass4NFV. +No specific deliverables are created, as SFC is included with Apex Documentation deliverables ~~~~~~~~~~~~~~~~~~~~~~~~~~ -- `Design document <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/development/design/index.html>`_ - -- `User Guide <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/userguide/index.html>`_ - -- `Installation Instructions <http://docs.opnfv.org/en/stable-fraser/submodules/sfc/docs/release/configguide/index.html>`_ - +- :ref:`Design document <sfc-design>` +- :ref:`User Guide <sfc-userguide:>` +- :ref:`Installation Instructions <sfc-configguide:>` - Release notes (This document) Known Limitations, Issues and Workarounds @@ -126,32 +112,18 @@ Known Limitations, Issues and Workarounds System 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 -a missing feature in ODL. We are unable to currently update a chain config - Known issues ------------ -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. - -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 ----------- Test results ============ -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 Fraser release, please see: +For more information on the OPNFV Hunter release, please see: OPNFV ----- @@ -160,12 +132,12 @@ OPNFV 2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_ -3) `OPNFV Fraser release <https://docs.opnfv.org/en/stable-fraser/index.html>`_ +3) `OPNFV Hunter release <https://docs.opnfv.org/en/latest/index.html>`_ OpenStack --------- -4) `OpenStack Pike Release artifacts <http://www.openstack.org/software/pike>`_ +4) `OpenStack Rocky Release artifacts <http://www.openstack.org/software/rocky>`_ 5) `OpenStack documentation <http://docs.openstack.org>`_ @@ -173,9 +145,3 @@ OpenDaylight ------------ 6) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_ - -Open vSwitch with NSH ---------------------- - -7) https://github.com/yyang13/ovs_nsh_patches - 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 65ba3c7e..b9195466 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 Fraser release uses the OpenDaylight Oxygen SR1 release. +into the OPNFV environment. The OPNFV SFC Gambia release uses the OpenDaylight Fluorine SR1 release. Scenario components and composition =================================== @@ -53,11 +53,14 @@ will automatically be installed. The VNF Manager --------------- -In order to create a VM for each Service Function, a VNF Manager is needed. The OPNFV +In order to create a VM for each Service Function, a VNF Manager is recommended. 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. +It is also possible to run tests without a VNF Manager, steering SFC through networking-sfc +project + Scenario usage overview ======================= .. Provide a brief overview on how to use the scenario and the features available to the @@ -66,7 +69,7 @@ Scenario usage overview Once this scenario is installed, it will be possible to create Service Chains and classification entries to map tenant traffic to individual, pre-defined Service Chains. -All configuration can be performed using the Tacker CLI. +All configuration can be performed using the Tacker CLI or the networking-sfc CLI. Limitations, Issues and Workarounds =================================== @@ -77,16 +80,21 @@ Limitations, Issues and Workarounds 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 Oxygen SR1 release, SFC was -changed to use a newer, branched version of OVS based on 2.6.1, called the "Yi Yang -Patch". +SFC needs OVS 2.9.2 or higher because it includes the Network Service Headers (NSH) +Service Chaining encapsulation. + +How to deploy the scenario +========================== + +There are three tools which can be used to deploy the scenario: + +- Apex - https://opnfv-apex.readthedocs.io/en/latest/release/installation/index.html#apex-installation +- XCI tool - https://opnfv-releng-xci.readthedocs.io/en/stable/xci-user-guide.html#user-guide +- Compass - https://opnfv-compass4nfv.readthedocs.io/en/stable-gambia/release/installation/index.html#compass4nfv-installation-instructions + +For more information about how to deploy the sfc scenario, check: -The older version of OVS only supported VXLAN-GPE + NSH encapsulation, but the newer -version supports both ETH + NSH and VXLAN-GPE + ETH + NSH. Currently SFC is only -implemented with VXLAN-GPE + ETH + NSH. +https://wiki.opnfv.org/display/sfc/Deploy+OPNFV+SFC+scenarios References ========== @@ -97,6 +105,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 Fraser release, please visit: +For more information on the OPNFV Gambia release, please visit: -https://docs.opnfv.org/en/stable-fraser/index.html +https://docs.opnfv.org/en/stable-gambia/index.html 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 65ba3c7e..11f787c5 100644 --- a/docs/release/scenarios/os-odl-sfc-noha/scenario.description.rst +++ b/docs/release/scenarios/os-odl-sfc-noha/scenario.description.rst @@ -6,9 +6,9 @@ Introduction ============ .. In this section explain the purpose of the scenario and the types of capabilities provided -The os-odl-sfc-ha is intended to be used to install the OPNFV SFC project in a standard +The os-odl-sfc-noha 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. +into the OPNFV environment. The OPNFV SFC Gambia release uses the OpenDaylight Fluorine SR1 release. Scenario components and composition =================================== @@ -53,11 +53,14 @@ will automatically be installed. The VNF Manager --------------- -In order to create a VM for each Service Function, a VNF Manager is needed. The OPNFV +In order to create a VM for each Service Function, a VNF Manager is recommended. 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. +It is also possible to run tests without a VNF Manager, steering SFC through networking-sfc +project + Scenario usage overview ======================= .. Provide a brief overview on how to use the scenario and the features available to the @@ -66,7 +69,7 @@ Scenario usage overview Once this scenario is installed, it will be possible to create Service Chains and classification entries to map tenant traffic to individual, pre-defined Service Chains. -All configuration can be performed using the Tacker CLI. +All configuration can be performed using the Tacker CLI or the networking-sfc CLI. Limitations, Issues and Workarounds =================================== @@ -77,16 +80,21 @@ Limitations, Issues and Workarounds 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 Oxygen SR1 release, SFC was -changed to use a newer, branched version of OVS based on 2.6.1, called the "Yi Yang -Patch". +SFC needs OVS 2.9.2 or higher because it includes the Network Service Headers (NSH) +Service Chaining encapsulation. + +How to deploy the scenario +========================== + +There are three tools which can be used to deploy the scenario: + +- Apex - https://opnfv-apex.readthedocs.io/en/latest/release/installation/index.html#apex-installation +- XCI tool - https://opnfv-releng-xci.readthedocs.io/en/stable/xci-user-guide.html#user-guide +- Compass - https://opnfv-compass4nfv.readthedocs.io/en/stable-gambia/release/installation/index.html#compass4nfv-installation-instructions + +For more information about how to deploy the sfc scenario, check: -The older version of OVS only supported VXLAN-GPE + NSH encapsulation, but the newer -version supports both ETH + NSH and VXLAN-GPE + ETH + NSH. Currently SFC is only -implemented with VXLAN-GPE + ETH + NSH. +https://wiki.opnfv.org/display/sfc/Deploy+OPNFV+SFC+scenarios References ========== @@ -97,6 +105,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 Fraser release, please visit: +For more information on the OPNFV Gambia release, please visit: -https://docs.opnfv.org/en/stable-fraser/index.html +https://docs.opnfv.org/en/stable-gambia/index.html diff --git a/docs/release/scenarios/os-odl-sfc_fdio-ha/index.rst b/docs/release/scenarios/os-odl-sfc_fdio-ha/index.rst deleted file mode 100644 index 28413b2e..00000000 --- a/docs/release/scenarios/os-odl-sfc_fdio-ha/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _os-odl-sfc_fdio-ha: - -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) <optionally add copywriters name> - -========================================= -os-odl-sfc_fdio-ha overview and description -========================================= -.. This document will be used to provide a description of the scenario for an end user. -.. You should explain the purpose of the scenario, the types of capabilities provided and -.. the unique components that make up the scenario including how they are used. - -.. toctree:: - :maxdepth: 3 - - ./scenario.description.rst - 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 deleted file mode 100644 index b9d965a3..00000000 --- a/docs/release/scenarios/os-odl-sfc_fdio-ha/scenario.description.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) <optionally add copywriters name> - -Introduction -============ -.. In this section explain the purpose of the scenario and the types of capabilities provided - -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 -=================================== -.. In this section describe the unique components that make up the scenario, -.. what each component provides and why it has been included in order -.. to communicate to the user the capabilities available in this scenario. - -OpenDaylight features installed -------------------------------- - -Scenario usage overview -======================= -.. Provide a brief overview on how to use the scenario and the features available to the -.. user. This should be an "introduction" to the userguide document, and explicitly link to it, -.. where the specifics of the features are covered including examples and API's - -Once this scenario is installed, it will be possible to create Service Chains and -classification entries to map tenant traffic to individual, pre-defined Service Chains. -All configuration can be performed using the Tacker CLI. - -Limitations, Issues and Workarounds -=================================== -.. Explain scenario limitations here, this should be at a design level rather than discussing -.. faults or bugs. If the system design only provide some expected functionality then provide -.. some insight at this point. - -Specific version of FD.IO ------------------------ - -TO BE ADDED - -References -========== diff --git a/docs/release/scenarios/os-odl-sfc_fdio-noha/index.rst b/docs/release/scenarios/os-odl-sfc_fdio-noha/index.rst deleted file mode 100644 index a77bc4c5..00000000 --- a/docs/release/scenarios/os-odl-sfc_fdio-noha/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _os-odl-sfc_fdio-noha: - -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) <optionally add copywriters name> - -=========================================== -os-odl-sfc_fdio-noha overview and description -=========================================== -.. This document will be used to provide a description of the scenario for an end user. -.. You should explain the purpose of the scenario, the types of capabilities provided and -.. the unique components that make up the scenario including how they are used. - -.. toctree:: - :maxdepth: 3 - - ./scenario.description.rst - 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 deleted file mode 100644 index b9d965a3..00000000 --- a/docs/release/scenarios/os-odl-sfc_fdio-noha/scenario.description.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) <optionally add copywriters name> - -Introduction -============ -.. In this section explain the purpose of the scenario and the types of capabilities provided - -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 -=================================== -.. In this section describe the unique components that make up the scenario, -.. what each component provides and why it has been included in order -.. to communicate to the user the capabilities available in this scenario. - -OpenDaylight features installed -------------------------------- - -Scenario usage overview -======================= -.. Provide a brief overview on how to use the scenario and the features available to the -.. user. This should be an "introduction" to the userguide document, and explicitly link to it, -.. where the specifics of the features are covered including examples and API's - -Once this scenario is installed, it will be possible to create Service Chains and -classification entries to map tenant traffic to individual, pre-defined Service Chains. -All configuration can be performed using the Tacker CLI. - -Limitations, Issues and Workarounds -=================================== -.. Explain scenario limitations here, this should be at a design level rather than discussing -.. faults or bugs. If the system design only provide some expected functionality then provide -.. some insight at this point. - -Specific version of FD.IO ------------------------ - -TO BE ADDED - -References -========== diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst index 0e9ce2cf..050a0c86 100644 --- a/docs/release/userguide/feature.userguide.rst +++ b/docs/release/userguide/feature.userguide.rst @@ -36,6 +36,17 @@ SFC capabilities and usage The OPNFV SFC feature can be deployed with either the "os-odl-sfc-ha" or the "os-odl-sfc-noha" scenario. SFC usage for both of these scenarios is the same. +Once the deployment has been completed, the SFC test cases use information +(e.g. INSTALLER IP, Controller IP, etc) of the environment which have been +retrieved first from the installer in order to execute the SFC test cases properly. +This is the default behavior. +In case there is not an installer in place and the server for the SFC test execution +has been prepared manually, installing all necessary components (e.g. OpenStack OpenDayLight etc) +by hand. The user should update the "pod.yaml" file, including the all necessary details +for each node which participates in the scenario. +In case the dovetail project triggers the SFC test scenarios, the "pod.yaml" file will be prepared +by dovetail project automatically. + As previously mentioned, Tacker is used as a VNF Manager and SFC Orchestrator. All the configuration necessary to create working service chains and classifiers can be performed using the Tacker command line. Refer to the `Tacker walkthrough <https://github.com/trozet/sfc-random/blob/master/tacker_sfc_apex_walkthrough.txt>`_ |