From fd54fcc22170aa880fc49730730ad80896e2e608 Mon Sep 17 00:00:00 2001
From: rexlee8776 <limingjiang@huawei.com>
Date: Wed, 8 Mar 2017 07:12:55 +0000
Subject: Yardstick Preliminary Documentation

JIRA: YARDSTICK-554

align with opnfvdocs path structure about testing projects

Change-Id: I6c2f2d37e41447dccd76b9f4426d00fd85cb1e3b
Signed-off-by: rexlee8776 <limingjiang@huawei.com>
---
 docs/testing/user/userguide/06-apexlake_api.rst | 89 +++++++++++++++++++++++++
 1 file changed, 89 insertions(+)
 create mode 100644 docs/testing/user/userguide/06-apexlake_api.rst

(limited to 'docs/testing/user/userguide/06-apexlake_api.rst')

diff --git a/docs/testing/user/userguide/06-apexlake_api.rst b/docs/testing/user/userguide/06-apexlake_api.rst
new file mode 100644
index 000000000..35a1dbe3e
--- /dev/null
+++ b/docs/testing/user/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
-- 
cgit 1.2.3-korg