Merge "Docs for ovsnfv RPM generation for Apex including scenario description, release notes and build procedures."

8 files changed, 440 insertions, 0 deletions

diff --git a/docs/buildprocedure/build.instructions.rst b/docs/buildprocedure/build.instructions.rst
new file mode 100644
index 0000000..e754967
--- /dev/null
+++ b/docs/buildprocedure/build.instructions.rst
@@ -0,0 +1,72 @@
+.. 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
+
+========
+Abstract
+========
+
+This document describes the optional build of the OPNFV Colorado release
+of the OVSNFV RPMs for the The dependencies and required
+system resources are also described.
+
+============
+Introduction
+============
+
+This document describes how to build the OVSNFV RPMs. These RPMs are incorporated into the
+Apex iso artifacts so there is no required action for Apex installation of OPNFV.
+
+This document describes the optional standalone build of the OVSNFV RPMs.
+
+============
+Requirements
+============
+
+
+Minimum Software Requirements
+=============================
+
+The build host should run Centos 7.0
+
+Setting up OPNFV Gerrit in order to being able to clone the code
+----------------------------------------------------------------
+
+- Start setting up OPNFV gerrit by creating a SSH key (unless you
+  don't already have one), create one with ssh-keygen
+
+- Add your generated public key in OPNFV Gerrit <https://gerrit.opnfv.org/>
+  (this requires a Linux foundation account, create one if you do not
+  already have one)
+
+- Select "SSH Public Keys" to the left and then "Add Key" and paste
+  your public key in.
+
+Clone the OPNFV code Git repository with your SSH key
+-----------------------------------------------------
+
+Clone the code repository:
+
+.. code-block:: bash
+
+    $ git clone ssh://<Linux foundation user>@gerrit.opnfv.org:29418/ovsnfv
+
+Clone the OPNFV code Git repository using HTML
+----------------------------------------------
+
+.. code-block:: bash
+
+    $ git clone https://gerrit.opnfv.org:29418/ovsnfv
+
+========
+Building
+========
+
+Build using build.sh
+--------------------
+
+.. code-block:: bash
+
+    $ cd ovsnfv/ci
+    $ ./build.sh
+
diff --git a/docs/buildprocedure/index.rst b/docs/buildprocedure/index.rst
new file mode 100644
index 0000000..f9c22a6
--- /dev/null
+++ b/docs/buildprocedure/index.rst
@@ -0,0 +1,14 @@
+.. This document is protected/licensed under the following conditions
+.. Licensed under a Creative Commons Attribution 4.0 International License.
+.. You should have received a copy of the license along with this work.
+.. If not, see <http://creativecommons.org/licenses/by/4.0/>.
+
+*********************************************
+Build instruction for the OVSNFV RPM for Apex
+*********************************************
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   build.instructions.rst
diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst
new file mode 100644
index 0000000..664306d
--- /dev/null
+++ b/docs/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-notes/release-notes.rst b/docs/release-notes/release-notes.rst
new file mode 100644
index 0000000..285bcae
--- /dev/null
+++ b/docs/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.git/README
+
+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/NEWS.rst b/docs/release/NEWS.rst
index 4e87aa0..ac5773f 100755
--- a/docs/release/NEWS.rst
+++ b/docs/release/NEWS.rst
@@ -7,3 +7,8 @@ January 2016
 
 - Initial Release of OVSNFV Fuel Plugin.
 
+September 2016
+============
+
+- Colorado Release of the OVSNFV RPM for Apex.
+
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
--- /dev/null
+++ b/docs/scenarios/os-nosdn-ovs-noha/ovs4nfv.png
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