licensed under the terms of the Apache License, Version 2.0.
==========================================
-OPNFV Farser Release Note for SampleVNF
+OPNFV Hunter Release Note for SampleVNF
==========================================
.. toctree::
| *Date* | *Version* | *Comment* |
| | | |
+----------------+--------------------+---------------------------------+
-| "April 27 2018"| 6.0.0 | SampleVNF for Farser release |
+| "May 10 2019" | 8.0 | SampleVNF for Hunter release |
| | | |
+----------------+--------------------+---------------------------------+
Project is a realization of the methodology in ETSI-ISG NFV-TST001_.
-OPNFV Farser Release
+OPNFV Hunter Release
======================
-This Farser release provides *SampleVNF* as a approx VNF repository for
+This Hunter release provides *SampleVNF* as a approx VNF repository for
VNF/NFVI testing, characterization and OPNFV feature testing, automated on
OPNFV platform, including:
* SampleVNF source code
-For Farser release, the *SampleVNF* supported:
+For Hunter release, the *SampleVNF* supported:
+----------------+---------------------------------------------------------+-------------------+
| *VNF* | *Name* | *version* |
.. note:: Highlevel Desgin and features supported by each of the VNFs is described in Developer
and user guide.
-For Farser release, the *SampleVNF* is used for the following
+For Hunter release, the *SampleVNF* is used for the following
testing:
* OPNFV platform testing - generic test cases to measure the categories:
| **Project** | SampleVNF |
| | |
+--------------------------------------+--------------------------------------+
-| **Repo/tag** | samplevnf/Farser.6.0.0 |
+| **Repo/tag** | opnfv-8.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **SampleVNF Docker image tag** | Farser.6.0.0 |
+| **SampleVNF Docker image tag** | Hunter 8.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release designation** | Farser |
+| **Release designation** | Hunter 8.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | "April" 27 2018" |
+| **Release date** | "May 10 2019" |
| | |
+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | OPNFV Farser release 6.0.0 |
+| **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 |
| | |
+--------------------------------------+--------------------------------------+
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
+- 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:
-- 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
+- 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
Corrected Faults
----------------
-Farser.6.0.0:
+Hunter 8.2:
+----------------------------+-------------------------------------------------------------------+
| **JIRA REFERENCE** | **DESCRIPTION** |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-98 | SampleVNF RESTful API support |
+| SAMPLEVNF-129 | Support for DPDK 18.05 and DPDK 18.08 |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-99 | Security gateway testing |
+| SAMPLEVNF-130 | Add support for counting non dataplane related packets |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-100 | Add support for generation of jumbo frames |
+| SAMPLEVNF-131 | test improvements and fixes for image creation |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-101 | Support for dpdk-stable-17.11.1 crypto |
+| SAMPLEVNF-132 | Local Documentation Builds |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-102 | Support async operation in handle_espo |
+| SAMPLEVNF-133 | Improve l3fwd performance |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-103 | Add support for reception of jumbo frames |
+| SAMPLEVNF-134 | Enable the local cache mac address |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-104 | Support additional MAC format in config file |
+| SAMPLEVNF-135 | Initial support for DPDK 18.05 |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-105 | support for multiple GEN tasks running on the same core |
+| SAMPLEVNF-136 | Adding centos.json to be used with packer to generate a VM with PROX|
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-106 | Add support for crypto on multiple cores |
+| SAMPLEVNF-137 | Adding support for Ubuntu 17.20... |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-107 | Zero packet loss testing |
+| SAMPLEVNF-138 | Get multiple port stats simultaneously |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-108 | Integrate irq mode into PROX (support display and command line) |
+| SAMPLEVNF-139 | Increase default mbuf size and code simplification/cleanup |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-109 | Add config option to use port mac as src mac in l2fwd and swap |
+| SAMPLEVNF-140 | update from src port in the pvt/pub handler |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-110 | Add support for DPDK 17.11 |
+
+
+
+
+Bug Fix Jira:
+
++----------------------------+-------------------------------------------------------------------+
+| **JIRA REFERENCE** | **DESCRIPTION** |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-111 | Add support for multiple tasks generating to same ip in l3 mode |
+| SAMPLEVNF-141 | Fix potential crash with latency accuracy |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-112 | Add l3 support for tasks without physical tx ports |
+| 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
+| SAMPLEVNF- | PROX support for dpdk 18,05 |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF- | PROX support for dpdk 18,05 |
++----------------------------+-------------------------------------------------------------------+
+
+
+
Bug Fix Jira:
+----------------------------+-------------------------------------------------------------------+
| **JIRA REFERENCE** | **DESCRIPTION** |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-113 | link speed when link is down at startup. |
+| SAMPLEVNF- | Fix samplevnf perf issues |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-114 | minimum latency |
+
+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
+
+
+
+
+Bug Fix Jira:
+
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-115 | potential crash if link speed is null |
+| **JIRA REFERENCE** | **DESCRIPTION** |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-116 | the calculation of dropped packets and other changes |
+| SAMPLEVNF- | Fix samplevnf perf issues |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-117 | latency accuracy and dumping latencies to file |
+
+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
+
+
+
+
+Bug Fix Jira:
+
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-118 | issues with the pkt_size command |
+| **JIRA REFERENCE** | **DESCRIPTION** |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-119 | extrapolation used in latency measurements |
+| SAMPLEVNF- | Fix samplevnf perf issues |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-120 | dumping receive packets |
+
+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
+
+
+
+
+Bug Fix Jira:
+
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-121 | using signature in latency measurements |
+| **JIRA REFERENCE** | **DESCRIPTION** |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-122 | stacking of rx receive functions |
+| SAMPLEVNF- | Fix samplevnf perf issues |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-123 | potential crash when issuing "tx distr stop" command. |
+
+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
+
+
+
+
+Bug Fix Jira:
+
++----------------------------+-------------------------------------------------------------------+
+| **JIRA REFERENCE** | **DESCRIPTION** |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF- | Fix samplevnf perf issues |
++----------------------------+-------------------------------------------------------------------+
+
+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
+
+
+
+
+Bug Fix Jira:
+
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-124 | extrapolation used in latency measurements |
+| **JIRA REFERENCE** | **DESCRIPTION** |
+----------------------------+-------------------------------------------------------------------+
-| SAMPLEVNF-125 | memory leak introduced by 4a65cd84 |
+| SAMPLEVNF- | Fix samplevnf perf issues |
+----------------------------+-------------------------------------------------------------------+
-Farser known restrictions/issues
+Hunter known restrictions/issues
====================================
+-----------+-----------+----------------------------------------------+
| Installer | Scenario | Issue |
- wiki project page: https://wiki.opnfv.org/display/SAM
- - wiki SampleVNF Farser release planing page: https://wiki.opnfv.org/display/SAM/F+Release+Plan+for+SampleVNF
+ - wiki SampleVNF Hunter release planing page: https://wiki.opnfv.org/display/SAM/H+-++Release+SampleVNF+planning
- SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
Code Review / samplevnf.git / blobdiff