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
|
.. 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 Euphrates 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* |
| | | |
+----------------+--------------------+---------------------------------+
| "Oct 20 2017" | 5.0 | SampleVNF for Euphrates 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 Euphrates Release
======================
This Euphrates 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 Euphrates 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.39.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 Euphrates 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** | samplevnf/Euphrates.5.0 |
| | |
+--------------------------------------+--------------------------------------+
| **SampleVNF Docker image tag** | Euphrates.5.0 |
| | |
+--------------------------------------+--------------------------------------+
| **Release designation** | Euphrates |
| | |
+--------------------------------------+--------------------------------------+
| **Release date** | "October 20 2017" |
| | |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery** | OPNFV Euphrates release 5.0 |
| | |
+--------------------------------------+--------------------------------------+
Deliverables
============
Documents
---------
- User Guide: http://artifacts.opnfv.org/samplevnf/euphrates/5.0.0/docs/testing_user_userguide/index.html
- Developer Guide: http://artifacts.opnfv.org/samplevnf/euphrates/5.0.0/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
- Introduce Network service benchmarking
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
----------------
Euphrates.5.0:
+----------------------------+------------------------------------------------+
| **JIRA REFERENCE** | **DESCRIPTION** |
| | |
+----------------------------+------------------------------------------------+
| | |
| | |
+----------------------------+------------------------------------------------+
Euphrates 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 Euphrates release planing page: https://wiki.opnfv.org/display/SAM/SampleVNF+Euphrates+Release+Planning
- SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
- SampleVNF IRC chanel: #opnfv-samplevnf
|
