diff options
| -rw-r--r-- | docs/proposal/integration_with_yardstick.rst | 32 | ||||
| -rw-r--r-- | docs/testing/user/configguide/configuration.rst | 4 | ||||
| -rw-r--r-- | legacy/config/SampleHeat.yaml | 2 | ||||
| -rw-r--r-- | legacy/docs/apidocs/qtip_restful_api.rst | 4 |
4 files changed, 21 insertions, 21 deletions
diff --git a/docs/proposal/integration_with_yardstick.rst b/docs/proposal/integration_with_yardstick.rst index a8298d6f..ce94b8fe 100644 --- a/docs/proposal/integration_with_yardstick.rst +++ b/docs/proposal/integration_with_yardstick.rst @@ -11,13 +11,13 @@ Problem description =================== For each specified QPI [1]_, QTIP needs to select a suite of test cases and collect -required test results. Based on these results, Qtip calculates the score. +required test results. Based on these results, QTIP calculates the score. Proposed change =============== -Qtip has a flexible architecture [2]_ to support different mode: standalone and agent. +QTIP has a flexible architecture [2]_ to support different mode: standalone and agent. It is recommended to use **agent mode** to work with existing test runners. Yardstick will -act as a runner to generate test result and trigger Qtip agent on the completion of test. +act as a runner to generate test result and trigger QTIP agent on the completion of test. Work Items in Yardstick @@ -25,41 +25,41 @@ Work Items in Yardstick 1. Create a customized suite in Yardstick -Yardstick not only has many existing suites but also support customized suites. Qtip could -create a suite named **Qtip-PoC** in Yardstick repo to verify workflow of Qtip agent mode. +Yardstick not only has many existing suites but also support customized suites. QTIP could +create a suite named **QTIP-PoC** in Yardstick repo to verify workflow of QTIP agent mode. -2. Launch Qtip in Yardstick +2. Launch QTIP in Yardstick -Whether to launch Qtip will be determined by checking the existence of OS environment -variable *QTIP*. If it exists, Qtip will be launched by using Yardstick CLI +Whether to launch QTIP will be determined by checking the existence of OS environment +variable *QTIP*. If it exists, QTIP will be launched by using Yardstick CLI `yardstick plugin install` [3]_. -3. Yardstick interacts with Qtip +3. Yardstick interacts with QTIP See -`Yardstick-Qtip+integration <https://wiki.opnfv.org/display/yardstick/Yardstick-Qtip+integration>`_ +`Yardstick-QTIP+integration <https://wiki.opnfv.org/display/yardstick/Yardstick-QTIP+integration>`_ for details. -Work Items in Qtip +Work Items in QTIP ------------------ 1. Provide an API for Yardstick to post test result and environment info After completing test execution, Yardstick will post test result and enviroment info with JSON format via QTIP API. See -`Yardstick-Qtip+integration <https://wiki.opnfv.org/display/yardstick/Yardstick-Qtip+integration>`_ +`Yardstick-QTIP+integration <https://wiki.opnfv.org/display/yardstick/Yardstick-QTIP+integration>`_ for details. 2. Parse yardstick test result -When Qtip agent receive Yarstick test result and enviroment info, Qtip agent will extract -metrics which is definded in metric spec configuration file. Based on these metrics, Qtip +When QTIP agent receive Yarstick test result and enviroment info, QTIP agent will extract +metrics which is definded in metric spec configuration file. Based on these metrics, QTIP agent will caculate QPI. 3. Provide an API for querying QPI -Qtip will provide an API for querying QPI. See -`Yardstick-Qtip+integration <https://wiki.opnfv.org/display/yardstick/Yardstick-Qtip+integration>`_ +QTIP will provide an API for querying QPI. See +`Yardstick-QTIP+integration <https://wiki.opnfv.org/display/yardstick/Yardstick-QTIP+integration>`_ for details. Implementation diff --git a/docs/testing/user/configguide/configuration.rst b/docs/testing/user/configguide/configuration.rst index 8cc891f0..0ca7ae8c 100644 --- a/docs/testing/user/configguide/configuration.rst +++ b/docs/testing/user/configguide/configuration.rst @@ -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/legacy/config/SampleHeat.yaml b/legacy/config/SampleHeat.yaml index 05f4c0b5..650c6a0c 100644 --- a/legacy/config/SampleHeat.yaml +++ b/legacy/config/SampleHeat.yaml @@ -9,7 +9,7 @@ heat_template_version: 2015-04-30 description: > - Used to run VMs for Qtip + Used to run VMs for QTIP parameters: image: diff --git a/legacy/docs/apidocs/qtip_restful_api.rst b/legacy/docs/apidocs/qtip_restful_api.rst index 06c01292..7e48b95b 100644 --- a/legacy/docs/apidocs/qtip_restful_api.rst +++ b/legacy/docs/apidocs/qtip_restful_api.rst @@ -4,7 +4,7 @@ .. (c) 2016 ZTE Corp. **************** -Qtip restful api +QTIP restful api **************** -You can get all the Qtip restful api by http://restful_api.qtip.openzero.net/api/spec.html. +You can get all the QTIP restful api by http://restful_api.qtip.openzero.net/api/spec.html. |