Docs update for E 5.1

Change-Id: I53972edc64398339463824d5f8d7193a6e15481f
Signed-off-by: Yang Yu <Gabriel.yuyang@huawei.com>

diff --git a/docs/release/release-notes/release_notes.rst b/docs/release/release-notes/release_notes.rst
index d8d143a..b52830e 100644 (file)
--- a/docs/release/release-notes/release_notes.rst
+++ b/docs/release/release-notes/release_notes.rst
@@ -56,6 +56,9 @@ Version History
 | Sept 15th, 2017|  1.6               | Bottlenecks Euphrates release 5.0 |
 |                |                    |                                   |
 +----------------+--------------------+-----------------------------------+
+| Nov 15th, 2017 |  1.6.1             | Bottlenecks Euphrates release 5.1 |
+|                |                    |                                   |
++----------------+--------------------+-----------------------------------+
 
 Summary
 =======
@@ -81,6 +84,30 @@ Release Data
 Euphrates Release Data
 -----------------------
 
++--------------------------------------+--------------------------------+
+| **Project**                          | Bottlenecks                    |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Repo/tag**                         | * Bottlenecks/5.1.0            |
+|                                      |                                |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Bottlenecks Docker image tag**     | * 5.1.0                        |
+|                                      |                                |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Release designation**              | * 5.1.0                        |
+|                                      |                                |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Release date**                     | * Nov 15th 2017                |
+|                                      |                                |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Purpose of the delivery**          | Euphrates stable release       |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+
 +--------------------------------------+--------------------------------+
 | **Project**                          | Bottlenecks                    |
 |                                      |                                |
@@ -238,7 +265,7 @@ Known restrictions/issues
   * Sometimes, Yardstick will return empty test results with test flag indicating test is excuted succefully.
   It maybe due to the environment issue or poor internet connection causing testing tools are not installed successfully.
 
-* Sometimes, a process will go to sleep state. In this case when a running tool go to sleep state, we try to call it twice. Normally, it will response.
+* Sometimes, a process will go to sleep state. In this case when a running tool go to sleep state, we try to call it twice. Normally, it will response. This applies to the traffic generator, i.e., netperf.
 
 
 Test results

diff --git a/docs/testing/user/userguide/overview.rst b/docs/testing/user/userguide/overview.rst
index 5d76c76..746f24c 100644 (file)
--- a/docs/testing/user/userguide/overview.rst
+++ b/docs/testing/user/userguide/overview.rst
@@ -58,17 +58,17 @@ Integration Description
 
 Test suite & Test case Description
 ==================================
-+--------+-------------------------------+
-|POSCA   | posca_factor_ping             |
-|        +-------------------------------+
-|        | posca_factor_system_bandwidth |
-|        +-------------------------------+
-|        | posca_facotor_througputs      |
-|        +-------------------------------+
-|        | posca_feature_scaleup         |
-|        +-------------------------------+
-|        | posca_feature_scaleout        |
-+--------+-------------------------------+
++--------+-------------------------------------+
+|POSCA   | posca_factor_ping                   |
+|        +-------------------------------------+
+|        | posca_factor_system_bandwidth       |
+|        +-------------------------------------+
+|        | posca_facotor_soak_througputs       |
+|        +-------------------------------------+
+|        | posca_feature_vnf_scale_up          |
+|        +-------------------------------------+
+|        | posca_feature_vnf_scale_out         |
++--------+-------------------------------------+
 
 As for the abandoned test suite in the previous Bottlenecks releases, please
 refer to http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/user/userguide/deprecated.html.

diff --git a/docs/testing/user/userguide/posca_guide.rst b/docs/testing/user/userguide/posca_guide.rst
index fc811b5..ec623d0 100644 (file)
--- a/docs/testing/user/userguide/posca_guide.rst
+++ b/docs/testing/user/userguide/posca_guide.rst
@@ -30,7 +30,7 @@ Scopes of the POSCA testsuite:
  b) Parameters choosing and Algorithms.
 
 Test stories of POSCA testsuite:
- a) Factor test (Stress test): base test cases that Feature test and Optimization will be dependant on.
+ a) Factor test (Stress test): base test cases that Feature test and Optimization will be dependant on or stress test to validate system.
  b) Feature test: test cases for features/scenarios.
  c) Optimization test: test to tune the system parameter.
 
@@ -45,6 +45,8 @@ Preinstall Packages
 * Docker: https://docs.docker.com/engine/installation/
     * For Ubuntu, please refer to https://docs.docker.com/engine/installation/linux/ubuntu/
 
+[Since Euphrates release, the docker-compose package is not required.]
+
 * Docker-Compose: https://docs.docker.com/compose/
 
 .. code-block:: bash
@@ -97,8 +99,10 @@ Edit admin_rc.sh and add the following line
 
     export OS_CACERT=/tmp/os_cacert
 
-If you are using compass, fuel, apex or joid to deploy your openstack
-environment, you could use the following command to get the required files.
+If you have deployed your openstack environment by compass,
+you could use the following command to get the required files. For Fuel, Apex and JOID installer, we only provide limited support now
+for retrieving the configuration/description files. If you find that the following command can not do the magic, you should put the
+required files in /tmp manually.
 
 .. code-block:: bash
 
@@ -116,9 +120,9 @@ Executing Specified Testcase
 
     bottlenecks testcase|teststory run <testname>
 
-    For the *testcase* command, testname should be as the same name of the test case configuration file located in testsuites/posca/testcase_cfg.
-    For stress tests in Danube/Euphrates, *testcase* should be replaced by either *posca_factor_ping* or *posca_factor_system_bandwidth*.
-    For the *teststory* command, a user can specify the test cases to be executed by defining it in a teststory configuration file located in testsuites/posca/testsuite_story. There is also an example there named *posca_factor_test*.
+For the *testcase* command, testname should be as the same name of the test case configuration file located in testsuites/posca/testcase_cfg.
+For stress tests in Danube/Euphrates, *testcase* should be replaced by either *posca_factor_ping* or *posca_factor_system_bandwidth*.
+For the *teststory* command, a user can specify the test cases to be executed by defining it in a teststory configuration file located in testsuites/posca/testsuite_story. There is also an example there named *posca_factor_test*.
 
 2. There are also other 2 ways to run test cases and test stories.