Add and update apex sdn and ovs scenarios to Danube 1.0danube.2.0danube.1.0stable/danube

Include two odl_l3 scenarios and the no-sdn l2 ha scenario.

Change-Id: I6a3d447b42a2d69ce3e50e007a66e22668a1383c
Signed-off-by: Thomas F Herbert <therbert@redhat.com>
(cherry picked from commit 3412a645cdea8c4eb28e8406ed161e8140011d0f)

11 files changed, 357 insertions, 21 deletions

diff --git a/docs/release/scenarios/os-nosdn-ovs-ha/index.rst b/docs/release/scenarios/os-nosdn-ovs-ha/index.rst
new file mode 100644
index 0000000..fc8f2b7
--- /dev/null
+++ b/docs/release/scenarios/os-nosdn-ovs-ha/index.rst
@@ -0,0 +1,20 @@
+.. _os-nosdn-ovs-noha:
+
+.. OPNFV - Open Platform for Network Function Virtualization
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+*******************************************************************************
+User Space Accelarated OVS scenario: os-nosdn-ovs-noha Overview and Description
+*******************************************************************************
+
+Scenario: "OpenStack - ovs-nfv" (apex-os-nosdn-ovs-ha)
+is a scenario developed as part of the ovsnfv
+OPNFV project.
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   scenario.description.rst
diff --git a/docs/release/scenarios/os-nosdn-ovs-ha/ovs4nfv.png b/docs/release/scenarios/os-nosdn-ovs-ha/ovs4nfv.png
new file mode 100644
index 0000000..ea9d543
--- /dev/null
+++ b/docs/release/scenarios/os-nosdn-ovs-ha/ovs4nfv.png
diff --git a/docs/release/scenarios/os-nosdn-ovs-ha/scenario.description.rst b/docs/release/scenarios/os-nosdn-ovs-ha/scenario.description.rst
new file mode 100644
index 0000000..874bc9c
--- /dev/null
+++ b/docs/release/scenarios/os-nosdn-ovs-ha/scenario.description.rst
@@ -0,0 +1,93 @@
+.. OPNFV - Open Platform for Network Function Virtualization
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Scenario: "OpenStack - ovs-nfv"
+=============================
+
+Scenario: apex-os-nosdn-ovs-ha
+
+"apex-os-ovs-ha" is a scenario developed as part of the OVS for NFV
+OPNFV project. The main components of the "apex-os-nosdn-ovs-ha" scenario
+are:
+
+ - APEX (TripleO) installer (please also see APEX installer documentation)
+ - Openstack (in HA configuration)
+ - OVS/DPDK Open vSwitch with DPDK data plane virtual forwarder for tenant networking
+
+Introduction
+============
+
+NFV and virtualized high performance applications, such as video processing,
+require Open vSwitch to be accelerated with a fast data plane solution that provides both
+carrier grade forwarding performance, scalability and open extensibility.
+
+A key component of any NFV solution is the virtual forwarder, which should consist of
+soft switch that includes an accelerated data plane component. For this, any virtual
+switch should make use of
+hardware accelerators and optimized cache operation to be run in user space.
+
+The "Openstack - Open vSwitch/DPDK" scenario provides
+use-cases for deployment of NFV nodes instantiated by
+an Openstack orchestration system on OVS/DPDK enabled compute nodes.
+
+A deployment of the "apex-os-nosdn-ovs-ha" scenario consists of 3 or more
+servers:
+
+  * 1 Jumphost hosting the APEX installer - running the Undercloud
+  * 1 Controlhost, which runs the Overcloud and Openstack services
+  * 1 or more Computehosts or nodes
+
+.. image:: ovs4nfv.png
+
+Tenant networking leverages Open vSwitch accelerated with a fast user space data path such
+as DPDK.
+Open VSwitch (OVS) with the Linux kernel module data path is used for all other
+connectivity, such as connectivity to public networking "the
+Internet" (i.e. br-ex) is performed via non-accelerated OVS.
+
+Features of the scenario
+------------------------
+
+Main features of the "apex-os-ovs-nosdn-ha" scenario:
+
+  * Automated installation using the APEX installer
+  * Accelerated tenant networking using OVS/DPDK as the forwarder
+
+Networking in this scenario using OVS with accelerated User space IO.
+---------------------------------------------------------------------
+
+The apex-os-nosdn-ovs-ha scenario combines components from three open
+source projects: OpenStack, Open vSwitch and DPDK. To make accelerated networking
+available for this scenario Open vSwitch is bound via its netdev interface
+with DPDK user space accelerated capability.
+
+Scenario Configuration
+======================
+
+Simply deploy this scenario by using the os-ovs-nosdn-ha.yaml deploy
+settings file.
+
+Validated deployment environments
+=================================
+
+The "os-odl_l2-ovs-ha" scenario has been deployed and tested
+on the following sets of hardware:
+ * virtual deployments
+ * Not yet validated on UCS hardware.
+
+
+Limitations, Issues and Workarounds
+===================================
+
+* _APEX-415 br-phy dpdk interfaces are not brought up by os-net-config
+
+References
+==========
+
+
+  * OVS for NFV OPNFV project wiki: https://wiki.opnfv.org/display/ovsnfv
+  * Open vSwitch: http://openvswitch.org/
+  * DPDK: http://dpdk.org
+  * OPNFV Danube release - more information: http://www.opnfv.org/colorado
diff --git a/docs/release/scenarios/os-nosdn-ovs-noha/scenario.description.rst b/docs/release/scenarios/os-nosdn-ovs-noha/scenario.description.rst
index 3027a7e..91504f1 100644
--- a/docs/release/scenarios/os-nosdn-ovs-noha/scenario.description.rst
+++ b/docs/release/scenarios/os-nosdn-ovs-noha/scenario.description.rst
@@ -37,7 +37,7 @@ servers:
 
   * 1 Jumphost hosting the APEX installer - running the Undercloud
   * 1 Controlhost, which runs the Overcloud and Openstack services
