1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
|
.. 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 <http://creativecommons.org/licenses/by/4.0/>.
:
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
======================
This Gambia release provides *SampleVNF* as a approx VNF repository for
VNF/NFVI testing, characterization and OPNFV feature testing, automated on
OPNFV platform, including:
* 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 Gambia 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.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 Gambia 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** | SampleVNF |
| | |
+--------------------------------------+--------------------------------------+
| **Repo/tag** | opnfv-7.1.0 |
| | |
+--------------------------------------+--------------------------------------+
| **SampleVNF Docker image tag** | Gambia 7.1 |
| | |
+--------------------------------------+--------------------------------------+
| **Release designation** | Gambia 7.1 |
| | |
+--------------------------------------+--------------------------------------+
| **Release date** | "Dec 14 2018" |
| | |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery** | Gambia 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/docs/testing_user_userguide/index.html
- Developer Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_developer/index.html
Software Deliverables
---------------------
- The SampleVNF Docker image: To be added
**SampleVNF tested on Contexts**
+---------------------+-------------------------------------------------------+
| **Context** | **Description** |
| | |
+---------------------+-------------------------------------------------------+
| *Heat* | Models orchestration using OpenStack Heat |
| | |
+---------------------+-------------------------------------------------------+
| *Node* | Models Baremetal, Controller, Compute |
| | |
+---------------------+-------------------------------------------------------+
| *Standalone* | Models VM running on Non-Managed NFVi |
| | |
+---------------------+-------------------------------------------------------+
Document Version Changes
------------------------
This is the first version of the SampleVNF in OPNFV.
It includes the following documentation updates:
- SampleVNF User Guide:
- SampleVNF Developer Guide
- 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
----------------
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 |
+----------------------------+-------------------------------------------------------------------+
| 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 |
+----------------------------+-------------------------------------------------------------------+
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 |
+----------------------------+-------------------------------------------------------------------+
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
====================================
+-----------+-----------+----------------------------------------------+
| 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** |
| | |
+----------------------------+------------------------------------------------+
| | |
| | |
+----------------------------+------------------------------------------------+
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
|
