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
|
.. 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 Farser 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* |
| | | |
+----------------+--------------------+---------------------------------+
| "May 25 2018" | 6.2.0 | SampleVNF for Farser 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 Farser Release
======================
This Farser 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 Farser 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 Farser 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-6.2.0 |
| | |
+--------------------------------------+--------------------------------------+
| **SampleVNF Docker image tag** | Farser 6.2 |
| | |
+--------------------------------------+--------------------------------------+
| **Release designation** | Farser 6.2 |
| | |
+--------------------------------------+--------------------------------------+
| **Release date** | "May 25 2018" |
| | |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery** | Fraser 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
-----------------
- SampleVNF RESTful API support
- Security gateway testing
- Support reading inline jumbo frame and dump them
- Add support for generation of jumbo frames
- Support for dpdk-stable-17.11.1 crypto
- Add support for multiple variables in core definition
- Support async operation in handle_esp
- Add support for reception of jumbo frames
- Support additional MAC format in config file
- Add support for multiple GEN tasks running on the same core
- Add support for crypto on multiple cores
- Zero packet loss testing has been added.
- Integrate irq mode into PROX (support display and command line)
- Support async operation in handle_esp
- Add config option to use port mac as src mac in l2fwd and swap
- Add support for DPDK 17.11
- Add support for multiple tasks generating to same ip in l3 mode.
- Add l3 support for tasks without physical tx ports
Bug fixes:
- link speed when link is down at startup.
- minimum latency
- potential crash if link speed is null
- the calculation of dropped packets and other changes
- latency accuracy and dumping latencies to file
- issues with the pkt_size command
- potential crash in rx and tx distribution
- extrapolation used in latency measurements
- dumping receive packets
- using signature in latency measurements
- stacking of rx receive functions
- potential crash when issuing "tx distr stop" command.
- extrapolation used in latency measurements
- memory leak introduced by 4a65cd84
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
----------------
Farser 6.2:
+----------------------------+-------------------------------------------------------------------+
| **JIRA REFERENCE** | **DESCRIPTION** |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-98 | SampleVNF RESTful API support |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-99 | Security gateway testing |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-100 | Add support for generation of jumbo frames |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-101 | Support for dpdk-stable-17.11.1 crypto |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-102 | Support async operation in handle_espo |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-103 | Add support for reception of jumbo frames |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-104 | Support additional MAC format in config file |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-105 | support for multiple GEN tasks running on the same core |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-106 | Add support for crypto on multiple cores |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-107 | Zero packet loss testing |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-108 | Integrate irq mode into PROX (support display and command line) |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-109 | Add config option to use port mac as src mac in l2fwd and swap |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-110 | Add support for DPDK 17.11 |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-111 | Add support for multiple tasks generating to same ip in l3 mode |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-112 | Add l3 support for tasks without physical tx ports |
+----------------------------+-------------------------------------------------------------------+
Bug Fix Jira:
+----------------------------+-------------------------------------------------------------------+
| **JIRA REFERENCE** | **DESCRIPTION** |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-113 | link speed when link is down at startup. |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-114 | minimum latency |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-115 | potential crash if link speed is null |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-116 | the calculation of dropped packets and other changes |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-117 | latency accuracy and dumping latencies to file |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-118 | issues with the pkt_size command |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-119 | extrapolation used in latency measurements |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-120 | dumping receive packets |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-121 | using signature in latency measurements |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-122 | stacking of rx receive functions |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-123 | potential crash when issuing "tx distr stop" command. |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-124 | extrapolation used in latency measurements |
+----------------------------+-------------------------------------------------------------------+
| SAMPLEVNF-125 | memory leak introduced by 4a65cd84 |
+----------------------------+-------------------------------------------------------------------+
Farser 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 Farser release planing page: https://wiki.opnfv.org/display/SAM/F+Release+Plan+for+SampleVNF
- SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
- SampleVNF IRC chanel: #opnfv-samplevnf
|
