summaryrefslogtreecommitdiffstats
path: root/docs/scenarios
diff options
context:
space:
mode:
Diffstat (limited to 'docs/scenarios')
-rw-r--r--docs/scenarios/os-odl_l2-sfc-ha/index.rst16
-rw-r--r--docs/scenarios/os-odl_l2-sfc-ha/scenario.description.rst118
-rw-r--r--docs/scenarios/os-odl_l2-sfc-noha/index.rst16
-rw-r--r--docs/scenarios/os-odl_l2-sfc-noha/scenario.description.rst118
4 files changed, 0 insertions, 268 deletions
diff --git a/docs/scenarios/os-odl_l2-sfc-ha/index.rst b/docs/scenarios/os-odl_l2-sfc-ha/index.rst
deleted file mode 100644
index d72e657c..00000000
--- a/docs/scenarios/os-odl_l2-sfc-ha/index.rst
+++ /dev/null
@@ -1,16 +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>
-
-=========================================
-os-odl_l2-sfc-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/scenarios/os-odl_l2-sfc-ha/scenario.description.rst b/docs/scenarios/os-odl_l2-sfc-ha/scenario.description.rst
deleted file mode 100644
index cb918002..00000000
--- a/docs/scenarios/os-odl_l2-sfc-ha/scenario.description.rst
+++ /dev/null
@@ -1,118 +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_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
-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-ovsdb-openstack
-- odl-mdsal-xsql
-- odl-neutron-service
-- odl-neutron-northbound-api
-- odl-neutron-spi
-- odl-neutron-transcriber
-- odl-mdsal-apidocs
-- odl-ovsdb-southbound-impl-rest
-- odl-ovsdb-southbound-impl-ui
-
-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.
-This scenario is not working in Colorado 1.0 with the Fuel installer, since Tacker is not
-registered in the HA Proxy and calls to Tacker fail. This will be fixed in Colorado 2.0.
-
-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
-Patch".
-
-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:
-
-http://artifacts.opnfv.org/sfc/brahmaputra/docs/design/architecture.html#ovs-nsh-patch-workaround
-
-In subsequent versions of SFC, we will change the SFF-SF transport to be ETH + NSH,
-which will obviate this work around.
-
-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 Colorado release, please visit:
-
-http://www.opnfv.org/colorado
-
diff --git a/docs/scenarios/os-odl_l2-sfc-noha/index.rst b/docs/scenarios/os-odl_l2-sfc-noha/index.rst
deleted file mode 100644
index ef3e4fbe..00000000
--- a/docs/scenarios/os-odl_l2-sfc-noha/index.rst
+++ /dev/null
@@ -1,16 +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>
-
-===========================================
-os-odl_l2-sfc-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/scenarios/os-odl_l2-sfc-noha/scenario.description.rst b/docs/scenarios/os-odl_l2-sfc-noha/scenario.description.rst
deleted file mode 100644
index b5d41044..00000000
--- a/docs/scenarios/os-odl_l2-sfc-noha/scenario.description.rst
+++ /dev/null
@@ -1,118 +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_l2-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 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. 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-ovsdb-openstack
-- odl-mdsal-xsql
-- odl-neutron-service
-- odl-neutron-northbound-api
-- odl-neutron-spi
-- odl-neutron-transcriber
-- odl-mdsal-apidocs
-- odl-ovsdb-southbound-impl-rest
-- odl-ovsdb-southbound-impl-ui
-
-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
-Patch".
-
-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:
-
-http://artifacts.opnfv.org/sfc/brahmaputra/docs/design/architecture.html#ovs-nsh-patch-workaround
-
-In subsequent versions of SFC, we will change the SFF-SF transport to be ETH + NSH,
-which will obviate this work around.
-
-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 Colorado release, please visit:
-
-http://www.opnfv.org/colorado
-