X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Frelease%2Frelease-notes%2Frelease-notes.rst;h=80f63e3261311ff4b8fd2f4196d9721c5bcb6b0a;hb=refs%2Fchanges%2F11%2F71611%2F1;hp=74e74f12de2c272fd18a9ca8f55b75823384928c;hpb=a9f8ae63f7b3b5cdc566bdaaf4521658779a86f7;p=samplevnf.git diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index 74e74f12..80f63e32 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 . -: +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 Gambia Release Note for SampleVNF -========================================== - -.. 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* | -| | | | -+----------------+--------------------+---------------------------------+ -| "Nov 01 2018" | 7.1.0 | SampleVNF for Gambia 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 Gambia Release +OPNFV Hunter Release ====================== -This Gambia 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: @@ -77,7 +34,7 @@ OPNFV platform, including: * SampleVNF source code -For Gambia release, the *SampleVNF* supported: +For Hunter release, the *SampleVNF* supported: +----------------+---------------------------------------------------------+-------------------+ | *VNF* | *Name* | *version* | @@ -97,7 +54,7 @@ For Gambia release, the *SampleVNF* supported: .. note:: Highlevel Desgin and features supported by each of the VNFs is described in Developer and user guide. -For Gambia 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: @@ -121,25 +78,25 @@ Yardstick Project. Release Data -============ +------------ +--------------------------------------+--------------------------------------+ | **Project** | SampleVNF | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | opnfv-7.1.0 | +| **Repo/tag** | opnfv-8.0 | | | | +--------------------------------------+--------------------------------------+ -| **SampleVNF Docker image tag** | Gambia 7.1 | +| **SampleVNF Docker image tag** | Hunter 8.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Gambia 7.1 | +| **Release designation** | Hunter 8.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | "Dec 14 2018" | +| **Release date** | "May 10 2019" | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Gambia alignment to Released | +| **Purpose of the delivery** | Hunter alignment to Released | | | bug-fixes for the following: | | | - Memory leak | | | - minimum latency | @@ -151,10 +108,10 @@ Release Data Deliverables -============ +------------ Documents ---------- +^^^^^^^^^ - User Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_user_userguide/index.html @@ -162,7 +119,7 @@ Documents Software Deliverables ---------------------- +^^^^^^^^^^^^^^^^^^^^^ - The SampleVNF Docker image: To be added @@ -184,7 +141,7 @@ Software Deliverables +---------------------+-------------------------------------------------------+ Document Version Changes ------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^ This is the first version of the SampleVNF in OPNFV. It includes the following documentation updates: @@ -197,7 +154,7 @@ It includes the following documentation updates: Feature additions ------------------ +^^^^^^^^^^^^^^^^^ - Support for DPDK 18.05 and DPDK 18.08 - Add support for counting non dataplane related packets @@ -222,7 +179,7 @@ Bug fixes: 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 @@ -232,37 +189,37 @@ Known Issues/Faults - Rest API uses port 80, make sure other webservices are stopped before using SampleVNF RestAPI. Corrected Faults ----------------- - -Gambia 7.1: - -+----------------------------+-------------------------------------------------------------------+ -| **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 | -+----------------------------+-------------------------------------------------------------------+ +^^^^^^^^^^^^^^^^ + +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.10... | -+----------------------------+-------------------------------------------------------------------+ -| 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 | -+----------------------------+-------------------------------------------------------------------+ ++----------------------------+----------------------------------------------------------------------+ +| 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 | ++----------------------------+----------------------------------------------------------------------+ @@ -285,141 +242,8 @@ Bug Fix Jira: | SAMPLEVNF-146 | Fix potential crash when shuffling mbufs | +----------------------------+-------------------------------------------------------------------+ -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 -| 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 -==================================== +Hunter known restrictions/issues +-------------------------------- +-----------+-----------+----------------------------------------------+ | Installer | Scenario | Issue | +===========+===========+==============================================+ @@ -428,136 +252,7 @@ Gambia known restrictions/issues 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** | @@ -569,11 +264,11 @@ Open JIRA tickets 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 + - wiki SampleVNF Hunter release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf