summaryrefslogtreecommitdiffstats
path: root/docs/release/scenarios
diff options
context:
space:
mode:
Diffstat (limited to 'docs/release/scenarios')
-rw-r--r--docs/release/scenarios/os-nosdn-ovs-noha/index.rst18
-rw-r--r--docs/release/scenarios/os-nosdn-ovs-noha/ovs4nfv.pngbin0 -> 49053 bytes
-rw-r--r--docs/release/scenarios/os-nosdn-ovs-noha/scenario.description.rst105
-rw-r--r--docs/release/scenarios/os-nosdn-ovs/index.rst17
-rw-r--r--docs/release/scenarios/os-nosdn-ovs/scenario.description.rst48
5 files changed, 188 insertions, 0 deletions
diff --git a/docs/release/scenarios/os-nosdn-ovs-noha/index.rst b/docs/release/scenarios/os-nosdn-ovs-noha/index.rst
new file mode 100644
index 0000000..27723c8
--- /dev/null
+++ b/docs/release/scenarios/os-nosdn-ovs-noha/index.rst
@@ -0,0 +1,18 @@
+.. 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-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-nosdn-ovs-noha/ovs4nfv.png b/docs/release/scenarios/os-nosdn-ovs-noha/ovs4nfv.png
new file mode 100644
index 0000000..ea9d543
--- /dev/null
+++ b/docs/release/scenarios/os-nosdn-ovs-noha/ovs4nfv.png
Binary files differ
diff --git a/docs/release/scenarios/os-nosdn-ovs-noha/scenario.description.rst b/docs/release/scenarios/os-nosdn-ovs-noha/scenario.description.rst
new file mode 100644
index 0000000..3027a7e
--- /dev/null
+++ b/docs/release/scenarios/os-nosdn-ovs-noha/scenario.description.rst
@@ -0,0 +1,105 @@
+.. 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-noha
+
+"apex-os-ovs-noha" is a scenario developed as part of the OVS for NFV
+OPNFV project. The main components of the "apex-os-nosdn-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
+
+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-noha" 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
+
+.. 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-ext) 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
+
+Networking in this scenario using OVS with accelerated User space IO.
+---------------------------------------------------------------------
+
+The apex-os-nosdn-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
+======================
+
+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
+
+Validated deployment environments
+=================================
+
+The "os-odl_l2-ovs-noha" scenario has been deployed and tested
+on the following sets of hardware:
+ * TBD
+
+
+Limitations, Issues and Workarounds
+===================================
+
+There are no known issues.
+
+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
diff --git a/docs/release/scenarios/os-nosdn-ovs/index.rst b/docs/release/scenarios/os-nosdn-ovs/index.rst
new file mode 100644
index 0000000..145d0ae
--- /dev/null
+++ b/docs/release/scenarios/os-nosdn-ovs/index.rst
@@ -0,0 +1,17 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Intel Corporation
+
+.. 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.
+
+=====================================
+os-nosdn-ovs overview and description
+=====================================
+
+.. toctree::
+ :maxdepth: 3
+
+ ./scenario.description.rst
+
diff --git a/docs/release/scenarios/os-nosdn-ovs/scenario.description.rst b/docs/release/scenarios/os-nosdn-ovs/scenario.description.rst
new file mode 100644
index 0000000..04d88a1
--- /dev/null
+++ b/docs/release/scenarios/os-nosdn-ovs/scenario.description.rst
@@ -0,0 +1,48 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Intel Corporation
+
+Introduction
+============
+For Fuel this scenario installs the latest DPDK-enabled Open vSwitch component,
+version - 2.5.90 based on DPDK 16.07.
+
+For Apex this scenario installs the latest DPDK-enabled Open vSwitch component,
+version - 2.5.90 based on DPDK 16.04.
+
+Scenario components and composition
+===================================
+This scenario is currently able to be installed using the Fuel and Apex installers.
+For details on how to install the ovsnfv scenarion using these installer tools
+please refer to the installation instructions at:
+ * Fuel installation instruction: http://artifacts.opnfv.org/fuel/colorado/2.0/docs/installation-instruction/index.html
+ * Apex installation instruction: http://artifacts.opnfv.org/apex/colorado/2.0/docs/installation-instruction/index.html
+
+.. Above links need to be updated with the eventual release URL's. This will need to be done closer to the
+.. release date once the project and docs team have a solution ready and the final version of the installation
+.. documents are done.
+
+Scenario usage overview
+=======================
+After installation use of the scenario requires no further action by the user.
+Traffic on the private network will automatically be processed by the upgraded
+DPDK datapath.
+
+Limitations, Issues and Workarounds
+===================================
+The same limitations that apply to using Fuel DPDK-enabled interfaces also apply
+when using this scenario. Including:
+
+* Fuel9 OVS-DPDK support works only for VLAN segmentation.
+* Only interfaces running the private network (and no other network) can be
+ supported so each node needs a separate interface dedicated to the private network.
+* The nodes with dpdk enabled interfaces will need to have hugepages
+ configured and some cores reserved for dpdk.
+
+
+References
+==========
+
+For more information on the OPNFV Colorado release, please visit
+http://www.opnfv.org/colorado
+