diff options
| -rw-r--r-- | docs/testing/developer/devguide/_assets/sequence.png (renamed from docs/testing/developer/design/_assets/sequence.png) | bin | 44132 -> 44132 bytes | |||
| -rw-r--r-- | docs/testing/developer/devguide/_assets/standalone.png (renamed from docs/testing/developer/design/_assets/standalone.png) | bin | 47515 -> 47515 bytes | |||
| -rw-r--r-- | docs/testing/developer/devguide/api.rst (renamed from docs/testing/developer/design/api.rst) | 0 | ||||
| -rw-r--r-- | docs/testing/developer/devguide/arch.rst (renamed from docs/testing/developer/design/arch.rst) | 0 | ||||
| -rw-r--r-- | docs/testing/developer/devguide/cli.rst (renamed from docs/testing/developer/design/cli.rst) | 0 | ||||
| -rw-r--r-- | docs/testing/developer/devguide/compute-qpi.rst (renamed from docs/testing/developer/design/compute-qpi.rst) | 0 | ||||
| -rw-r--r-- | docs/testing/developer/devguide/index.rst (renamed from docs/testing/developer/design/index.rst) | 0 | ||||
| -rw-r--r-- | docs/testing/user/userguide/cli.rst | 6 | ||||
| -rw-r--r-- | docs/testing/user/userguide/index.rst | 1 | ||||
| -rw-r--r-- | docs/testing/user/userguide/overview.rst | 32 |
10 files changed, 39 insertions, 0 deletions
diff --git a/docs/testing/developer/design/_assets/sequence.png b/docs/testing/developer/devguide/_assets/sequence.png Binary files differindex b15458bf..b15458bf 100644 --- a/docs/testing/developer/design/_assets/sequence.png +++ b/docs/testing/developer/devguide/_assets/sequence.png diff --git a/docs/testing/developer/design/_assets/standalone.png b/docs/testing/developer/devguide/_assets/standalone.png Binary files differindex 50222b5b..50222b5b 100644 --- a/docs/testing/developer/design/_assets/standalone.png +++ b/docs/testing/developer/devguide/_assets/standalone.png diff --git a/docs/testing/developer/design/api.rst b/docs/testing/developer/devguide/api.rst index eb2b0d67..eb2b0d67 100644 --- a/docs/testing/developer/design/api.rst +++ b/docs/testing/developer/devguide/api.rst diff --git a/docs/testing/developer/design/arch.rst b/docs/testing/developer/devguide/arch.rst index d95faba6..d95faba6 100644 --- a/docs/testing/developer/design/arch.rst +++ b/docs/testing/developer/devguide/arch.rst diff --git a/docs/testing/developer/design/cli.rst b/docs/testing/developer/devguide/cli.rst index 487bdec5..487bdec5 100644 --- a/docs/testing/developer/design/cli.rst +++ b/docs/testing/developer/devguide/cli.rst diff --git a/docs/testing/developer/design/compute-qpi.rst b/docs/testing/developer/devguide/compute-qpi.rst index 2e5aa87c..2e5aa87c 100644 --- a/docs/testing/developer/design/compute-qpi.rst +++ b/docs/testing/developer/devguide/compute-qpi.rst diff --git a/docs/testing/developer/design/index.rst b/docs/testing/developer/devguide/index.rst index 2b4bd9b0..2b4bd9b0 100644 --- a/docs/testing/developer/design/index.rst +++ b/docs/testing/developer/devguide/index.rst diff --git a/docs/testing/user/userguide/cli.rst b/docs/testing/user/userguide/cli.rst index 19420bd1..96026c5b 100644 --- a/docs/testing/user/userguide/cli.rst +++ b/docs/testing/user/userguide/cli.rst @@ -38,6 +38,12 @@ as above. An important thing to remember is to provide absolute path of result d qtip plan run <plan_name> -p $PWD/result Similarly, the same commands can be used for the other two components making up the plans, i.e QPI's and metrics. +For example, in order to run a single metric +:: + + qtip metric run <metric_name> -p $PWD/result + +The same can be applied for a QPI. QTIP also provides the utility to view benchmarking results on the console. One just need to provide to where the results are stored. Extending the example above diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst index 78c5d117..96d077c0 100644 --- a/docs/testing/user/userguide/index.rst +++ b/docs/testing/user/userguide/index.rst @@ -11,5 +11,6 @@ QTIP User Guide .. toctree:: :maxdepth: 2 + overview.rst cli.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/ |
