aboutsummaryrefslogtreecommitdiffstats
path: root/docs/userguide/06-apexlake_api.rst
diff options
context:
space:
mode:
authorliang gao <jean.gaoliang@huawei.com>2016-08-21 03:21:16 +0000
committerGerrit Code Review <gerrit@172.30.200.206>2016-08-21 03:21:16 +0000
commitbd97bf5dddf4411c6c51939b55ef19c985d526cd (patch)
tree7efa297fc138516bf3b543e08de8c3a21099e904 /docs/userguide/06-apexlake_api.rst
parente5a2154bf5c2a18c661fa3fba540c172f177dec1 (diff)
parent5a7bd787c86bf706153b3cc6f41fc8d35569c955 (diff)
Merge "Restructure user-guide"
Diffstat (limited to 'docs/userguide/06-apexlake_api.rst')
-rw-r--r--docs/userguide/06-apexlake_api.rst89
1 files changed, 89 insertions, 0 deletions
diff --git a/docs/userguide/06-apexlake_api.rst b/docs/userguide/06-apexlake_api.rst
new file mode 100644
index 000000000..35a1dbe3e
--- /dev/null
+++ b/docs/userguide/06-apexlake_api.rst
@@ -0,0 +1,89 @@
+.. 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