summaryrefslogtreecommitdiffstats
path: root/docs/templates
diff options
context:
space:
mode:
authorJulien <zhang.jun3g@zte.com.cn>2016-08-14 18:20:04 +0800
committerYujun Zhang <zhang.yujunz@zte.com.cn>2016-08-15 10:56:13 +0800
commitbccbfad3b977dbce91a1fa5d1d02f7a6b0070f97 (patch)
treee410d653d4e4521004b7d88d2cf9ed57ab77f6e4 /docs/templates
parentf13e8325c532f63c48ceaefc740f09cb55adc026 (diff)
Doc updates according to DOCS project
Upddating QTIP docs according to DOCS project wiki in: https://wiki.opnfv.org/display/DOC/Configurartion+guide and https://wiki.opnfv.org/display/DOC/Userguide JIRA: QTIP-102 Change-Id: Iab5bdcf3f290bc88d2fedc8a0153e26daf89cde8 Signed-off-by: Julien <zhang.jun3g@zte.com.cn>
Diffstat (limited to 'docs/templates')
-rw-r--r--docs/templates/index.rst35
-rw-r--r--docs/templates/sample_config.yaml50
2 files changed, 59 insertions, 26 deletions
diff --git a/docs/templates/index.rst b/docs/templates/index.rst
index c893df6f..1a8bc649 100644
--- a/docs/templates/index.rst
+++ b/docs/templates/index.rst
@@ -1,30 +1,13 @@
-.. OPNFV Release Engineering documentation, created by
- sphinx-quickstart on Tue Jun 9 19:12:31 2015.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2015 Dell Inc.
+.. (c) 2016 ZTE Corp.
-.. image:: ../etc/opnfv-logo.png
- :height: 40
- :width: 200
- :alt: OPNFV
- :align: left
-
-Example Documentation table of contents
-=======================================
-
-Contents:
+**************
+QTIP Templates
+**************
.. toctree::
- :numbered:
- :maxdepth: 4
-
- testcase_description_v2_template.rst
-
-Indices and tables
-==================
-
-* :ref:`search`
-
-Revision: _sha1_
+ :maxdepth: 2
-Build date: |today|
+ ./testcase_description_v2_template.rst
diff --git a/docs/templates/sample_config.yaml b/docs/templates/sample_config.yaml
new file mode 100644
index 00000000..8dcaa11c
--- /dev/null
+++ b/docs/templates/sample_config.yaml
@@ -0,0 +1,50 @@
+ ## This is a sample Config.yaml file
+
+#Scenario would define the test case scenario.
+#The benchmark key contains the benchmark to run such as dhrystone,whetstone,dpi,ssh etc.
+# Host and server list the different machines on which the benchmark would run.
+# On machines listed within hosts, the benchmarks would run in parallel.
+# On machines listed within server, the benchmarks would run when the benechmarks running on hosts have been completed.
+# This has been used to control the folow of the testcase. For example, running the testcases on a vm vs hostmachin, we would like to run the test case serially. It should run first on the host machine and then on the vm. This testcase flow control could be used for other testcases to be developed such as those for networking.
+Scenario:
+ benchmark: dhrystone
+ host: machine_1, machine_2, virtualmachine_1
+ server:
+
+
+#Context would define the environment on which to run:
+#Host Machine keys would contain Host_Machines/ Baremetal machines to run the benchmarks on
+#e.g in Host Machine , machine_1 and machine_2 are the bare metal machines. For each baremetal machine its IP(which should be reachable from the location on which you run QTIP), passwords and its role(host or server)
+Context:
+ Host_Machines:
+ machine_1:
+ ip: 172.18.0.16
+ pw: Op3nStack
+ role: host
+ Virtual_Machines:
+ virtualmachine_1:
+ availability_zone: nova
+ public_network: 'net04_ext'
+ OS_image: QTIP_CentOS
+ flavor: m1.large
+ role: server
+#Proxy_Environment key was optional.If all the Machines could access the public network, no need to define Proxy_Environment.Could be used later for getting http,https proxy infos which would be setted on all the Host_Manchines and Virtual_Machines.
+ Proxy_Environment:
+ http_proxy: http://10.20.0.1:8118
+ https_proxy: http://10.20.0.1:8118
+ no_proxy: localhost,127.0.0.1,10.20.*,192.168.*
+
+# A general description of the testcase. Could be used later for reports.
+Test_Description:
+ Test_category: "Compute"
+ Benchmark: "dhrystone"
+ Overview: >
+ ''' This test will run the dhrystone benchmark in serial on machine_1 and machine_2.\n
+ if you wish to add a virtual machine add the following information under the Virtual_Machine tag
+
+ virtualmachine_1:
+ availability_zone:
+ public_network:
+ OS_image:
+ flavor:
+ role: '''