Use Case View Part Of SWA

this part will show some use case to help users to use yardstick

Change-Id: If521bebaff066185ba59ffa5ab35347915818926
Signed-off-by: kubi <jean.gaoliang@huawei.com>
(cherry picked from commit e2876079f91b617bbcfc63b1e75e808319b8cd75)

diff --git a/docs/userguide/architecture.rst b/docs/userguide/architecture.rst
index ccf8d48..c34a3c8 100644 (file)
--- a/docs/userguide/architecture.rst
+++ b/docs/userguide/architecture.rst
@@ -127,7 +127,32 @@ Snippet of an Iteration runner configuration:
 
 Use-Case View
 =============
-TBD(kubi)
+Yardstick Use-Case View shows two kinds of users. One is the Tester who will
+do testing in cloud, the other is the User who is more concerned with test result
+and result analyses.
+
+For testers, they will run a single test case or test case suite to verify
+infrastructure compliance or bencnmark their own infrastructure performance.
+Test result will be stored by dispatcher module, three kinds of store method
+(file, influxdb and http) can be configured. The detail information of
+scenarios and runners can be queried with CLI by testers.
+
+For users, they would check test result with four ways.
+
+If dispatcher module is configured as file(default), there are two ways to
+check test result. One is to get result from yardstick.out ( default path:
+/tmp/yardstick.out), the other is to get plot of test result, it will be shown
+if users execute command "yardstick-plot".
+
+If dispatcher module is configured as influxdb, users will check test
+result on Grafana which is most commonly used for visualizing time series data.
+
+If dispatcher module is configured as http, users will check test result
+on OPNFV testing dashboard which use MongoDB as backend.
+
+.. image:: images/Use_case.png
+   :width: 800px
+   :alt: Yardstick Use-Case View
 
 Logical View
 ============

diff --git a/docs/userguide/images/Use_case.png b/docs/userguide/images/Use_case.png
new file mode 100644 (file)
index 0000000..acd52f5
Binary files /dev/null and b/docs/userguide/images/Use_case.png differ