aboutsummaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide
diff options
context:
space:
mode:
authorYujun Zhang <zhang.yujunz@zte.com.cn>2017-03-23 17:12:45 +0800
committerYujun Zhang <zhang.yujunz@zte.com.cn>2017-03-28 13:56:57 +0800
commit49fb80ed6d849af903c45238cf00e08e79167a83 (patch)
treec18d11bac148e4ce013fe223b87b4ed15547f591 /docs/testing/user/userguide
parentfe8d49ebb1b563a1831341b049090388281127d3 (diff)
Add project introduction
Change-Id: I5d0553f0ccec571f9db90b2fd8f25f0941f00b03 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
Diffstat (limited to 'docs/testing/user/userguide')
-rw-r--r--docs/testing/user/userguide/index.rst1
-rw-r--r--docs/testing/user/userguide/overview.rst32
2 files changed, 33 insertions, 0 deletions
diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst
index 576a988d..04a12f08 100644
--- a/docs/testing/user/userguide/index.rst
+++ b/docs/testing/user/userguide/index.rst
@@ -11,6 +11,7 @@ QTIP User Guide
.. toctree::
:maxdepth: 2
+ overview.rst
cli.rst
api.rst
qpi-compute.rst
diff --git a/docs/testing/user/userguide/overview.rst b/docs/testing/user/userguide/overview.rst
new file mode 100644
index 00000000..1ad0b670
--- /dev/null
+++ b/docs/testing/user/userguide/overview.rst
@@ -0,0 +1,32 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2017 ZTE Corp.
+
+
+############
+Introduction
+############
+
+`QTIP`_ is the project for **Platform Performance Benchmarking** in `OPNFV`_. It aims to provide user a simple indicator
+for performance, simple but supported by comprehensive testing data and transparent calculation formula.
+
+QTIP introduces a concept called **QPI**, a.k.a. QTIP Performance Index, which aims to be a **TRUE** indicator of
+performance. **TRUE** reflects the core value of QPI in four aspects
+
+- *Transparent*: being an open source project, user can inspect all details behind QPI, e.g. formulas, metrics, raw data
+- *Reliable*: the integrity of QPI will be guaranteed by traceability in each step back to raw test result
+- *Understandable*: QPI is broke down into section scores, and workload scores in report to help user to understand
+- *Extensible*: users may create their own QPI by composing the existed metrics in QTIP or extend new metrics
+
+##########
+Benchmarks
+##########
+
+The builtin benchmarks of QTIP are located in ``<package_root>/benchmarks`` folder
+
+- *QPI*: specifications about how an QPI is calculated and sources of metrics
+- *metric*: performance metrics referred in QPI, currently it is categorized by performance testing tools
+- *plan*: executable benchmarking plan which collects metrics and calculate QPI
+
+.. _QTIP: https://wiki.opnfv.org/display/qtip
+.. _OPNFV: https://www.opnfv.org/