From de5bd974bee689f4a1ae06f5e0f9c9cee5ffd581 Mon Sep 17 00:00:00 2001 From: Thomas F Herbert Date: Mon, 12 Sep 2016 18:21:32 -0400 Subject: Docs for ovsnfv RPM generation for Apex including scenario description, release notes and build procedures. JIRA: OVSNFV-43 Change-Id: I4228e3ba8d7c43b0385c57cae2fcfd508dc5c687 Signed-off-by: Thomas F Herbert --- docs/scenarios/os-nosdn-ovs-noha/index.rst | 18 ++++ docs/scenarios/os-nosdn-ovs-noha/ovs4nfv.png | Bin 0 -> 49053 bytes .../os-nosdn-ovs-noha/scenario.description.rst | 105 +++++++++++++++++++++ 3 files changed, 123 insertions(+) create mode 100644 docs/scenarios/os-nosdn-ovs-noha/index.rst create mode 100644 docs/scenarios/os-nosdn-ovs-noha/ovs4nfv.png create mode 100644 docs/scenarios/os-nosdn-ovs-noha/scenario.description.rst (limited to 'docs/scenarios') diff --git a/docs/scenarios/os-nosdn-ovs-noha/index.rst b/docs/scenarios/os-nosdn-ovs-noha/index.rst new file mode 100644 index 0000000..27723c8 --- /dev/null +++ b/docs/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/scenarios/os-nosdn-ovs-noha/ovs4nfv.png b/docs/scenarios/os-nosdn-ovs-noha/ovs4nfv.png new file mode 100644 index 0000000..ea9d543 Binary files /dev/null and b/docs/scenarios/os-nosdn-ovs-noha/ovs4nfv.png differ diff --git a/docs/scenarios/os-nosdn-ovs-noha/scenario.description.rst b/docs/scenarios/os-nosdn-ovs-noha/scenario.description.rst new file mode 100644 index 0000000..3027a7e --- /dev/null +++ b/docs/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 -- cgit 1.2.3-korg