Merge "Add pod.yaml files for Apex"
[yardstick.git] / docs / testing / user / userguide / 10-yardstick-user-interface.rst
1 ========================
2 Yardstick User Interface
3 ========================
4
5 This interface provides a user to view the test result
6 in table format and also values pinned on to a graph.
7
8
9 Command
10 =======
11 ::
12
13     yardstick report generate <task-ID> <testcase-filename>
14
15
16 Description
17 ===========
18
19 1. When the command is triggered using the task-id and the testcase
20 name provided the respective values are retrieved from the
21 database (influxdb in this particular case).
22
23 2. The values are then formatted and then provided to the html
24 template framed with complete html body using Django Framework.
25
26 3. Then the whole template is written into a html file.
27
28 The graph is framed with Timestamp on x-axis and output values
29 (differ from testcase to testcase) on y-axis with the help of
30 "Highcharts".