diff options
| -rw-r--r-- | docs/testing/user/userguide/cli.rst | 53 |
1 files changed, 51 insertions, 2 deletions
diff --git a/docs/testing/user/userguide/cli.rst b/docs/testing/user/userguide/cli.rst index a7d3c63e..19420bd1 100644 --- a/docs/testing/user/userguide/cli.rst +++ b/docs/testing/user/userguide/cli.rst @@ -1,2 +1,51 @@ -- How to use qtip-cli to list, show and run benchmarks. -- Refer to auto generated help page if available, or give hint on how to get help. +************** +QTIP CLI Usage +************** + +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, +a user may group them under plans. + +QTIP CLI provides interface to all of the above the components. A help page provides a list of all the commands +along with a short description. +:: + + qtip [-h|--help] + +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 plan list + +In order to view the details about a specific plan. +:: + + qtip plan show <plan_name> + +where *plan_name* is one of those listed from the previous command. + +To execute a complete plan +:: + + qtip plan run <plan_name> -p <path_to_result_directory> + +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. +:: + + mkdir result + qtip plan run <plan_name> -p $PWD/result + +Similarly, the same commands can be used for the other two components making up the plans, i.e QPI's and metrics. + +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 +:: + + qtip report show <metric_name> -p $PWD/result + +Debug option helps identify the error by providing a detailed traceback. It can be enabled as +:: + + qtip [-d|--debug] plan run <plan_name> |