From: yuyang <Gabriel.yuyang@huawei.com>
Date: Tue, 2 May 2017 04:16:22 +0000 (+0800)
Subject: Add description of environment clean-up
X-Git-Tag: opnfv-5.0.0~39
X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=commitdiff_plain;h=15355fd57080a7ac625549e9e9b98237164e46d2

Add description of environment clean-up

JIRA: BOTTLENECK-165

More details of the environment clean-up for ping test case

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

diff --git a/docs/testing/developer/devguide/posca_guide.rst b/docs/testing/developer/devguide/posca_guide.rst
index fb3291fc..5d101a6e 100644
--- a/docs/testing/developer/devguide/posca_guide.rst
+++ b/docs/testing/developer/devguide/posca_guide.rst
@@ -38,6 +38,7 @@ Detailed workflow is illutrated below.
 
 * https://wiki.opnfv.org/display/bottlenecks
 
+
 Preinstall Packages
 ====================
 
@@ -63,6 +64,7 @@ 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.
 
+
 Downloading Bottlenecks Software
 --------------------------------
 
@@ -73,6 +75,7 @@ Downloading Bottlenecks Software
     git clone https://gerrit.opnfv.org/gerrit/bottlenecks
     cd bottlenecks
 
+
 Preparing Python Virtual Evnironment
 ------------------------------------
 
@@ -80,6 +83,7 @@ Preparing Python Virtual Evnironment
 
     . pre_virt_env.sh
 
+
 Excuting Specified Testcase
 ---------------------------
 
@@ -111,6 +115,14 @@ The second is using python interpreter.
     docker exec bottleneckcompose_bottlenecks_1 python ${POSCA_SCRIPT}/run_posca.py [testcase <testcase>] [teststory <teststory>]
 
 
+Showing Report
+--------------
+
+Bottlenecks uses ELK to illustrate the testing results.
+Asumming IP of the SUT (System Under Test) is denoted as ipaddr,
+then the address of Kibana is http://[ipaddr]:5601. One can visit this address to see the illustrations.
+Address for elasticsearch is http://[ipaddr]:9200. One can use any Rest Tool to visit the testing data stored in elasticsearch.
+
 Cleaning Up Environment
 -----------------------
 
@@ -119,6 +131,14 @@ Cleaning Up Environment
     . rm_virt_env.sh
 
 
+If you want to clean the dockers that established during the test, you can excute the additional commands below.
+
+.. code-block:: bash
+
+    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
+
+
 Run POSCA through Community CI
 ==============================
 * POSCA test cases are runned by OPNFV CI now. See https://build.opnfv.org for more information.