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.
9 * Supported SampleVNF in this release is PROX for dataplane benchmarking purposes.
10 * PROX supporting up to DPDK:20.05
11 * Introducing ability to make test cloud-configured dataplane networking benchmarks using
12 ETSI NFV TST009 standard methods
13 * Test automation using X-testing
17 ======================
19 This Hunter release provides *SampleVNF* as a approx VNF repository for
20 VNF/NFVI testing, characterization and OPNFV feature testing, automated on
21 OPNFV platform, including:
23 * Documentation generated with Sphinx
29 * Release notes (this document)
33 * Automated SampleVNF test suit in OPNFV Yardstick_ Project
35 * SampleVNF source code
37 For Hunter release, the *SampleVNF* supported:
39 +----------------+---------------------------------------------------------+-------------------+
40 | *VNF* | *Name* | *version* |
41 +----------------+---------------------------------------------------------+-------------------+
42 | *CGNAPT* | Carrier Grade Network Address and port Translation .5.0 | v0.1.0 |
43 +----------------+---------------------------------------------------------+-------------------+
44 | *Prox* | Packet pROcessing eXecution engine | v0.40.0 |
45 | | acts as traffic generator, L3FWD, L2FWD, BNG etc | |
46 +----------------+---------------------------------------------------------+-------------------+
47 | *vACL* | Access Control List | v0.1.0 |
48 +----------------+---------------------------------------------------------+-------------------+
49 | *vFW* | Firewall | v0.1.0 |
50 +----------------+---------------------------------------------------------+-------------------+
51 | *UDP_replay* | UDP_Replay | v0.1.0 |
52 +----------------+---------------------------------------------------------+-------------------+
54 .. note:: Highlevel Desgin and features supported by each of the VNFs is described in Developer
57 For Hunter release, the *SampleVNF* is used for the following
60 * OPNFV platform testing - generic test cases to measure the categories:
62 * NFVI Characterization:
66 * VNF Characterization:
68 * Network - rfc2544, rfc3511, latency, http_test etc
71 The *SampleVNF* is developed in the OPNFV community, by the SampleVNF_ team.
72 The *Network Service Benchmarking* SampleVNF Characterization Testing tool is a part of the
75 .. note:: The test case description template used for the SampleVNF in yardstick
76 test cases is based on the document ETSI-ISG NFV-TST001_; the results report template
77 used for the SampleVNF test results is based on the IEEE Std 829-2008.
83 +--------------------------------------+--------------------------------------+
84 | **Project** | SampleVNF |
86 +--------------------------------------+--------------------------------------+
87 | **Repo/tag** | opnfv-8.0 |
89 +--------------------------------------+--------------------------------------+
90 | **SampleVNF Docker image tag** | Hunter 8.0 |
92 +--------------------------------------+--------------------------------------+
93 | **Release designation** | Hunter 8.0 |
95 +--------------------------------------+--------------------------------------+
96 | **Release date** | "May 10 2019" |
98 +--------------------------------------+--------------------------------------+
99 | **Purpose of the delivery** | Hunter alignment to Released |
100 | | bug-fixes for the following: |
102 | | - minimum latency |
103 | | - Increase default mbuf size and |
104 | | code simplification/cleanup |
105 | | - Crash in rx/tx distribution |
107 +--------------------------------------+--------------------------------------+
116 - User Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_user_userguide/index.html
118 - Developer Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_developer/index.html
121 Software Deliverables
122 ^^^^^^^^^^^^^^^^^^^^^
124 - The SampleVNF Docker image: To be added
127 **SampleVNF tested on Contexts**
129 +---------------------+-------------------------------------------------------+
130 | **Context** | **Description** |
132 +---------------------+-------------------------------------------------------+
133 | *Heat* | Models orchestration using OpenStack Heat |
135 +---------------------+-------------------------------------------------------+
136 | *Node* | Models Baremetal, Controller, Compute |
138 +---------------------+-------------------------------------------------------+
139 | *Standalone* | Models VM running on Non-Managed NFVi |
141 +---------------------+-------------------------------------------------------+
143 Document Version Changes
144 ^^^^^^^^^^^^^^^^^^^^^^^^
146 This is the first version of the SampleVNF in OPNFV.
147 It includes the following documentation updates:
149 - SampleVNF User Guide:
151 - SampleVNF Developer Guide
153 - SampleVNF Release Notes for SampleVNF: this document
159 - Support for DPDK 18.05 and DPDK 18.08
160 - Add support for counting non dataplane related packets
161 - test improvements and fixes for image creation
162 - Local Documentation Builds
163 - Improve l3fwd performance
164 - Enable the local cache mac address
165 - Initial support for DPDK 18.05
166 - Adding centos.json to be used with packer to generate a VM with PROX
167 - Adding support for Ubuntu 17.10...
168 - Get multiple port stats simultaneously
169 - Increase default mbuf size and code simplification/cleanup
170 - update from src port in the pvt/pub handler
173 - Fix potential crash with latency accuracy
174 - TempFix: vCGNAPT/vACL ipv4 perf issue
175 - Temp Fix for vFW perf issue
176 - fix code standard in VNFs/DPPD-PROX/handle_esp.c
177 - Workaround DPDK net/virtio queue setup issue
178 - Fix potential crash when shuffling mbufs
183 - Huge page freeing needs to be handled properly while running the application else it might
184 cause system crash. Known issue from DPDK.
185 - UDP Replay is used to capture throughput for dynamic cgnapt
186 - Hardware Checksum offload is not supported for IPv6 traffic
187 - SampleVNF on sriov is tested till 4 threads
188 - Rest API is supported only for vACL, vFW, vCGNAPT
189 - Rest API uses port 80, make sure other webservices are stopped before using SampleVNF RestAPI.
196 +----------------------------+----------------------------------------------------------------------+
197 | **JIRA REFERENCE** | **DESCRIPTION** |
198 +----------------------------+----------------------------------------------------------------------+
199 | SAMPLEVNF-129 | Support for DPDK 18.05 and DPDK 18.08 |
200 +----------------------------+----------------------------------------------------------------------+
201 | SAMPLEVNF-130 | Add support for counting non dataplane related packets |
202 +----------------------------+----------------------------------------------------------------------+
203 | SAMPLEVNF-131 | test improvements and fixes for image creation |
204 +----------------------------+----------------------------------------------------------------------+
205 | SAMPLEVNF-132 | Local Documentation Builds |
206 +----------------------------+----------------------------------------------------------------------+
207 | SAMPLEVNF-133 | Improve l3fwd performance |
208 +----------------------------+----------------------------------------------------------------------+
209 | SAMPLEVNF-134 | Enable the local cache mac address |
210 +----------------------------+----------------------------------------------------------------------+
211 | SAMPLEVNF-135 | Initial support for DPDK 18.05 |
212 +----------------------------+----------------------------------------------------------------------+
213 | SAMPLEVNF-136 | Adding centos.json to be used with packer to generate a VM with PROX|
214 +----------------------------+----------------------------------------------------------------------+
215 | SAMPLEVNF-137 | Adding support for Ubuntu 17.20... |
216 +----------------------------+----------------------------------------------------------------------+
217 | SAMPLEVNF-138 | Get multiple port stats simultaneously |
218 +----------------------------+----------------------------------------------------------------------+
219 | SAMPLEVNF-139 | Increase default mbuf size and code simplification/cleanup |
220 +----------------------------+----------------------------------------------------------------------+
221 | SAMPLEVNF-140 | update from src port in the pvt/pub handler |
222 +----------------------------+----------------------------------------------------------------------+
229 +----------------------------+-------------------------------------------------------------------+
230 | **JIRA REFERENCE** | **DESCRIPTION** |
231 +----------------------------+-------------------------------------------------------------------+
232 | SAMPLEVNF-141 | Fix potential crash with latency accuracy |
233 +----------------------------+-------------------------------------------------------------------+
234 | SAMPLEVNF-142 | TempFix: vCGNAPT/vACL ipv4 perf issue |
235 +----------------------------+-------------------------------------------------------------------+
236 | SAMPLEVNF-143 | Temp Fix for vFW perf issue |
237 +----------------------------+-------------------------------------------------------------------+
238 | SAMPLEVNF-144 | fix code standard in VNFs/DPPD-PROX/handle_esp.c |
239 +----------------------------+-------------------------------------------------------------------+
240 | SAMPLEVNF-145 | Workaround DPDK net/virtio queue setup issue |
241 +----------------------------+-------------------------------------------------------------------+
242 | SAMPLEVNF-146 | Fix potential crash when shuffling mbufs |
243 +----------------------------+-------------------------------------------------------------------+
245 Hunter known restrictions/issues
246 --------------------------------
247 +-----------+-----------+----------------------------------------------+
248 | Installer | Scenario | Issue |
249 +===========+===========+==============================================+
251 +-----------+-----------+----------------------------------------------+
257 +----------------------------+------------------------------------------------+
258 | **JIRA REFERENCE** | **DESCRIPTION** |
260 +----------------------------+------------------------------------------------+
263 +----------------------------+------------------------------------------------+
269 - wiki project page: https://wiki.opnfv.org/display/SAM
271 - wiki SampleVNF Hunter release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
273 - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
275 - SampleVNF IRC chanel: #opnfv-samplevnf