Include two odl_l3 scenarios and the no-sdn l2 ha scenario.
Change-Id: I6a3d447b42a2d69ce3e50e007a66e22668a1383c
Signed-off-by: Thomas F Herbert <therbert@redhat.com>
- Colorado Release of the OVSNFV RPM for Apex.
+March 2017
+============
+
+- Danube Release of the OVSNFV RPM for Apex.
+
=============================================================
-OPNFV Release Notes for the Colorado release of OVS for OPNFV
+OPNFV Release Notes for the Danube release of OVS for OPNFV
=============================================================
Abstract
========
-This document provides the release notes for Colorado release of
+This document provides the release notes for Danube release of
OVS for OPNFV.
Version history
Summary
=======
-The Colorado release of OVSNFV will provide RPMs for DPDK and OVS with DPDK.
-Also for the Colorado release an RPM of an interim release of OVS and the
+The Danube release of OVSNFV will provide RPMs for DPDK and OVS with DPDK.
+Also for the Danube release an RPM of an interim release of OVS and the
OVS kernel module with NSH patches.
- Documentation is built by Jenkins
| **Project** | ovsnfv |
| | |
+--------------------------------------+--------------------------------------+
-| **Repo/tag** | ovsnfv/colorado.1.0 |
+| **Repo/tag** | ovsnfv/Danube.1.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release designation** | colorado.1.0 |
+| **Release designation** | Danube 1.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | 2016-09-14 |
+| **Release date** | 2017-3-31 |
| | |
+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | OPNFV Colorado release |
+| **Purpose of the delivery** | OPNFV Danube release |
| | |
+--------------------------------------+--------------------------------------+
Module version changes
~~~~~~~~~~~~~~~~~~~~~~
-This is the first tracked version of OVSNFV for the Colorado release.
+This is the first tracked version of OVSNFV for the Danube release.
-- Open vSwitch 2.5.90
+- Open vSwitch 2.6
-- DPDK 16.04
+- DPDK 16.11
Unsupported Experimental OVS with NSH
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Document version changes
~~~~~~~~~~~~~~~~~~~~~~~~
-This is the first tracked version of Colorado release of OVSNFV
+This is the first tracked version of Danube release of OVSNFV
The following documentation is provided with this release:
-- OVSNFV Build instructions of the RPMs for the Colorado release
+- OVSNFV Build instructions of the RPMs for the Danube release
ver. 1.0.0
Feature additions
- ovs4opnfv-e8acab14-openvswitch-ovn-host-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
- ovs4opnfv-e8acab14-openvswitch-ovn-vtep-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
+- DPDK 16.11
+
+
+ - ovsnfv/ovs4opnfv-e8acab14-dpdk-16.11-5.el7.centos.x86_64.rpm
+ - ovsnfv/ovs4opnfv-e8acab14-dpdk-debuginfo-16.11-5.el7.centos.x86_64.rpm
+ - ovsnfv/ovs4opnfv-e8acab14-dpdk-devel-16.11-5.el7.centos.x86_64.rpm
+ - ovsnfv/ovs4opnfv-e8acab14-dpdk-doc-16.11-5.el7.centos.noarch.rpm
+ - ovsnfv/ovs4opnfv-e8acab14-dpdk-examples-16.11-5.el7.centos.x86_64.rpm
+ - ovsnfv/ovs4opnfv-e8acab14-dpdk-tools-16.11-5.el7.centos.x86_64.rpm
+
+- OVS 2.6
+
+ - ovsnfv/ovs4opnfv-e8acab14-openvswitch-2.6.0-1.el7.centos.x86_64.rpm
+ - ovsnfv/ovs4opnfv-e8acab14-openvswitch-debuginfo-2.6.0-1.el7.centos.x86_64.rpm
+ - ovsnfv/ovs4opnfv-e8acab14-openvswitch-devel-2.6.0-1.el7.centos.x86_64.rpm
+ - ovsnfv/ovs4opnfv-e8acab14-openvswitch-ovn-central-2.6.0-1.el7.centos.x86_64.rpm
+ - ovsnfv/ovs4opnfv-e8acab14-openvswitch-ovn-common-2.6.0-1.el7.centos.x86_64.rpm
+ - ovsnfv/ovs4opnfv-e8acab14-openvswitch-ovn-docker-2.6.0-1.el7.centos.x86_64.rpm
+ - ovsnfv/ovs4opnfv-e8acab14-openvswitch-ovn-host-2.6.0-1.el7.centos.x86_64.rpm
+ - ovsnfv/ovs4opnfv-e8acab14-openvswitch-ovn-vtep-2.6.0-1.el7.centos.x86_64.rpm
+
EXPERIMENTAL artifacts produced by OVS for NFV
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Documentation deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~
-- RPM build instructions for the Colorado release version 1.0.0
-- OVSNFV Release Notes for the Colorado release version 1.0.0
+- RPM build instructions for the Danube release version 1.0.0
+- OVSNFV Release Notes for the Danube release version 1.0.0
- Configuration Guide for OVSNFV
- Supported Scenario Description and Documentation
| **JIRA REFERENCE** | **SLOGAN** |
| | |
+--------------------------------------+--------------------------------------+
-| | |
+| APEX-415 | br-phy dpdk interfaces are not |
+| | brought up by net-config |
| | |
+--------------------------------------+--------------------------------------+
Test Result
===========
-The Colorado release of OVS/DPDK RPM deployed with the Apex deployment
+The DAnube release of OVS/DPDK RPM deployed with the Apex deployment
toolchain has undergone QA test runs with the following results:
+--------------------------------------+--------------------------------------+
References
==========
-For more information on the OPNFV Colorado release, please see:
+For more information on the OPNFV Danube release, please see:
-http://wiki.opnfv.org/releases/Colorado
+http://wiki.opnfv.org/releases/Danube
:Author: Thomas F Herbert (therbert@redhat.com)
:Version: 1.0.0
--- /dev/null
+.. _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
--- /dev/null
+.. 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
* 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
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
------------------------
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
==========
* 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
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
--- /dev/null
+.. _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
--- /dev/null
+.. 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
--- /dev/null
+.. _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
--- /dev/null
+.. 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
Code Review / ovsnfv.git / commitdiff
