summaryrefslogtreecommitdiffstats
path: root/docs/release
diff options
context:
space:
mode:
Diffstat (limited to 'docs/release')
-rwxr-xr-xdocs/release/configguide/featureconfig.rst37
-rw-r--r--docs/release/configguide/index.rst14
-rw-r--r--docs/release/installation0
-rw-r--r--docs/release/release-notes/index.rst11
-rw-r--r--docs/release/release-notes/release-notes.rst215
-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
-rw-r--r--docs/release/userguide/feature.userguide.rst17
-rw-r--r--docs/release/userguide/index.rst24
12 files changed, 506 insertions, 0 deletions
diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst
new file mode 100755
index 0000000..093f236
--- /dev/null
+++ b/docs/release/configguide/featureconfig.rst
@@ -0,0 +1,37 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (c) 2016 Open Platform for NFV Project, Inc. and its contributors
+
+Installing OVSNFV Fuel Plugin
+=============================
+
+* On the Fuel UI, create a new environment.
+* Assign nodes as normal.
+* In Settings > Compute, ensure KVM is selected which is required to enable DPDK on nodes' interfaces.
+* On the compute nodes' interface settings enable DPDK on the interface running the
+ private network.
+* *Do not enable DPDK on the control nodes.*
+* In Settings > Other
+ * Enable "Install Openvswitch with NSH/DPDK"
+ * Enable "Install DPDK"
+ * Disable "Install NSH"
+* In Nodes, for each compute node:
+ * Reserve some memory for DPDK hugepages - typically 128-512MB per NUMA node.
+ * Reserve some memory for Nova hugepages - typically 70-90% of total memory.
+ * Pin DPDK cores - typically 2.
+* Continue with environment configuration and deployment as normal.
+
+
+Upgrading the plugin
+--------------------
+
+From time to time new versions of the plugin may become available.
+
+The plugin cannot be upgraded if an active environment is using the plugin.
+
+In order to upgrade the plugin:
+
+* Copy the updated plugin file to the fuel-master.
+* On the Fuel UI, reset the environment.
+* On the Fuel CLI "fuel plugins --update <fuel-plugin-file>"
+* On the Fuel UI, re-deploy the environment.
diff --git a/docs/release/configguide/index.rst b/docs/release/configguide/index.rst
new file mode 100644
index 0000000..70bb4a4
--- /dev/null
+++ b/docs/release/configguide/index.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright (c) 2016 Open Platform for NFV Project, Inc. and its contributors
+
+==============================
+OVSNFV Guides and Installation
+==============================
+
+.. toctree::
+ :numbered:
+ :maxdepth: 3
+
+ featureconfig.rst
+
diff --git a/docs/release/installation b/docs/release/installation
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/docs/release/installation
diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst
new file mode 100644
index 0000000..664306d
--- /dev/null
+++ b/docs/release/release-notes/index.rst
@@ -0,0 +1,11 @@
+************************
+OPNFV OPNFV Release Notes
+************************
+
+Contents:
+
+.. toctree::
+ :numbered:
+ :maxdepth: 4
+
+ release-notes.rst
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
new file mode 100644
index 0000000..683ce06
--- /dev/null
+++ b/docs/release/release-notes/release-notes.rst
@@ -0,0 +1,215 @@
+=============================================================
+OPNFV Release Notes for the Colorado release of OVS for OPNFV
+=============================================================
+
+
+.. contents:: Table of Contents
+ :backlinks: none
+
+
+Abstract
+========
+
+This document provides the release notes for Colorado release of
+OVS for OPNFV.
+
+Version history
+===============
+
+
++-------------+-----------+------------------+----------------------+
+| **Date** | **Ver.** | **Authors** | **Comment** |
+| | | | |
++-------------+-----------+------------------+----------------------+
+
+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
+OVS kernel module with NSH patches.
+
+- Documentation is built by Jenkins
+- .rpm packages are built by Jenkins
+
+Release Data
+============
+
++--------------------------------------+--------------------------------------+
+| **Project** | ovsnfv |
+| | |
++--------------------------------------+--------------------------------------+
+| **Repo/tag** | ovsnfv/colorado.1.0 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release designation** | colorado.1.0 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Release date** | 2016-09-14 |
+| | |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery** | OPNFV Colorado release |
+| | |
++--------------------------------------+--------------------------------------+
+
+Version change
+--------------
+
+Module version changes
+~~~~~~~~~~~~~~~~~~~~~~
+This is the first tracked version of OVSNFV for the Colorado release.
+
+- Open vSwitch 2.5.90
+
+- DPDK 16.04
+
+Unsupported Experimental OVS with NSH
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- **Experimental** Open vSwitch 2.5.90 with NSH
+- **Experimental** Open vSwitch 2.5.90 with NSH Kernel Module
+- OVS commit7d433ae57ebb90cd68e8fa948a096f619ac4e2d8
+
+For more information see:
+
+- https://github.com/yyang13/ovs_nsh_patches/blob/master/README.md
+
+Document version changes
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+This is the first tracked version of Colorado release of OVSNFV
+The following documentation is provided with this release:
+
+- OVSNFV Build instructions of the RPMs for the Colorado release
+ ver. 1.0.0
+
+Feature additions
+~~~~~~~~~~~~~~~~~
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: OVSNFV-1 | Setup OVS/DPDK RPM |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: OVSNFV-27 | A deployment with Apex using |
+| | OVS/DPDK passes all relevant |
+| | functest tests. |
++--------------------------------------+--------------------------------------+
+| JIRA: OVSNFV-29 | Apex consume ovsnfv generated RPM |
+| | |
++--------------------------------------+--------------------------------------+
+
+Bug corrections
+~~~~~~~~~~~~~~~
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| | |
+| | |
++--------------------------------------+--------------------------------------+
+
+Deliverables
+------------
+
+Software deliverables
+~~~~~~~~~~~~~~~~~~~~~
+build.sh - Builds the RPM artifacts
+
+Artifacts produced by OVSNFV
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Artifacts consist of RPMs. Artifacts for this release conist of RPMs.
+The RPM file names are all prefixed
+with ovs4opnfv-e8acab14-
+RPMs are uploaded into the OPNFV artifactory in the opnfv artifactory in the
+ovsnfv/colorado directory.
+
+- DPDK 16.04
+
+ - ovs4opnfv-e8acab14-dpdk-16.04.0-1.el7.centos.x86_64.rpm
+ - ovs4opnfv-e8acab14-dpdk-debuginfo-16.04.0-1.el7.centos.x86_64.rpm
+ - ovs4opnfv-e8acab14-dpdk-devel-16.04.0-1.el7.centos.x86_64.rpm
+ - ovs4opnfv-e8acab14-dpdk-examples-16.04.0-1.el7.centos.x86_64.rpm
+ - ovs4opnfv-e8acab14-dpdk-tools-16.04.0-1.el7.centos.x86_64.rpm
+
+- OVS with DPDK
+
+ - ovs4opnfv-e8acab14-openvswitch-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
+ - ovs4opnfv-e8acab14-openvswitch-debuginfo-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
+ - ovs4opnfv-e8acab14-openvswitch-devel-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
+ - ovs4opnfv-e8acab14-openvswitch-ovn-central-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
+ - ovs4opnfv-e8acab14-openvswitch-ovn-common-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
+ - ovs4opnfv-e8acab14-openvswitch-ovn-docker-2.5.90-0.12032.gitc61e93d6.1.el7.centos.x86_64.rpm
+ - 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
+
+EXPERIMENTAL artifacts produced by OVS for NFV
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
+ - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-debuginfo-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
+ - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-devel-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
+ - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-kmod-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
+ - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-central-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
+ - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-common-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
+ - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-docker-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
+ - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-host-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
+ - ovs4opnfv-e8acab14-EXPERIMENTAL-openvswitch-ovn-vtep-2.5.90-0.11975.NSH7d433ae5.1.el7.centos.x86_64.rpm
+
+
+Documentation deliverables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+- RPM build instructions for the Colorado release version 1.0.0
+- OVSNFV Release Notes for the Colorado release version 1.0.0
+- Configuration Guide for OVSNFV
+- Supported Scenario Description and Documentation
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+Known issues
+------------
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| | |
+| | |
++--------------------------------------+--------------------------------------+
+
+Workarounds
+-----------
+**-**
+
+
+Test Result
+===========
+
+The Colorado release of OVS/DPDK RPM deployed with the Apex deployment
+toolchain has undergone QA test runs with the following results:
+
++--------------------------------------+--------------------------------------+
+| **TEST-SUITE** | **Results:** |
+| | |
++--------------------------------------+--------------------------------------+
+| **-** | **-** |
++--------------------------------------+--------------------------------------+
+
+
+References
+==========
+
+For more information on the OPNFV Colorado release, please see:
+
+http://wiki.opnfv.org/releases/Colorado
+
+:Author: Thomas F Herbert (therbert@redhat.com)
+:Version: 1.0.0
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
+
diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst
new file mode 100644
index 0000000..5741f2d
--- /dev/null
+++ b/docs/release/userguide/feature.userguide.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
+
+OVSNFV description
+=====================
+Open vSwtich (OVS) is a software switch commonly used in OPNFV deployments.
+OVSNFV project supplies a Fuel Plugin to upgrade DPDK enabled Open vSwitch on
+an OPNFV to 2.5.90.
+
+
+OVSNFV capabilities and usage
+================================
+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.
+
diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst
new file mode 100644
index 0000000..1566bf6
--- /dev/null
+++ b/docs/release/userguide/index.rst
@@ -0,0 +1,24 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Intel Corporation
+
+=================
+OVSNFV user guide
+=================
+
+.. The feature user guide should provide an OPNFV user with enough information to
+.. use the features provided by the feature project in the supported scenarios.
+.. This guide should walk a user through the usage of the features once a scenario
+.. has been deployed and is active according to the installation guide provided
+.. by the installer project.
+
+
+.. toctree::
+ :maxdepth: 3
+
+ ./feature.userguide.rst
+
+.. The feature.userguide.rst file should contain the text for this document
+.. additional documents can be added to this directory and added in the right order
+.. to this file as a list below.
+