Update document according to Danube release plan

JIRA: BOTTLENECK-145

Currently, the docs of Bottlenecks still follow the format
from Colorado. Some work need to be done regarding reorganizing
the contents according to the Danube release.

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

diff --git a/docs/release/release-notes/release_notes.rst b/docs/release/release-notes/release_notes.rst
index 76b5c1c..dd08a0e 100644 (file)
--- a/docs/release/release-notes/release_notes.rst
+++ b/docs/release/release-notes/release_notes.rst
@@ -38,33 +38,27 @@ Version History
 | Sept 22nd, 2016|  1.0               | Bottlenecks Colorado release 1.0|
 |                |                    |                                 |
 +----------------+--------------------+---------------------------------+
-| Feb 17nd, 2016 |  1.1               | Bottlenecks Danube release 1.0  |
+| Feb 17nd, 2017 |  1.1               | Bottlenecks Danube release 1.0  |
+|                |                    |                                 |
++----------------+--------------------+---------------------------------+
+| Mar 24nd, 2017 |  1.2               | Bottlenecks Danube release 1.0  |
 |                |                    |                                 |
 +----------------+--------------------+---------------------------------+
-
 
 Summary
 =======
 
 * Documentation generated with Sphinx
 
-  * User guide
-
-  * Installation Procedure
-
-  * Release Notes (this document)
+  * Release
 
-  * Platform Overview
+    * Release Notes
 
-  * Configuration Guide
+  * Testing
 
-* Bottlenecks test suite
+    * User Guide
 
-  * Jenkins Jobs for OPNFV community labs
-
-* Bottlenecks framework
-
-* Bottlenecks test cases
+    * Development Guide
 
 The *Bottlenecks software* is developed in the OPNFV community, by the
 Bottlenecks_ team.
@@ -72,26 +66,26 @@ Bottlenecks_ team.
 Release Data
 ============
 
-Bramaputra Release Data
+Danube Release Data
 -----------------------
 
 +--------------------------------------+--------------------------------------+
 | **Project**                          | Bottlenecks                          |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Repo/tag**                         | Bottlenecks/brahmaputra.1.0          |
+| **Repo/tag**                         | Bottlenecks/danube.1.0               |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Bottlenecks Docker image tag**     | brahmaputra.1.0                      |
+| **Bottlenecks Docker image tag**     | danube.1.0                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release designation**              | Brahmaputra base release             |
+| **Release designation**              | Danube 1.0                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release date**                     | February 25 2016                     |
+| **Release date**                     | March 31 2017                        |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Purpose of the delivery**          | Brahmaputra base release             |
+| **Purpose of the delivery**          | Danube base release                  |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
@@ -108,7 +102,7 @@ Colorado Release Data
 | **Bottlenecks Docker image tag**     | colorado.1.0                         |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release designation**              | Colorado base release                |
+| **Release designation**              | Colorado 1.0                         |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 | **Release date**                     | September 22 2016                    |
@@ -118,9 +112,29 @@ Colorado Release Data
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
-Colorado Release Data
+Bramaputra Release Data
 -----------------------
-* TODO
+
++--------------------------------------+--------------------------------------+
+| **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 base release             |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
 
 Danube Deliverables
 ===================
@@ -138,11 +152,9 @@ Documentatiion Deliverables
 
 **Bottlenecks documentation <danube.1.0>**
 
-* Platformation Overview: http://artifacts.opnfv.org/bottlenecks/danube/1.0/docs/platformoverview/index.html
-* Configuration Guide: http://artifacts.opnfv.org/bottlenecks/danube/1.0/configurationguide/index.html
-* Installation Guide: http://artifacts.opnfv.org/bottlenecks/danube/docs/installationprocedure/index.html
-* http://artifacts.opnfv.org/bottlenecks/danube/1.0/releasenotes/index.html
-* User Guide: http://artifacts.opnfv.org/bottlenecks/danube/1.0/docs/userguide/index.html
+* Release Notes: TO-DO
+* User Guide: TO-DO
+* Development Guide: TO-DO
 
 Colorado Deliverables
 =====================
@@ -169,7 +181,8 @@ Documentatiion Deliverables
 Reason for Version
 ==================
 
-* In Danube, POSCA testsuite is introduced and two stress tests are implemented.
+* In Danube, POSCA testsuite is introduced and two stress tests are implemented. Rubbos and vstf are
+not supported in 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.
 
@@ -187,6 +200,27 @@ Test results are available in:
 
  - jenkins logs on CI: https://build.opnfv.org/ci/view/bottlenecks/
 
