diff options
| -rwxr-xr-x | docs/userguide/architecture.rst | 52 | ||||
| -rw-r--r-- | docs/userguide/images/Use_case.png | bin | 0 -> 105787 bytes | |||
| -rw-r--r-- | docs/userguide/images/test_execution_flow.png | bin | 0 -> 51473 bytes |
3 files changed, 50 insertions, 2 deletions
diff --git a/docs/userguide/architecture.rst b/docs/userguide/architecture.rst index b03ba6dd5..800e82224 100755 --- 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 ============ @@ -135,7 +160,30 @@ TBD(Qiliang) Process View (Test execution flow) ================================== -TBD(Limingjiang) +Yardstick process view shows how yardstick runs a test case. Below is the +sequence graph about the test execution flow using heat context, and each +object represents one module in yardstick: + +.. image:: images/test_execution_flow.png + :width: 800px + :alt: Yardstick Process View + +A user wants to do a test with yardstick. He can use the CLI to input the +command to start a task. "TaskCommands" will receive the command and ask +"HeatContext" to parse the context. "HeatContext" will then ask "Model" to +convert the model. After the model is generated, "HeatContext" will inform +"Openstack" to deploy the heat stack by heat template. After "Openstack" +deploys the stack, "HeatContext" will inform "Runner" to run the specific test +case. + +Firstly, "Runner" would ask "TestScenario" to process the specific scenario. +Then "TestScenario" will start to log on the openstack by ssh protocal and +execute the test case on the specified VMs. After the script execution +finishes, "TestScenario" will send a message to inform "Runner". When the +testing job is done, "Runner" will inform "Dispatcher" to output the test +result via file, influxdb or http. After the result is output, "HeatContext" +will call "Openstack" to undeploy the heat stack. Once the stack is +undepoyed, the whole test ends. Deployment View =============== diff --git a/docs/userguide/images/Use_case.png b/docs/userguide/images/Use_case.png Binary files differnew file mode 100644 index 000000000..acd52f526 --- /dev/null +++ b/docs/userguide/images/Use_case.png diff --git a/docs/userguide/images/test_execution_flow.png b/docs/userguide/images/test_execution_flow.png Binary files differnew file mode 100644 index 000000000..c20a931a4 --- /dev/null +++ b/docs/userguide/images/test_execution_flow.png |
