1 .. This work is licensed under a Creative Commons Attribution 4.0 International
3 .. http://creativecommons.org/licenses/by/4.0
4 .. (c) OPNFV, Huawei Technologies Co.,Ltd and others.
13 Yardstick support restful API in danube.
20 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
22 Description: This API is used to do some work related to environment. For now, we support:
24 1. Prepare yardstick environment(Including fetch openrc file, get external network and load images)
25 2. Start a InfluxDB docker container and config yardstick output to InfluxDB.
26 3. Start a Grafana docker container and config with the InfluxDB.
28 Which API to call will depend on the Parameters.
34 Prepare Yardstick Environment
38 'action': 'prepareYardstickEnv'
41 This is an asynchronous API. You need to call /yardstick/asynctask API to get the task result.
44 Start and Config InfluxDB docker container
48 'action': 'createInfluxDBContainer'
51 This is an asynchronous API. You need to call /yardstick/asynctask API to get the task result.
54 Start and Config Grafana docker container
58 'action': 'createGrafanaContainer'
61 This is an asynchronous API. You need to call /yardstick/asynctask API to get the task result.
67 Description: This API is used to get the status of asynchronous task
73 Get the status of asynchronous task
76 http://localhost:8888/yardstick/asynctask?task_id=3f3f5e03-972a-4847-a5f8-154f1b31db8c
78 The returned status will be 0(running), 1(finished) and 2(failed).
84 Description: This API is used to list all release test cases now in yardstick.
90 Get a list of release test cases
93 http://localhost:8888/yardstick/testcases
96 /yardstick/testcases/release/action
97 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
99 Description: This API is used to run a yardstick release test case.
105 Run a release test case
109 'action': 'runTestCase',
116 This is an asynchronous API. You need to call /yardstick/results to get the result.
119 /yardstick/testcases/samples/action
120 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
122 Description: This API is used to run a yardstick sample test case.
128 Run a sample test case
132 'action': 'runTestCase',
139 This is an asynchronous API. You need to call /yardstick/results to get the result.
142 /yardstick/testsuites/action
143 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
145 Description: This API is used to run a yardstick test suite.
155 'action': 'runTestSuite',
162 This is an asynchronous API. You need to call /yardstick/results to get the result.
169 Description: This API is used to get the test results of certain task. If you call /yardstick/testcases/samples/action API, it will return a task id. You can use the returned task id to get the results by using this API.
172 Get test results of one task
175 http://localhost:8888/yardstick/results?task_id=3f3f5e03-972a-4847-a5f8-154f1b31db8c
177 This API will return a list of test case result