shaker/doc/source/tools.rst
Oded Le'Sage 68266af6c7 update master/slave terms
This commit replaces all master/slave references with primary/minion in
an effort to be more socially aware and inclusive

Change-Id: I3d5db71de6506d458707403e8f8c5e0493b78f4f
2020-07-15 16:40:32 -05:00

52 lines
1004 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:
shaker-image-builder
--------------------
Builds base 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 base image from OpenStack cloud.
.. literalinclude:: tools/shaker-cleanup.txt