shaker/doc/source/tools.rst
Ilya Shakhat 59723a8099 Implement agent-less execution mode (aka spot)
Added new entry-point shaker-spot, which allows to execute scenarios
from the local node. Example of such scenario is spot/tcp which uses
iperf3 to measure bandwidth against one of public hosts.

Change-Id: I9303785501c3af7212ca590b8de63218ca877cd6
2015-12-21 16:33:59 +03:00

49 lines
980 B
ReStructuredText

===================
CLI Tools Reference
===================
shaker
------
Executes specified scenario in OpenStack cloud, stores results and generates HTML report.
.. literalinclude:: tools/shaker.txt
shaker-spot
-----------
Executes specified scenario from the local node, stores results and generates HTML report.
.. literalinclude:: tools/shaker-spot.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