diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configguide/configuration.rst | 6 | ||||
| -rw-r--r-- | docs/configguide/index.rst | 7 | ||||
| -rw-r--r-- | docs/download/sample_config.yaml (renamed from docs/templates/sample_config.yaml) | 0 | ||||
| -rw-r--r-- | docs/overview/index.rst (renamed from docs/templates/index.rst) | 10 | ||||
| -rw-r--r-- | docs/overview/overview.rst (renamed from docs/userguide/overview.rst) | 5 | ||||
| -rw-r--r-- | docs/userguide/_01-compute.rst (renamed from docs/userguide/01-compute.rst) | 5 | ||||
| -rw-r--r-- | docs/userguide/_02-network.rst (renamed from docs/userguide/02-network.rst) | 4 | ||||
| -rw-r--r-- | docs/userguide/_03-storage.rst (renamed from docs/userguide/03-storage.rst) | 4 | ||||
| -rw-r--r-- | docs/userguide/_testcase_description.rst (renamed from docs/templates/testcase_description_v2_template.rst) | 5 | ||||
| -rw-r--r-- | docs/userguide/annex.rst | 19 | ||||
| -rw-r--r-- | docs/userguide/benchmark-suites.rst | 12 | ||||
| -rw-r--r-- | docs/userguide/index.rst | 15 | ||||
| -rw-r--r-- | docs/userguide/introduction.rst | 6 |
13 files changed, 61 insertions, 37 deletions
diff --git a/docs/configguide/configuration.rst b/docs/configguide/configuration.rst index a9bb6b1a..e5228541 100644 --- a/docs/configguide/configuration.rst +++ b/docs/configguide/configuration.rst @@ -3,9 +3,9 @@ .. (c) 2015 Dell Inc. .. (c) 2016 ZTE Corp. - -Qtip configuration -================== +************* +Configuration +************* QTIP currently supports by using a Docker image or by pulling the repo from the upstream repository found at https://git.opnfv.org/qtip. Detailed steps diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst index e8b6f4e1..291a809b 100644 --- a/docs/configguide/index.rst +++ b/docs/configguide/index.rst @@ -3,9 +3,10 @@ .. (c) 2015 Dell Inc. .. (c) 2016 ZTE Corp. -**************** -QTIP Configguide -**************** + +================= +QTIP Config Guide +================= .. toctree:: :maxdepth: 2 diff --git a/docs/templates/sample_config.yaml b/docs/download/sample_config.yaml index 13f6d3fe..13f6d3fe 100644 --- a/docs/templates/sample_config.yaml +++ b/docs/download/sample_config.yaml diff --git a/docs/templates/index.rst b/docs/overview/index.rst index 1a8bc649..731b8d49 100644 --- a/docs/templates/index.rst +++ b/docs/overview/index.rst @@ -1,13 +1,13 @@ .. 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. -************** -QTIP Templates -************** + +===================== +QTIP Project Overview +===================== .. toctree:: :maxdepth: 2 - ./testcase_description_v2_template.rst + ./overview.rst diff --git a/docs/userguide/overview.rst b/docs/overview/overview.rst index 82b7de91..aa09c7c3 100644 --- a/docs/userguide/overview.rst +++ b/docs/overview/overview.rst @@ -3,10 +3,9 @@ .. (c) 2015 Dell Inc. .. (c) 2016 ZTE Corp. - -******** +======== Overview -******** +======== .. _QTIP: https://wiki.opnfv.org/platform_performance_benchmarking diff --git a/docs/userguide/01-compute.rst b/docs/userguide/_01-compute.rst index 7a2f09f5..7cd4c2ce 100644 --- a/docs/userguide/01-compute.rst +++ b/docs/userguide/_01-compute.rst @@ -4,9 +4,8 @@ .. (c) 2016 ZTE Corp. -Compute test cases -================== - +Compute Suite +============= Introduction ------------ diff --git a/docs/userguide/02-network.rst b/docs/userguide/_02-network.rst index c556642b..13697aba 100644 --- a/docs/userguide/02-network.rst +++ b/docs/userguide/_02-network.rst @@ -4,8 +4,8 @@ .. (c) 2016 ZTE Corp. -Network test cases -================== +Network Suite +============= QTIP uses IPerf3 as the main tool for testing the network throughput. There are three tests that are run through the QTIP framework. diff --git a/docs/userguide/03-storage.rst b/docs/userguide/_03-storage.rst index ea3bb4f3..b1490432 100644 --- a/docs/userguide/03-storage.rst +++ b/docs/userguide/_03-storage.rst @@ -4,8 +4,8 @@ .. (c) 2016 ZTE Corp. -Storage test cases -================== +Storage Suite +============= The QTIP benchmark suite aims to evaluate storage components within an OPNFV platform. For Brahamaputra release, FIO would evaluate File System performance for the host machine. diff --git a/docs/templates/testcase_description_v2_template.rst b/docs/userguide/_testcase_description.rst index d68509f8..d60ca949 100644 --- a/docs/templates/testcase_description_v2_template.rst +++ b/docs/userguide/_testcase_description.rst @@ -4,9 +4,8 @@ Upload the .rst for the test case in /docs/ directory. Review in Gerrit. -************************************* -QTIP Test Case Description TCXXX -************************************* +Test Case Description +===================== +-----------------------------------------------------------------------------+ |test case slogan e.g. Network throughput | diff --git a/docs/userguide/annex.rst b/docs/userguide/annex.rst new file mode 100644 index 00000000..406d5132 --- /dev/null +++ b/docs/userguide/annex.rst @@ -0,0 +1,19 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 ZTE Corp. + + +***** +Annex +***** + +Templates +========= + +.. include:: _testcase_description.rst + + +Downloads +========= + +- :download:`Sample configuration <../download/sample_config.yaml>`
\ No newline at end of file diff --git a/docs/userguide/benchmark-suites.rst b/docs/userguide/benchmark-suites.rst new file mode 100644 index 00000000..9a3929cc --- /dev/null +++ b/docs/userguide/benchmark-suites.rst @@ -0,0 +1,12 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 ZTE Corp. + + +**************** +Benchmark Suites +**************** + +.. include:: _01-compute.rst +.. include:: _02-network.rst +.. include:: _03-storage.rst diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index 202bf66e..3032f357 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -4,18 +4,13 @@ .. (c) 2016 ZTE Corp. -************** -QTIP Userguide -************** - -Colorado 1.0 ------------- +=============== +QTIP User Guide +=============== .. toctree:: :maxdepth: 2 - ./overview.rst ./introduction.rst - ./01-compute.rst - ./02-network.rst - ./03-storage.rst + ./benchmark-suites.rst + ./annex.rst diff --git a/docs/userguide/introduction.rst b/docs/userguide/introduction.rst index b874ea46..2655347e 100644 --- a/docs/userguide/introduction.rst +++ b/docs/userguide/introduction.rst @@ -4,9 +4,9 @@ .. (c) 2016 ZTE Corp. -***************** -Qtip Introduction -***************** +************ +Introduction +************ This guide will serve as a first step to familiarize the user with how to run QTIP the first time when the user clones QTIP on to their host machine. |