licensed under the terms of the Apache License, Version 2.0.
==========================================
-OPNFV Euphrates Release Note for SampleVNF
+OPNFV Gambia Release Note for SampleVNF
==========================================
.. toctree::
| *Date* | *Version* | *Comment* |
| | | |
+----------------+--------------------+---------------------------------+
-| "Oct 20 2017" | 5.0 | SampleVNF for Euphrates release |
+| "Jan 17 2019" | 7.2.0 | SampleVNF for Gambia release |
| | | |
+----------------+--------------------+---------------------------------+
Project is a realization of the methodology in ETSI-ISG NFV-TST001_.
-OPNFV Euphrates Release
+OPNFV Gambia Release
======================
-This Euphrates release provides *SampleVNF* as a approx VNF repository for
+This Gambia 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 Euphrates release, the *SampleVNF* supported:
+For Gambia release, the *SampleVNF* supported:
+----------------+---------------------------------------------------------+-------------------+
| *VNF* | *Name* | *version* |
+----------------+---------------------------------------------------------+-------------------+
| *CGNAPT* | Carrier Grade Network Address and port Translation .5.0 | v0.1.0 |
+----------------+---------------------------------------------------------+-------------------+
-| *Prox* | Packet pROcessing eXecution engine | v0.39.0 |
+| *Prox* | Packet pROcessing eXecution engine | v0.40.0 |
| | acts as traffic generator, L3FWD, L2FWD, BNG etc | |
+----------------+---------------------------------------------------------+-------------------+
| *vACL* | Access Control List | v0.1.0 |
.. note:: Highlevel Desgin and features supported by each of the VNFs is described in Developer
and user guide.
-For Euphrates release, the *SampleVNF* is used for the following
+For Gambia release, the *SampleVNF* is used for the following
testing:
* OPNFV platform testing - generic test cases to measure the categories:
| **Project** | SampleVNF |
| | |
+--------------------------------------+--------------------------------------+
-| **Repo/tag** | samplevnf/Euphrates.5.0 |
+| **Repo/tag** | opnfv-7.2.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **SampleVNF Docker image tag** | Euphrates.5.0 |
+| **SampleVNF Docker image tag** | Gambia 7.2 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release designation** | Euphrates |
+| **Release designation** | Gambia 7.2 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | "October 20 2017" |
+| **Release date** | "Dec 14 2018" |
| | |
+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | OPNFV Euphrates release 5.0 |
+| **Purpose of the delivery** | Gambia 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 |
| | |
+--------------------------------------+--------------------------------------+
Documents
---------
- - User Guide: http://artifacts.opnfv.org/samplevnf/euphrates/5.0.0/docs/testing_user_userguide/index.html
+ - User Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_user_userguide/index.html
- - Developer Guide: http://artifacts.opnfv.org/samplevnf/euphrates/5.0.0/docs/testing_developer/index.html
+ - Developer Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_developer/index.html
Software Deliverables
Feature additions
-----------------
-- SampleVNF RESTful API support
-
-- Introduce Network service benchmarking
+- 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
Corrected Faults
----------------
-Euphrates.5.0:
+Gambia 7.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 |
++----------------------------+-------------------------------------------------------------------+
+
+Gambia known restrictions/issues
+====================================
++-----------+-----------+----------------------------------------------+
+| Installer | Scenario | Issue |
++===========+===========+==============================================+
+| | | |
++-----------+-----------+----------------------------------------------+
+
+
+Open JIRA tickets
+=================
+----------------------------+------------------------------------------------+
| **JIRA REFERENCE** | **DESCRIPTION** |
+----------------------------+------------------------------------------------+
-Euphrates known restrictions/issues
+Useful links
+============
+
+ - wiki project page: https://wiki.opnfv.org/display/SAM
+
+ - wiki SampleVNF Gambia 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- | Fix samplevnf perf issues |
++----------------------------+-------------------------------------------------------------------+
+
+Gambia 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 Gambia 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 |
++----------------------------+-------------------------------------------------------------------+
+
+Gambia 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 Gambia 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 |
++----------------------------+-------------------------------------------------------------------+
+
+Gambia 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 Gambia 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 |
++----------------------------+-------------------------------------------------------------------+
+
+Gambia 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 Gambia 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 |
++----------------------------+-------------------------------------------------------------------+
+
+Gambia 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 Gambia 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 |
++----------------------------+-------------------------------------------------------------------+
+
+Gambia known restrictions/issues
====================================
+-----------+-----------+----------------------------------------------+
| Installer | Scenario | Issue |
- wiki project page: https://wiki.opnfv.org/display/SAM
- - wiki SampleVNF Euphrates release planing page: https://wiki.opnfv.org/display/SAM/SampleVNF+Euphrates+Release+Planning
+ - wiki SampleVNF Gambia release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
- SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
Code Review / samplevnf.git / blobdiff