Adding Initial samplevnf release notes draft for E-Release

JIRA: SAMPLEVNF-74
Change-Id: I6d3adacc9236006f64218aad5378a4af5dd2efe5
Signed-off-by: Deepak S <deepak.s@linux.intel.com>

5 files changed, 266 insertions, 155 deletions

diff --git a/docs/release/release-notes/index.rst b/docs/release/release-notes/index.rst
index dc0698c8..323e42ef 100644
--- a/docs/release/release-notes/index.rst
+++ b/docs/release/release-notes/index.rst
@@ -1,4 +1,7 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+ .. _samplevnf-results:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) OPNFV, Intel Corporation and others.
 
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
index cc745945..5d9abc25 100644
--- a/docs/release/release-notes/release-notes.rst
+++ b/docs/release/release-notes/release-notes.rst
@@ -1,234 +1,234 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) OPNFV, Intel Corporation and others.
 
+=======
+License
+=======
+
+OPNFV release note for SampleVNF Docs
+are licensed under a Creative Commons Attribution 4.0 International License.
+You should have received a copy of the license along with this.
+If not, see <http://creativecommons.org/licenses/by/4.0/>.
+:
+The *SampleVNFs*, the *SampleVNF test cases* are opensource software,
+ licensed under the terms of the Apache License, Version 2.0.
+
+===========================================
+OPNFV Euphrates Release Note for SampleVNF
+===========================================
 
-This document provides the release notes for OPNFV Euphrates of SampleVNF project.
+.. toctree::
+   :maxdepth: 2
 
-.. contents::
-   :depth: 3
-   :local:
+.. _SampleVNF: https://wiki.opnfv.org/samplevnf
 
+.. _Yardstick: https://wiki.opnfv.org/yardstick
 
-Version history
----------------
+.. _NFV-TST001: http://www.etsi.org/deliver/etsi_gs/NFV-TST/001_099/001/01.01.01_60/gs_NFV-TST001v010101p.pdf
 
-+--------------------+--------------------+--------------------+--------------------+
-| **Date**           | **Ver.**           | **Author**         | **Comment**        |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-| 2017-07-17         | 0.1.0              | Deepak S           | First draft        |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-|                    |                    |                    |                    |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-|                    |                    |                    |                    |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
 
-Important notes
+Abstract
+========
+
+This document describes the release note of SampleVNF project.
+
+
+Version History
 ===============
 
-<STATE IMPORTANT NOTES/DEVdddddIATIONS SINCE PREVIOUS ITERATIVE RELEASE AND OTHER IMPORTANT NOTES FOR THIS RELEASE>
++----------------+--------------------+---------------------------------+
+| *Date*         | *Version*          | *Comment*                       |
+|                |                    |                                 |
++----------------+--------------------+---------------------------------+
++----------------+--------------------+---------------------------------+
+|                |  1.0               | SampleVNF for Euphrates release    |
+|                |                    |                                 |
++----------------+--------------------+---------------------------------+
 
-<EXAMPLE>:
 
-**Attention:** Please be aware that since LSV3 a pre-deploy script must be ran on the Fuel master -
-see the OPNFV@Fuel SW installation instructions
+Important Notes
+===============
 
+The software delivered in the OPNFV SampleVNF_ Project, comprising the
+*SampleVNF VNFs*, the *SampleVNF test cases* and performance test case
+are part of  OPNFV Yardstick_ Project is a realization of the methodology in
+ETSI-ISG NFV-TST001_.
 
-Summary
-=======
 
-<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
+OPNFV Euphrates Release
+======================
 
-<EXAMPLE>:
+This Euphrates release provides *SampleVNF* as a approx VNF repository for
+VNF/NFVI testing, characterization and OPNFV feature testing, automated on
+OPNFV platform, including:
 
-Arno Fuel@OPNFV is based the OpenStack Fuel upstream project version 6.0.1,
-but adds OPNFV unique components such as OpenDaylight version: Helium as well as other OPNFV unique configurations......
+* Documentation generated with Sphinx
 
+  * User Guide
 
-Release Data
-============
-<STATE RELEVANT RELEASE DATA/RECORDS>
+  * Developer Guide
 
