-.. 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.
-This document provides the release notes for OPNFV Euphrates of SampleVNF project.
+OPNFV Jerma Release
+===================
+* The only supported test VNF in this release for dataplane benchmarking purposes is PROX
+* PROX supporting up to DPDK:20.05
+* Introducing ability to make test cloud-configured dataplane networking benchmarks using
+ ETSI NFV TST009 standard methods
+* Test automation using X-testing
-.. contents::
- :depth: 3
- :local:
+OPNFV Hunter Release
+======================
-Version history
----------------
+This Hunter release provides *SampleVNF* as a approx VNF repository for
+VNF/NFVI testing, characterization and OPNFV feature testing, automated on
+OPNFV platform, including:
-+--------------------+--------------------+--------------------+--------------------+
-| **Date** | **Ver.** | **Author** | **Comment** |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-| 2017-07-17 | 0.1.0 | Deepak S | First draft |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-| | | | |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-| | | | |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
+* Documentation generated with Sphinx
-Important notes
-===============
+ * User Guide
-<STATE IMPORTANT NOTES/DEVdddddIATIONS SINCE PREVIOUS ITERATIVE RELEASE AND OTHER IMPORTANT NOTES FOR THIS RELEASE>
+ * Developer Guide
-<EXAMPLE>:
+ * Release notes (this document)
-**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
+ * Results
+* Automated SampleVNF test suit in OPNFV Yardstick_ Project
-Summary
-=======
+* SampleVNF source code
-<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
+For Hunter release, the *SampleVNF* supported:
-<EXAMPLE>:
++----------------+---------------------------------------------------------+-------------------+
+| *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 |
++----------------+---------------------------------------------------------+-------------------+
-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......
+.. note:: Highlevel Desgin and features supported by each of the VNFs is described in Developer
+ and user guide.
+For Hunter release, the *SampleVNF* is used for the following
+testing:
-Release Data
-============
-<STATE RELEVANT RELEASE DATA/RECORDS>
-
-<EXAMPLE>:
-
-+--------------------------------------+--------------------------------------+
-| **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|
-| | |
-+--------------------------------------+--------------------------------------+
+* OPNFV platform testing - generic test cases to measure the categories:
-Version change
-^^^^^^^^^^^^^^^^
-
-Module version changes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-<STATE WHAT UPSTREAM, - AS WELL AS OPNFV MODULE VERSIONS HAVE CHANGED>
+ * NFVI Characterization:
-<EXAMPLE>:
+ * Network
-- Fuel have changed from 5.1 to 6.0.1
+ * VNF Characterization:
-- OpenDaylight has changed from Helium-SR1 to Helium-SR2
+ * Network - rfc2544, rfc3511, latency, http_test etc
-Document version changes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-<STATE WHAT RELATED DOCUMENTS THAT CHANGES WITH THIS RELEASE>
-<EXAMPLE>:
+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.
-- The Fuel@OPNFV installation guide version has changed from version 0.1 to to 0.2
-
-Reason for version
-^^^^^^^^^^^^^^^^^^^^
-Feature additions
-~~~~~~~~~~~~~~~~~~~~~~~
-<STATE ADDED FEATURES BY REFERENCE TO JIRA>
+.. 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.
-<EXAMPLE>:
-**JIRA BACK-LOG:**
+Release Data
+------------
+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE** | **SLOGAN** |
+| **Project** | SampleVNF |
| | |
+--------------------------------------+--------------------------------------+
-| BGS-123 | ADD OpenDaylight ml2 integration |
+| **Repo/tag** | opnfv-8.0 |
| | |
+--------------------------------------+--------------------------------------+
-| BGS-456 | Add auto-deployment of Fuel@OPNFV |
+| **SampleVNF Docker image tag** | Hunter 8.0 |
| | |
+--------------------------------------+--------------------------------------+
-
-Bug corrections
-~~~~~~~~~~~~~~~~~~~~~
-
-**JIRA TICKETS:**
-
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE** | **SLOGAN** |
+| **Release designation** | Hunter 8.0 |
| | |
+--------------------------------------+--------------------------------------+
-| BGS-888 | Fuel doesn't deploy |
+| **Release date** | "May 10 2019" |
| | |
+--------------------------------------+--------------------------------------+
-| BGS-999 | Floating IP doesn't work |
+| **Purpose of the delivery** | Hunter 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>:
+Deliverables
+------------
-Documentation deliverables
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Documents
+^^^^^^^^^
-<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
+ - User Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_user_userguide/index.html
-<EXAMPLE>:
+ - Developer Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_developer/index.html
-Known Limitations, Issues and Workarounds
-=========================================
+Software Deliverables
+^^^^^^^^^^^^^^^^^^^^^
-System Limitations
-^^^^^^^^^^^^^^^^^^^^
-<STATE ALL RELEVANT SYSTEM LIMITATIONS>
+ - The SampleVNF Docker image: To be added
-<EXAMPLE>:
-**Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades
+**SampleVNF tested on Contexts**
-**Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade
++---------------------+-------------------------------------------------------+
+| **Context** | **Description** |
+| | |
++---------------------+-------------------------------------------------------+
+| *Heat* | Models orchestration using OpenStack Heat |
+| | |
++---------------------+-------------------------------------------------------+
+| *Node* | Models Baremetal, Controller, Compute |
+| | |
++---------------------+-------------------------------------------------------+
+| *Standalone* | Models VM running on Non-Managed NFVi |
+| | |
++---------------------+-------------------------------------------------------+
-**Storage:** Ceph is the only supported storage configuration.
+Document Version Changes
+^^^^^^^^^^^^^^^^^^^^^^^^
-**Max number of networks:** 3800 (Needs special switch config.)
+This is the first version of the SampleVNF in OPNFV.
+It includes the following documentation updates:
-**L3Agent:** L3 agent and floating IPs is not supported.
+- SampleVNF User Guide:
-Known issues
-^^^^^^^^^^^^^^^
-<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
+- SampleVNF Developer Guide
-<EXAMPLE>:
+- SampleVNF Release Notes for SampleVNF: this document
-**JIRA TICKETS:**
-+--------------------------------------+--------------------------------------+
-| **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
+Feature additions
^^^^^^^^^^^^^^^^^
-<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:
-
-+--------------------------------------+--------------------------------------+
-| **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....... |
-+--------------------------------------+--------------------------------------+
-
-References
-==========
-<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
-
-<EXAMPLE>:
-
-For more information on the OPNFV Danube release, please see:
+- Support for DPDK 18.05 and DPDK 18.08
+- Add support for counting non dataplane related packets
+- test improvements and fixes for image creation
+- Local Documentation Builds
+- Improve l3fwd performance
+- Enable the local cache mac address
+- Initial support for DPDK 18.05
+- Adding centos.json to be used with packer to generate a VM with PROX
+- Adding support for Ubuntu 17.10...
+- Get multiple port stats simultaneously
+- Increase default mbuf size and code simplification/cleanup
+- update from src port in the pvt/pub handler
+
+Bug fixes:
+- Fix potential crash with latency accuracy
+- TempFix: vCGNAPT/vACL ipv4 perf issue
+- Temp Fix for vFW perf issue
+- fix code standard in VNFs/DPPD-PROX/handle_esp.c
+- Workaround DPDK net/virtio queue setup issue
+- Fix potential crash when shuffling mbufs
+
+
+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
+^^^^^^^^^^^^^^^^
-http://opnfv.org/danube
+Hunter 8.2:
+
++----------------------------+----------------------------------------------------------------------+
+| **JIRA REFERENCE** | **DESCRIPTION** |
++----------------------------+----------------------------------------------------------------------+
+| SAMPLEVNF-129 | Support for DPDK 18.05 and DPDK 18.08 |
++----------------------------+----------------------------------------------------------------------+
+| SAMPLEVNF-130 | Add support for counting non dataplane related packets |
++----------------------------+----------------------------------------------------------------------+
+| SAMPLEVNF-131 | test improvements and fixes for image creation |
++----------------------------+----------------------------------------------------------------------+
+| SAMPLEVNF-132 | Local Documentation Builds |
++----------------------------+----------------------------------------------------------------------+
+| SAMPLEVNF-133 | Improve l3fwd performance |
++----------------------------+----------------------------------------------------------------------+
+| SAMPLEVNF-134 | Enable the local cache mac address |
++----------------------------+----------------------------------------------------------------------+
+| SAMPLEVNF-135 | Initial support for DPDK 18.05 |
++----------------------------+----------------------------------------------------------------------+
+| SAMPLEVNF-136 | Adding centos.json to be used with packer to generate a VM with PROX|
++----------------------------+----------------------------------------------------------------------+
+| SAMPLEVNF-137 | Adding support for Ubuntu 17.20... |
++----------------------------+----------------------------------------------------------------------+
+| SAMPLEVNF-138 | Get multiple port stats simultaneously |
++----------------------------+----------------------------------------------------------------------+
+| SAMPLEVNF-139 | Increase default mbuf size and code simplification/cleanup |
++----------------------------+----------------------------------------------------------------------+
+| SAMPLEVNF-140 | update from src port in the pvt/pub handler |
++----------------------------+----------------------------------------------------------------------+
+
+
+
+
+Bug Fix Jira:
+
++----------------------------+-------------------------------------------------------------------+
+| **JIRA REFERENCE** | **DESCRIPTION** |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-141 | Fix potential crash with latency accuracy |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-142 | TempFix: vCGNAPT/vACL ipv4 perf issue |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-143 | Temp Fix for vFW perf issue |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-144 | fix code standard in VNFs/DPPD-PROX/handle_esp.c |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-145 | Workaround DPDK net/virtio queue setup issue |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-146 | Fix potential crash when shuffling mbufs |
++----------------------------+-------------------------------------------------------------------+
+
+Hunter known restrictions/issues
+--------------------------------
++-----------+-----------+----------------------------------------------+
+| Installer | Scenario | Issue |
++===========+===========+==============================================+
+| | | |
++-----------+-----------+----------------------------------------------+
+
+
+Open JIRA tickets
+-----------------
+
++----------------------------+------------------------------------------------+
+| **JIRA REFERENCE** | **DESCRIPTION** |
+| | |
++----------------------------+------------------------------------------------+
+| | |
+| | |
++----------------------------+------------------------------------------------+
+
+
+Useful links
+------------
+
+ - wiki project page: https://wiki.opnfv.org/display/SAM
+
+ - wiki SampleVNF Hunter release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
+
+ - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
+
+ - SampleVNF IRC chanel: #opnfv-samplevnf
Code Review / samplevnf.git / blobdiff