summaryrefslogtreecommitdiffstats
path: root/docs/release
diff options
context:
space:
mode:
Diffstat (limited to 'docs/release')
-rw-r--r--docs/release/release-notes/release-notes.rst64
1 files changed, 42 insertions, 22 deletions
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
index 192e82e5..a66a6ee8 100644
--- a/docs/release/release-notes/release-notes.rst
+++ b/docs/release/release-notes/release-notes.rst
@@ -23,7 +23,7 @@ OPNFV Euphrates Release Note for SampleVNF
.. toctree::
:maxdepth: 2
-.. _SampleVNF: https://wiki.opnfv.org/samplevnf
+.. _SampleVNF: https://wiki.opnfv.org/SAM
.. _Yardstick: https://wiki.opnfv.org/yardstick
@@ -44,7 +44,7 @@ Version History
| | | |
+----------------+--------------------+---------------------------------+
+----------------+--------------------+---------------------------------+
-| | 1.0 | SampleVNF for Euphrates release |
+| "Oct 20 2017" | 5.0 | SampleVNF for Euphrates release |
| | | |
+----------------+--------------------+---------------------------------+
@@ -53,9 +53,8 @@ Important Notes
===============
The software delivered in the OPNFV SampleVNF_ Project, comprising the
-*SampleVNF VNFs*, the *SampleVNF test cases* and performance test case
-are part of OPNFV Yardstick_ Project is a realization of the methodology in
-ETSI-ISG NFV-TST001_.
+*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
@@ -79,6 +78,25 @@ OPNFV platform, including:
* 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:
@@ -93,9 +111,9 @@ testing:
* Network - rfc2544, rfc3511, latency, http_test etc
-The *SampleVNF* is developed in the OPNFV community, by the
-SampleVNF_ team. The *Network Service Benchmarking* Testing tool is a part of
-the Yardstick Project.
+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
@@ -109,19 +127,19 @@ Release Data
| **Project** | SampleVNF |
| | |
+--------------------------------------+--------------------------------------+
-| **Repo/tag** | |
+| **Repo/tag** | samplevnf/Euphrates.5.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **SampleVNF Docker image tag** | |
+| **SampleVNF Docker image tag** | Euphrates.5.0 |
| | |
+--------------------------------------+--------------------------------------+
| **Release designation** | Euphrates |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | |
+| **Release date** | "October 20 2017" |
| | |
+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | |
+| **Purpose of the delivery** | OPNFV Euphrates release 5.0 |
| | |
+--------------------------------------+--------------------------------------+
@@ -132,9 +150,9 @@ Deliverables
Documents
---------
- - User Guide
+ - User Guide: http://artifacts.opnfv.org/samplevnf/euphrates/5.0.0/docs/testing_user_userguide/index.html
- - Developer Guide
+ - Developer Guide: http://artifacts.opnfv.org/samplevnf/euphrates/5.0.0/docs/testing_developer/index.html
Software Deliverables
@@ -166,9 +184,6 @@ This is the first version of the SampleVNF in OPNFV.
It includes the following documentation updates:
- SampleVNF User Guide:
- add "network service benchmarking(NSB)" chapter;
- add "SampleVNF - NSB Testing -Installation" chapter; add "SampleVNF API" chapter;
- add "SampleVNF user interface" chapter; Update SampleVNF installation chapter;
- SampleVNF Developer Guide
@@ -185,24 +200,29 @@ Feature additions
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.1.0:
+Euphrates.5.0:
+----------------------------+------------------------------------------------+
| **JIRA REFERENCE** | **DESCRIPTION** |
| | |
+----------------------------+------------------------------------------------+
-| JIRA: samplevnf- | |
+| | |
| | |
+----------------------------+------------------------------------------------+
-Euphrates known restrictions/issues
+Euphrates known restrictions/issues
====================================
+-----------+-----------+----------------------------------------------+
| Installer | Scenario | Issue |