|author||Brady Johnson <email@example.com>||2016-09-02 11:28:47 +0200|
|committer||Brady Johnson <firstname.lastname@example.org>||2016-09-02 13:06:28 +0000|
diff --git a/docs/scenarios/os-odl_l2-sfc-ha/scenario.description.rst b/docs/scenarios/os-odl_l2-sfc-ha/scenario.description.rst
new file mode 100644
@@ -0,0 +1,116 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. (c) <optionally add copywriters name>
+.. In this section explain the purpose of the scenario and the types of capabilities provided
+The os-odl_l2-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 Colorado release uses the OpenDaylight Boron 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.
+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
+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:
+The following are the Netvirt features that get installed:
+By simply installing the odl-ovsdb-openstack 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
+.. 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 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 Boron release, SFC was
+changed to use a newer, branched version of OVS based on 2.5.90, called the "Yi Yang
+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.
+Workaround for VXLAN and OpenStack
+When using NSH with VXLAN tunnels, its important that the VXLAN tunnel is terminated
+in the SF VM. This allows the SF to see the NSH header, allowing it to decrement the
+NSI and also to use the NSH metadata. When using VXLAN with OpenStack, the tunnels
+are not terminated in the SF VM, but in the “br-int” OVS bridge. A work-around has
+been created to address this issue, which can be found here:
+In subsequent versions of SFC, we will change the SFF-SF transport to be ETH + NSH,
+which will obviate this work around.
+For more information about SFC, please visit:
+For more information on the OPNFV Colorado release, please visit: