Docs for Danube 3

JIRA: BOTTLENECKS-137

Documentation for Danube 3

Change-Id: Ic4b2611028fa45c0b731e998296e5000e35a33f6
Signed-off-by: yuyang <Gabriel.yuyang@huawei.com>

diff --git a/docs/images/Framework_Setup.png b/docs/images/Framework_Setup.png
deleted file mode 100644 (file)
index 4d175e0..0000000
Binary files a/docs/images/Framework_Setup.png and /dev/null differ

diff --git a/docs/images/example.png b/docs/images/example.png
deleted file mode 100644 (file)
index e69de29..0000000

diff --git a/docs/release/release-notes/release_notes.rst b/docs/release/release-notes/release_notes.rst
index cf1b51e..d529bf7 100644 (file)
--- a/docs/release/release-notes/release_notes.rst
+++ b/docs/release/release-notes/release_notes.rst
@@ -50,6 +50,9 @@ Version History
 | Apr 25th, 2017 |  1.4               | Bottlenecks Danube release 2.0  |
 |                |                    |                                 |
 +----------------+--------------------+---------------------------------+
+| Jun 19th, 2017 |  1.5               | Bottlenecks Danube release 3.0  |
+|                |                    |                                 |
++----------------+--------------------+---------------------------------+
 
 Summary
 =======
@@ -75,75 +78,75 @@ Release Data
 Danube Release Data
 -----------------------
 
-+--------------------------------------+--------------------------------------+
-| **Project**                          | Bottlenecks                          |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Repo/tag**                         | * Bottlenecks/danube.1.0             |
-|                                      | * Bottlenecks/danube.2.0             |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Bottlenecks Docker image tag**     | * danube.1.0                         |
-|                                      | * danube.2.0                         |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release designation**              | * Danube 1.0                         |
-|                                      | * Danube 2.0                         |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release date**                     | * March 31st 2017                    |
-|                                      | * May 1st 2017                       |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery**          | Danube stable release                |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
++--------------------------------------+--------------------------------+
+| **Project**                          | Bottlenecks                    |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Repo/tag**                         | * Bottlenecks/danube.1.0       |
+|                                      | * Bottlenecks/danube.2.0       |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Bottlenecks Docker image tag**     | * danube.1.0                   |
+|                                      | * danube.2.0                   |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Release designation**              | * Danube 1.0                   |
+|                                      | * Danube 2.0                   |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Release date**                     | * March 31st 2017              |
+|                                      | * May 1st 2017                 |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Purpose of the delivery**          | Danube stable release          |
+|                                      |                                |
++--------------------------------------+--------------------------------+
 
 Colorado Release Data
 -----------------------
 
-+--------------------------------------+--------------------------------------+
-| **Project**                          | Bottlenecks                          |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Repo/tag**                         | Bottlenecks/colorado.1.0             |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Bottlenecks Docker image tag**     | * colorado.1.0                       |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release designation**              | * Colorado 1.0                       |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release date**                     | * September 22 2016                  |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery**          | Colorado stable release              |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
++--------------------------------------+--------------------------------+
+| **Project**                          | Bottlenecks                    |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Repo/tag**                         | Bottlenecks/colorado.1.0       |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Bottlenecks Docker image tag**     | * colorado.1.0                 |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Release designation**              | * Colorado 1.0                 |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Release date**                     | * September 22 2016            |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Purpose of the delivery**          | Colorado stable release        |
+|                                      |                                |
++--------------------------------------+--------------------------------+
 
 Bramaputra Release Data
 -----------------------
 
-+--------------------------------------+--------------------------------------+
-| **Project**                          | Bottlenecks                          |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Repo/tag**                         | Bottlenecks/brahmaputra.1.0          |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Bottlenecks Docker image tag**     | * brahmaputra.1.0                    |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release designation**              | * Brahmaputra 1.0                    |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release date**                     | * February 25 2016                   |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery**          | Brahmaputra stable release           |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
++--------------------------------------+--------------------------------+
+| **Project**                          | Bottlenecks                    |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Repo/tag**                         | Bottlenecks/brahmaputra.1.0    |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Bottlenecks Docker image tag**     | * brahmaputra.1.0              |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Release designation**              | * Brahmaputra 1.0              |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Release date**                     | * February 25 2016             |
+|                                      |                                |
++--------------------------------------+--------------------------------+
+| **Purpose of the delivery**          | Brahmaputra stable release     |
+|                                      |                                |
++--------------------------------------+--------------------------------+
 
 
 Danube Deliverables
@@ -152,7 +155,7 @@ Danube Deliverables
 Software Deliverables
 ---------------------
 
-**Bottlenecks source code <danube.1.0>**
+**Bottlenecks source code <danube>**
 
 * https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary
 
@@ -160,7 +163,7 @@ Software Deliverables
 Documentatiion Deliverables
 ---------------------------
 
-**Bottlenecks documentation <danube.1.0>**
+**Bottlenecks documentation <danube>**
 
 * Release Notes: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/release/release-notes/release_notes.html
 * User Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/user/userguide/index.html
@@ -192,7 +195,7 @@ Reason for Version
 ==================
 
 * In Danube, POSCA testsuite is introduced and two stress tests are implemented. Rubbos and vstf are
-not supported in this release.
+not supported in this release. Their documentations for former releases will only be kept this release.
 * In Colorado, rubbos is refactored by using puppet, which makes it quite flexible to configure with different number of load generator(Client), worker(tomcat).
 * In Colorado, vstf is refactored by extracting the test case's configuration information.
 
