aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorYujun Zhang <zhang.yujunz@zte.com.cn>2017-02-18 23:50:47 +0800
committerYujun Zhang <zhang.yujunz@zte.com.cn>2017-02-18 23:50:47 +0800
commitb9de54adc5963e54303dccf5930f6b20cc445dae (patch)
tree557ba58f02b53f26dd1b03ab3cb02186fda6a2c0 /docs
parent93421c6375a450baa7bedb323e36b5efd238a58d (diff)
Migrate to Danube document guide
https://wiki.opnfv.org/display/DOC Change-Id: I85535f158022fe0aeb7c888273dc81fbbf4ddeda Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
Diffstat (limited to 'docs')
-rw-r--r--docs/development/design/apidocs/index.rst (renamed from docs/apidocs/index.rst)0
-rw-r--r--docs/development/design/apidocs/qtip_restful_api.rst (renamed from docs/apidocs/qtip_restful_api.rst)0
-rw-r--r--docs/development/design/compute_QPI.rst (renamed from docs/designspec/compute_QPI.rst)0
-rw-r--r--docs/development/design/dashboard.rst (renamed from docs/designspec/dashboard.rst)0
-rw-r--r--docs/development/design/index.rst (renamed from docs/designspec/index.rst)0
-rw-r--r--docs/development/design/integration_with_yardstick.rst (renamed from docs/designspec/integration_with_yardstick.rst)0
-rw-r--r--docs/development/overview/.gitkeep0
-rw-r--r--docs/development/requirement/.gitkeep0
-rw-r--r--docs/download/sample_config.yaml50
-rw-r--r--docs/overview/index.rst14
-rw-r--r--docs/overview/overview.rst21
-rw-r--r--docs/release/configguide/configuration.rst (renamed from docs/configguide/configuration.rst)0
-rw-r--r--docs/release/configguide/index.rst (renamed from docs/configguide/index.rst)0
-rw-r--r--docs/release/installation/.gitkeep0
-rw-r--r--docs/release/release-notes/brahmaputra.rst (renamed from docs/releasenotes/brahmaputra.rst)0
-rw-r--r--docs/release/release-notes/index.rst (renamed from docs/releasenotes/index.rst)0
-rw-r--r--docs/release/scenarios/.gitkeep0
-rw-r--r--docs/release/userguide/_01-compute.rst (renamed from docs/userguide/_01-compute.rst)0
-rw-r--r--docs/release/userguide/_02-network.rst (renamed from docs/userguide/_02-network.rst)0
-rw-r--r--docs/release/userguide/_03-storage.rst (renamed from docs/userguide/_03-storage.rst)0
-rw-r--r--docs/release/userguide/_testcase_description.rst (renamed from docs/userguide/_testcase_description.rst)0
-rw-r--r--docs/release/userguide/annex.rst (renamed from docs/userguide/annex.rst)0
-rw-r--r--docs/release/userguide/benchmark-suites.rst (renamed from docs/userguide/benchmark-suites.rst)0
-rw-r--r--docs/release/userguide/index.rst (renamed from docs/userguide/index.rst)0
-rw-r--r--docs/release/userguide/introduction.rst (renamed from docs/userguide/introduction.rst)0
-rw-r--r--docs/testing/.gitkeep0
26 files changed, 0 insertions, 85 deletions
diff --git a/docs/apidocs/index.rst b/docs/development/design/apidocs/index.rst
index 241a2680..241a2680 100644
--- a/docs/apidocs/index.rst
+++ b/docs/development/design/apidocs/index.rst
diff --git a/docs/apidocs/qtip_restful_api.rst b/docs/development/design/apidocs/qtip_restful_api.rst
index 06c01292..06c01292 100644
--- a/docs/apidocs/qtip_restful_api.rst
+++ b/docs/development/design/apidocs/qtip_restful_api.rst
diff --git a/docs/designspec/compute_QPI.rst b/docs/development/design/compute_QPI.rst
index 2e5aa87c..2e5aa87c 100644
--- a/docs/designspec/compute_QPI.rst
+++ b/docs/development/design/compute_QPI.rst
diff --git a/docs/designspec/dashboard.rst b/docs/development/design/dashboard.rst
index 60c4720d..60c4720d 100644
--- a/docs/designspec/dashboard.rst
+++ b/docs/development/design/dashboard.rst
diff --git a/docs/designspec/index.rst b/docs/development/design/index.rst
index b6dd0c01..b6dd0c01 100644
--- a/docs/designspec/index.rst
+++ b/docs/development/design/index.rst
diff --git a/docs/designspec/integration_with_yardstick.rst b/docs/development/design/integration_with_yardstick.rst
index a8298d6f..a8298d6f 100644
--- a/docs/designspec/integration_with_yardstick.rst
+++ b/docs/development/design/integration_with_yardstick.rst
diff --git a/docs/development/overview/.gitkeep b/docs/development/overview/.gitkeep
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/docs/development/overview/.gitkeep
diff --git a/docs/development/requirement/.gitkeep b/docs/development/requirement/.gitkeep
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/docs/development/requirement/.gitkeep
diff --git a/docs/download/sample_config.yaml b/docs/download/sample_config.yaml
deleted file mode 100644
index 13f6d3fe..00000000
--- a/docs/download/sample_config.yaml
+++ /dev/null
@@ -1,50 +0,0 @@
- ## 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/docs/overview/index.rst b/docs/overview/index.rst
deleted file mode 100644
index 9a387360..00000000
--- a/docs/overview/index.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-.. 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/docs/overview/overview.rst b/docs/overview/overview.rst
deleted file mode 100644
index 4fd42356..00000000
--- a/docs/overview/overview.rst
+++ /dev/null
@@ -1,21 +0,0 @@
-.. 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.
diff --git a/docs/configguide/configuration.rst b/docs/release/configguide/configuration.rst
index 78e96492..78e96492 100644
--- a/docs/configguide/configuration.rst
+++ b/docs/release/configguide/configuration.rst
diff --git a/docs/configguide/index.rst b/docs/release/configguide/index.rst
index d5e05d63..d5e05d63 100644
--- a/docs/configguide/index.rst
+++ b/docs/release/configguide/index.rst
diff --git a/docs/release/installation/.gitkeep b/docs/release/installation/.gitkeep
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/docs/release/installation/.gitkeep
diff --git a/docs/releasenotes/brahmaputra.rst b/docs/release/release-notes/brahmaputra.rst
index 92fafd80..92fafd80 100644
--- a/docs/releasenotes/brahmaputra.rst
+++ b/docs/release/release-notes/brahmaputra.rst
diff --git a/docs/releasenotes/index.rst b/docs/release/release-notes/index.rst
index 5d045388..5d045388 100644
--- a/docs/releasenotes/index.rst
+++ b/docs/release/release-notes/index.rst
diff --git a/docs/release/scenarios/.gitkeep b/docs/release/scenarios/.gitkeep
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/docs/release/scenarios/.gitkeep
diff --git a/docs/userguide/_01-compute.rst b/docs/release/userguide/_01-compute.rst
index 56be5488..56be5488 100644
--- a/docs/userguide/_01-compute.rst
+++ b/docs/release/userguide/_01-compute.rst
diff --git a/docs/userguide/_02-network.rst b/docs/release/userguide/_02-network.rst
index 00fe5b0a..00fe5b0a 100644
--- a/docs/userguide/_02-network.rst
+++ b/docs/release/userguide/_02-network.rst
diff --git a/docs/userguide/_03-storage.rst b/docs/release/userguide/_03-storage.rst
index b1490432..b1490432 100644
--- a/docs/userguide/_03-storage.rst
+++ b/docs/release/userguide/_03-storage.rst
diff --git a/docs/userguide/_testcase_description.rst b/docs/release/userguide/_testcase_description.rst
index d60ca949..d60ca949 100644
--- a/docs/userguide/_testcase_description.rst
+++ b/docs/release/userguide/_testcase_description.rst
diff --git a/docs/userguide/annex.rst b/docs/release/userguide/annex.rst
index e8bf5555..e8bf5555 100644
--- a/docs/userguide/annex.rst
+++ b/docs/release/userguide/annex.rst
diff --git a/docs/userguide/benchmark-suites.rst b/docs/release/userguide/benchmark-suites.rst
index 84d1c647..84d1c647 100644
--- a/docs/userguide/benchmark-suites.rst
+++ b/docs/release/userguide/benchmark-suites.rst
diff --git a/docs/userguide/index.rst b/docs/release/userguide/index.rst
index 4be3e498..4be3e498 100644
--- a/docs/userguide/index.rst
+++ b/docs/release/userguide/index.rst
diff --git a/docs/userguide/introduction.rst b/docs/release/userguide/introduction.rst
index 3147f0aa..3147f0aa 100644
--- a/docs/userguide/introduction.rst
+++ b/docs/release/userguide/introduction.rst
diff --git a/docs/testing/.gitkeep b/docs/testing/.gitkeep
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/docs/testing/.gitkeep