+The test results are reported to MongoDB. An example is given below.
+
+::
+
+    {
+      "project_name": "bottlenecks",
+      "scenario": "os-odl_l2-nofeature-ha",
+      "stop_date": null,
+      "trust_indicator": null,
+      "case_name": "posca_stress_ping",
+      "build_tag": "bottlenecks-compass-posca_stress_ping-baremetal-daily-master",
+      "version": "master",
+      "pod_name": "huawei-pod2",
+      "criteria": "PASS",
+      "installer": "compass",
+      "_id": "58cf4d3e32c829000a1150a8",
+      "start_date": "2017-3-9 4:33:04",
+      "details": {}
+    }
+
+For more information, please refer to: https://wiki.opnfv.org/display/testing/Result+alignment+for+ELK+post-processing
 
 Open JIRA tickets
 =================
@@ -194,10 +228,12 @@ 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 |
 +------------------+-----------------------------------------------+
 
 

diff --git a/docs/release/release-notes/requirements_notes.rst b/docs/release/release-notes/requirements_notes.rst
index 2660bb0..9e1c471 100644 (file)
--- a/docs/release/release-notes/requirements_notes.rst
+++ b/docs/release/release-notes/requirements_notes.rst
@@ -11,13 +11,14 @@ Bottlenecks Requirements Notes for OPNFV Danube Release
 Installer Requirements
 ======================
 
-* TODO
+In Danube, test cases are runned defaultly over compass4nfv deployment.
 
 =====================
 Hardware Requirements
 =====================
 
-* TODO
+No specific requirements for hardware, as long as there is external network connection.
+So that the dependent package could be downloaded.
 
 =====================
 Software Requirements
@@ -26,7 +27,12 @@ Software Requirements
 Operation System
 ----------------
 
-* TODO
+Ubuntu 14.04 is the default system. However, we do not do any linux core operation or call any system related api directly. The software could be runned in higher versions of Ubuntu with high probability. Thorough tests are not performed.
+
+Cloud OS
+--------
+
+Bottlenecks support OpenStack Newton with compatibility for both openstack V2/V3 API. That is, Bottlenecks could be runned over lower version of OpenStack.
 
 Depending Package
 -----------------
@@ -103,3 +109,4 @@ Depending Package
 - wrapt==1.10.6
 - pyroute2==0.4.10
 - elasticsearch==5.0.1
+- docker==2.0.2

diff --git a/docs/testing/developer/deprecated.rst b/docs/testing/developer/deprecated.rst
new file mode 100644 (file)
index 0000000..1566f38
--- /dev/null
+++ b/docs/testing/developer/deprecated.rst
@@ -0,0 +1,15 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Huawei Technologies Co.,Ltd and others.
+
+**************************************
+Bottlenecks - Deprecated Testing Guide
+**************************************
+
+
+.. toctree::
+   :maxdepth: 1
+
+   ./rubbos_guide.rst
+   ./vstf_guide.rst
+

diff --git a/docs/testing/developer/index.rst b/docs/testing/developer/index.rst
index 20cc00e..8d57ead 100644 (file)
--- a/docs/testing/developer/index.rst
+++ b/docs/testing/developer/index.rst
@@ -7,10 +7,10 @@ Bottlenecks - Testing Guide
 ***************************
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    ./overview.rst
    ./posca_guide.rst
-   ./rubbos_guide.rst
-   ./vstf_guide.rst
    ./dashboard_guide.rst
+   ./deprecated.rst
+

diff --git a/docs/testing/developer/overview.rst b/docs/testing/developer/overview.rst
index 8bc1b7c..42f06eb 100644 (file)
--- a/docs/testing/developer/overview.rst
+++ b/docs/testing/developer/overview.rst
@@ -25,7 +25,7 @@ vstf is refactored by extracting the test case's configuration information.
 
 Danube: posca testsuite is introduced to implementing stress (factor), scenario and
 tuning test in parametric manner. Two testcases are developed and integrated into
-community CI pipeline.
+community CI pipeline. Rubbos and VSTF are not supported any more.
 
 Integration Description
 =======================

diff --git a/docs/testing/user/userguide/deprecated.rst b/docs/testing/user/userguide/deprecated.rst
new file mode 100644 (file)
index 0000000..80fe44a
--- /dev/null
+++ b/docs/testing/user/userguide/deprecated.rst
@@ -0,0 +1,28 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+***********************************
+Bottlenecks - Deprecated Test Cases
+***********************************
+
+.. This index.rst file is used to structure and organise the content in these directories.
+.. The documentation toolchain will create web and pdf versions of the content of this file.
+
+.. toctree::
+   :maxdepth: 1
+
+   ./rubbos/rubbos_basic.rst
+   ./rubbos/rubbos_tc1101.rst
+   ./rubbos/rubbos_tc1201.rst
+   ./rubbos/rubbos_tc1301.rst
+   ./rubbos/rubbos_tc1401.rst
+   ./rubbos/rubbos_heavy_tc1101.rst
+   ./vstf/vstf_Ti1.rst
+   ./vstf/vstf_Ti2.rst
+   ./vstf/vstf_Ti3.rst
+   ./vstf/vstf_Tn1.rst
+   ./vstf/vstf_Tn2.rst
+   ./vstf/vstf_Tu1.rst
+   ./vstf/vstf_Tu2.rst
+   ./vstf/vstf_Tu3.rst
+

diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst
index 8afd57a..795530d 100644 (file)
--- a/docs/testing/user/userguide/index.rst
+++ b/docs/testing/user/userguide/index.rst
@@ -9,21 +9,9 @@ Bottlenecks - User Guide
 .. The documentation toolchain will create web and pdf versions of the content of this file.
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
-   ./rubbos/rubbos_basic.rst
-   ./rubbos/rubbos_tc1101.rst
-   ./rubbos/rubbos_tc1201.rst
-   ./rubbos/rubbos_tc1301.rst
-   ./rubbos/rubbos_tc1401.rst
-   ./rubbos/rubbos_heavy_tc1101.rst
-   ./vstf/vstf_Ti1.rst
-   ./vstf/vstf_Ti2.rst
-   ./vstf/vstf_Ti3.rst
-   ./vstf/vstf_Tn1.rst
-   ./vstf/vstf_Tn2.rst
-   ./vstf/vstf_Tu1.rst
-   ./vstf/vstf_Tu2.rst
-   ./vstf/vstf_Tu3.rst
    ./posca/posca_stress_ping.rst
    ./posca/posca_stress_traffic.rst
+   ./deprecated.rst
+

diff --git a/docs/testing/user/userguide/posca/posca_stress_ping.rst b/docs/testing/user/userguide/posca/posca_stress_ping.rst
index 846b468..963cf50 100644 (file)
--- a/docs/testing/user/userguide/posca/posca_stress_ping.rst
+++ b/docs/testing/user/userguide/posca/posca_stress_ping.rst
@@ -32,21 +32,23 @@ Test Case
 
 Configuration
 ============
-load_manager:
-  scenarios:
-    tool: ping
-    test_times: 100
-    package_size:
-    num_stack: 2, 5, 10
-    package_loss: 10%
+::
 
-  contexts:
-    stack_create: yardstick
-    flavor:
-    yardstick_test_ip:
-    yardstick_test_dir: "samples"
-    yardstick_testcase: "ping_bottlenecks"
+    load_manager:
+      scenarios:
+        tool: ping
+        test_times: 100
+        package_size:
+        num_stack: 2, 5, 10
+        package_loss: 10%
 
-dashboard:
-  dashboard: "y"
-  dashboard_ip:
+      contexts:
+        stack_create: yardstick
+        flavor:
+        yardstick_test_ip:
+        yardstick_test_dir: "samples"
+        yardstick_testcase: "ping_bottlenecks"
+
+    dashboard:
+      dashboard: "y"
+      dashboard_ip:

diff --git a/docs/testing/user/userguide/posca/posca_stress_traffic.rst b/docs/testing/user/userguide/posca/posca_stress_traffic.rst
index a995996..5f02e03 100644 (file)
--- a/docs/testing/user/userguide/posca/posca_stress_traffic.rst
+++ b/docs/testing/user/userguide/posca/posca_stress_traffic.rst
@@ -32,18 +32,20 @@ Test Case
 
 Configration
 ===========
-test_config:
-  tool: netperf
-  protocol: tcp
-  test_time: 20
-  tx_pkt_sizes: 64, 256, 1024, 4096, 8192, 16384, 32768, 65536
-  rx_pkt_sizes: 64, 256, 1024, 4096, 8192, 16384, 32768, 65536
-  cpu_load: 0.9
-  latency: 100000
-runner_config:
-  dashboard: "y"
-  dashboard_ip:
-  stack_create: yardstick
-  yardstick_test_ip:
-  yardstick_test_dir: "samples"
-  yardstick_testcase: "netperf_bottlenecks"
+::
+
+    test_config:
+      tool: netperf
+      protocol: tcp
+      test_time: 20
+      tx_pkt_sizes: 64, 256, 1024, 4096, 8192, 16384, 32768, 65536
+      rx_pkt_sizes: 64, 256, 1024, 4096, 8192, 16384, 32768, 65536
+      cpu_load: 0.9
+      latency: 100000
+    runner_config:
+      dashboard: "y"
+      dashboard_ip:
+      stack_create: yardstick
+      yardstick_test_ip:
+      yardstick_test_dir: "samples"
+      yardstick_testcase: "netperf_bottlenecks"