diff options
Diffstat (limited to 'docs/testing/user')
| -rw-r--r-- | docs/testing/user/configguide/configuration.rst | 6 | ||||
| -rw-r--r-- | docs/testing/user/configguide/index.rst | 6 | ||||
| -rw-r--r-- | docs/testing/user/userguide/api.rst | 13 | ||||
| -rw-r--r-- | docs/testing/user/userguide/cli.rst | 10 | ||||
| -rw-r--r-- | docs/testing/user/userguide/compute.rst (renamed from docs/testing/user/userguide/qpi-compute.rst) | 25 | ||||
| -rw-r--r-- | docs/testing/user/userguide/index.rst | 6 | ||||
| -rw-r--r-- | docs/testing/user/userguide/overview.rst | 10 |
7 files changed, 41 insertions, 35 deletions
diff --git a/docs/testing/user/configguide/configuration.rst b/docs/testing/user/configguide/configuration.rst index 8cc891f0..f048558e 100644 --- a/docs/testing/user/configguide/configuration.rst +++ b/docs/testing/user/configguide/configuration.rst @@ -41,7 +41,7 @@ Run and enter the docker instance :: envs="INSTALLER_TYPE={INSTALLER_TYPE} -e INSTALLER_IP={INSTALLER_IP}" - docker run --name qtip -id -e $envs opnfv/qtip + docker run -p [HOST_IP:]<HOST_PORT>:5000 --name qtip -id -e $envs opnfv/qtip docker exec -i -t qtip /bin/bash ``INSTALLER_TYPE`` should be one of OPNFV installer, e.g. apex, compass, daisy, fuel @@ -68,14 +68,14 @@ Environment configuration Hardware configuration ---------------------- -Qtip does not have specific hardware requriements, and it can runs over any +QTIP does not have specific hardware requriements, and it can runs over any OPNFV installer. Jumphost configuration ---------------------- -Installer Docker on Jumphost, which is used for running Qtip image. +Installer Docker on Jumphost, which is used for running QTIP image. You can refer to these links: diff --git a/docs/testing/user/configguide/index.rst b/docs/testing/user/configguide/index.rst index d5e05d63..43c32cab 100644 --- a/docs/testing/user/configguide/index.rst +++ b/docs/testing/user/configguide/index.rst @@ -4,9 +4,9 @@ .. (c) 2016 ZTE Corp. -################# -QTIP Config Guide -################# +********************************* +QTIP Installation & Configuration +********************************* .. toctree:: :maxdepth: 2 diff --git a/docs/testing/user/userguide/api.rst b/docs/testing/user/userguide/api.rst index 080fef5f..05b0e8f2 100644 --- a/docs/testing/user/userguide/api.rst +++ b/docs/testing/user/userguide/api.rst @@ -1,6 +1,10 @@ -************** -QTIP API Usage -************** +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +*************** +API User Manual +*************** QTIP consists of a number of benchmarking tools or metrics, grouped under QPI's. QPI's map to the different components of an NFVI ecosystem, such as compute, network and storage. Depending on the type of application, @@ -15,8 +19,7 @@ Running After installing QTIP. API server can be run using command ``qtip-api`` on the local machine. -All the resources and their corresponding operation details can be seen at ``/v1.0/ui``, -on hosting server(``0.0.0.0:5000`` for the local machine). +All the resources and their corresponding operation details can be seen at ``/v1.0/ui``. The whole API specification in json format can be seen at ``/v1.0/swagger.json``. diff --git a/docs/testing/user/userguide/cli.rst b/docs/testing/user/userguide/cli.rst index 96026c5b..99efd930 100644 --- a/docs/testing/user/userguide/cli.rst +++ b/docs/testing/user/userguide/cli.rst @@ -1,6 +1,10 @@ -************** -QTIP CLI Usage -************** +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +*************** +CLI User Manual +*************** QTIP consists of a number of benchmarking tools or metrics, grouped under QPI's. QPI's map to the different components of a NFVI ecosystem, such as compute, network and storage. Depending on the type of application, diff --git a/docs/testing/user/userguide/qpi-compute.rst b/docs/testing/user/userguide/compute.rst index d64925bd..f889bfe6 100644 --- a/docs/testing/user/userguide/qpi-compute.rst +++ b/docs/testing/user/userguide/compute.rst @@ -4,11 +4,9 @@ .. (c) 2016 ZTE Corp. -Compute QPI -=========== - -Introduction ------------- +******************************** +Compute Performance Benchmarking +******************************** The compute QPI aims to benchmark the compute components of an OPNFV platform. Such components include, the CPU performance, the memory performance. @@ -23,13 +21,14 @@ Note: The Compute benchmank constains relatively old benchmarks such as dhryston and whetstone. The suite would be updated for better benchmarks such as Linbench for the OPNFV E release. -Getting start with compute QPI ------------------------------- + +Getting started +=============== Notice: All descriptions are based on QTIP container. Inventory File -^^^^^^^^^^^^^^ +-------------- QTIP uses Ansible to trigger benchmark test. Ansible uses an inventory file to determine what hosts to work against. QTIP can automatically generate a inventory @@ -43,7 +42,7 @@ IP addresses. For example: 10.20.0.12 QTIP key Pair -^^^^^^^^^^^^^ +------------- QTIP use a SSH key pair to connect to remote hosts. When users execute compute QPI, QTIP will generate a key pair named *QtipKey* under ``/home/opnfv/qtip/`` and pass @@ -54,8 +53,8 @@ manual. If *CI_DEBUG* is not set or set to *false*, QTIP will delete the key fro remote hosts before the execution ends. Please make sure the key deleted from remote hosts or it can introduce a security flaw. -Commands to run compute QPI -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Commands +-------- In a QTIP container, you can run compute QPI by using QTIP CLI: :: @@ -68,8 +67,8 @@ timestamp name. you can get more details from *userguide/cli.rst*. -Benchmarks ----------- +Metrics +------- The benchmarks include: diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst index 04a12f08..d0d555f8 100644 --- a/docs/testing/user/userguide/index.rst +++ b/docs/testing/user/userguide/index.rst @@ -4,9 +4,9 @@ .. (c) 2016 ZTE Corp. -############### +*************** QTIP User Guide -############### +*************** .. toctree:: :maxdepth: 2 @@ -14,4 +14,4 @@ QTIP User Guide overview.rst cli.rst api.rst - qpi-compute.rst + compute.rst diff --git a/docs/testing/user/userguide/overview.rst b/docs/testing/user/userguide/overview.rst index 1ad0b670..726d70bc 100644 --- a/docs/testing/user/userguide/overview.rst +++ b/docs/testing/user/userguide/overview.rst @@ -3,9 +3,9 @@ .. (c) 2017 ZTE Corp. -############ -Introduction -############ +******** +Overview +******** `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. @@ -18,9 +18,9 @@ performance. **TRUE** reflects the core value of QPI in four aspects - *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 |