-  * 1 or more Computehosts
+  * 1 or more computehosts or nodes
 
 .. image:: ovs4nfv.png
 
@@ -45,7 +45,7 @@ Tenant networking leverages Open vSwitch accelerated with a fast user space data
 as DPDK.
 Open VSwitch (OVS) with the Linux kernel module data path is used for all other
 connectivity, such as connectivity to public networking "the
-Internet" (i.e. br-ext) is performed via non-accelerated OVS.
+Internet" (i.e. br-ex) is performed via non-accelerated OVS.
 
 Features of the scenario
 ------------------------
@@ -66,34 +66,22 @@ with DPDK user space accelerated capability.
 Scenario Configuration
 ======================
 
-To enable the "apex-os-nosdn-ovs-noha" scenario check the appropriate settings
-in the APEX configuration files. Those are typically found in /etc/opnfv-apex.
-
-File "deploy_settings.yaml" choose false for sdn controller::
-
-  global_params:
-    ha_enabled: false
-
-  deploy_options:
-    sdn_controller: false
-    sdn_l3: false
-    tacker: false
-    congress: false
-    sfc: false
-    vpn: false
+Simply deploy this scenario by using the os-ovs-nosdn-noha.yaml deploy
+settings file.
 
 Validated deployment environments
 =================================
 
 The "os-odl_l2-ovs-noha" scenario has been deployed and tested
 on the following sets of hardware:
- * TBD
+ * Validated on virtual deployments only.
+ * Not yet validated on the UCS hardware.
 
 
 Limitations, Issues and Workarounds
 ===================================
 
-There are no known issues.
+* _APEX-415 br-phy dpdk interfaces are not brought up by os-net-config
 
 References
 ==========
@@ -102,4 +90,4 @@ References
   * OVS for NFV OPNFV project wiki: https://wiki.opnfv.org/display/ovsnfv
   * Open vSwitch: http://openvswitch.org/
   * DPDK: http://dpdk.org
-  * OPNFV Colorado release - more information: http://www.opnfv.org/colorado
+  * OPNFV Danube release - more information: http://www.opnfv.org/colorado
diff --git a/docs/release/scenarios/os-nosdn-ovs/scenario.description.rst b/docs/release/scenarios/os-nosdn-ovs/scenario.description.rst
index 04d88a1..4525a98 100644
--- a/docs/release/scenarios/os-nosdn-ovs/scenario.description.rst
+++ b/docs/release/scenarios/os-nosdn-ovs/scenario.description.rst
@@ -43,6 +43,6 @@ when using this scenario. Including:
 References
 ==========
 
-For more information on the OPNFV Colorado release, please visit
+For more information on the OPNFV Danube release, please visit
 http://www.opnfv.org/colorado
 
