1 .. This work is licensed under a Creative Commons Attribution 4.0 International
3 .. http://creativecommons.org/licenses/by/4.0
4 .. (c) OPNFV, Intel Corporation and others.
10 OPNFV release note for SampleVNF Docs
11 are licensed under a Creative Commons Attribution 4.0 International License.
12 You should have received a copy of the license along with this.
13 If not, see <http://creativecommons.org/licenses/by/4.0/>.
16 The *SampleVNFs*, the *SampleVNF test cases* are opensource software,
17 licensed under the terms of the Apache License, Version 2.0.
19 ==========================================
20 OPNFV Gambia Release Note for SampleVNF
21 ==========================================
26 .. _SampleVNF: https://wiki.opnfv.org/SAM
28 .. _Yardstick: https://wiki.opnfv.org/yardstick
30 .. _NFV-TST001: http://www.etsi.org/deliver/etsi_gs/NFV-TST/001_099/001/01.01.01_60/gs_NFV-TST001v010101p.pdf
36 This document describes the release note of SampleVNF project.
42 +----------------+--------------------+---------------------------------+
43 | *Date* | *Version* | *Comment* |
45 +----------------+--------------------+---------------------------------+
46 | "May 25 2018" | 7.0.0 | SampleVNF for Gambia release |
48 +----------------+--------------------+---------------------------------+
54 The software delivered in the OPNFV SampleVNF_ Project, comprising the
55 *SampleVNF VNFs* and performance test case are part of OPNFV Yardstick_
56 Project is a realization of the methodology in ETSI-ISG NFV-TST001_.
60 ======================
62 This Gambia release provides *SampleVNF* as a approx VNF repository for
63 VNF/NFVI testing, characterization and OPNFV feature testing, automated on
64 OPNFV platform, including:
66 * Documentation generated with Sphinx
72 * Release notes (this document)
76 * Automated SampleVNF test suit in OPNFV Yardstick_ Project
78 * SampleVNF source code
80 For Gambia release, the *SampleVNF* supported:
82 +----------------+---------------------------------------------------------+-------------------+
83 | *VNF* | *Name* | *version* |
84 +----------------+---------------------------------------------------------+-------------------+
85 | *CGNAPT* | Carrier Grade Network Address and port Translation .5.0 | v0.1.0 |
86 +----------------+---------------------------------------------------------+-------------------+
87 | *Prox* | Packet pROcessing eXecution engine | v0.40.0 |
88 | | acts as traffic generator, L3FWD, L2FWD, BNG etc | |
89 +----------------+---------------------------------------------------------+-------------------+
90 | *vACL* | Access Control List | v0.1.0 |
91 +----------------+---------------------------------------------------------+-------------------+
92 | *vFW* | Firewall | v0.1.0 |
93 +----------------+---------------------------------------------------------+-------------------+
94 | *UDP_replay* | UDP_Replay | v0.1.0 |
95 +----------------+---------------------------------------------------------+-------------------+
97 .. note:: Highlevel Desgin and features supported by each of the VNFs is described in Developer
100 For Gambia release, the *SampleVNF* is used for the following
103 * OPNFV platform testing - generic test cases to measure the categories:
105 * NFVI Characterization:
109 * VNF Characterization:
111 * Network - rfc2544, rfc3511, latency, http_test etc
114 The *SampleVNF* is developed in the OPNFV community, by the SampleVNF_ team.
115 The *Network Service Benchmarking* SampleVNF Characterization Testing tool is a part of the
118 .. note:: The test case description template used for the SampleVNF in yardstick
119 test cases is based on the document ETSI-ISG NFV-TST001_; the results report template
120 used for the SampleVNF test results is based on the IEEE Std 829-2008.
126 +--------------------------------------+--------------------------------------+
127 | **Project** | SampleVNF |
129 +--------------------------------------+--------------------------------------+
130 | **Repo/tag** | opnfv-7.0.0 |
132 +--------------------------------------+--------------------------------------+
133 | **SampleVNF Docker image tag** | Gambia 7.0 |
135 +--------------------------------------+--------------------------------------+
136 | **Release designation** | Gambia 7.0 |
138 +--------------------------------------+--------------------------------------+
139 | **Release date** | "Nov 02 2018" |
141 +--------------------------------------+--------------------------------------+
142 | **Purpose of the delivery** | Gambia alignment to Released |
143 | | bug-fixes for the following: |
145 | | - minimum latency |
146 | | - Increase default mbuf size and |
147 | | code simplification/cleanup |
148 | | - Crash in rx/tx distribution |
150 +--------------------------------------+--------------------------------------+
159 - User Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_user_userguide/index.html
161 - Developer Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_developer/index.html
164 Software Deliverables
165 ---------------------
167 - The SampleVNF Docker image: To be added
170 **SampleVNF tested on Contexts**
172 +---------------------+-------------------------------------------------------+
173 | **Context** | **Description** |
175 +---------------------+-------------------------------------------------------+
176 | *Heat* | Models orchestration using OpenStack Heat |
178 +---------------------+-------------------------------------------------------+
179 | *Node* | Models Baremetal, Controller, Compute |
181 +---------------------+-------------------------------------------------------+
182 | *Standalone* | Models VM running on Non-Managed NFVi |
184 +---------------------+-------------------------------------------------------+
186 Document Version Changes
187 ------------------------
189 This is the first version of the SampleVNF in OPNFV.
190 It includes the following documentation updates:
192 - SampleVNF User Guide:
194 - SampleVNF Developer Guide
196 - SampleVNF Release Notes for SampleVNF: this document
202 - SampleVNF RESTful API support
203 - Security gateway testing
204 - Support reading inline jumbo frame and dump them
205 - Add support for generation of jumbo frames
206 - Support for dpdk-stable-17.11.1 crypto
207 - Add support for multiple variables in core definition
208 - Support async operation in handle_esp
209 - Add support for reception of jumbo frames
210 - Support additional MAC format in config file
211 - Add support for multiple GEN tasks running on the same core
212 - Add support for crypto on multiple cores
213 - Zero packet loss testing has been added.
214 - Integrate irq mode into PROX (support display and command line)
215 - Support async operation in handle_esp
216 - Add config option to use port mac as src mac in l2fwd and swap
217 - Add support for DPDK 17.11
218 - Add support for multiple tasks generating to same ip in l3 mode.
219 - Add l3 support for tasks without physical tx ports
222 - link speed when link is down at startup.
224 - potential crash if link speed is null
225 - the calculation of dropped packets and other changes
226 - latency accuracy and dumping latencies to file
227 - issues with the pkt_size command
228 - potential crash in rx and tx distribution
229 - extrapolation used in latency measurements
230 - dumping receive packets
231 - using signature in latency measurements
232 - stacking of rx receive functions
233 - potential crash when issuing "tx distr stop" command.
234 - extrapolation used in latency measurements
235 - memory leak introduced by 4a65cd84
240 - Huge page freeing needs to be handled properly while running the application else it might
241 cause system crash. Known issue from DPDK.
242 - UDP Replay is used to capture throughput for dynamic cgnapt
243 - Hardware Checksum offload is not supported for IPv6 traffic
244 - SampleVNF on sriov is tested till 4 threads
245 - Rest API is supported only for vACL, vFW, vCGNAPT
246 - Rest API uses port 80, make sure other webservices are stopped before using SampleVNF RestAPI.
253 +----------------------------+-------------------------------------------------------------------+
254 | **JIRA REFERENCE** | **DESCRIPTION** |
255 +----------------------------+-------------------------------------------------------------------+
256 | SAMPLEVNF- | PROX support for dpdk 18,05 |
257 +----------------------------+-------------------------------------------------------------------+
264 +----------------------------+-------------------------------------------------------------------+
265 | **JIRA REFERENCE** | **DESCRIPTION** |
266 +----------------------------+-------------------------------------------------------------------+
267 | SAMPLEVNF- | Fix samplevnf perf issues |
268 +----------------------------+-------------------------------------------------------------------+
270 Gambia known restrictions/issues
271 ====================================
272 +-----------+-----------+----------------------------------------------+
273 | Installer | Scenario | Issue |
274 +===========+===========+==============================================+
276 +-----------+-----------+----------------------------------------------+
282 +----------------------------+------------------------------------------------+
283 | **JIRA REFERENCE** | **DESCRIPTION** |
285 +----------------------------+------------------------------------------------+
288 +----------------------------+------------------------------------------------+
294 - wiki project page: https://wiki.opnfv.org/display/SAM
296 - wiki SampleVNF Gambia release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
298 - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
300 - SampleVNF IRC chanel: #opnfv-samplevnf