-<EXAMPLE>:
+  * Release notes (this document)
 
-+--------------------------------------+--------------------------------------+
-| **Project**                          | E.g. Arno/genesis/fuel@opnfv         |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Repo/commit-ID**                   | E.g. genesis/adf634a0d4.....         |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release designation**              | E.g. Arno RC2                        |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release date**                     | E.g. 2015-04-16                      |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery**          | E.g. OPNFV Internal quality assurance|
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
+  * Results
 
-Version change
-^^^^^^^^^^^^^^^^
+* Automated SampleVNF test suit in OPNFV Yardstick_ Project
 
-Module version changes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-<STATE WHAT UPSTREAM, - AS WELL AS OPNFV MODULE VERSIONS HAVE CHANGED>
+* SampleVNF source code
 
-<EXAMPLE>:
+For Euphrates release, the *SampleVNF * is used for the following
+testing:
 
-- Fuel have changed from 5.1 to 6.0.1
+* OPNFV platform testing - generic test cases to measure the categories:
 
-- OpenDaylight has changed from Helium-SR1 to Helium-SR2
+  * NFVi Characterization:
 
-Document version changes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-<STATE WHAT RELATED DOCUMENTS THAT CHANGES WITH THIS RELEASE>
+    * Network
 
-<EXAMPLE>:
+  * VNF Characterization:
 
-- The Fuel@OPNFV installation guide version has changed from version 0.1 to to 0.2
+    * Network - rfc2544, rfc3511, latency, http_test etc
 
-Reason for version
-^^^^^^^^^^^^^^^^^^^^
-Feature additions
-~~~~~~~~~~~~~~~~~~~~~~~
-<STATE ADDED FEATURES BY REFERENCE TO JIRA>
 
-<EXAMPLE>:
+The *SampleVNF* is developed in the OPNFV community, by the
+SampleVNF_ team. The *Network Service Benchmarking* Testing tool is a part of
+the Yardstick Project.
+
+.. note:: The test case description template used for the SampleVNF in yardstick
+  test cases is based on the document ETSI-ISG NFV-TST001_; the results report template
+  used for the SampleVNF test results is based on the IEEE Std 829-2008.
 
-**JIRA BACK-LOG:**
+
+Release Data
+============
 
 +--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE**                   | **SLOGAN**                           |
+| **Project**                          | SampleVNF                            |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| BGS-123                              | ADD OpenDaylight ml2 integration     |
+| **Repo/tag**                         |                                      |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| BGS-456                              | Add auto-deployment of Fuel@OPNFV    |
+| **SampleVNF Docker image tag**       |                                      |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-
-Bug corrections
-~~~~~~~~~~~~~~~~~~~~~
-
-**JIRA TICKETS:**
-
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE**                   | **SLOGAN**                           |
+| **Release designation**              | Euphrates                            |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| BGS-888                              | Fuel doesn't deploy                  |
+| **Release date**                     |                                      |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| BGS-999                              | Floating IP doesn't work             |
+| **Purpose of the delivery**          |                                      |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
+
 Deliverables
-----------------
+============
 
-Software deliverables
-^^^^^^^^^^^^^^^^^^^^^^^
+Documents
+---------
 
-<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
+ - User Guide:  To be added
 
-<EXAMPLE>:
+ - Developer Guide: To be added
 
-Documentation deliverables
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
+Software Deliverables
+---------------------
 
-<EXAMPLE>:
+ - The SampleVNF Docker image: To be added
 
 
-Known Limitations, Issues and Workarounds
-=========================================
+**SampleVNF tested on Contexts**
 
-System Limitations
-^^^^^^^^^^^^^^^^^^^^
-<STATE ALL RELEVANT SYSTEM LIMITATIONS>
++---------------------+-------------------------------------------------------+
+| **Context**         | **Description**                                       |
+|                     |                                                       |
++---------------------+-------------------------------------------------------+
+| *Heat*              | Models orchestration using OpenStack Heat             |
+|                     |                                                       |
++---------------------+-------------------------------------------------------+
+| *Node*              | Models Baremetal, Controller, Compute                 |
+|                     |                                                       |
++---------------------+-------------------------------------------------------+
+| *Standalone*        | Models VM running on Non-Managed NFVi                 |
+|                     |                                                       |
++---------------------+-------------------------------------------------------+
 
