Add Gambia release notes
[samplevnf.git] / docs / release / release-notes / release-notes.rst
index e76e509..68d8430 100644 (file)
@@ -17,7 +17,7 @@ The *SampleVNFs*, the *SampleVNF test cases* are opensource software,
 licensed under the terms of the Apache License, Version 2.0.
 
 ==========================================
-OPNFV Farser Release Note for SampleVNF
+OPNFV Gambia Release Note for SampleVNF
 ==========================================
 
 .. toctree::
@@ -43,7 +43,7 @@ Version History
 | *Date*         | *Version*          | *Comment*                       |
 |                |                    |                                 |
 +----------------+--------------------+---------------------------------+
-| "Oct 20 2017"  |  6.0               | SampleVNF for Farser release |
+| "May 25 2018"  |  7.0.0             | SampleVNF for Gambia release    |
 |                |                    |                                 |
 +----------------+--------------------+---------------------------------+
 
@@ -56,10 +56,10 @@ The software delivered in the OPNFV SampleVNF_ Project, comprising the
 Project is a realization of the methodology in ETSI-ISG NFV-TST001_.
 
 
-OPNFV Farser Release
+OPNFV Gambia Release
 ======================
 
-This Farser release provides *SampleVNF* as a approx VNF repository for
+This Gambia release provides *SampleVNF* as a approx VNF repository for
 VNF/NFVI testing, characterization and OPNFV feature testing, automated on
 OPNFV platform, including:
 
@@ -77,14 +77,14 @@ OPNFV platform, including:
 
 * SampleVNF source code
 
-For Farser release, the *SampleVNF* supported:
+For Gambia 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       |
+| *Prox*         | Packet pROcessing eXecution engine                      |     v0.40.0       |
 |                |  acts as traffic generator, L3FWD, L2FWD, BNG etc       |                   |
 +----------------+---------------------------------------------------------+-------------------+
 | *vACL*         | Access Control List                                     |     v0.1.0        |
@@ -97,7 +97,7 @@ For Farser release, the *SampleVNF* supported:
 .. note:: Highlevel Desgin and features supported by each of the VNFs is described in Developer
           and user guide.
 
-For Farser release, the *SampleVNF* is used for the following
+For Gambia release, the *SampleVNF* is used for the following
 testing:
 
 * OPNFV platform testing - generic test cases to measure the categories:
@@ -108,7 +108,7 @@ testing:
 
   * VNF Characterization:
 
-    * Network - rfc2544, rfc36.0, latency, http_test etc
+    * Network - rfc2544, rfc3511, latency, http_test etc
 
 
 The *SampleVNF* is developed in the OPNFV community, by the SampleVNF_ team.
@@ -127,19 +127,25 @@ Release Data
 | **Project**                          | SampleVNF                            |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Repo/tag**                         | samplevnf/Farser.6.0              |
+| **Repo/tag**                         | opnfv-7.0.0                          |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **SampleVNF Docker image tag**       | Farser.6.0                        |
+| **SampleVNF Docker image tag**       | Gambia 7.0                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release designation**              | Farser                            |
+| **Release designation**              | Gambia 7.0                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release date**                     | "October 20 2017"                    |
+| **Release date**                     | "Nov 02 2018"                        |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Purpose of the delivery**          | OPNFV Farser release 6.0          |
+| **Purpose of the delivery**          | Gambia alignment to Released         |
+|                                      | bug-fixes for the following:         |
+|                                      | - Memory leak                        |
+|                                      | - minimum latency                    |
+|                                      | - Increase default mbuf size and     |
+|                                      |   code simplification/cleanup        |
+|                                      | - Crash in rx/tx distribution        |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
@@ -150,9 +156,9 @@ Deliverables
 Documents
 ---------
 
- - User Guide: http://artifacts.opnfv.org/samplevnf/euphrates/5.0.0/docs/testing_user_userguide/index.html
+ - User Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_user_userguide/index.html
 
- - Developer Guide: http://artifacts.opnfv.org/samplevnf/euphrates/5.0.0/docs/testing_developer/index.html
+ - Developer Guide: http://artifacts.opnfv.org/samplevnf/docs/testing_developer/index.html
 
 
 Software Deliverables
@@ -194,8 +200,39 @@ Feature additions
 -----------------
 
 - SampleVNF RESTful API support
-
-- Introduce Network service benchmarking
+- Security gateway testing
+- Support reading inline jumbo frame and dump them
+- Add support for generation of jumbo frames
+- Support for dpdk-stable-17.11.1 crypto
+- Add support for multiple variables in core definition
+- Support async operation in handle_esp
+- Add support for reception of jumbo frames
+- Support additional MAC format in config file
+- Add support for multiple GEN tasks running on the same core
+- Add support for crypto on multiple cores
+- Zero packet loss testing has been added.
+- Integrate irq mode into PROX (support display and command line)
+- Support async operation in handle_esp
+- Add config option to use port mac as src mac in l2fwd and swap
+- Add support for DPDK 17.11
+- Add support for multiple tasks generating to same ip in l3 mode.
+- Add l3 support for tasks without physical tx ports
+
+Bug fixes:
+- link speed when link is down at startup.
+- minimum latency
+- potential crash if link speed is null
+- the calculation of dropped packets and other changes
+- latency accuracy and dumping latencies to file
+- issues with the pkt_size command
+- potential crash in rx and tx distribution
+- extrapolation used in latency measurements
+- dumping receive packets
+- using signature in latency measurements
+- stacking of rx receive functions
+- potential crash when issuing "tx distr stop" command.
+- extrapolation used in latency measurements
+- memory leak introduced by 4a65cd84
 
 
 Known Issues/Faults
@@ -211,18 +248,26 @@ Known Issues/Faults
 Corrected Faults
 ----------------
 
-Farser.6.0:
+Gambia 7.0:
 
-+----------------------------+------------------------------------------------+
-| **JIRA REFERENCE**         | **DESCRIPTION**                                |
-|                            |                                                |
-+----------------------------+------------------------------------------------+
-|                            |                                                |
-|                            |                                                |
-+----------------------------+------------------------------------------------+
++----------------------------+-------------------------------------------------------------------+
+| **JIRA REFERENCE**         | **DESCRIPTION**                                                   |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-                 |  PROX support for dpdk 18,05                                    |
++----------------------------+-------------------------------------------------------------------+
+
+
+
+
+Bug Fix Jira:
 
++----------------------------+-------------------------------------------------------------------+
+| **JIRA REFERENCE**         | **DESCRIPTION**                                                   |
++----------------------------+-------------------------------------------------------------------+
+| SAMPLEVNF-                 |  Fix samplevnf perf issues          |
++----------------------------+-------------------------------------------------------------------+
 
-Farser known restrictions/issues
+Gambia known restrictions/issues
 ====================================
 +-----------+-----------+----------------------------------------------+
 | Installer | Scenario  |  Issue                                       |
@@ -248,7 +293,7 @@ Useful links
 
  - wiki project page: https://wiki.opnfv.org/display/SAM
 
- - wiki SampleVNF Farser release planing page: https://wiki.opnfv.org/display/SAM/F+Release+Plan+for+SampleVNF
+ - wiki SampleVNF Gambia release planing page: https://wiki.opnfv.org/display/SAM/G+-+Release+SampleVNF+planning
 
  - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf