X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Frelease%2Frelease-notes%2Frelease-notes.rst;h=6ff1679d9c8c7460b905ed68a680eab4246ba662;hb=9033cadea78ca28c726323cb8334c7206fe51c22;hp=cc7459451cae1d35ccec1f17acdd374224991b37;hpb=272dd80f707564a7b810f46aef31b81994a0e1b4;p=samplevnf.git diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index cc745945..6ff1679d 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -1,234 +1,580 @@ -.. 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. +======= +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 . +: + +The *SampleVNFs*, the *SampleVNF test cases* are opensource software, +licensed under the terms of the Apache License, Version 2.0. + +========================================== +OPNFV Hunter 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 -This document provides the release notes for OPNFV Euphrates of SampleVNF project. -.. contents:: - :depth: 3 - :local: +Abstract +======== +This document describes the release note of SampleVNF project. -Version history ---------------- -+--------------------+--------------------+--------------------+--------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| 2017-07-17 | 0.1.0 | Deepak S | First draft | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | | | | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | | | | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ +Version History +=============== + ++----------------+--------------------+---------------------------------+ +| *Date* | *Version* | *Comment* | +| | | | ++----------------+--------------------+---------------------------------+ +| "May 10 2019" | 8.0 | SampleVNF for Hunter release | +| | | | ++----------------+--------------------+---------------------------------+ + -Important notes +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_. -: -**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 +OPNFV Hunter Release +====================== +This Hunter release provides *SampleVNF* as a approx VNF repository for +VNF/NFVI testing, characterization and OPNFV feature testing, automated on +OPNFV platform, including: -Summary -======= +* Documentation generated with Sphinx + + * User Guide + + * Developer Guide + + * Release notes (this document) + + * Results + +* Automated SampleVNF test suit in OPNFV Yardstick_ Project - +* SampleVNF source code -: +For Hunter release, the *SampleVNF* supported: -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...... ++----------------+---------------------------------------------------------+-------------------+ +| *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 | ++----------------+---------------------------------------------------------+-------------------+ + +.. 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: + +* OPNFV platform testing - generic test cases to measure the categories: + + * NFVI Characterization: + + * Network + + * VNF Characterization: + + * Network - rfc2544, rfc3511, latency, http_test etc + + +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 + used for the SampleVNF test results is based on the IEEE Std 829-2008. Release Data ============ - - -: +--------------------------------------+--------------------------------------+ -| **Project** | E.g. Arno/genesis/fuel@opnfv | +| **Project** | SampleVNF | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/tag** | opnfv-8.0 | | | | +--------------------------------------+--------------------------------------+ -| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... | +| **SampleVNF Docker image tag** | Hunter 8.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | E.g. Arno RC2 | +| **Release designation** | Hunter 8.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | E.g. 2015-04-16 | +| **Release date** | "May 10 2019" | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | E.g. OPNFV Internal quality assurance| +| **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 | | | | +--------------------------------------+--------------------------------------+ -Version change -^^^^^^^^^^^^^^^^ -Module version changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - +Deliverables +============ -: +Documents +--------- -- Fuel have changed from 5.1 to 6.0.1 + - User Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_user_userguide/index.html -- OpenDaylight has changed from Helium-SR1 to Helium-SR2 + - Developer Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_developer/index.html -Document version changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -: +Software Deliverables +--------------------- -- The Fuel@OPNFV installation guide version has changed from version 0.1 to to 0.2 + - The SampleVNF Docker image: To be added -Reason for version -^^^^^^^^^^^^^^^^^^^^ -Feature additions -~~~~~~~~~~~~~~~~~~~~~~~ - -: +**SampleVNF tested on Contexts** -**JIRA BACK-LOG:** ++---------------------+-------------------------------------------------------+ +| **Context** | **Description** | +| | | ++---------------------+-------------------------------------------------------+ +| *Heat* | Models orchestration using OpenStack Heat | +| | | ++---------------------+-------------------------------------------------------+ +| *Node* | Models Baremetal, Controller, Compute | +| | | ++---------------------+-------------------------------------------------------+ +| *Standalone* | Models VM running on Non-Managed NFVi | +| | | ++---------------------+-------------------------------------------------------+ -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| BGS-123 | ADD OpenDaylight ml2 integration | -| | | -+--------------------------------------+--------------------------------------+ -| BGS-456 | Add auto-deployment of Fuel@OPNFV | -| | | -+--------------------------------------+--------------------------------------+ +Document Version Changes +------------------------ -Bug corrections -~~~~~~~~~~~~~~~~~~~~~ +This is the first version of the SampleVNF in OPNFV. +It includes the following documentation updates: -**JIRA TICKETS:** +- SampleVNF User Guide: -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| BGS-888 | Fuel doesn't deploy | -| | | -+--------------------------------------+--------------------------------------+ -| BGS-999 | Floating IP doesn't work | -| | | -+--------------------------------------+--------------------------------------+ +- SampleVNF Developer Guide -Deliverables +- SampleVNF Release Notes for SampleVNF: this document + + +Feature additions +----------------- + +- 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 ---------------- -Software deliverables -^^^^^^^^^^^^^^^^^^^^^^^ +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 -Documentation deliverables -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + - 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 | ++----------------------------+-------------------------------------------------------------------+ -: -Known Limitations, Issues and Workarounds -========================================= -System Limitations -^^^^^^^^^^^^^^^^^^^^ - +Bug Fix Jira: -: ++----------------------------+-------------------------------------------------------------------+ +| **JIRA REFERENCE** | **DESCRIPTION** | ++----------------------------+-------------------------------------------------------------------+ +| SAMPLEVNF- | Fix samplevnf perf issues | ++----------------------------+-------------------------------------------------------------------+ -**Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades +Hunter known restrictions/issues +==================================== ++-----------+-----------+----------------------------------------------+ +| Installer | Scenario | Issue | ++===========+===========+==============================================+ +| | | | ++-----------+-----------+----------------------------------------------+ -**Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade -**Storage:** Ceph is the only supported storage configuration. +Open JIRA tickets +================= -**Max number of networks:** 3800 (Needs special switch config.) ++----------------------------+------------------------------------------------+ +| **JIRA REFERENCE** | **DESCRIPTION** | +| | | ++----------------------------+------------------------------------------------+ +| | | +| | | ++----------------------------+------------------------------------------------+ -**L3Agent:** L3 agent and floating IPs is not supported. -Known issues -^^^^^^^^^^^^^^^ - +Useful links +============ -: + - wiki project page: https://wiki.opnfv.org/display/SAM -**JIRA TICKETS:** + - wiki SampleVNF Hunter release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning -+--------------------------------------+--------------------------------------+ -| **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" | -| | | -+--------------------------------------+--------------------------------------+ + - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf -Workarounds -^^^^^^^^^^^^^^^^^ + - SampleVNF IRC chanel: #opnfv-samplevnf - -: -- 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 -=========== - +Bug Fix Jira: -: ++----------------------------+-------------------------------------------------------------------+ +| **JIRA REFERENCE** | **DESCRIPTION** | ++----------------------------+-------------------------------------------------------------------+ +| SAMPLEVNF- | Fix samplevnf perf issues | ++----------------------------+-------------------------------------------------------------------+ -Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results: +Hunter known restrictions/issues +==================================== ++-----------+-----------+----------------------------------------------+ +| Installer | Scenario | Issue | ++===========+===========+==============================================+ +| | | | ++-----------+-----------+----------------------------------------------+ -+--------------------------------------+--------------------------------------+ -| **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 -========== - +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: + ++----------------------------+-------------------------------------------------------------------+ +| **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: + ++----------------------------+-------------------------------------------------------------------+ +| **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: + ++----------------------------+-------------------------------------------------------------------+ +| **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/H+-++Release+SampleVNF+planning -For more information on the OPNFV Danube release, please see: + - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf -http://opnfv.org/danube + - SampleVNF IRC chanel: #opnfv-samplevnf