From e2fd28497f0083099181a9b65696e5ea8c422007 Mon Sep 17 00:00:00 2001 From: yuyang Date: Tue, 25 Apr 2017 11:17:25 +0800 Subject: [PATCH] Docs for Danube 2.0 JIRA: BOTTLENECK-165 Documents adapted to Danube 2.0 Change-Id: Ic46cc0ad2f2706986b294f539bba1264ec6f8b0b Signed-off-by: yuyang --- docs/release/release-notes/release_notes.rst | 43 ++++++++++++---------- docs/testing/developer/devguide/overview.rst | 6 +-- docs/testing/developer/devguide/posca_guide.rst | 29 ++++++++++++--- .../user/userguide/posca/posca_stress_ping.rst | 8 ++-- .../user/userguide/posca/posca_stress_traffic.rst | 7 ++-- 5 files changed, 58 insertions(+), 35 deletions(-) diff --git a/docs/release/release-notes/release_notes.rst b/docs/release/release-notes/release_notes.rst index d4a56703..cf1b51ee 100644 --- a/docs/release/release-notes/release_notes.rst +++ b/docs/release/release-notes/release_notes.rst @@ -47,6 +47,9 @@ Version History | Mar 24nd, 2017 | 1.3 | Bottlenecks Danube release 1.0 | | | | | +----------------+--------------------+---------------------------------+ +| Apr 25th, 2017 | 1.4 | Bottlenecks Danube release 2.0 | +| | | | ++----------------+--------------------+---------------------------------+ Summary ======= @@ -76,19 +79,23 @@ Danube Release Data | **Project** | Bottlenecks | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | Bottlenecks/danube.1.0 | +| **Repo/tag** | * Bottlenecks/danube.1.0 | +| | * Bottlenecks/danube.2.0 | | | | +--------------------------------------+--------------------------------------+ -| **Bottlenecks Docker image tag** | danube.1.0 | +| **Bottlenecks Docker image tag** | * danube.1.0 | +| | * danube.2.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Danube 1.0 | +| **Release designation** | * Danube 1.0 | +| | * Danube 2.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | March 31 2017 | +| **Release date** | * March 31st 2017 | +| | * May 1st 2017 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Danube base release | +| **Purpose of the delivery** | Danube stable release | | | | +--------------------------------------+--------------------------------------+ @@ -102,16 +109,16 @@ Colorado Release Data | **Repo/tag** | Bottlenecks/colorado.1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Bottlenecks Docker image tag** | colorado.1.0 | +| **Bottlenecks Docker image tag** | * colorado.1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Colorado 1.0 | +| **Release designation** | * Colorado 1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | September 22 2016 | +| **Release date** | * September 22 2016 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Colorado base release | +| **Purpose of the delivery** | Colorado stable release | | | | +--------------------------------------+--------------------------------------+ @@ -125,16 +132,16 @@ Bramaputra Release Data | **Repo/tag** | Bottlenecks/brahmaputra.1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Bottlenecks Docker image tag** | brahmaputra.1.0 | +| **Bottlenecks Docker image tag** | * brahmaputra.1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Brahmaputra 1.0 | +| **Release designation** | * Brahmaputra 1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | February 25 2016 | +| **Release date** | * February 25 2016 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | Brahmaputra base release | +| **Purpose of the delivery** | Brahmaputra stable release | | | | +--------------------------------------+--------------------------------------+ @@ -155,9 +162,9 @@ Documentatiion Deliverables **Bottlenecks documentation ** -* Release Notes: TO-DO -* User Guide: TO-DO -* Development Guide: TO-DO +* 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 +* Development Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/developer/devguide/index.html Colorado Deliverables ===================== @@ -200,7 +207,7 @@ Known restrictions/issues For OPNFV CI, this loop will be automatically stopped because of the default timeout setting. However, for local testing, user should stop this loop manually. * Sometimes, Yardstick will return empty test results with test flag indicating test is excuted succefully. - It maybe because of the environment issue or poor internet connection causing tools are not installed successfully. + It maybe because of the environment issue or poor internet connection causing testing tools are not installed successfully. * Sometimes, a process will go to dormancy. In this case, if a tool is installed in the SUT and its process go dormancy, we try to call it twice. Normally, it will response. @@ -261,5 +268,3 @@ Useful links - Bottlenecks CI dashboard: https://build.opnfv.org/ci/view/bottlenecks - Bottlenecks IRC chanel: #opnfv-bottlenecks - - diff --git a/docs/testing/developer/devguide/overview.rst b/docs/testing/developer/devguide/overview.rst index 01b0ff80..f561bfab 100644 --- a/docs/testing/developer/devguide/overview.rst +++ b/docs/testing/developer/devguide/overview.rst @@ -70,9 +70,7 @@ Test suite & Test case Description | +-------------------------------+ | | vstf_Tu3 | +--------+-------------------------------+ -|posca | posca_stress_ping | +|posca | posca_factor_ping | | +-------------------------------+ -| | posca_stress_traffic | -| | | -| | (posca_factor_sys_bandwidth) | +| | posca_factor_system_bandwidth | +--------+-------------------------------+ diff --git a/docs/testing/developer/devguide/posca_guide.rst b/docs/testing/developer/devguide/posca_guide.rst index 5b2556f8..fb3291fc 100644 --- a/docs/testing/developer/devguide/posca_guide.rst +++ b/docs/testing/developer/devguide/posca_guide.rst @@ -41,12 +41,25 @@ Detailed workflow is illutrated below. Preinstall Packages ==================== -* Please refer to release notes. +* Docker: https://docs.docker.com/engine/installation/ + * For Ubuntu, please refer to https://docs.docker.com/engine/installation/linux/ubuntu/ + +* Docker-Compose: https://docs.docker.com/compose/ + +.. code-block:: bash + + if [ -d usr/local/bin/docker-compose ]; then + rm -rf usr/local/bin/docker-compose + fi + curl -L https://github.com/docker/compose/releases/download/1.11.0/docker-compose-`uname -s`-`uname -m` > /usr/local/bin/docker-compose + chmod +x /usr/local/bin/docker-compose + Run POSCA Locally ================= -POSCA testsuite is hight automated regarding test environment preparation, installing testing tools, excuting tests and show the report/analysis. A few steps are needed to run it locally. +POSCA testsuite is highly automated regarding test environment preparation, installing testing tools, excuting tests and showing the report/analysis. +A few steps are needed to run it locally. It is presumed that a user is using Compass4nfv to deploy OPNFV Danube and the user logins jumper server as root. @@ -58,6 +71,7 @@ Downloading Bottlenecks Software mkdir /home/opnfv cd /home/opnfv git clone https://gerrit.opnfv.org/gerrit/bottlenecks + cd bottlenecks Preparing Python Virtual Evnironment ------------------------------------ @@ -75,7 +89,8 @@ Bottlencks provide a CLI interface to run the tests, which is one of the most co bottlenecks [testcase run ] [teststory run ] -For the *testcase* command, testcase name should be the same as the name of the test case configuration file located in testsuites/posca/testcase_cfg. +For the *testcase* command, testcase name should be as the same name of the test case configuration file located in testsuites/posca/testcase_cfg. +For stress tests in Danube, *testcase* should be replaced by either *posca_factor_ping* or *posca_factor_system_bandwidth*. For the *teststory* command, a user could specified the test cases to be excuted by defined it in a teststory configuration file located in testsuites/posca/testsuite_story. There is also an example there named *posca_factor_test*. There are also other 2 ways to run test cases and test stories. @@ -83,13 +98,17 @@ The first one is using shell script. .. code-block:: bash - bash run_tests.sh [-h|--help] [-s ] [-c ] + bash run_tests.sh [-h|--help] [-s ] [-c ] The second is using python interpreter. .. code-block:: bash - python testsuites/posca/run_posca.py [testcase ] [teststory ] + docker-compose -f docker/bottleneck-compose/docker-compose.yml up -d + docker pull tutum/influxdb:0.13 + sleep 5 + POSCA_SCRIPT="/home/opnfv/bottlenecks/testsuites/posca" + docker exec bottleneckcompose_bottlenecks_1 python ${POSCA_SCRIPT}/run_posca.py [testcase ] [teststory ] Cleaning Up Environment diff --git a/docs/testing/user/userguide/posca/posca_stress_ping.rst b/docs/testing/user/userguide/posca/posca_stress_ping.rst index 963cf508..953ff4b7 100644 --- a/docs/testing/user/userguide/posca/posca_stress_ping.rst +++ b/docs/testing/user/userguide/posca/posca_stress_ping.rst @@ -14,14 +14,14 @@ Test Case |Bottlenecks POSCA Stress Test Ping | | | +--------------+--------------------------------------------------------------+ -|test case name| posca_stress_ping | +|test case name| posca_posca_ping | | | | +--------------+--------------------------------------------------------------+ -|description | Stress test regarding perfomance life-cycle while using ping | +|description | Stress test regarding life-cycle while using ping | | | to validate the VM pairs constructions | +--------------+--------------------------------------------------------------+ |configuration | config file: | -| | /testsuite/posca/testcase_cfg/posca_stress_ping | +| | /testsuite/posca/testcase_cfg/posca_posca_ping.yaml | | | | | | stack number: 5, 10, 20, 50 ... | | | | @@ -39,7 +39,7 @@ Configuration tool: ping test_times: 100 package_size: - num_stack: 2, 5, 10 + num_stack: 5, 10, 20 package_loss: 10% contexts: diff --git a/docs/testing/user/userguide/posca/posca_stress_traffic.rst b/docs/testing/user/userguide/posca/posca_stress_traffic.rst index 5f02e036..d0e702f3 100644 --- a/docs/testing/user/userguide/posca/posca_stress_traffic.rst +++ b/docs/testing/user/userguide/posca/posca_stress_traffic.rst @@ -9,19 +9,20 @@ POSCA Stress (Factor) Test of System bandwidth Test Case -======== +========= +-----------------------------------------------------------------------------+ |Bottlenecks POSCA Stress Test Traffic | | | +--------------+--------------------------------------------------------------+ -|test case name| posca_stress_ping | +|test case name| posca_factor_system_bandwith | | | | +--------------+--------------------------------------------------------------+ |description | Stress test regarding baseline of the system for a single | | | user, i.e., a VM pair while increasing the package size | +--------------+--------------------------------------------------------------+ |configuration | config file: | -| | /testsuite/posca/testcase_cfg/posca_factor_system_bandwith | +| | /testsuite/posca/testcase_cfg/ | +| | posca_factor_system_bandwith.yaml | | | | | | stack number: 1 | | | | -- 2.16.6