aboutsummaryrefslogtreecommitdiffstats
path: root/docs/release/scenarios/os-odl-sfc-noha/scenario.description.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/release/scenarios/os-odl-sfc-noha/scenario.description.rst')
-rw-r--r--docs/release/scenarios/os-odl-sfc-noha/scenario.description.rst51
1 files changed, 26 insertions, 25 deletions
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..11f787c5 100644
--- a/docs/release/scenarios/os-odl-sfc-noha/scenario.description.rst
+++ b/docs/release/scenarios/os-odl-sfc-noha/scenario.description.rst
@@ -7,9 +7,8 @@ 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.
+OPNFV High Availability mode. The OPNFV SFC project integrates the OpenDaylight SFC project
+into the OPNFV environment. The OPNFV SFC Gambia release uses the OpenDaylight Fluorine 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:
@@ -55,10 +53,13 @@ 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
-with the OpenDaylight SFC project.
+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
=======================
@@ -68,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
===================================
@@ -76,23 +77,24 @@ 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
-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:
-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.
+- 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:
+
+https://wiki.opnfv.org/display/sfc/Deploy+OPNFV+SFC+scenarios
References
==========
@@ -103,7 +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 Euphrates release, please visit:
-
-http://www.opnfv.org/euphrates
+For more information on the OPNFV Gambia release, please visit:
+https://docs.opnfv.org/en/stable-gambia/index.html