Distributed data-plane performance testing tool

Go to file

Ian Wienand ecd88a3967 Replace openstack.org git:// URLs with https:// This is a mechanically generated change to replace openstack.org git:// URLs with https:// equivalents. This is in aid of a planned future move of the git hosting infrastructure to a self-hosted instance of gitea (https://gitea.io), which does not support the git wire protocol at this stage. This update should result in no functional change. For more information see the thread at http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003825.html Change-Id: I37f57d6c8b5c86ea87247dc0220c6030993633ec		2019-03-25 11:38:38 +00:00
doc/source	Replace openstack.org git:// URLs with https://	2019-03-25 11:38:38 +00:00
etc	Enhance Shaker to support custom user options	2018-11-06 16:53:26 -06:00
shaker	Merge "Adjust new config options to use dash instead of underscore"	2018-12-10 21:20:06 +00:00
tools	Add Zuul job to build Docker image	2018-11-09 09:31:01 +01:00
.dockerignore	Pack Shaker into container	2016-08-04 15:36:41 +03:00
.gitignore	Enhance Shaker to support custom user options	2018-11-06 16:53:26 -06:00
.gitreview	Update .gitreview for new namespace	2015-10-17 22:38:47 +00:00
.stestr.conf	Switch to stestr	2018-07-06 10:33:13 +07:00
.zuul.yaml	Replace py35 job with py36	2019-03-25 09:54:08 +01:00
Dockerfile	Add Zuul job to build Docker image	2018-11-09 09:31:01 +01:00
LICENSE	Initial commit	2015-01-28 18:56:01 +03:00
README.rst	Add Zuul job to build Docker image	2018-11-09 09:31:01 +01:00
config-generator.conf	Fix config processing for oslo.log	2015-03-03 17:38:25 +03:00
openstack-common.conf	Use oslo.log lib instead of incunator code	2015-03-03 16:14:19 +03:00
readthedocs.yml	Fix docs gate and rtd build	2016-12-14 12:51:10 +04:00
requirements.txt	Enhance Shaker to provide the ability to define support templates	2018-11-05 11:12:14 -06:00
rtd-requirements.txt	Fix docs gate and rtd build	2016-12-14 12:51:10 +04:00
setup.cfg	Run tests on Python 3.7	2019-02-19 20:30:28 +00:00
setup.py	Update requirements and pin pyzmq	2015-11-12 14:05:16 +03:00
test-requirements.txt	Switch to stestr	2018-07-06 10:33:13 +07:00
tox.ini	Replace py35 job with py36	2019-03-25 09:54:08 +01:00

README.rst

Shaker

The distributed data-plane testing tool built for OpenStack.

Shaker wraps around popular system network testing tools like iperf, iperf3 and netperf (with help of flent). 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.

Features

User-defined topology via Heat templates
Simultaneously test execution on multiple instances
Interactive report with stats and charts
Built-in SLA verification

Deployment Requirements

Shaker server routable from OpenStack cloud
Admin-user access to OpenStack API is preferable

Run in Python Environment

$ pip install pyshaker
$ . openrc
$ shaker-image-builder
$ shaker --server-endpoint <host:port> --scenario <scenario> --report <report.html>``

where:

host and port - host and port of machine where Shaker is deployed
scenario - the scenario to execute, e.g. openstack/perf_l2 ( catalog)
<report.html> - file to store the final report

Full list of parameters is available in documentation.

Shaker in Container

Shaker is available as container at Docker Hub at performa/shaker

$ docker run -p <port>:<port> -v <artifacts-dir>:/artifacts performa/shaker --scenario <scenario> --server-endpoint <host:port>
  --os-auth-url <os-auth-url> --os-username <os-username> --os-password <os-password> --os-project-name <os-project-name>