-.. 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 Farser 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/SAM
+.. _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* |
+| | | |
++----------------+--------------------+---------------------------------+
+| "May 25 2018" | 6.1.0 | SampleVNF for Farser 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* 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 Farser Release
+======================
-<EXAMPLE>:
+This Farser 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 Farser release, the *SampleVNF* supported:
-- Fuel have changed from 5.1 to 6.0.1
++----------------+---------------------------------------------------------+-------------------+
+| *VNF* | *Name* | *version* |
++----------------+---------------------------------------------------------+-------------------+
+| *CGNAPT* | Carrier Grade Network Address and port Translation .5.0 | v0.1.0 |
++----------------+---------------------------------------------------------+-------------------+
+| *Prox* | Packet pROcessing eXecution engine | v0.40.0 |
+| | acts as traffic generator, L3FWD, L2FWD, BNG etc | |
++----------------+---------------------------------------------------------+-------------------+
+| *vACL* | Access Control List | v0.1.0 |
++----------------+---------------------------------------------------------+-------------------+
+| *vFW* | Firewall | v0.1.0 |
++----------------+---------------------------------------------------------+-------------------+
+| *UDP_replay* | UDP_Replay | v0.1.0 |
++----------------+---------------------------------------------------------+-------------------+
-- OpenDaylight has changed from Helium-SR1 to Helium-SR2
+.. note:: Highlevel Desgin and features supported by each of the VNFs is described in Developer
+ and user guide.
-Document version changes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-<STATE WHAT RELATED DOCUMENTS THAT CHANGES WITH THIS RELEASE>
+For Farser release, the *SampleVNF* is used for the following
+testing:
-<EXAMPLE>:
+* OPNFV platform testing - generic test cases to measure the categories:
-- The Fuel@OPNFV installation guide version has changed from version 0.1 to to 0.2
+ * NFVI Characterization:
-Reason for version
-^^^^^^^^^^^^^^^^^^^^
-Feature additions
-~~~~~~~~~~~~~~~~~~~~~~~
-<STATE ADDED FEATURES BY REFERENCE TO JIRA>
+ * Network
+
+ * VNF Characterization:
+
+ * Network - rfc2544, rfc3511, latency, http_test etc
-<EXAMPLE>:
-**JIRA BACK-LOG:**
+The *SampleVNF* is developed in the OPNFV community, by the SampleVNF_ team.
+The *Network Service Benchmarking* SampleVNF Characterization 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.
+
+
+Release Data
+============
+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE** | **SLOGAN** |
+| **Project** | SampleVNF |
| | |
+--------------------------------------+--------------------------------------+
-| BGS-123 | ADD OpenDaylight ml2 integration |
+| **Repo/tag** | opnfv-6.1.0 |
| | |
+--------------------------------------+--------------------------------------+
-| BGS-456 | Add auto-deployment of Fuel@OPNFV |
+| **SampleVNF Docker image tag** | Farser 6.1 |
| | |
+--------------------------------------+--------------------------------------+
-
-Bug corrections
-~~~~~~~~~~~~~~~~~~~~~
-
-**JIRA TICKETS:**
-
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE** | **SLOGAN** |
+| **Release designation** | Farser 6.1 |
| | |
+--------------------------------------+--------------------------------------+
-| BGS-888 | Fuel doesn't deploy |
+| **Release date** | "May 25 2018" |
| | |
+--------------------------------------+--------------------------------------+
-| BGS-999 | Floating IP doesn't work |
+| **Purpose of the delivery** | Fraser alignment to Released |
+| | bug-fixes for the following: |
+| | - Memory leak |
+| | - minimum latency |
+| | - Increase default mbuf size and |
+| | code simplification/cleanup |
+| | - Crash in rx/tx distribution |
| | |
+--------------------------------------+--------------------------------------+
-Deliverables
-----------------
-
-Software deliverables
-^^^^^^^^^^^^^^^^^^^^^^^
-
-<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
-<EXAMPLE>:
-
-Documentation deliverables
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
-
-<EXAMPLE>:
+Deliverables
+============
+Documents
+---------
-Known Limitations, Issues and Workarounds
-=========================================
+ - User Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_user_userguide/index.html
-System Limitations
-^^^^^^^^^^^^^^^^^^^^
-<STATE ALL RELEVANT SYSTEM LIMITATIONS>
+ - Developer Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_developer/index.html
-<EXAMPLE>:
-**Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades
+Software Deliverables
+---------------------
-**Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade
+ - The SampleVNF Docker image: To be added
-**Storage:** Ceph is the only supported storage configuration.
-**Max number of networks:** 3800 (Needs special switch config.)
+**SampleVNF tested on Contexts**
-**L3Agent:** L3 agent and floating IPs is not supported.
++---------------------+-------------------------------------------------------+
+| **Context** | **Description** |
+| | |
++---------------------+-------------------------------------------------------+
+| *Heat* | Models orchestration using OpenStack Heat |
+| | |
++---------------------+-------------------------------------------------------+
+| *Node* | Models Baremetal, Controller, Compute |
+| | |
++---------------------+-------------------------------------------------------+
+| *Standalone* | Models VM running on Non-Managed NFVi |
+| | |
++---------------------+-------------------------------------------------------+
-Known issues
-^^^^^^^^^^^^^^^
-<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
+Document Version Changes
+------------------------
-<EXAMPLE>:
+This is the first version of the SampleVNF in OPNFV.
+It includes the following documentation updates:
-**JIRA TICKETS:**
+- SampleVNF User Guide:
-+--------------------------------------+--------------------------------------+
-| **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" |
-| | |
-+--------------------------------------+--------------------------------------+
+- SampleVNF Developer Guide
-Workarounds
-^^^^^^^^^^^^^^^^^
+- SampleVNF Release Notes for SampleVNF: this document
-<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
-
-Test Result
-===========
-<STATE THE QA COVERAGE AND RESULTS>
-
-<EXAMPLE>:
-
-Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results:
+Feature additions
+-----------------
+
+- SampleVNF RESTful API support
+- Security gateway testing
+- Support reading inline jumbo frame and dump them
+- Add support for generation of jumbo frames
+- Support for dpdk-stable-17.11.1 crypto
+- Add support for multiple variables in core definition
+- Support async operation in handle_esp
+- Add support for reception of jumbo frames
+- Support additional MAC format in config file
+- Add support for multiple GEN tasks running on the same core
+- Add support for crypto on multiple cores
+- Zero packet loss testing has been added.
+- Integrate irq mode into PROX (support display and command line)
+- Support async operation in handle_esp
+- Add config option to use port mac as src mac in l2fwd and swap
+- Add support for DPDK 17.11
+- Add support for multiple tasks generating to same ip in l3 mode.
+- Add l3 support for tasks without physical tx ports
+
+Bug fixes:
+- link speed when link is down at startup.
+- minimum latency
+- potential crash if link speed is null
+- the calculation of dropped packets and other changes
+- latency accuracy and dumping latencies to file
+- issues with the pkt_size command
+- potential crash in rx and tx distribution
+- extrapolation used in latency measurements
+- dumping receive packets
+- using signature in latency measurements
+- stacking of rx receive functions
+- potential crash when issuing "tx distr stop" command.
+- extrapolation used in latency measurements
+- memory leak introduced by 4a65cd84
+
+
+Known Issues/Faults
+-------------------
+- Huge page freeing needs to be handled properly while running the application else it might
+ cause system crash. Known issue from DPDK.
+- UDP Replay is used to capture throughput for dynamic cgnapt
+- Hardware Checksum offload is not supported for IPv6 traffic
+- SampleVNF on sriov is tested till 4 threads
+- Rest API is supported only for vACL, vFW, vCGNAPT
+- Rest API uses port 80, make sure other webservices are stopped before using SampleVNF RestAPI.
+
+Corrected Faults
+----------------
-+--------------------------------------+--------------------------------------+
-| **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....... |
-+--------------------------------------+--------------------------------------+
+Farser 6.1:
+
++----------------------------+-------------------------------------------------------------------+
+| **JIRA REFERENCE** | **DESCRIPTION** |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-98 | SampleVNF RESTful API support |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-99 | Security gateway testing |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-100 | Add support for generation of jumbo frames |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-101 | Support for dpdk-stable-17.11.1 crypto |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-102 | Support async operation in handle_espo |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-103 | Add support for reception of jumbo frames |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-104 | Support additional MAC format in config file |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-105 | support for multiple GEN tasks running on the same core |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-106 | Add support for crypto on multiple cores |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-107 | Zero packet loss testing |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-108 | Integrate irq mode into PROX (support display and command line) |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-109 | Add config option to use port mac as src mac in l2fwd and swap |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-110 | Add support for DPDK 17.11 |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-111 | Add support for multiple tasks generating to same ip in l3 mode |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-112 | Add l3 support for tasks without physical tx ports |
++----------------------------+-------------------------------------------------------------------+
+
+Bug Fix Jira:
+
++----------------------------+-------------------------------------------------------------------+
+| **JIRA REFERENCE** | **DESCRIPTION** |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-113 | link speed when link is down at startup. |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-114 | minimum latency |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-115 | potential crash if link speed is null |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-116 | the calculation of dropped packets and other changes |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-117 | latency accuracy and dumping latencies to file |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-118 | issues with the pkt_size command |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-119 | extrapolation used in latency measurements |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-120 | dumping receive packets |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-121 | using signature in latency measurements |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-122 | stacking of rx receive functions |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-123 | potential crash when issuing "tx distr stop" command. |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-124 | extrapolation used in latency measurements |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-125 | memory leak introduced by 4a65cd84 |
++----------------------------+-------------------------------------------------------------------+
+
+Farser 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 Farser release planing page: https://wiki.opnfv.org/display/SAM/F+Release+Plan+for+SampleVNF
-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