Distributed data-plane performance testing tool
Go to file
Ilya Shakhat fe2c09482e Show proper error message if Heat is not present
Change-Id: I0cd5662aec4ad80d413782ad9830a9825c5abc64
2017-08-09 13:42:37 +02:00
doc/source Update URLs in documents according to document migration 2017-07-21 17:12:37 +08:00
etc Add support for CentOS7 through diskimage-builder 2017-07-17 08:52:15 -04:00
shaker Show proper error message if Heat is not present 2017-08-09 13:42:37 +02:00
tools Deprecate pyshaker-agent package 2017-03-01 13:42:08 +04:00
.dockerignore Pack Shaker into container 2016-08-04 15:36:41 +03:00
.gitignore Initial commit 2015-01-28 18:56:01 +03:00
.gitreview Update .gitreview for new namespace 2015-10-17 22:38:47 +00:00
.testr.conf Include tests into the package 2015-07-09 11:12:29 +03:00
Dockerfile Install necessary tools inside Docker image 2017-04-04 15:34:57 +04:00
LICENSE Initial commit 2015-01-28 18:56:01 +03:00
README.rst Doc update 2016-08-19 17:22:22 +03: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 Integrate diskimage-builder into shaker-image-builder 2017-03-03 17:33:22 +04:00
rtd-requirements.txt Fix docs gate and rtd build 2016-12-14 12:51:10 +04:00
setup.cfg Bump dependencies versions 2017-03-01 11:29:34 +04:00
setup.py Update requirements and pin pyzmq 2015-11-12 14:05:16 +03:00
test-requirements.txt Bump dependencies versions 2017-03-01 11:29:34 +04:00
tox.ini Enable some off-by-default checks 2017-07-21 16:49:33 +08: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 shakhat/shaker

$ docker run -p <port>:<port> -v <artifacts-dir>:/artifacts shakhat/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>
where:
  • host and port - host and port on machine where Shaker is deployed
  • artifacts-dir - where to store report and raw result
  • scenario - the scenario to execute, e.g. openstack/perf_l2 ( catalog)
  • os-XXX - OpenStack cloud credentials