Merge "Bugfix in role enable_hugepages_on_boot"
[yardstick.git] / docs / release / release-notes / release-notes.rst
index c998f0f..4ebf0ec 100644 (file)
@@ -30,13 +30,16 @@ This document describes the release note of Yardstick project.
 
 Version History
 ---------------
-+------------------+-----------+---------------------------------+
-| *Date*           | *Version* | *Comment*                       |
-|                  |           |                                 |
-+------------------+-----------+---------------------------------+
-| October 20, 2017 | 5.0.0     | Yardstick for Euphrates release |
-|                  |           |                                 |
-+------------------+-----------+---------------------------------+
++-------------------+-----------+---------------------------------+
+| *Date*            | *Version* | *Comment*                       |
+|                   |           |                                 |
++-------------------+-----------+---------------------------------+
+| December 15, 2017 | 5.1.0     | Yardstick for Euphrates release |
+|                   |           |                                 |
++-------------------+-----------+---------------------------------+
+| October 20, 2017  | 5.0.0     | Yardstick for Euphrates release |
+|                   |           |                                 |
++-------------------+-----------+---------------------------------+
 
 
 Important Notes
@@ -98,6 +101,8 @@ testing:
 
 * Test cases for the following OPNFV Projects:
 
+  * Container4NFV
+
   * High Availability
 
   * IPv6
@@ -127,19 +132,19 @@ Release Data
 | **Project**                    | Yardstick             |
 |                                |                       |
 +--------------------------------+-----------------------+
-| **Repo/tag**                   | yardstick/opnfv-5.0.0 |
+| **Repo/tag**                   | yardstick/opnfv-5.1.0 |
 |                                |                       |
 +--------------------------------+-----------------------+
-| **Yardstick Docker image tag** | opnfv-5.0.0           |
+| **Yardstick Docker image tag** | opnfv-5.1.0           |
 |                                |                       |
 +--------------------------------+-----------------------+
 | **Release designation**        | Euphrates             |
 |                                |                       |
 +--------------------------------+-----------------------+
-| **Release date**               | October 20, 2017      |
+| **Release date**               | December 15, 2017     |
 |                                |                       |
 +--------------------------------+-----------------------+
-| **Purpose of the delivery**    | OPNFV Euphrates 5.0.0 |
+| **Purpose of the delivery**    | OPNFV Euphrates 5.1.0 |
 |                                |                       |
 +--------------------------------+-----------------------+
 
@@ -159,7 +164,7 @@ Software Deliverables
 ^^^^^^^^^^^^^^^^^^^^^
 
 
- - The Yardstick Docker image: https://hub.docker.com/r/opnfv/yardstick (tag: opnfv-5.0.0)
+ - The Yardstick Docker image: https://hub.docker.com/r/opnfv/yardstick (tag: opnfv-5.1.0)
 
 
 New Contexts
@@ -248,6 +253,8 @@ New Scenarios
 |                |                                                     |
 |                | * computecapacity                                   |
 |                |                                                     |
+|                | * SpecCPU2006                                       |
+|                |                                                     |
 +----------------+-----------------------------------------------------+
 | *Networking*   | * iperf3                                            |
 |                |                                                     |
@@ -279,12 +286,16 @@ New Scenarios
 |                |                                                     |
 |                | * nstat                                             |
 |                |                                                     |
+|                | * pktgenDPDK                                        |
+|                |                                                     |
 +----------------+-----------------------------------------------------+
 | *Parser*       | Tosca2Heat                                          |
 |                |                                                     |
 +----------------+-----------------------------------------------------+
 | *Storage*      | fio                                                 |
 |                |                                                     |
+|                | bonnie++                                            |
+|                |                                                     |
 |                | storagecapacity                                     |
 |                |                                                     |
 +----------------+-----------------------------------------------------+
@@ -300,6 +311,17 @@ New Scenarios
 New Test cases
 ^^^^^^^^^^^^^^
 
+* Generic NFVI test cases
+
+ * OPNFV_YARDSTICK_TCO78 - SPEC CPU 2006
+
+ * OPNFV_YARDSTICK_TCO79 - Bonnie++
+
+* Kubernetes Test cases
+
+ * OPNFV_YARDSTICK_TCO80 - NETWORK LATENCY BETWEEN CONTAINER
+
+ * OPNFV_YARDSTICK_TCO81 - NETWORK LATENCY BETWEEN CONTAINER AND VM
 
 
 Version Change
@@ -308,16 +330,20 @@ Version Change
 Module Version Changes
 ^^^^^^^^^^^^^^^^^^^^^^
 
-This is the fourth tracked release of Yardstick. It is based on following
+This is the fifth tracked release of Yardstick. It is based on following
 upstream versions:
 
 - OpenStack Ocata
 
+- OpenDayLight Nitrogen
+
+- ONOS Junco
+
 
 Document Version Changes
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
-This is the fourth tracked version of the Yardstick framework in OPNFV.
+This is the fifth tracked version of the Yardstick framework in OPNFV.
 It includes the following documentation updates:
 
 - Yardstick User Guide: add "network service benchmarking(NSB)" chapter;