-<EXAMPLE>:
+Document Version Changes
+------------------------
 
-**Max number of blades:**   1 Fuel master, 3 Controllers, 20 Compute blades
+This is the first version of the SampleVNF  in OPNFV.
+It includes the following documentation updates:
 
-**Min number of blades:**   1 Fuel master, 1 Controller, 1 Compute blade
+- SampleVNF User Guide:
+  add "network service benchmarking(NSB)" chapter;
+  add "SampleVNF - NSB Testing -Installation" chapter; add "SampleVNF API" chapter;
+  add "SampleVNF user interface" chapter; Update SampleVNF installation chapter;
 
-**Storage:**    Ceph is the only supported storage configuration.
+- SampleVNF Developer Guide
 
-**Max number of networks:**   3800 (Needs special switch config.)
+- SampleVNF Release Notes for SampleVNF: this document
 
-**L3Agent:**   L3 agent and floating IPs is not supported.
 
-Known issues
-^^^^^^^^^^^^^^^
-<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
+Feature additions
+-----------------
 
-<EXAMPLE>:
+- SampleVNF RESTful API support
 
-**JIRA TICKETS:**
+- Introduce Network service benchmarking
 
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE**                   | **SLOGAN**                           |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| BGS-987                              | Nova-compute process does            |
-|                                      | not re-spawn when killed             |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| BGS-654                              | MOS 5.1 : neutron net-list returns   |
-|                                      | "400 Bad request"                    |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
 
-Workarounds
-^^^^^^^^^^^^^^^^^
+Known Issues/Faults
+------------
 
-<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE>
 
-<EXAMPLE>:
 
-- In case the contact with a compute is lost - restart the compute host
-- In case the disk is full on a controller - delete all files in /tmp
+Corrected Faults
+----------------
 
-Test Result
-===========
-<STATE THE QA COVERAGE AND RESULTS>
+Euphrates.1.0:
 
-<EXAMPLE>:
++----------------------------+------------------------------------------------+
+| **JIRA REFERENCE**         | **DESCRIPTION**                                |
+|                            |                                                |
++----------------------------+------------------------------------------------+
+| JIRA: samplevnf-           |                                                |
+|                            |                                                |
++----------------------------+------------------------------------------------+
 
-Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results:
 
-+--------------------------------------+--------------------------------------+
-| **TEST-SUITE**                       | **Results:**                         |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| Tempest test suite 123               | Following tests failed:              |
-|                                      |                                      |
-|                                      | 1. Image resizing....                |
-|                                      |                                      |
-|                                      | 2. Heat deploy....                   |
-+--------------------------------------+--------------------------------------+
-| Robot test suite 456                 | Following tests failed:              |
-|                                      |                                      |
-|                                      | 1.......                             |
-|                                      |                                      |
-|                                      | 2.......                             |
-+--------------------------------------+--------------------------------------+
+Euphrates  known restrictions/issues
+====================================
++-----------+-----------+----------------------------------------------+
+| Installer | Scenario  |  Issue                                       |
++===========+===========+==============================================+
+|           |           |                                              |
++-----------+-----------+----------------------------------------------+
+
+
+Open JIRA tickets
+=================
+
++----------------------------+------------------------------------------------+
+| **JIRA REFERENCE**         | **DESCRIPTION**                                |
+|                            |                                                |
++----------------------------+------------------------------------------------+
+|                            |                                                |
+|                            |                                                |
++----------------------------+------------------------------------------------+
+
+
+Useful links
+============
 
-References
-==========
-<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
+ - wiki project page: https://wiki.opnfv.org/display/SAM
 
-<EXAMPLE>:
+ - wiki SampleVNF Euphrates release planing page: https://wiki.opnfv.org/display/SAM/SampleVNF+Euphrates+Release+Planning
 
-For more information on the OPNFV Danube release, please see:
+ - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
 
-http://opnfv.org/danube
+ - SampleVNF IRC chanel: #opnfv-samplevnf
diff --git a/docs/release/results/index.rst b/docs/release/results/index.rst
new file mode 100644
index 00000000..25066c26
--- /dev/null
+++ b/docs/release/results/index.rst
@@ -0,0 +1,16 @@
+.. _samplevnf-results:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation and other.
+
+======================
+SampleVNF test results
+======================
+
+.. toctree::
+   :maxdepth: 4
+
+.. include:: ./overview.rst
+.. include:: ./results.rst
diff --git a/docs/release/results/overview.rst b/docs/release/results/overview.rst
new file mode 100644
index 00000000..77b36542
--- /dev/null
+++ b/docs/release/results/overview.rst
@@ -0,0 +1,27 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation and other.
+
+Yardstick test tesult document overview
+=======================================
+
+.. _`SampleVNF user guide`: artifacts.opnfv.org/samplevnf/docs/userguide/index.html
+
+This document provides an overview of the results of test cases developed by
+the OPNFV SampleVNF Project & test cases executed part of yardstick
+
+SampleVNF project is described in `SampleVNF user guide`_.
+
+OPNFV CI for SampleVNF automated build, deploy and testing for
+the software developed in OPNFV is out of scope for OPNFV E-release.
+
+OPNFV Yardstick is used as a Test Infrastrucutre to validate all the performace
+testcases on different context like Bare-Metal, Standalone virtualization and
+Openstack. OPNF CI enable for yardstick testases work in progress.
+
+References
+----------
+
+* IEEE Std 829-2008. "Standard for Software and System Test Documentation".
+* DPDK. "http://dpdk.org/".
diff --git a/docs/release/results/results.rst b/docs/release/results/results.rst
new file mode 100644
index 00000000..f64f3422
--- /dev/null
+++ b/docs/release/results/results.rst
@@ -0,0 +1,65 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation and other.
+
+Results listed by scenario
+==========================
+
+The following sections describe the yardstick results as evaluated for the
+Euphrates release. Each section describes the determined state of the specific
+test case in Euphrates release.
+
+Feature Test Results
+====================
+
+The following features were verified by SampleVNF test cases:
+
+   * vFirewall
+      * Basic Packet filter dropping malformed, invalid packets based on L3/L4 packet headers
+      * Policy based filtering
+      * Dynamic Packet filtering through Connection Tracker for TCP and UDP
+      * SYN-flood protection via synproxy for TCP
+      * UDP, TCP and ICMP protocol pass-through
+      * CLI based enable/disable connection tracking, synproxy, basic packet filtering
+      * Multithread support
+      * Multiple physical port support
+      * Providing statistics on traffic traversing the VNF
+
+   * vCG-NAPT- Carrier Grade Network Address and port Translation
+     * Static and dynamic Network address translation.
+     * Static and dynamic Network address and port translation
+     * ARP (request, response, gratuitous)
+     * ICMP (terminal echo, echo response, pass-through)
+     * UDP, TCP and ICMP protocol pass-through
+     * Multithread support and Multiple physical port support
+     * Limiting max ports per client
+     * Limiting max clients per public IP address
+     * Live Session tracking to NAT flow
+     * NAT64 – connectivity between IPv6 access network to IPv4 data network.
+
+   * vACL - Access Control List
+     * CLI based Run-time rule configuration (Add, Delete, List, Display, Clear, Modify)
+     * IPv4 and IPv6 5 tuple packet Selector support
+     * Counting packets and bytes per rule
+     * Multithread support
+     * Multiple physical port support
+     * Forwarding packets to specific ports on base of rules
+     * Rules definition on base TCP/UDP connection tracking
+
+   * Prox - Packet pROcessing eXecution engine.
+     * Classify
+     * Drop
+     * Basic Forwarding (no touch)
+     * L2 Forwarding (change MAC)
+     * GRE encap/decap
+     * Load balance based on packet fields
+     * Symmetric load balancing
+     * QinQ encap/decap IPv4/IPv6
+     * ARP
+     * QoS
+     * Routing
+     * Unmpls
+     * Policing
+     * Basic ACL
+     * Basic CGNAT