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 | "Oct 20 2017" | 6.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.39.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, rfc36.0, 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 |
132 +--------------------------------------+--------------------------------------+
133 | **SampleVNF Docker image tag** | Farser.6.0 |
135 +--------------------------------------+--------------------------------------+
136 | **Release designation** | Farser |
138 +--------------------------------------+--------------------------------------+
139 | **Release date** | "October 20 2017" |
141 +--------------------------------------+--------------------------------------+
142 | **Purpose of the delivery** | OPNFV Farser release 6.0 |
144 +--------------------------------------+--------------------------------------+
153 - User Guide: http://artifacts.opnfv.org/samplevnf/euphrates/5.0.0/docs/testing_user_userguide/index.html
155 - Developer Guide: http://artifacts.opnfv.org/samplevnf/euphrates/5.0.0/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
198 - Introduce Network service benchmarking
203 - Huge page freeing needs to be handled properly while running the application else it might
204 cause system crash. Known issue from DPDK.
205 - UDP Replay is used to capture throughput for dynamic cgnapt
206 - Hardware Checksum offload is not supported for IPv6 traffic
207 - SampleVNF on sriov is tested till 4 threads
208 - Rest API is supported only for vACL, vFW, vCGNAPT
209 - Rest API uses port 80, make sure other webservices are stopped before using SampleVNF RestAPI.
216 +----------------------------+------------------------------------------------+
217 | **JIRA REFERENCE** | **DESCRIPTION** |
219 +----------------------------+------------------------------------------------+
222 +----------------------------+------------------------------------------------+
225 Farser known restrictions/issues
226 ====================================
227 +-----------+-----------+----------------------------------------------+
228 | Installer | Scenario | Issue |
229 +===========+===========+==============================================+
231 +-----------+-----------+----------------------------------------------+
237 +----------------------------+------------------------------------------------+
238 | **JIRA REFERENCE** | **DESCRIPTION** |
240 +----------------------------+------------------------------------------------+
243 +----------------------------+------------------------------------------------+
249 - wiki project page: https://wiki.opnfv.org/display/SAM
251 - wiki SampleVNF Farser release planing page: https://wiki.opnfv.org/display/SAM/F+Release+Plan+for+SampleVNF
253 - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
255 - SampleVNF IRC chanel: #opnfv-samplevnf