@@ -334,20 +360,22 @@ Feature additions
 
 - Yardstick RESTful API support
 
-- Introduce Network service benchmarking
+- Network service benchmarking
 
-- Introduce stress testing with Bottlenecks team
+- Stress testing with Bottlenecks team
 
 - Yardstick framework improvement:
 
-  - Parellel test cases execution support
-
   - yardstick report CLI
 
   - Node context support OpenStack configuration via Ansible
 
   - Https support
 
+  - Kubernetes context type
+
+- Yardstick container local GUI
+
 - Python 3 support
 
 
@@ -450,6 +478,52 @@ Known Issues/Faults
 Corrected Faults
 ^^^^^^^^^^^^^^^^
 
+Euphrates 5.1.0:
+
++---------------------+-------------------------------------------------------------------------+
+| **JIRA REFERENCE**  | **DESCRIPTION**                                                         |
+|                     |                                                                         |
++---------------------+-------------------------------------------------------------------------+
+| JIRA: YARDSTICK-841 | Fix various NSB license issues                                          |
++---------------------+-------------------------------------------------------------------------+
+| JIRA: YARDSTICK-73  | How To Work with Test Cases                                             |
++---------------------+-------------------------------------------------------------------------+
+| JIRA: YARDSTICK-500 | VNF testing documentation                                               |
++---------------------+-------------------------------------------------------------------------+
+| JIRA: YARDSTICK-826 | Allow overriding Heat IP addresses to match traffic generator profile   |
++---------------------+-------------------------------------------------------------------------+
+| JIRA: YARDSTICK-828 | Refactor doc/testing/user/userguide "Yardstick Installation"            |
++---------------------+-------------------------------------------------------------------------+
+| JIRA: YARDSTICK-830 | build_yardstick_image Ansible mount module doesn't work on Ubuntu 14.04 |
++---------------------+-------------------------------------------------------------------------+
+| JIRA: YARDSTICK-833 | ansible_common transform password into lower case                       |
++---------------------+-------------------------------------------------------------------------+
+| JIRA: YARDSTICK-847 | tc006, tc079, tc082 miss grafana dashboard in local deployment          |
++---------------------+-------------------------------------------------------------------------+
+| JIRA: YARDSTICK-849 | kill process do not accurately kill the process like "nova-api"         |
++---------------------+-------------------------------------------------------------------------+
+| JIRA: YARDSTICK-850 | tc023 miss description and tc050-58 wrong description                   |
++---------------------+-------------------------------------------------------------------------+
+| JIRA: YARDSTICK-852 | tc078 cpu2006 fails in some situation                                   |
++---------------------+-------------------------------------------------------------------------+
+| JIRA: YARDSTICK-854 | yardstick docker lack of trex_client                                    |
++---------------------+-------------------------------------------------------------------------+
+| JIRA: YARDSTICK-867 | testcase tc078 have no data stored or dashboard to show results         |
++---------------------+-------------------------------------------------------------------------+
+| JIRA: YARDSTICK-871 | Remove img_modify_playbook assignation in build_yardstick_image.yml     |
++---------------------+-------------------------------------------------------------------------+
+| JIRA: YARDSTICK-829 | "nsb_setup.sh" doesn't parse the controller IP correctly                |
++---------------------+-------------------------------------------------------------------------+
+| JIRA: YARDSTICK-839 | NSB Prox BM test cases to be fixed for incorporating scale-up           |
++---------------------+-------------------------------------------------------------------------+
+| JIRA: YARDSTICK-840 | NSB Prox test documentation of vPE and LW-AFTR test cases               |
++---------------------+-------------------------------------------------------------------------+
+| JIRA: YARDSTICK-848 | NSB "Prox" : Cleanup duplicated traffic profile                         |
++---------------------+-------------------------------------------------------------------------+
+
+
+
+
 Euphrates 5.0.0:
 
 +---------------------+--------------------------------------------+
@@ -482,24 +556,6 @@ Euphratess 5.0.0 known restrictions/issues
 +-----------+-----------+----------------------------------------------+
 
 
-Open JIRA tickets
------------------
-
-+---------------------+----------------------------------------------+
-| **JIRA REFERENCE**  | **DESCRIPTION**                              |
-|                     |                                              |
-+---------------------+----------------------------------------------+
-| JIRA: YARDSTICK-626 | Fio and Lmbench don't work in Ubuntu-arm64   |
-|                     | image                                        |
-+---------------------+----------------------------------------------+
-| JIRA: YARDSTICK-603 | Timeout waiting for floating ip              |
-|                     | (which actually pingable)                    |
-+---------------------+----------------------------------------------+
-| JIRA: YARDSTICK-412 | IPv6 test case should add support for newton |
-|                     |                                              |
-+---------------------+----------------------------------------------+
-
-
 Useful links
 ------------