diff --git a/docs/release/scenarios/os-odl_l3-ovs-ha/index.rst b/docs/release/scenarios/os-odl_l3-ovs-ha/index.rst
new file mode 100644
index 0000000..fadf8e4
--- /dev/null
+++ b/docs/release/scenarios/os-odl_l3-ovs-ha/index.rst
@@ -0,0 +1,20 @@
+.. _os-odl_l3-ovs-no:
+
+.. OPNFV - Open Platform for Network Function Virtualization
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+*******************************************************************************
+User Space Accelarated OVS scenario: os-odl_l3-ovs-no Overview and Description
+*******************************************************************************
+
+Scenario: "OpenStack - ovs-nfv" (apex-os-odl_l3-ovs-no)
+is a scenario developed as part of the ovsnfv
+OPNFV project.
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   scenario.description.rst
diff --git a/docs/release/scenarios/os-odl_l3-ovs-ha/ovs4nfv.png b/docs/release/scenarios/os-odl_l3-ovs-ha/ovs4nfv.png
new file mode 100644
index 0000000..ea9d543
--- /dev/null
+++ b/docs/release/scenarios/os-odl_l3-ovs-ha/ovs4nfv.png
diff --git a/docs/release/scenarios/os-odl_l3-ovs-ha/scenario.description.rst b/docs/release/scenarios/os-odl_l3-ovs-ha/scenario.description.rst
new file mode 100644
index 0000000..080d83a
--- /dev/null
+++ b/docs/release/scenarios/os-odl_l3-ovs-ha/scenario.description.rst
@@ -0,0 +1,98 @@
+.. OPNFV - Open Platform for Network Function Virtualization
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Scenario: "OpenStack - ovs-nfv"
+=============================
+
+Scenario: apex-os-odl_l3-ovs-ha
+
+"apex-os-odl_l3-ovs-ha" is a scenario developed as part of the OVS for NFV
+OPNFV project. The main components of the "apex-os-odl_l3-ovs-ha" scenario
+are:
+
+ - APEX (TripleO) installer (please also see APEX installer documentation)
+ - Openstack (in HA configuration)
+ - OVS/DPDK Open vSwitch with DPDK data plane virtual forwarder for tenant networking
+ - ODL Open Daylight service running on a single controller
+ - One or more compute hosts or nodes
+
+Introduction
+============
+
+NFV and virtualized high performance applications, such as video processing,
+require Open vSwitch to be accelerated with a fast data plane solution that provides both
+carrier grade forwarding performance, scalability and open extensibility.
+
+A key component of any NFV solution is the virtual forwarder, which should consist of
+soft switch that includes an accelerated data plane component. For this, any virtual
+switch should make use of
+hardware accelerators and optimized cache operation to be run in user space.
+
+The apex-os-odl_l3-ovs-ha scenario provides
+use-cases for deployment of NFV nodes instantiated by
+an Openstack orchestration system on OVS/DPDK enabled compute nodes
+with Open Daylight controller service.
+
+A deployment of the "apex-os-odl_l3-ovs-ha" scenario consists of 3 or more
+servers:
+
+  * 1 Jumphost hosting the APEX installer - running the Undercloud
+  * 1 Controlhost, which runs the Overcloud, Openstack services,
+  and Open Daylight service.
+  * 1 or more Computehosts or nodes
+
+.. image:: ovs4nfv.png
+
+Tenant networking leverages Open vSwitch accelerated with a fast user space data path such
+as DPDK.
+Open VSwitch (OVS) with the Linux kernel module data path is used for all other
+connectivity, such as connectivity to public networking "the
+Internet" (i.e. br-ex) is performed via non-accelerated OVS with Linux kernel data path.
+
+Features of the scenario
+------------------------
+
+Main features of the "apex-os-ovs-nosdn-ha" scenario:
+
+  * Automated installation using the APEX installer
+  * Accelerated tenant networking using OVS/DPDK as the forwarder
+  * VXLAN l3 tenant network support with accelerated DPDK ports.
+
+Networking in this scenario using OVS with accelerated User space IO.
+---------------------------------------------------------------------
+
+The apex-os-odl_l3-ovs-ha scenario combines components from three open
+source projects: OpenStack, Open vSwitch and DPDK. To make accelerated networking
+available for this scenario Open vSwitch is bound via its netdev interface
+with DPDK user space accelerated capability.
+
+Scenario Configuration
+======================
+
+Simply deploy this scenario by using the os-odl_l3-ovs-ha.yaml deploy
+settings file.
+
+Validated deployment environments
+=================================
+
+The "os-odl_l3-ovs-ha" scenario has been deployed and tested
+on the following sets of hardware:
+ * virtual deployments only
+ * Not yet validated on UCS hardware
+
+
+Limitations, Issues and Workarounds
+===================================
+
+* _APEX-415 br-phy dpdk interfaces are not brought up by os-net-config
+
+References
+==========
+
+
+  * OVS for NFV OPNFV project wiki: https://wiki.opnfv.org/display/ovsnfv
+  * Open vSwitch: http://openvswitch.org/
+  * DPDK: http://dpdk.org
+  * OPNFV Danube release - more information: http://www.opnfv.org/colorado
diff --git a/docs/release/scenarios/os-odl_l3-ovs-noha/index.rst b/docs/release/scenarios/os-odl_l3-ovs-noha/index.rst
new file mode 100644
index 0000000..8d60d40
--- /dev/null
+++ b/docs/release/scenarios/os-odl_l3-ovs-noha/index.rst
@@ -0,0 +1,20 @@
+.. _os-odl_l3-ovs-noha:
+
+.. OPNFV - Open Platform for Network Function Virtualization
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+*******************************************************************************
+User Space Accelarated OVS scenario: os-odl_l3-ovs-noha Overview and Description
+*******************************************************************************
+
+Scenario: "OpenStack - ovs-nfv" (apex-os-odl_l3-ovs-noha)
+is a scenario developed as part of the ovsnfv
+OPNFV project.
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   scenario.description.rst
diff --git a/docs/release/scenarios/os-odl_l3-ovs-noha/ovs4nfv.png b/docs/release/scenarios/os-odl_l3-ovs-noha/ovs4nfv.png
new file mode 100644
index 0000000..ea9d543
--- /dev/null
+++ b/docs/release/scenarios/os-odl_l3-ovs-noha/ovs4nfv.png
diff --git a/docs/release/scenarios/os-odl_l3-ovs-noha/scenario.description.rst b/docs/release/scenarios/os-odl_l3-ovs-noha/scenario.description.rst
new file mode 100644
index 0000000..bb14e1a
--- /dev/null
+++ b/docs/release/scenarios/os-odl_l3-ovs-noha/scenario.description.rst
@@ -0,0 +1,97 @@
+.. OPNFV - Open Platform for Network Function Virtualization
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Scenario: "OpenStack - ovs-nfv"
+=============================
+
+Scenario: apex-os-odl_l3-ovs-noha
+
+"apex-os-odl_l3-ovs-noha" is a scenario developed as part of the OVS for NFV
+OPNFV project. The main components of the "apex-os-odl_l3-ovs-noha" scenario
+are:
+
+ - APEX (TripleO) installer (please also see APEX installer documentation)
+ - Openstack (in non-HA configuration)
+ - OVS/DPDK Open vSwitch with DPDK data plane virtual forwarder for tenant networking
+ - ODL  Open Daylight service running on a single controller
+
+Introduction
+============
+
+NFV and virtualized high performance applications, such as video processing,
+require Open vSwitch to be accelerated with a fast data plane solution that provides both
+carrier grade forwarding performance, scalability and open extensibility.
+
+A key component of any NFV solution is the virtual forwarder, which should consist of
+soft switch that includes an accelerated data plane component. For this, any virtual
+switch should make use of
+hardware accelerators and optimized cache operation to be run in user space.
+
+The apex-os-odl_l3-ovs-noha scenario provides
+use-cases for deployment of NFV nodes instantiated by
+an Openstack orchestration system on OVS/DPDK enabled compute nodes
+with Open Daylight controller service.
+
+A deployment of the "apex-os-odl_l3-ovs-noha" scenario consists of 3 or more
+servers:
+
+  * 1 Jumphost hosting the APEX installer - running the Undercloud
+  * 1 Controlhost, which runs the Overcloud, Openstack services and
+  Open Daylight service
+  * 1 or more Computehosts or nodes
+
+.. image:: ovs4nfv.png
+
+Tenant networking leverages Open vSwitch accelerated with a fast user space data path such
+as DPDK.
+Open VSwitch (OVS) with the Linux kernel module data path is used for all other
+connectivity, such as connectivity to public networking "the
+Internet" (i.e. br-ex) is performed via non-accelerated OVS.
+
+Features of the scenario
+------------------------
+
+Main features of the "apex-os-ovs-nosdn-noha" scenario:
+
+  * Automated installation using the APEX installer
+  * Accelerated tenant networking using OVS/DPDK as the forwarder
+  * VXLAN l3 tenant network support with accelerated DPDK ports.
+
+Networking in this scenario using OVS with accelerated User space IO.
+---------------------------------------------------------------------
+
+The apex-os-odl_l3-ovs-noha scenario combines components from three open
+source projects: OpenStack, Open vSwitch and DPDK. To make accelerated networking
+available for this scenario Open vSwitch is bound via its netdev interface
+with DPDK user space accelerated capability.
+
+Scenario Configuration
+======================
+
+Simply deploy this scenario by using the os-odl_l3-ovs-noha.yaml deploy
+settings file.
+
+Validated deployment environments
+=================================
+
+The "os-odl_l3-ovs-noha" scenario has been deployed and tested
+on the following sets of hardware:
+ * virtual deployment only
+ * Not yet validated on UCS hardware.
+
+
+Limitations, Issues and Workarounds
+===================================
+
+* _APEX-415 br-phy dpdk interfaces are not brought up by os-net-config
+
+References
+==========
+
+
+  * OVS for NFV OPNFV project wiki: https://wiki.opnfv.org/display/ovsnfv
+  * Open vSwitch: http://openvswitch.org/
+  * DPDK: http://dpdk.org
+  * OPNFV Danube release - more information: http://www.opnfv.org/colorado