From 084446656bf2794a11de56b782f589af1f703487 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 --- .../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 ++-------------------- 4 files changed, 17 insertions(+), 138 deletions(-) (limited to 'docs/release/scenarios') 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