Doc update/fix
Change-Id: Ifaee3aa4acb8852ddea128d3222c909aebe4ead0
This commit is contained in:
ahothan
parent
96b2bac24b
commit
b1c58f3a9d
@ -129,6 +129,6 @@ Links
|
||||
* Source: `<http://git.openstack.org/cgit/openstack/kloudbuster>`_
|
||||
* Supports/Bugs: `<http://launchpad.net/kloudbuster>`_
|
||||
* Mailing List: kloudbuster-core@lists.launchpad.net
|
||||
* `The KloudBuster REST API documentation <https://github.com/openstack/kloudbuster/blob/master/doc/source/_static/kloudbuster-swagger.html>`_
|
||||
* `KloudBuster REST API documentation Preview <https://htmlpreview.github.io/?https://github.com/openstack/kloudbuster/blob/master/doc/source/_static/kloudbuster-swagger.html>`_
|
||||
|
||||
|
||||
|
||||
@ -96,7 +96,8 @@ Interacting with the KloudBuster Server REST Interface
|
||||
Once the server is started, you can use different HTTP methods
|
||||
(GET/PUT/POST/DELETE) to interact with the KloudBuster REST interface using the provided URL at port 8080.
|
||||
|
||||
`KloudBuster REST API Dcumentaton <https://github.com/openstack/kloudbuster/blob/master/doc/source/_static/kloudbuster-swagger.html>`_
|
||||
* `KloudBuster REST API Documentation Preview <https://htmlpreview.github.io/?https://github.com/openstack/kloudbuster/blob/master/doc/source/_static/kloudbuster-swagger.html>`_
|
||||
* `REST API Documentation (Swagger yaml) <https://github.com/openstack/kloudbuster/blob/master/kb_server/kloudbuster-swagger.yaml>`_
|
||||
|
||||
|
||||
Running the KloudBuster HTTP Data Plane Scale Test from CLI
|
||||
@ -349,60 +350,8 @@ Example 3: Single-cloud Mode, Customized VM placements
|
||||
|
||||
$ kloudbuster --tested-rc ~/admin_openrc.sh --tested-passwd admin -t cfg.topo.yaml
|
||||
|
||||
|
||||
<<<<<<< 18e555dbd3ff384ff34baa341b2dfa544eaae760
|
||||
Interpret the Results
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
KloudBuster does come with a good Web UI to display the results in a pretty
|
||||
graphical way. However, in the case if you are not using the Web UI,
|
||||
KloudBuster also has a small tool locally to generate the chart. It accepts
|
||||
JSON files generated by KloudBuster. To see the chart in HTML, simply run::
|
||||
|
||||
$ kb_gen_chart -c <HTML_FILANAME_TO_SAVE> <JSON_FILE>
|
||||
|
||||
Check::
|
||||
|
||||
$ kb_gen_chart -h
|
||||
|
||||
for more options.
|
||||
|
||||
|
||||
Running with Rest API
|
||||
---------------------
|
||||
|
||||
All Rest APIs are well documented using `Swagger <http://swagger.io/>`_. In
|
||||
order to view them in a nice format, copy the entire contents of file
|
||||
kb_server/kloudbuster-swagger.yaml, and paste into the left panel of
|
||||
http://editor.swagger.io. Then you will see the specification of all Rest
|
||||
APIs in the right panel of the web page.
|
||||
|
||||
A static HTML version can be found
|
||||
`here <https://github.com/openstack/kloudbuster/blob/master/doc/source/_static/kloudbuster-swagger.html>`_.
|
||||
|
||||
.. _start_kloudbuster_server:
|
||||
|
||||
KloudBuster integrates a Python based web server
|
||||
`Pecan <http://www.pecanpy.org/>`_ to host both the KloudBuster Rest API
|
||||
server and the KloudBuster front-end website, which listens to
|
||||
localhost:8080 by default.
|
||||
|
||||
From the root of the KloudBuster repository, go to kb_server directory.
|
||||
If this is the first time to start the server, run below command once
|
||||
to setup the environment::
|
||||
|
||||
$ python setup.py develop
|
||||
|
||||
Then start the server by doing::
|
||||
|
||||
$ pecan serve config.py
|
||||
|
||||
Idealy, you should see a message like below, which indicates the server
|
||||
is up running::
|
||||
=======
|
||||
Displaying the Results
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
>>>>>>> Update doc for storage
|
||||
|
||||
Results can be saved in a file in json format or in html format. The json format is more appropriate for usage by any post-processing tool or script
|
||||
while the html file is more adapted for human usage.
|
||||
@ -491,23 +440,23 @@ Running the KloudBuster Storage Scale Test from CLI
|
||||
|
||||
To run the storage scale test you need to pass the following options on the command line.
|
||||
|
||||
--storage::
|
||||
--storage:
|
||||
|
||||
this option enables the storage scale test (and disables the http data plane scale test)
|
||||
|
||||
--tested-rc::
|
||||
--tested-rc:
|
||||
|
||||
to provide the OpenStack openrc credential file to use
|
||||
|
||||
--tested_passwd::
|
||||
--tested_passwd:
|
||||
|
||||
to provide the OpenStack password
|
||||
|
||||
--json (optional)::
|
||||
--json (optional):
|
||||
|
||||
save results in the passed json file
|
||||
|
||||
--html (optional)::
|
||||
--html (optional):
|
||||
|
||||
generate results in HTML format with Javascript charts
|
||||
|
||||
@ -518,23 +467,23 @@ Example of run (git clone, with pip install you can directly invoke the kloudbus
|
||||
|
||||
A custom configuration file can be created and modified to adjust several storage scale test parameters (use the *--show-config* option and redirect to a new custom configuration file then pass it using *--config*):
|
||||
|
||||
server|vms_per_network::
|
||||
server|vms_per_network:
|
||||
|
||||
specify how many VMs you want to test for storage access
|
||||
|
||||
client|progression::
|
||||
client|progression:
|
||||
|
||||
can be enabled to get progression scale numbers for storage test
|
||||
|
||||
client|storage_tool_configs::
|
||||
client|storage_tool_configs:
|
||||
|
||||
can be modified to fit the exact storage workload suite you want to test
|
||||
|
||||
client|volume_size::
|
||||
client|volume_size:
|
||||
|
||||
size of the Cinder volume to be attached to each VM instance (in GB)
|
||||
|
||||
client|io_file_size::
|
||||
client|io_file_size:
|
||||
|
||||
size of the test file to be used for the storage tests (in GB)
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user