diff options
| author |   JingLu5 <lvjing5@huawei.com> | 2017-03-28 01:43:21 +0000 |
|---|---|---|
| committer | Jing Lu <lvjing5@huawei.com> | 2017-03-30 09:49:20 +0000 |
| commit | 6c0f8306f7bed99905af7a21fc5171642d3c4827 (patch) | |
| tree | 7ab553bf4677425ad6fd18089deb7916e90b0a74 /docs/testing/user/userguide/10-apexlake_api.rst | |
| parent | b2a79813f57a94b6565fa8f967d10d295010dfff (diff) | |
Refine documentation
Change-Id: I0d3387a520e3decf51bb0f7db53996f148a611d0
Signed-off-by: JingLu5 <lvjing5@huawei.com>
(cherry picked from commit 2347f3977823bfd0c4b1fa832d9046b8a625596b)
Diffstat (limited to 'docs/testing/user/userguide/10-apexlake_api.rst')
| -rw-r--r-- | docs/testing/user/userguide/10-apexlake_api.rst | 89 |
1 files changed, 0 insertions, 89 deletions
diff --git a/docs/testing/user/userguide/10-apexlake_api.rst b/docs/testing/user/userguide/10-apexlake_api.rst deleted file mode 100644 index 35a1dbe3e..000000000 --- a/docs/testing/user/userguide/10-apexlake_api.rst +++ /dev/null @@ -1,89 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International -.. License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Intel Corporation and others. - - -================================= -Apexlake API Interface Definition -================================= - -Abstract --------- - -The API interface provided by the framework to enable the execution of test -cases is defined as follows. - - -init ----- - -**static init()** - - Initializes the Framework - - **Returns** None - - -execute_framework ------------------ - -**static execute_framework** (test_cases, - - iterations, - - heat_template, - - heat_template_parameters, - - deployment_configuration, - - openstack_credentials) - - Executes the framework according the specified inputs - - **Parameters** - - - **test_cases** - - Test cases to be run with the workload (dict() of dict()) - - Example: - test_case = dict() - - test_case[’name’] = ‘module.Class’ - - test_case[’params’] = dict() - - test_case[’params’][’throughput’] = ‘1’ - - test_case[’params’][’vlan_sender’] = ‘1000’ - - test_case[’params’][’vlan_receiver’] = ‘1001’ - - test_cases = [test_case] - - - **iterations** - Number of test cycles to be executed (int) - - - **heat_template** - (string) File name of the heat template corresponding to the workload to be deployed. - It contains the parameters to be evaluated in the form of #parameter_name. - (See heat_templates/vTC.yaml as example). - - - **heat_template_parameters** - (dict) Parameters to be provided as input to the - heat template. See http://docs.openstack.org/developer/heat/ template_guide/hot_guide.html - section “Template input parameters” for further info. - - - **deployment_configuration** - ( dict[string] = list(strings) ) ) Dictionary of parameters - representing the deployment configuration of the workload. - - The key is a string corresponding to the name of the parameter, - the value is a list of strings representing the value to be - assumed by a specific param. The parameters are user defined: - they have to correspond to the place holders (#parameter_name) - specified in the heat template. - - **Returns** dict() containing results |