shaker/doc/source/index.rst
Ilya Shakhat f0168e1d6b Document config parameters
Use oslo.config Sphinx extension to document all
config parameters.

Change-Id: Id934e8fac689d8cdbcc2d59663efdfcf1573e8ab
2016-08-11 13:40:26 +03:00

26 lines
681 B
ReStructuredText

Welcome to Shaker!
==================
**The distributed data-plane testing tool built for OpenStack.**
Shaker wraps around popular system network testing tools like
`iperf <https://iperf.fr/>`_, `iperf3 <https://iperf.fr/>`_
and netperf (with help of `flent <https://flent.org/>`_).
Shaker is able to deploy OpenStack instances and networks in different
topologies. Shaker scenario specifies the deployment and list of tests
to execute. Additionally tests may be tuned dynamically in command-line.
.. toctree::
:maxdepth: 2
installation
usage
architecture
tools
catalog
examples/index
examples_spot
reports/index
config
contributing