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 Farser 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 | "April 27 2018"| 6.0.0 | SampleVNF for Farser 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 Farser 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 Farser 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 Farser 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** | samplevnf/Farser.6.0.0 |
132 +--------------------------------------+--------------------------------------+
133 | **SampleVNF Docker image tag** | Farser.6.0.0 |
135 +--------------------------------------+--------------------------------------+
136 | **Release designation** | Farser |
138 +--------------------------------------+--------------------------------------+
139 | **Release date** | "April" 27 2018" |
141 +--------------------------------------+--------------------------------------+
142 | **Purpose of the delivery** | OPNFV Farser release 6.0.0 |
144 +--------------------------------------+--------------------------------------+
153 - User Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_user_userguide/index.html
155 - Developer Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_developer/index.html
158 Software Deliverables
159 ---------------------
161 - The SampleVNF Docker image: To be added
164 **SampleVNF tested on Contexts**
166 +---------------------+-------------------------------------------------------+
167 | **Context** | **Description** |
169 +---------------------+-------------------------------------------------------+
170 | *Heat* | Models orchestration using OpenStack Heat |
172 +---------------------+-------------------------------------------------------+
173 | *Node* | Models Baremetal, Controller, Compute |
175 +---------------------+-------------------------------------------------------+
176 | *Standalone* | Models VM running on Non-Managed NFVi |
178 +---------------------+-------------------------------------------------------+
180 Document Version Changes
181 ------------------------
183 This is the first version of the SampleVNF in OPNFV.
184 It includes the following documentation updates:
186 - SampleVNF User Guide:
188 - SampleVNF Developer Guide
190 - SampleVNF Release Notes for SampleVNF: this document
196 - SampleVNF RESTful API support
197 - Security gateway testing
198 - Support reading inline jumbo frame and dump them
199 - Add support for generation of jumbo frames
200 - Support for dpdk-stable-17.11.1 crypto
201 - Add support for multiple variables in core definition
202 - Support async operation in handle_esp
203 - Add support for reception of jumbo frames
204 - Support additional MAC format in config file
205 - Add support for multiple GEN tasks running on the same core
206 - Add support for crypto on multiple cores
207 - Zero packet loss testing has been added.
208 - Integrate irq mode into PROX (support display and command line)
209 - Support async operation in handle_esp
210 - Add config option to use port mac as src mac in l2fwd and swap
211 - Add support for DPDK 17.11
212 - Add support for multiple tasks generating to same ip in l3 mode.
213 - Add l3 support for tasks without physical tx ports
216 - link speed when link is down at startup.
218 - potential crash if link speed is null
219 - the calculation of dropped packets and other changes
220 - latency accuracy and dumping latencies to file
221 - issues with the pkt_size command
222 - potential crash in rx and tx distribution
223 - extrapolation used in latency measurements
224 - dumping receive packets
225 - using signature in latency measurements
226 - stacking of rx receive functions
227 - potential crash when issuing "tx distr stop" command.
228 - extrapolation used in latency measurements
229 - memory leak introduced by 4a65cd84
234 - Huge page freeing needs to be handled properly while running the application else it might
235 cause system crash. Known issue from DPDK.
236 - UDP Replay is used to capture throughput for dynamic cgnapt
237 - Hardware Checksum offload is not supported for IPv6 traffic
238 - SampleVNF on sriov is tested till 4 threads
239 - Rest API is supported only for vACL, vFW, vCGNAPT
240 - Rest API uses port 80, make sure other webservices are stopped before using SampleVNF RestAPI.
247 +----------------------------+-------------------------------------------------------------------+
248 | **JIRA REFERENCE** | **DESCRIPTION** |
249 +----------------------------+-------------------------------------------------------------------+
250 | SAMPLEVNF-98 | SampleVNF RESTful API support |
251 +----------------------------+-------------------------------------------------------------------+
252 | SAMPLEVNF-99 | Security gateway testing |
253 +----------------------------+-------------------------------------------------------------------+
254 | SAMPLEVNF-100 | Add support for generation of jumbo frames |
255 +----------------------------+-------------------------------------------------------------------+
256 | SAMPLEVNF-101 | Support for dpdk-stable-17.11.1 crypto |
257 +----------------------------+-------------------------------------------------------------------+
258 | SAMPLEVNF-102 | Support async operation in handle_espo |
259 +----------------------------+-------------------------------------------------------------------+
260 | SAMPLEVNF-103 | Add support for reception of jumbo frames |
261 +----------------------------+-------------------------------------------------------------------+
262 | SAMPLEVNF-104 | Support additional MAC format in config file |
263 +----------------------------+-------------------------------------------------------------------+
264 | SAMPLEVNF-105 | support for multiple GEN tasks running on the same core |
265 +----------------------------+-------------------------------------------------------------------+
266 | SAMPLEVNF-106 | Add support for crypto on multiple cores |
267 +----------------------------+-------------------------------------------------------------------+
268 | SAMPLEVNF-107 | Zero packet loss testing |
269 +----------------------------+-------------------------------------------------------------------+
270 | SAMPLEVNF-108 | Integrate irq mode into PROX (support display and command line) |
271 +----------------------------+-------------------------------------------------------------------+
272 | SAMPLEVNF-109 | Add config option to use port mac as src mac in l2fwd and swap |
273 +----------------------------+-------------------------------------------------------------------+
274 | SAMPLEVNF-110 | Add support for DPDK 17.11 |
275 +----------------------------+-------------------------------------------------------------------+
276 | SAMPLEVNF-111 | Add support for multiple tasks generating to same ip in l3 mode |
277 +----------------------------+-------------------------------------------------------------------+
278 | SAMPLEVNF-112 | Add l3 support for tasks without physical tx ports |
279 +----------------------------+-------------------------------------------------------------------+
283 +----------------------------+-------------------------------------------------------------------+
284 | **JIRA REFERENCE** | **DESCRIPTION** |
285 +----------------------------+-------------------------------------------------------------------+
286 | SAMPLEVNF-113 | link speed when link is down at startup. |
287 +----------------------------+-------------------------------------------------------------------+
288 | SAMPLEVNF-114 | minimum latency |
289 +----------------------------+-------------------------------------------------------------------+
290 | SAMPLEVNF-115 | potential crash if link speed is null |
291 +----------------------------+-------------------------------------------------------------------+
292 | SAMPLEVNF-116 | the calculation of dropped packets and other changes |
293 +----------------------------+-------------------------------------------------------------------+
294 | SAMPLEVNF-117 | latency accuracy and dumping latencies to file |
295 +----------------------------+-------------------------------------------------------------------+
296 | SAMPLEVNF-118 | issues with the pkt_size command |
297 +----------------------------+-------------------------------------------------------------------+
298 | SAMPLEVNF-119 | extrapolation used in latency measurements |
299 +----------------------------+-------------------------------------------------------------------+
300 | SAMPLEVNF-120 | dumping receive packets |
301 +----------------------------+-------------------------------------------------------------------+
302 | SAMPLEVNF-121 | using signature in latency measurements |
303 +----------------------------+-------------------------------------------------------------------+
304 | SAMPLEVNF-122 | stacking of rx receive functions |
305 +----------------------------+-------------------------------------------------------------------+
306 | SAMPLEVNF-123 | potential crash when issuing "tx distr stop" command. |
307 +----------------------------+-------------------------------------------------------------------+
308 | SAMPLEVNF-124 | extrapolation used in latency measurements |
309 +----------------------------+-------------------------------------------------------------------+
310 | SAMPLEVNF-125 | memory leak introduced by 4a65cd84 |
311 +----------------------------+-------------------------------------------------------------------+
313 Farser known restrictions/issues
314 ====================================
315 +-----------+-----------+----------------------------------------------+
316 | Installer | Scenario | Issue |
317 +===========+===========+==============================================+
319 +-----------+-----------+----------------------------------------------+
325 +----------------------------+------------------------------------------------+
326 | **JIRA REFERENCE** | **DESCRIPTION** |
328 +----------------------------+------------------------------------------------+
331 +----------------------------+------------------------------------------------+
337 - wiki project page: https://wiki.opnfv.org/display/SAM
339 - wiki SampleVNF Farser release planing page: https://wiki.opnfv.org/display/SAM/F+Release+Plan+for+SampleVNF
341 - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
343 - SampleVNF IRC chanel: #opnfv-samplevnf