performa/shaker
Code Issues Proposed changes

Update docs about spot scenarios

Browse Source 
Change-Id: I6c34074f3b674be03ef51a9df34836cff8d7d99c
Related-bug: #1663404
This commit is contained in:
Ilya Shakhat 2017-02-13 13:08:59 +04:00
parent b1604a6617
commit 61a326f36f
2 changed files with 38 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
doc/source/examples_spot.rst
View File

@ -4,11 +4,16 @@
Spot Scenarios
==============
Spot scenarios are executed between the local machine (where shaker runs) and
the remote. Local machine must have all necessary tools installed, e.g. the
following scenarios require iperf3_ and flent_ utilities.
TCP
---
This scenario tests TCP bandwidth to the destination host. By default it sends traffic to one
of public iperf servers. This can be overridden via parameter ``--matrix "{host:<host>}"``.
of public iperf3 servers. This can be overridden via parameter ``--matrix "{host:<host>}"``.
The scenario requires iperf3_ to be installed locally.
How To Run
^^^^^^^^^^
@ -47,16 +52,44 @@ UDP
---
This scenario tests UDP packets per second to the destination host. By default it sends traffic to one
of public iperf servers. This can be overridden via parameter ``--matrix "{host:<host>}"``.
of public iperf3 servers. This can be overridden via parameter ``--matrix "{host:<host>}"``.
The scenario requires iperf3_ to be installed locally.
How To Run
^^^^^^^^^^
.. code::
.. code::
shaker-spot --scenario spot/udp --report report.html
shaker-spot --scenario spot/udp --report report.html
Scenario
^^^^^^^^
.. literalinclude:: ../../shaker/scenarios/spot/udp.yaml
Ping
----
This scenario tests ICMP ping between the local machine and the remote. By default pings are
sent to public 8.8.8.8 address. The remote address can be overridden via parameter
``--matrix "{host: <host>}"``. The scenario requires flent_ to be installed locally.
How To Run
^^^^^^^^^^
.. code::
shaker-spot --scenario spot/ping --report report.html
Scenario
^^^^^^^^
.. literalinclude:: ../../shaker/scenarios/spot/ping.yaml
.. references:
.. _iperf3: https://iperf.fr/
.. _flent: https://flent.org/

2
doc/source/installation.rst
View File

@ -113,7 +113,7 @@ Non-OpenStack Deployment (aka Spot mode)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To run scenarios against remote nodes (``shaker-spot`` command) install shaker on the local host.
Make sure all necessary system tools are installed too. See :ref:`spot_scenarios` for more details.
Make sure all necessary tools are installed too. Refer to :ref:`spot_scenarios` for more details.
Run Shaker against OpenStack deployed by Fuel-CCP on Kubernetes