aboutsummaryrefslogtreecommitdiffstats
path: root/docs/userguide
diff options
context:
space:
mode:
Diffstat (limited to 'docs/userguide')
-rw-r--r--docs/userguide/_01-compute.rst6
-rw-r--r--docs/userguide/annex.rst9
-rw-r--r--docs/userguide/benchmark-suites.rst9
-rw-r--r--docs/userguide/index.rst6
-rw-r--r--docs/userguide/introduction.rst96
5 files changed, 63 insertions, 63 deletions
diff --git a/docs/userguide/_01-compute.rst b/docs/userguide/_01-compute.rst
index 7cd4c2ce..56be5488 100644
--- a/docs/userguide/_01-compute.rst
+++ b/docs/userguide/_01-compute.rst
@@ -58,7 +58,7 @@ OpenSSL Speed
OpenSSL Speed can be used to benchmark compute performance of a machine. In QTIP, two OpenSSL Speed benchmarks are incorporated:
1. RSA signatunes/sec signed by a machine
-2. AES 128-bit encnyption throught for a machine for cipher block sizes
+2. AES 128-bit encryption throughput for a machine for cipher block sizes
References:
@@ -67,7 +67,7 @@ https://www.openssl.org/docs/manmaster/apps/speed.html
RAMSpeed
^^^^^^^^
-RAMSpeed is used to measune a machine's memory perfomace.
+RAMSpeed is used to measure a machine's memory perfomace.
The problem(array)size is large enough to ensure Cache Misses so that the main machine memory is used.
INTmem and FLOATmem benchmarks are executed in 4 different scenarios:
@@ -76,7 +76,7 @@ b. Add: a(i)=b(i)+c(i)
c. Scale: a(i)=b(i)*d
d. Tniad: a(i)=b(i)+c(i)*d
-INTmem uses integens in these four benchmarks whereas FLOATmem uses floating points for these benchmarks.
+INTmem uses integers in these four benchmarks whereas FLOATmem uses floating points for these benchmarks.
References:
diff --git a/docs/userguide/annex.rst b/docs/userguide/annex.rst
index 406d5132..e8bf5555 100644
--- a/docs/userguide/annex.rst
+++ b/docs/userguide/annex.rst
@@ -7,13 +7,12 @@
Annex
*****
-Templates
-=========
-
-.. include:: _testcase_description.rst
+.. toctree::
+ :maxdepth: 2
+ _testcase_description.rst
Downloads
=========
-- :download:`Sample configuration <../download/sample_config.yaml>` \ No newline at end of file
+- :download:`Sample configuration <../download/sample_config.yaml>`
diff --git a/docs/userguide/benchmark-suites.rst b/docs/userguide/benchmark-suites.rst
index 9a3929cc..84d1c647 100644
--- a/docs/userguide/benchmark-suites.rst
+++ b/docs/userguide/benchmark-suites.rst
@@ -7,6 +7,9 @@
Benchmark Suites
****************
-.. include:: _01-compute.rst
-.. include:: _02-network.rst
-.. include:: _03-storage.rst
+.. toctree::
+ :maxdepth: 2
+
+ _01-compute.rst
+ _02-network.rst
+ _03-storage.rst
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index 3032f357..5ae4f345 100644
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -11,6 +11,6 @@ QTIP User Guide
.. toctree::
:maxdepth: 2
- ./introduction.rst
- ./benchmark-suites.rst
- ./annex.rst
+ introduction.rst
+ benchmark-suites.rst
+ annex.rst
diff --git a/docs/userguide/introduction.rst b/docs/userguide/introduction.rst
index 2655347e..4876d0e2 100644
--- a/docs/userguide/introduction.rst
+++ b/docs/userguide/introduction.rst
@@ -9,16 +9,16 @@ Introduction
************
This guide will serve as a first step to familiarize the user with how to
-run QTIP the first time when the user clones QTIP on to their host machine.
-In order to clone QTIP please follow the instructions in the
-installation.rst located in docs/userguide/installation.rst.
+run QTIP the first time when the user pull QTIP image on to their host machine.
+In order to install and config QTIP please follow the instructions in the
+configuration.rst located in docs/configguide/configuration.rst.
QTIP Directory structure:
-------------------------
The QTIP directory has been sectioned off into multiple folders to facilitate
segmenting information into relevant categories. The folders that concern
- the end user are `test_cases/` and `test_list/`.
+ the end user are `test_cases/` and `benchmarks/suite/`.
**test_cases/:**
@@ -58,29 +58,29 @@ distinguishes between a test to be run on the Virtual Machine or the compute
node itself, respectively.
-**test_list/:**
+**benchmarks/suite/:**
This folder contains three files, namely `compute`, `network` and `storage`.
These files list the benchmarks are to be run by the QTIP framework. Sample
compute test file is shown below
::
-{
+ {
"bm": [
- "dhrystone_bm.yaml",
- "whetstone_bm.yaml",
- "ramspeed_bm.yaml",
- "dpi_bm.yaml",
- "ssl_bm.yaml"
+ "dhrystone_bm.yaml",
+ "whetstone_bm.yaml",
+ "ramspeed_bm.yaml",
+ "dpi_bm.yaml",
+ "ssl_bm.yaml"
],
"vm": [
- "dhrystone_vm.yaml",
- "whetstone_vm.yaml",
- "ramspeed_vm.yaml",
- "dpi_vm.yaml",
- "ssl_vm.yaml"
+ "dhrystone_vm.yaml",
+ "whetstone_vm.yaml",
+ "ramspeed_vm.yaml",
+ "dpi_vm.yaml",
+ "ssl_vm.yaml"
]
-}
+ }
The compute file will now run all the benchmarks listed above one after
another on the environment.
@@ -132,11 +132,13 @@ The `Context` tag helps the user list the number of compute nodes they want
to run dhrystone on. The user can list all the compute nodes under the
`Host_Machines` tag. All the machines under test must be listed under the
`Host_Machines` and naming it incrementally higher. The `ip:` tag is used
- to specify the IP of the particular compute node. The `pw:` tag can be left
- blank because QTIP uses its own key for ssh. In order to run dhrystone on
- one compute node at a time the user needs to edit the `role:` tag. `role:
- host` for machine_1 and `role: server` for machine_2 will allow for
- dhrystone to be run on machine_1 and then run on machine_2.
+ to specify the IP of the particular compute node.The `ip:` tag can be left
+ blank when installer type is 'fuel',because QTIP will get ip
+ from installer. The `pw:` tag can be left blank because QTIP uses its own
+ key for ssh. In order to run dhrystone on one compute node at a time the user
+ needs to edit the `role:` tag. `role: host` for machine_1 and `role: server`
+ for machine_2 will allow for dhrystone to be run on machine_1 and then run
+ on machine_2.
::
@@ -312,71 +314,67 @@ Sample dhrystone_vm.yaml file:
Commands to run the Framework:
------------------------------
-In order to start QTIP on the default lab please use the following commands (asssuming you have prepared the config files in the test_cases/default/ directory and listed the intended suite in the test_list/<RELEVANT-SUITE-FILE>):
+In order to start QTIP on the default lab please use the following commands (asssuming your installer
+is 'fuel' or 'compass', you use the config files in the test_cases/default/ directory and listed the
+intended suite in the benchmarks/suite/<RELEVANT-SUITE-FILE>):
-First step is to export the necessary information to the environment.
-::
-
- source get_env_info.sh -n <INSTALLER_TYPE> -i <INSTALLER_IP>
-
-for running qtip on an openstack deployed using FUEL with the Installer IP 10.20.0.2
-::
-
- source get_env_info.sh -n fuel -i 10.20.0.2
+First step is to export the necessary information to the environment and generate QTIP key pair.
+Please follow the instructions in the configuration.rst.
-This will generate the `opnfv-creds.sh` file needed to use the python clients for keystone, glance, nova, and neutron.
+Secondary step download the QTIP image and upload it to the Cloud.QTIP will use this image
+to create VM when test VM performance.
::
- source opnfv-creds.sh
+ source docker/prepare_qtip_image.sh
-Running QTIP on the using `default` as the pod name and for the `compute` suite by cli
+Running QTIP on the using `default` as the pod name and for the `compute` suite by cli.
::
python qtip.py -l default -f compute
-Running QTIP on the using 'default' as the pod name and for the 'compute' suite 'bm' type by restful api
+Running QTIP on the using 'default' as the pod name and for the 'compute' suite 'bm' type by restful api.
::
- curl --trace-ascii debug.txt -X POST -d '{ "installer_ip": "10.20.6.2","installer_type":"fuel", "suite_name":"compute", "type": "BM"}' -H "Content-Type: application/json" http://qtip_server_ip:5000/api/v1.0/jobs
+ curl --trace-ascii debug.txt -X POST -d '{ "installer_ip": "10.20.6.2","installer_type":"fuel", "suite_name":"compute", "type": "BM"}' -H "Content-Type: application/json" http://127.0.0.1:5000/api/v1.0/jobs
-Running QTIP on the using 'default' as the pod name and for the 'compute' suite 'vm' type by restful api
+Running QTIP on the using 'default' as the pod name and for the 'compute' suite 'vm' type by restful api.
::
- curl --trace-ascii debug.txt -X POST -d '{ "installer_ip": "10.20.6.2","installer_type":"fuel", "suite_name":"compute", "type": "VM"}' -H "Content-Type: application/json" http://qtip_server_ip:5000/api/v1.0/jobs
+ curl --trace-ascii debug.txt -X POST -d '{ "installer_ip": "10.20.6.2","installer_type":"fuel", "suite_name":"compute", "type": "VM"}' -H "Content-Type: application/json" http://127.0.0.1:5000/api/v1.0/jobs
-Running QTIP on the using `default` as the pod name and for the `network` suite by cli
+Running QTIP on the using `default` as the pod name and for the `network` suite by cli.
::
python qtip.py -l default -f network
-Running QTIP on the using 'default' as the pod name and for the 'network' suite 'bm' type by restful api
+Running QTIP on the using 'default' as the pod name and for the 'network' suite 'bm' type by restful api.
::
- curl --trace-ascii debug.txt -X POST -d '{ "installer_ip": "10.20.6.2","installer_type":"fuel", "suite_name":"network", "type": "BM"}' -H "Content-Type: application/json" http://qtip_server_ip:5000/api/v1.0/jobs
+ curl --trace-ascii debug.txt -X POST -d '{ "installer_ip": "10.20.6.2","installer_type":"fuel", "suite_name":"network", "type": "BM"}' -H "Content-Type: application/json" http://127.0.0.1:5000/api/v1.0/jobs
-Running QTIP on the using `default` as the pod name and for the `storage` suite by cli
+Running QTIP on the using `default` as the pod name and for the `storage` suite by cli.
::
python qtip.py -l default -f network
-Running QTIP on the using 'default' as the pod name and for the 'storage' suite 'bm' type by restful api
+Running QTIP on the using 'default' as the pod name and for the 'storage' suite 'bm' type by restful api.
::
- curl --trace-ascii debug.txt -X POST -d '{ "installer_ip": "10.20.6.2","installer_type":"fuel", "suite_name":"storage", "type": "BM"}' -H "Content-Type: application/json" http://qtip_server_ip:5000/api/v1.0/jobs
+ curl --trace-ascii debug.txt -X POST -d '{ "installer_ip": "10.20.6.2","installer_type":"fuel", "suite_name":"storage", "type": "BM"}' -H "Content-Type: application/json" http://127.0.0.1:5000/api/v1.0/jobs
Get running QTIP job status by restful api
::
- curl --trace-ascii debug.txt -X GET http://qtip_server_ip:5000/api/v1.0/jobs/job-id
+ curl --trace-ascii debug.txt -X GET http://127.0.0.1:5000/api/v1.0/jobs/job-id
For example:
- curl --trace-ascii debug.txt -X GET http://172.37.0.3:5000/api/v1.0/jobs/5b71f035-3fd6-425c-9cc7-86acd3a04214
+ curl --trace-ascii debug.txt -X GET http://127.0.0.1:5000/api/v1.0/jobs/5b71f035-3fd6-425c-9cc7-86acd3a04214
Stop running QTIP job by restful api.The job will finish the current benchmark test and stop.
::
- curl --trace-ascii debug.txt -X DELTET http://qtip_server_ip:5000/api/v1.0/jobs/job-id
+ curl --trace-ascii debug.txt -X DELTET http://127.0.0.1:5000/api/v1.0/jobs/job-id
For example:
- curl --trace-ascii debug.txt -X DELETE http://172.37.0.3:5000/api/v1.0/jobs/5b71f035-3fd6-425c-9cc7-86acd3a04214q
+ curl --trace-ascii debug.txt -X DELETE http://127.0.0.1:5000/api/v1.0/jobs/5b71f035-3fd6-425c-9cc7-86acd3a04214q
Results:
--------