@@ -240,20 +243,19 @@ The test results are reported to MongoDB. An example is given below.
     }
 
 For more information, please refer to: https://wiki.opnfv.org/display/testing/Result+alignment+for+ELK+post-processing
+ - Results reported in MongoDB could find at http://testresults.opnfv.org/test/api/v1/results?project=bottlenecks
+ - Test Cases are defined in http://testresults.opnfv.org/test/api/v1/results?project=bottlenecks
 
 Open JIRA tickets
 =================
 
-+------------------+-----------------------------------------------+
-|   JIRA           |         Description                           |
-+==================+===============================================+
-| BOTTLENECK-103   | Refactoring the Bottlenecks tesing workflow   |
-+------------------+-----------------------------------------------+
-| BOTTLENECK-135   | Avoiding docker-compose building new image    |
-|                  | for Bottlenecks                               |
-+------------------+-----------------------------------------------+
-| BOTTLENECK-147   | Investigting why calling remote docker client |
-+------------------+-----------------------------------------------+
++------------------+----------------------------------------------------+
+|   JIRA           |         Description                                |
++==================+====================================================+
+| BOTTLENECK-103   | Refactoring the Bottlenecks tesing workflow        |
++------------------+----------------------------------------------------+
+| BOTTLENECK-147   | Investigting why calling remote docker client      |
++------------------+----------------------------------------------------+
 
 
 Useful links

diff --git a/docs/testing/developer/devguide/overview.rst b/docs/testing/developer/devguide/overview.rst
index f561bfa..f2e8bff 100644 (file)
--- a/docs/testing/developer/devguide/overview.rst
+++ b/docs/testing/developer/devguide/overview.rst
@@ -20,7 +20,7 @@ Virtual switch test framework(VSTF) is also introduced,
 which is an test framework used for vswitch performance test.
 
 Colorado: rubbos is refactored by using puppet, which makes it quite flexible
-to configure with different number of load generator(Client), worker(tomcat).
+to configure with different number of load generator (Client), worker (tomcat).
 vstf is refactored by extracting the test case's configuration information.
 
 Danube: posca testsuite is introduced to implementing stress (factor), scenario and
@@ -30,7 +30,7 @@ community CI pipeline. Rubbos and VSTF are not supported any more.
 Integration Description
 =======================
 +-------------+----------------------+----------------------+
-| Release     | integrated installer | Supported Testsuite  |
+| Release     | Integrated Installer | Supported Testsuite  |
 +-------------+----------------------+----------------------+
 | Brahmaputra |    Fuel              | Rubbos, VSTF         |
 +-------------+----------------------+----------------------+
@@ -42,6 +42,10 @@ Integration Description
 Test suite & Test case Description
 ==================================
 +--------+-------------------------------+
+|POSCA   | posca_factor_ping             |
+|        +-------------------------------+
+|        | posca_factor_system_bandwidth |
++--------+-------------------------------+
 |Rubbos  | rubbos_basic                  |
 |        +-------------------------------+
 |        | rubbos_TC1101                 |
@@ -70,7 +74,3 @@ Test suite & Test case Description
 |        +-------------------------------+
 |        | vstf_Tu3                      |
 +--------+-------------------------------+
-|posca   | posca_factor_ping             |
-|        +-------------------------------+
-|        | posca_factor_system_bandwidth |
-+--------+-------------------------------+

diff --git a/docs/testing/developer/devguide/posca_guide.rst b/docs/testing/developer/devguide/posca_guide.rst
index 5d101a6..ae6c248 100644 (file)
--- a/docs/testing/developer/devguide/posca_guide.rst
+++ b/docs/testing/developer/devguide/posca_guide.rst
@@ -138,10 +138,37 @@ If you want to clean the dockers that established during the test, you can excut
     docker-compose -f docker/bottleneck-compose/docker-compose.yml down -d
     docker ps -a | grep 'influxdb' | awk '{print $1}' | xargs docker rm -f >/dev/stdout
 
+Or you can just run the following command
+
+.. code-block:: bash
+
+    bash run_tests.sh --cleanup
+
+Note that you can also add cleanup parameter when you run a test case. Then environment will be automatically cleaned up when
+completing the test.
 
 Run POSCA through Community CI
 ==============================
-* POSCA test cases are runned by OPNFV CI now. See https://build.opnfv.org for more information.
+POSCA test cases are runned by OPNFV CI now. See https://build.opnfv.org for details of the building jobs.
+Each building job is set up to execute a single test case. The test results/logs will be printed on the web page and
+reported automatically to community MongoDB. There are two ways to report the results.
+
+1. Report testing result by shell script
+
+.. code-block:: bash
+
+    bash run_tests.sh [-h|--help] [-s <testsuite>] [-c <testcase>] --report
+
+2. Report testing result by python interpreter
+
+.. code-block:: bash
+
+    docker-compose -f docker/bottleneck-compose/docker-compose.yml up -d
+    docker pull tutum/influxdb:0.13
+    sleep 5
+    REPORT="True"
+    POSCA_SCRIPT="/home/opnfv/bottlenecks/testsuites/posca"
+    docker exec bottleneckcompose_bottlenecks_1 python ${POSCA_SCRIPT}/run_posca.py [testcase <testcase>] [teststory <teststory>] REPORT
 
 Test Result Description
 =======================