diff options
Diffstat (limited to 'docs/release/release-notes/release-notes.rst')
| -rw-r--r-- | docs/release/release-notes/release-notes.rst | 221 |
1 files changed, 122 insertions, 99 deletions
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index e76e5098..f9daae50 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -3,63 +3,20 @@ .. 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/>. -: +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 -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 -========================================== +OPNFV Hunter Release +==================== -.. toctree:: - :maxdepth: 2 - -.. _SampleVNF: https://wiki.opnfv.org/SAM - -.. _Yardstick: https://wiki.opnfv.org/yardstick - -.. _NFV-TST001: http://www.etsi.org/deliver/etsi_gs/NFV-TST/001_099/001/01.01.01_60/gs_NFV-TST001v010101p.pdf - - -Abstract -======== - -This document describes the release note of SampleVNF project. - - -Version History -=============== - -+----------------+--------------------+---------------------------------+ -| *Date* | *Version* | *Comment* | -| | | | -+----------------+--------------------+---------------------------------+ -| "Oct 20 2017" | 6.0 | SampleVNF for Farser release | -| | | | -+----------------+--------------------+---------------------------------+ - - -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_. - - -OPNFV Farser 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: @@ -73,19 +30,19 @@ OPNFV platform, including: * Results -* Automated SampleVNF test suit in OPNFV Yardstick_ Project +* Automated SampleVNF test suit in OPNFV Yardstick Project * SampleVNF source code -For Farser release, the *SampleVNF* supported: +For Hunter 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 | -| | acts as traffic generator, L3FWD, L2FWD, BNG etc | | +| *Prox* | Packet pROcessing eXecution engine | v0.40.0 | +| | acts as traffic generator, L3FWD, L2FWD, BNG etc | | +----------------+---------------------------------------------------------+-------------------+ | *vACL* | Access Control List | v0.1.0 | +----------------+---------------------------------------------------------+-------------------+ @@ -97,7 +54,7 @@ For Farser release, the *SampleVNF* supported: .. 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: @@ -108,55 +65,64 @@ testing: * VNF Characterization: - * Network - rfc2544, rfc36.0, latency, http_test etc + * Network - rfc2544, rfc3511, latency, http_test etc -The *SampleVNF* is developed in the OPNFV community, by the SampleVNF_ team. +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 + test cases is based on the document `ETSI GS NFV-TST 001`_; the results report template used for the SampleVNF test results is based on the IEEE Std 829-2008. +.. _ETSI GS NFV-TST 001: https://portal.etsi.org/webapp/workprogram/Report_WorkItem.asp?WKI_ID=46009 + Release Data -============ +------------ +--------------------------------------+--------------------------------------+ | **Project** | SampleVNF | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | samplevnf/Farser.6.0 | +| **Repo/tag** | opnfv-8.0 | | | | +--------------------------------------+--------------------------------------+ -| **SampleVNF Docker image tag** | Farser.6.0 | +| **SampleVNF Docker image tag** | Hunter 8.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Farser | +| **Release designation** | Hunter 8.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | "October 20 2017" | +| **Release date** | "May 10 2019" | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | OPNFV Farser release 6.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 | | | | +--------------------------------------+--------------------------------------+ Deliverables -============ +------------ 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 ---------------------- +^^^^^^^^^^^^^^^^^^^^^ - The SampleVNF Docker image: To be added @@ -178,7 +144,7 @@ Software Deliverables +---------------------+-------------------------------------------------------+ Document Version Changes ------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^ This is the first version of the SampleVNF in OPNFV. It includes the following documentation updates: @@ -191,15 +157,32 @@ It includes the following documentation updates: 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 -------------------- +^^^^^^^^^^^^^^^^^^^ - 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 @@ -209,21 +192,61 @@ Known Issues/Faults - Rest API uses port 80, make sure other webservices are stopped before using SampleVNF RestAPI. Corrected Faults ----------------- - -Farser.6.0: - -+----------------------------+------------------------------------------------+ -| **JIRA REFERENCE** | **DESCRIPTION** | -| | | -+----------------------------+------------------------------------------------+ -| | | -| | | -+----------------------------+------------------------------------------------+ - - -Farser known restrictions/issues -==================================== +^^^^^^^^^^^^^^^^ + +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 | +===========+===========+==============================================+ @@ -232,7 +255,7 @@ Farser known restrictions/issues Open JIRA tickets -================= +----------------- +----------------------------+------------------------------------------------+ | **JIRA REFERENCE** | **DESCRIPTION** | @@ -244,12 +267,12 @@ Open JIRA tickets Useful links -============ +------------ - - wiki project page: https://wiki.opnfv.org/display/SAM + - wiki project page: https://wiki-old.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/G+-+Release+SampleVNF+planning - - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf + - SampleVNF repo: https://git.opnfv.org/samplevnf/ - SampleVNF IRC chanel: #opnfv-samplevnf |