diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/release/release-notes/euphrates.rst | 137 | ||||
| -rw-r--r-- | docs/testing/user/configguide/index.rst | 6 | ||||
| -rw-r--r-- | docs/testing/user/userguide/cli.rst | 55 |
3 files changed, 171 insertions, 27 deletions
diff --git a/docs/release/release-notes/euphrates.rst b/docs/release/release-notes/euphrates.rst new file mode 100644 index 00000000..48058e64 --- /dev/null +++ b/docs/release/release-notes/euphrates.rst @@ -0,0 +1,137 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +********* +Euphrates +********* + +This document provides the release notes of QTIP for OPNFV Euphrates release + +.. contents:: + :depth: 3 + :local: + +Version history +=============== + ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2017-10-20 | Euphrates 1.0 | Yujun Zhang | | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ + +Summary +======= + +QTIP Euphrates release continues working on **QPI**, a.k.a. QTIP Performance Index, which is calculated from metrics +collected in performance tests. + +Besides compute performance benchmark, QTIP has integrated OPNFV storperf for storage performance benchmarking. + +A PoC of web portal is implemented as the starting point of Benchmarking as a Service. + +Release Data +============ + ++--------------------------------------+--------------------------------------+ +| **Project** | QTIP | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/commit-ID** | qtip/euphrates.1.0 | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | stable version | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | 2017-10-20 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | release with OPNFV cycle | +| | | ++--------------------------------------+--------------------------------------+ + +Version change +-------------- + +Module version changes +^^^^^^^^^^^^^^^^^^^^^^ + +The following Python packages are used in this release:: + + humanfriendly==4.4.1 + connexion==1.1.11 + Jinja2==2.9.6 + Django==1.11.5 + asq==1.2.1 + six==1.11.0 + ansible==2.4.0.0 + requests==2.18.4 + prettytable==0.7.2 + numpy==1.13.1 + click==6.7 + pbr==3.1.1 + PyYAML==3.12 + +It is considered as a baseline for future releases. + +Reason for version +------------------ + +Features additions +^^^^^^^^^^^^^^^^^^ + +* Storage QPI (QTIP Performance Index) specification and benchmarking project + +Framework evolution +^^^^^^^^^^^^^^^^^^^ + +Ansible is used as the backbone of QTIP framework. Not only the main testing procedure is built as Ansible roles, but +also the inventory discovery is implemented as Ansible module, the calculation and collection actions are Ansible +plugins. Even the testing project itself is generated using jinja2 template rendering driven by Ansible. + +Deliverables +------------ + +Software +^^^^^^^^ + +- `QTIP Docker image <https://hub.docker.com/r/opnfv/qtip>`_ (tag: euphrates.1.0) + +Documentation +^^^^^^^^^^^^^ + +- `Installation & Configuration <http://docs.opnfv.org/en/stable-euphrates/qtip/docs/testing/user/configguide>`_ +- `User Guide <http://docs.opnfv.org/en/stable-euphrates/submodules/qtip/docs/testing/user/userguide>`_ +- `Developer Guide <http://docs.opnfv.org/en/stable-euphrates/submodules/qtip/docs/testing/developer/devguide>`_ + +Known Limitations, Issues and Workarounds +========================================= + +Limitations +----------- + +- Supporting on legacy OPNFV fuel installer is no longer maintained. + +Known issues +------------ + +Test Result +=========== + +QTIP has undergone QA test runs with the following results: + ++---------------------------------------------------+--------------------------------------+ +| **TEST-SUITES** | **Results:** | +| | | ++---------------------------------------------------+--------------------------------------+ +| qtip-verify-euphrates | 53/53 passed, 86% lines coverage | +| | | ++---------------------------------------------------+--------------------------------------+ +| qtip-compute-apex-euphrates | passed | +| | | ++---------------------------------------------------+--------------------------------------+ +| qtip-storage-apex-euphrates | passed | +| | | ++---------------------------------------------------+--------------------------------------+ diff --git a/docs/testing/user/configguide/index.rst b/docs/testing/user/configguide/index.rst index ce733666..fa893e5e 100644 --- a/docs/testing/user/configguide/index.rst +++ b/docs/testing/user/configguide/index.rst @@ -4,9 +4,9 @@ .. (c) 2016 ZTE Corp. -********************************* -QTIP Installation & Configuration -********************************* +*********************** +QTIP Installation Guide +*********************** .. toctree:: :maxdepth: 2 diff --git a/docs/testing/user/userguide/cli.rst b/docs/testing/user/userguide/cli.rst index 8a983155..f0894b01 100644 --- a/docs/testing/user/userguide/cli.rst +++ b/docs/testing/user/userguide/cli.rst @@ -7,7 +7,7 @@ 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, +components of a NFVi ecosystem, such as compute, network and storage. Depending on the type of application, a user may group them under plans. Bash Command Completion @@ -26,53 +26,60 @@ QTIP CLI provides interface to all of the above the components. A help page prov along with a short description. :: - qtip [-h|--help] + qtip --help Usage ===== -Typically a complete plan is executed at the target environment. QTIP defaults to a number of sample plans. -A list of all the available plans can be viewed +QTIP is currently supports two different QPI's, compute and storage. To list all the supported QPI :: - qtip plan list + qtip qpi list -In order to view the details about a specific plan. +The details of any QPI can be viewed as follows :: - qtip plan show <plan_name> +qtip qpi show <qpi_name> -where *plan_name* is one of those listed from the previous command. - -To execute a complete plan +In order to benchmark either one of them, their respective templates need to be generated :: - qtip plan run <plan_name> -p <path_to_result_directory> + qtip create --project-template [compute|storage] <workspace_name> + +By default, the compute template will be generated. An interactive prompt would gather all parameters specific to +OpenStack installation. -QTIP does not limit result storage at a specific directory. Instead a user may specify his own result storage -as above. An important thing to remember is to provide absolute path of result directory. +Once the template generation is complete, configuration for OpenStack needs to be generated. :: - mkdir result - qtip plan run <plan_name> -p $PWD/result + cd <workspace_name> + qtip setup -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 +This step generates the inventory, populating it with target nodes. + +QTIP can now be run :: - qtip metric run <metric_name> -p $PWD/result + qtip run -The same can be applied for a QPI. +This would start the complete testing suite, which is either compute or storage. Each suite normally takes about +half an hour to complete. -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 +Benchmarking report is made for each and every individual section in a QPI, on a particular target node. It consists of +the actual test values on that node along with scores calculated by comparison against a baseline. :: - qtip report show <metric_name> -p $PWD/result + qtip report show [-n|--node] <node> <section_name> + Debugging options ================= -Debug option helps identify the error by providing a detailed traceback. It can be enabled as +QTIP uses Ansible as the runner. One can use all of Ansible's CLI option with QTIP. In order to enable verbose mode +:: + + qtip setup -v + +One may also be able to achieve the different levels of verbosity :: - qtip [-d|--debug] plan run <plan_name> + qtip run [-v|-vv|-vvv] |