Merge "Migrate to Danube document guide"

3 files changed, 85 insertions, 0 deletions

diff --git a/legacy/docs/download/sample_config.yaml b/legacy/docs/download/sample_config.yaml
new file mode 100644
index 00000000..13f6d3fe
--- /dev/null
+++ b/legacy/docs/download/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). If your installer is 'fuel' or 'compass' and you left baremetal machine IP empty,qtip will get compute node ip from installer automaticly.
+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: '''
diff --git a/legacy/docs/overview/index.rst b/legacy/docs/overview/index.rst
new file mode 100644
index 00000000..9a387360
--- /dev/null
+++ b/legacy/docs/overview/index.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2016 ZTE Corp.
+
+
+
+#####################
+QTIP Project Overview
+#####################
+
+.. toctree::
+   :maxdepth: 2
+
+   ./overview.rst
diff --git a/legacy/docs/overview/overview.rst b/legacy/docs/overview/overview.rst
new file mode 100644
index 00000000..4fd42356
--- /dev/null
+++ b/legacy/docs/overview/overview.rst
@@ -0,0 +1,21 @@
+.. 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.
+
+********
+Overview
+********
+
+.. _QTIP: https://wiki.opnfv.org/platform_performance_benchmarking
+
+QTIP_ is an OPNFV Project.
+
+QTIP aims to benchmark OPNFV platforms through a "Bottom up" approach, testing
+bare-metal components first.
+
+The overall problem this project tries to solve is the general
+characterization of an OPNFV platform. It will focus on general performance
+questions that are common to the platform itself, or applicable to multiple
+OPNFV use cases. QTIP will provide the capability to quantify a platform's
+performance behavior in a standardized, rigorous, and open way.