From 38fede733887c328ce6f457838dd712c9384a819 Mon Sep 17 00:00:00 2001 From: Yujun Zhang Date: Tue, 1 Nov 2016 16:59:52 +0800 Subject: Outline of QPI dashboard design specification. JIRA: QTIP-126 Change-Id: Id7f116fb479617d56edfb9b1513fd0fb508b6383 Signed-off-by: Yujun Zhang --- docs/designspec/dashboard.rst | 70 +++++++++++++++++++++++++++++++++++++++++++ docs/designspec/index.rst | 13 ++++++++ 2 files changed, 83 insertions(+) create mode 100644 docs/designspec/dashboard.rst create mode 100644 docs/designspec/index.rst (limited to 'docs') diff --git a/docs/designspec/dashboard.rst b/docs/designspec/dashboard.rst new file mode 100644 index 00000000..ad5520b6 --- /dev/null +++ b/docs/designspec/dashboard.rst @@ -0,0 +1,70 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 ZTE Corp. + + +********* +Dashboard +********* + +The dashboard gives user an intuitive view of benchmark result. + +Purpose +======= + +The basic element to be displayed is QPI a.k.a. QTIP Performance Index. But it +is also important to show user + +#. How is the final score calculated? +#. Under what condition is the test plan executed? +#. How many runs of a performance tests have been executed and is there any deviation? +#. Comparison of benchmark result from different PODs or configuration + +Templates +========= + +Different board templates are created to satisfy the above requirements. + +Composition +----------- + +QTIP gives a simple score but there must be a complex formula behind it. This +view explains the composition of the QPI. + +Condition +--------- + +The condition of a benchmark result includes + +* System Under Test + + * Hardware environment + * Hypervisor version + * Operation System release version + * System Configuration + +* Test Tools + + * Release version + * Configuration + +* Test Facility + + * Laboratory + * Engineer + * Date + +Conditions that do NOT have an obvious affect on the test result may be ignored, +e.g. temperature, power supply. + +Deviation +--------- + +Performance tests are usually repeated many times to reduce random disturbance. +This view shall show an overview of deviation among different runs. + +Comparison +---------- + +Comparison can be done between different PODs or different configuration on the +same PODs. diff --git a/docs/designspec/index.rst b/docs/designspec/index.rst new file mode 100644 index 00000000..e9b3f9fd --- /dev/null +++ b/docs/designspec/index.rst @@ -0,0 +1,13 @@ +.. 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 Design Specifications +########################## + +.. toctree:: + :maxdepth: 2 + + dashboard.rst -- cgit 1.2.3-korg