diff options
Diffstat (limited to 'docs/testing')
| -rw-r--r-- | docs/testing/user/configguide/index.rst | 1 | ||||
| -rw-r--r-- | docs/testing/user/configguide/web.rst | 74 | ||||
| -rw-r--r-- | docs/testing/user/userguide/cli.rst | 55 | ||||
| -rw-r--r-- | docs/testing/user/userguide/index.rst | 1 | ||||
| -rw-r--r-- | docs/testing/user/userguide/web.rst | 70 |
5 files changed, 177 insertions, 24 deletions
diff --git a/docs/testing/user/configguide/index.rst b/docs/testing/user/configguide/index.rst index 43c32cab..ce733666 100644 --- a/docs/testing/user/configguide/index.rst +++ b/docs/testing/user/configguide/index.rst @@ -12,3 +12,4 @@ QTIP Installation & Configuration :maxdepth: 2 ./configuration.rst + ./web.rst diff --git a/docs/testing/user/configguide/web.rst b/docs/testing/user/configguide/web.rst new file mode 100644 index 00000000..83365abe --- /dev/null +++ b/docs/testing/user/configguide/web.rst @@ -0,0 +1,74 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +*************************************** +Web Portal installation & configuration +*************************************** + +Web Portal for Benchmarking is developed on python `Django`_ Framework. Right now the installation +is need to be done from source. + + + +Clone QTIP Repo +=============== + +:: + + git clone https://github.com/opnfv/qtip.git + + +Setup database and Initialize user data +======================================= + +CD into `web` directory. +------------------------ + +:: + + cd qtip/qtip/web + + +Setup migrations +---------------- + +:: + + python manage.py makemigrations + + +In usual case migrations will be already available with source. Console willll notify you +of the same. + +Run migrations +-------------- + +:: + + python manage.py migrate + + +Create superuser +---------------- +:: + + python manage.py createsuperuser + + +Console will prompt for adding new web admin. Enter new credentials. + + + +Collecting Static Dependencies +------------------------------ +:: + + python manage.py importstatic + + +This will import js and css dependencies for UI in static directory. Now the web application is +ready to run. + + +.. _Django: https://docs.djangoproject.com/en/1.11/ 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] diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst index e6eaea59..8cbb43c2 100644 --- a/docs/testing/user/userguide/index.rst +++ b/docs/testing/user/userguide/index.rst @@ -15,4 +15,5 @@ QTIP User Guide getting-started.rst cli.rst api.rst + web.rst compute.rst diff --git a/docs/testing/user/userguide/web.rst b/docs/testing/user/userguide/web.rst new file mode 100644 index 00000000..79f180d9 --- /dev/null +++ b/docs/testing/user/userguide/web.rst @@ -0,0 +1,70 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +********************** +Web Portal User Manual +********************** + +QTIP consists of different tools(metrics) to benchmark the NFVI. These metrics +fall under different NFVI subsystems(QPI's) such as compute, storage and network. +QTIP benchmarking tasks are built upon `Ansible`_ playbooks and roles. +QTIP web portal is a platform to expose QTIP as a benchmarking service hosted on a central host. + + +Running +======= + +After setting up the web portal as instructed in config guide, cd into the `web` directory. + +and run. + +:: + + python manage.py runserver 0.0.0.0 + + +You can access the portal by logging onto `<host>:8000/bench/login/` + +If you want to use port 80, you may need sudo permission. + +:: + + sudo python manage.py runserver 0.0.0.0:80 + +To Deploy on `wsgi`_, Use the Django `deployment tutorial`_ + + +Features +======== + +After logging in You'll be redirect to QTIP-Web Dashboard. You'll see following menus on left. + + * Repos + * Run Benchmarks + * Tasks + +Repo +---- + + Repos are links to qtip `workspaces`_. This menu list all the aded repos. Links to new repos + can be added here. + +Run Benchmarks +-------------- + + To run a benchmark, select the corresponding repo and run. QTIP Benchmarking service will clone + the workspace and run the benchmarks. Inventories used are predefined in the workspace repo in the `/hosts/` config file. + +Tasks +----- + + All running or completed benchmark jobs can be seen in Tasks menu with their status. + + +*New users can be added by Admin on the Django Admin app by logging into `/admin/'.* + +.. _Ansible: https://www.ansible.com/ +.. _wsgi: https://wsgi.readthedocs.io/en/latest/what.html +.. _deployment tutorial: https://docs.djangoproject.com/en/1.11/howto/deployment/wsgi/ +.. _workspaces: https://github.com/opnfv/qtip/blob/master/docs/testing/developer/devguide/ansible.rst#create-workspace |