shaker/doc/source/tools.rst
Ilya Shakhat 4de3521e80 Add documentation
Change-Id: I4ab97018c6a2776da76b7b36b86cf17340cab3dd
2015-05-14 19:51:30 +03:00

41 lines
819 B
ReStructuredText

===================
CLI Tools Reference
===================
shaker
------
Executes specified scenario in OpenStack cloud, stores results and generates HTML report.
.. literalinclude:: tools/shaker.txt
shaker-image-builder
--------------------
Builds master image in OpenStack cloud. The image is based on Ubuntu cloud image distro and
configured to run ``shaker-agent``.
.. literalinclude:: tools/shaker-image-builder.txt
shaker-agent
------------
Client-side process that is run inside pre-configured image.
.. literalinclude:: tools/shaker-agent.txt
shaker-report
-------------
Generates report based on raw results stored in JSON format.
.. literalinclude:: tools/shaker-report.txt
shaker-cleanup
--------------
Removes master image from OpenStack cloud.
.. literalinclude:: tools/shaker-cleanup.txt