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/>.
15 The *SampleVNFs*, the *SampleVNF test cases* are opensource software,
16 licensed under the terms of the Apache License, Version 2.0.
18 ===========================================
19 OPNFV Euphrates Release Note for SampleVNF
20 ===========================================
25 .. _SampleVNF: https://wiki.opnfv.org/samplevnf
27 .. _Yardstick: https://wiki.opnfv.org/yardstick
29 .. _NFV-TST001: http://www.etsi.org/deliver/etsi_gs/NFV-TST/001_099/001/01.01.01_60/gs_NFV-TST001v010101p.pdf
35 This document describes the release note of SampleVNF project.
41 +----------------+--------------------+---------------------------------+
42 | *Date* | *Version* | *Comment* |
44 +----------------+--------------------+---------------------------------+
45 +----------------+--------------------+---------------------------------+
46 | | 1.0 | SampleVNF for Euphrates release |
48 +----------------+--------------------+---------------------------------+
54 The software delivered in the OPNFV SampleVNF_ Project, comprising the
55 *SampleVNF VNFs*, the *SampleVNF test cases* and performance test case
56 are part of OPNFV Yardstick_ Project is a realization of the methodology in
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 * is used for the following
84 * OPNFV platform testing - generic test cases to measure the categories:
86 * NFVi Characterization:
90 * VNF Characterization:
92 * Network - rfc2544, rfc3511, latency, http_test etc
95 The *SampleVNF* is developed in the OPNFV community, by the
96 SampleVNF_ team. The *Network Service Benchmarking* Testing tool is a part of
97 the Yardstick Project.
99 .. note:: The test case description template used for the SampleVNF in yardstick
100 test cases is based on the document ETSI-ISG NFV-TST001_; the results report template
101 used for the SampleVNF test results is based on the IEEE Std 829-2008.
107 +--------------------------------------+--------------------------------------+
108 | **Project** | SampleVNF |
110 +--------------------------------------+--------------------------------------+
113 +--------------------------------------+--------------------------------------+
114 | **SampleVNF Docker image tag** | |
116 +--------------------------------------+--------------------------------------+
117 | **Release designation** | Euphrates |
119 +--------------------------------------+--------------------------------------+
120 | **Release date** | |
122 +--------------------------------------+--------------------------------------+
123 | **Purpose of the delivery** | |
125 +--------------------------------------+--------------------------------------+
134 - User Guide: To be added
136 - Developer Guide: To be added
139 Software Deliverables
140 ---------------------
142 - The SampleVNF Docker image: To be added
145 **SampleVNF tested on Contexts**
147 +---------------------+-------------------------------------------------------+
148 | **Context** | **Description** |
150 +---------------------+-------------------------------------------------------+
151 | *Heat* | Models orchestration using OpenStack Heat |
153 +---------------------+-------------------------------------------------------+
154 | *Node* | Models Baremetal, Controller, Compute |
156 +---------------------+-------------------------------------------------------+
157 | *Standalone* | Models VM running on Non-Managed NFVi |
159 +---------------------+-------------------------------------------------------+
161 Document Version Changes
162 ------------------------
164 This is the first version of the SampleVNF in OPNFV.
165 It includes the following documentation updates:
167 - SampleVNF User Guide:
168 add "network service benchmarking(NSB)" chapter;
169 add "SampleVNF - NSB Testing -Installation" chapter; add "SampleVNF API" chapter;
170 add "SampleVNF user interface" chapter; Update SampleVNF installation chapter;
172 - SampleVNF Developer Guide
174 - SampleVNF Release Notes for SampleVNF: this document
180 - SampleVNF RESTful API support
182 - Introduce Network service benchmarking
195 +----------------------------+------------------------------------------------+
196 | **JIRA REFERENCE** | **DESCRIPTION** |
198 +----------------------------+------------------------------------------------+
199 | JIRA: samplevnf- | |
201 +----------------------------+------------------------------------------------+
204 Euphrates known restrictions/issues
205 ====================================
206 +-----------+-----------+----------------------------------------------+
207 | Installer | Scenario | Issue |
208 +===========+===========+==============================================+
210 +-----------+-----------+----------------------------------------------+
216 +----------------------------+------------------------------------------------+
217 | **JIRA REFERENCE** | **DESCRIPTION** |
219 +----------------------------+------------------------------------------------+
222 +----------------------------+------------------------------------------------+
228 - wiki project page: https://wiki.opnfv.org/display/SAM
230 - wiki SampleVNF Euphrates release planing page: https://wiki.opnfv.org/display/SAM/SampleVNF+Euphrates+Release+Planning
232 - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
234 - SampleVNF IRC chanel: #opnfv-samplevnf