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 Euphrates 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 +----------------+--------------------+---------------------------------+
47 | "Oct 20 2017" | 5.0 | SampleVNF for Euphrates release |
49 +----------------+--------------------+---------------------------------+
55 The software delivered in the OPNFV SampleVNF_ Project, comprising the
56 *SampleVNF VNFs* and performance test case are part of OPNFV Yardstick_
57 Project is a realization of the methodology in ETSI-ISG NFV-TST001_.
60 OPNFV Euphrates Release
61 ======================
63 This Euphrates release provides *SampleVNF* as a approx VNF repository for
64 VNF/NFVI testing, characterization and OPNFV feature testing, automated on
65 OPNFV platform, including:
67 * Documentation generated with Sphinx
73 * Release notes (this document)
77 * Automated SampleVNF test suit in OPNFV Yardstick_ Project
79 * SampleVNF source code
81 For Euphrates release, the *SampleVNF* supported:
84 +----------------+---------------------------------------------------------+-------------------+
85 | **VNF** | **Name** | **version** |
86 +----------------+---------------------------------------------------------+-------------------+
87 | **CGNAPT** | Carrier Grade Network Address and port Translation .5.0 | v0.1.0 |
88 +----------------+---------------------------------------------------------+-------------------+
89 | **Prox** | Packet pROcessing eXecution engine | v0.39.0 |
90 | acts as traffic generator, L3FWD, L2FWD, BNG etc | |
91 +----------------+---------------------------------------------------------+-------------------+
92 | **vACL** | Access Control List | v0.1.0 |
93 +----------------+---------------------------------------------------------+-------------------+
94 | **vFW** | Firewall | v0.1.0 |
95 +----------------+---------------------------------------------------------+-------------------+
96 | **UDP_replay** | UDP_Replay | v0.1.0 |
97 +----------------+---------------------------------------------------------+-------------------+
99 .. note:: Highlevel Desgin and features supported by each of the VNFs is described in Developer
102 For Euphrates release, the *SampleVNF* is used for the following
105 * OPNFV platform testing - generic test cases to measure the categories:
107 * NFVI Characterization:
111 * VNF Characterization:
113 * Network - rfc2544, rfc3511, latency, http_test etc
116 The *SampleVNF* is developed in the OPNFV community, by the SampleVNF_ team.
117 The *Network Service Benchmarking* SampleVNF Characterization Testing tool is a part of the
120 .. note:: The test case description template used for the SampleVNF in yardstick
121 test cases is based on the document ETSI-ISG NFV-TST001_; the results report template
122 used for the SampleVNF test results is based on the IEEE Std 829-2008.
128 +--------------------------------------+--------------------------------------+
129 | **Project** | SampleVNF |
131 +--------------------------------------+--------------------------------------+
132 | **Repo/tag** | samplevnf/Euphrates.5.0 |
134 +--------------------------------------+--------------------------------------+
135 | **SampleVNF Docker image tag** | Euphrates.5.0 |
137 +--------------------------------------+--------------------------------------+
138 | **Release designation** | Euphrates |
140 +--------------------------------------+--------------------------------------+
141 | **Release date** | "October 20 2017" |
143 +--------------------------------------+--------------------------------------+
144 | **Purpose of the delivery** | OPNFV Euphrates release 5.0 |
146 +--------------------------------------+--------------------------------------+
155 - User Guide: http://artifacts.opnfv.org/samplevnf/euphrates/5.0.0/docs/testing_user_userguide/index.html
157 - Developer Guide: http://artifacts.opnfv.org/samplevnf/euphrates/5.0.0/docs/testing_developer/index.html
160 Software Deliverables
161 ---------------------
163 - The SampleVNF Docker image: To be added
166 **SampleVNF tested on Contexts**
168 +---------------------+-------------------------------------------------------+
169 | **Context** | **Description** |
171 +---------------------+-------------------------------------------------------+
172 | *Heat* | Models orchestration using OpenStack Heat |
174 +---------------------+-------------------------------------------------------+
175 | *Node* | Models Baremetal, Controller, Compute |
177 +---------------------+-------------------------------------------------------+
178 | *Standalone* | Models VM running on Non-Managed NFVi |
180 +---------------------+-------------------------------------------------------+
182 Document Version Changes
183 ------------------------
185 This is the first version of the SampleVNF in OPNFV.
186 It includes the following documentation updates:
188 - SampleVNF User Guide:
190 - SampleVNF Developer Guide
192 - SampleVNF Release Notes for SampleVNF: this document
198 - SampleVNF RESTful API support
200 - Introduce Network service benchmarking
205 - Huge page freeing needs to be handled properly while running the application else it might
206 cause system crash. Known issue from DPDK.
207 - UDP Replay is used to capture throughput for dynamic cgnapt
208 - Hardware Checksum offload is not supported for IPv6 traffic
209 - SampleVNF on sriov is tested till 4 threads
210 - Rest API is supported only for vACL, vFW, vCGNAPT
211 - Rest API uses port 80, make sure other webservices are stopped before using SampleVNF RestAPI.
218 +----------------------------+------------------------------------------------+
219 | **JIRA REFERENCE** | **DESCRIPTION** |
221 +----------------------------+------------------------------------------------+
224 +----------------------------+------------------------------------------------+
227 Euphrates known restrictions/issues
228 ====================================
229 +-----------+-----------+----------------------------------------------+
230 | Installer | Scenario | Issue |
231 +===========+===========+==============================================+
233 +-----------+-----------+----------------------------------------------+
239 +----------------------------+------------------------------------------------+
240 | **JIRA REFERENCE** | **DESCRIPTION** |
242 +----------------------------+------------------------------------------------+
245 +----------------------------+------------------------------------------------+
251 - wiki project page: https://wiki.opnfv.org/display/SAM
253 - wiki SampleVNF Euphrates release planing page: https://wiki.opnfv.org/display/SAM/SampleVNF+Euphrates+Release+Planning
255 - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
257 - SampleVNF IRC chanel: #opnfv-samplevnf