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 | "Jan 17 2019" | 7.2.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.2.0 |
132 +--------------------------------------+--------------------------------------+
133 | **SampleVNF Docker image tag** | Gambia 7.2 |
135 +--------------------------------------+--------------------------------------+
136 | **Release designation** | Gambia 7.2 |
138 +--------------------------------------+--------------------------------------+
139 | **Release date** | "Dec 14 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 - Support for DPDK 18.05 and DPDK 18.08
203 - Add support for counting non dataplane related packets
204 - test improvements and fixes for image creation
205 - Local Documentation Builds
206 - Improve l3fwd performance
207 - Enable the local cache mac address
208 - Initial support for DPDK 18.05
209 - Adding centos.json to be used with packer to generate a VM with PROX
210 - Adding support for Ubuntu 17.10...
211 - Get multiple port stats simultaneously
212 - Increase default mbuf size and code simplification/cleanup
213 - update from src port in the pvt/pub handler
216 - Fix potential crash with latency accuracy
217 - TempFix: vCGNAPT/vACL ipv4 perf issue
218 - Temp Fix for vFW perf issue
219 - fix code standard in VNFs/DPPD-PROX/handle_esp.c
220 - Workaround DPDK net/virtio queue setup issue
221 - Fix potential crash when shuffling mbufs
226 - Huge page freeing needs to be handled properly while running the application else it might
227 cause system crash. Known issue from DPDK.
228 - UDP Replay is used to capture throughput for dynamic cgnapt
229 - Hardware Checksum offload is not supported for IPv6 traffic
230 - SampleVNF on sriov is tested till 4 threads
231 - Rest API is supported only for vACL, vFW, vCGNAPT
232 - Rest API uses port 80, make sure other webservices are stopped before using SampleVNF RestAPI.
239 +----------------------------+-------------------------------------------------------------------+
240 | **JIRA REFERENCE** | **DESCRIPTION** |
241 +----------------------------+-------------------------------------------------------------------+
242 | SAMPLEVNF-129 | Support for DPDK 18.05 and DPDK 18.08 |
243 +----------------------------+-------------------------------------------------------------------+
244 | SAMPLEVNF-130 | Add support for counting non dataplane related packets |
245 +----------------------------+-------------------------------------------------------------------+
246 | SAMPLEVNF-131 | test improvements and fixes for image creation |
247 +----------------------------+-------------------------------------------------------------------+
248 | SAMPLEVNF-132 | Local Documentation Builds |
249 +----------------------------+-------------------------------------------------------------------+
250 | SAMPLEVNF-133 | Improve l3fwd performance |
251 +----------------------------+-------------------------------------------------------------------+
252 | SAMPLEVNF-134 | Enable the local cache mac address |
253 +----------------------------+-------------------------------------------------------------------+
254 | SAMPLEVNF-135 | Initial support for DPDK 18.05 |
255 +----------------------------+-------------------------------------------------------------------+
256 | SAMPLEVNF-136 | Adding centos.json to be used with packer to generate a VM with PROX|
257 +----------------------------+-------------------------------------------------------------------+
258 | SAMPLEVNF-137 | Adding support for Ubuntu 17.20... |
259 +----------------------------+-------------------------------------------------------------------+
260 | SAMPLEVNF-138 | Get multiple port stats simultaneously |
261 +----------------------------+-------------------------------------------------------------------+
262 | SAMPLEVNF-139 | Increase default mbuf size and code simplification/cleanup |
263 +----------------------------+-------------------------------------------------------------------+
264 | SAMPLEVNF-140 | update from src port in the pvt/pub handler |
265 +----------------------------+-------------------------------------------------------------------+
272 +----------------------------+-------------------------------------------------------------------+
273 | **JIRA REFERENCE** | **DESCRIPTION** |
274 +----------------------------+-------------------------------------------------------------------+
275 | SAMPLEVNF-141 | Fix potential crash with latency accuracy |
276 +----------------------------+-------------------------------------------------------------------+
277 | SAMPLEVNF-142 | TempFix: vCGNAPT/vACL ipv4 perf issue |
278 +----------------------------+-------------------------------------------------------------------+
279 | SAMPLEVNF-143 | Temp Fix for vFW perf issue |
280 +----------------------------+-------------------------------------------------------------------+
281 | SAMPLEVNF-144 | fix code standard in VNFs/DPPD-PROX/handle_esp.c |
282 +----------------------------+-------------------------------------------------------------------+
283 | SAMPLEVNF-145 | Workaround DPDK net/virtio queue setup issue |
284 +----------------------------+-------------------------------------------------------------------+
285 | SAMPLEVNF-146 | Fix potential crash when shuffling mbufs |
286 +----------------------------+-------------------------------------------------------------------+
288 Gambia known restrictions/issues
289 ====================================
290 +-----------+-----------+----------------------------------------------+
291 | Installer | Scenario | Issue |
292 +===========+===========+==============================================+
294 +-----------+-----------+----------------------------------------------+
300 +----------------------------+------------------------------------------------+
301 | **JIRA REFERENCE** | **DESCRIPTION** |
303 +----------------------------+------------------------------------------------+
306 +----------------------------+------------------------------------------------+
312 - wiki project page: https://wiki.opnfv.org/display/SAM
314 - wiki SampleVNF Gambia release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
316 - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
318 - SampleVNF IRC chanel: #opnfv-samplevnf
319 | SAMPLEVNF- | PROX support for dpdk 18,05 |
320 +----------------------------+-------------------------------------------------------------------+
321 | SAMPLEVNF- | PROX support for dpdk 18,05 |
322 +----------------------------+-------------------------------------------------------------------+
329 +----------------------------+-------------------------------------------------------------------+
330 | **JIRA REFERENCE** | **DESCRIPTION** |
331 +----------------------------+-------------------------------------------------------------------+
332 | SAMPLEVNF- | Fix samplevnf perf issues |
333 +----------------------------+-------------------------------------------------------------------+
335 Gambia known restrictions/issues
336 ====================================
337 +-----------+-----------+----------------------------------------------+
338 | Installer | Scenario | Issue |
339 +===========+===========+==============================================+
341 +-----------+-----------+----------------------------------------------+
347 +----------------------------+------------------------------------------------+
348 | **JIRA REFERENCE** | **DESCRIPTION** |
350 +----------------------------+------------------------------------------------+
353 +----------------------------+------------------------------------------------+
359 - wiki project page: https://wiki.opnfv.org/display/SAM
361 - wiki SampleVNF Gambia release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
363 - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
365 - SampleVNF IRC chanel: #opnfv-samplevnf
372 +----------------------------+-------------------------------------------------------------------+
373 | **JIRA REFERENCE** | **DESCRIPTION** |
374 +----------------------------+-------------------------------------------------------------------+
375 | SAMPLEVNF- | Fix samplevnf perf issues |
376 +----------------------------+-------------------------------------------------------------------+
378 Gambia known restrictions/issues
379 ====================================
380 +-----------+-----------+----------------------------------------------+
381 | Installer | Scenario | Issue |
382 +===========+===========+==============================================+
384 +-----------+-----------+----------------------------------------------+
390 +----------------------------+------------------------------------------------+
391 | **JIRA REFERENCE** | **DESCRIPTION** |
393 +----------------------------+------------------------------------------------+
396 +----------------------------+------------------------------------------------+
402 - wiki project page: https://wiki.opnfv.org/display/SAM
404 - wiki SampleVNF Gambia release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
406 - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
408 - SampleVNF IRC chanel: #opnfv-samplevnf
415 +----------------------------+-------------------------------------------------------------------+
416 | **JIRA REFERENCE** | **DESCRIPTION** |
417 +----------------------------+-------------------------------------------------------------------+
418 | SAMPLEVNF- | Fix samplevnf perf issues |
419 +----------------------------+-------------------------------------------------------------------+
421 Gambia known restrictions/issues
422 ====================================
423 +-----------+-----------+----------------------------------------------+
424 | Installer | Scenario | Issue |
425 +===========+===========+==============================================+
427 +-----------+-----------+----------------------------------------------+
433 +----------------------------+------------------------------------------------+
434 | **JIRA REFERENCE** | **DESCRIPTION** |
436 +----------------------------+------------------------------------------------+
439 +----------------------------+------------------------------------------------+
445 - wiki project page: https://wiki.opnfv.org/display/SAM
447 - wiki SampleVNF Gambia release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
449 - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
451 - SampleVNF IRC chanel: #opnfv-samplevnf
458 +----------------------------+-------------------------------------------------------------------+
459 | **JIRA REFERENCE** | **DESCRIPTION** |
460 +----------------------------+-------------------------------------------------------------------+
461 | SAMPLEVNF- | Fix samplevnf perf issues |
462 +----------------------------+-------------------------------------------------------------------+
464 Gambia known restrictions/issues
465 ====================================
466 +-----------+-----------+----------------------------------------------+
467 | Installer | Scenario | Issue |
468 +===========+===========+==============================================+
470 +-----------+-----------+----------------------------------------------+
476 +----------------------------+------------------------------------------------+
477 | **JIRA REFERENCE** | **DESCRIPTION** |
479 +----------------------------+------------------------------------------------+
482 +----------------------------+------------------------------------------------+
488 - wiki project page: https://wiki.opnfv.org/display/SAM
490 - wiki SampleVNF Gambia release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
492 - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
494 - SampleVNF IRC chanel: #opnfv-samplevnf
501 +----------------------------+-------------------------------------------------------------------+
502 | **JIRA REFERENCE** | **DESCRIPTION** |
503 +----------------------------+-------------------------------------------------------------------+
504 | SAMPLEVNF- | Fix samplevnf perf issues |
505 +----------------------------+-------------------------------------------------------------------+
507 Gambia known restrictions/issues
508 ====================================
509 +-----------+-----------+----------------------------------------------+
510 | Installer | Scenario | Issue |
511 +===========+===========+==============================================+
513 +-----------+-----------+----------------------------------------------+
519 +----------------------------+------------------------------------------------+
520 | **JIRA REFERENCE** | **DESCRIPTION** |
522 +----------------------------+------------------------------------------------+
525 +----------------------------+------------------------------------------------+
531 - wiki project page: https://wiki.opnfv.org/display/SAM
533 - wiki SampleVNF Gambia release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
535 - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
537 - SampleVNF IRC chanel: #opnfv-samplevnf
544 +----------------------------+-------------------------------------------------------------------+
545 | **JIRA REFERENCE** | **DESCRIPTION** |
546 +----------------------------+-------------------------------------------------------------------+
547 | SAMPLEVNF- | Fix samplevnf perf issues |
548 +----------------------------+-------------------------------------------------------------------+
550 Gambia known restrictions/issues
551 ====================================
552 +-----------+-----------+----------------------------------------------+
553 | Installer | Scenario | Issue |
554 +===========+===========+==============================================+
556 +-----------+-----------+----------------------------------------------+
562 +----------------------------+------------------------------------------------+
563 | **JIRA REFERENCE** | **DESCRIPTION** |
565 +----------------------------+------------------------------------------------+
568 +----------------------------+------------------------------------------------+
574 - wiki project page: https://wiki.opnfv.org/display/SAM
576 - wiki SampleVNF Gambia release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
578 - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
580 - SampleVNF IRC chanel: #opnfv-samplevnf