A collection of plugins for Rally framework designed for the OpenStack platform.
Go to file
Andrey Kurilin 0a777912d0 [Docs] use openstack theme outside rtd
Rally team posts documentation at two places:
- http://rally.readthedocs.org/en/latest/ (preferable place)
- http://docs.openstack.org/developer/rally/

Most projects post docs at docs.o.o with oslosphinx theme. Since default
theme of sphinx is not so good, let's use official openstack theme instead.

Theme from oslosphinx has several issues:
- it is hard to find the link to home page of project documentation
- there is no sidebar with global content

Based on these two issues let's extend oslosphinx theme a bit.

Change-Id: Ifc75b430b7335c6a87a9102810ec33a5a913c43a
2016-04-20 16:03:13 +03:00
devstack devstack: support to be enabled with different plugin name 2016-03-23 16:10:41 +08:00
doc [Docs] use openstack theme outside rtd 2016-04-20 16:03:13 +03:00
etc [Verify] Fixing issue with discovering images 2016-04-15 13:02:59 +03:00
rally Merge "Refactor neutron utils" 2016-04-15 02:19:21 +00:00
rally-jobs Merge "Isolate scenario args between iterations" 2016-04-15 10:41:22 +00:00
samples [Bug1535948] Add Heat template validator 2016-04-06 17:40:04 +03:00
tests Merge "Refactor neutron utils" 2016-04-15 02:19:21 +00:00
.coveragerc Integrate Rally & Alembic 2016-01-29 11:24:16 +00:00
.dockerignore Fix docker build command 2015-11-10 16:33:29 -08:00
.gitignore [gates] Convert Rally to the new Devstack plugin model 2015-09-03 23:00:09 -07:00
.gitreview Update .gitreview file to reflect repo rename 2015-04-18 00:37:36 +00:00
Dockerfile [Docs] Add cli reference to docs 2016-02-26 16:31:03 +02:00
LICENSE Initial commit 2013-08-03 09:17:25 -07:00
README.rst Add 'Who Is Using Rally' paragraph to the docs 2015-09-24 17:34:03 +03:00
requirements.txt Updated from global requirements 2016-04-15 01:58:50 +00:00
setup.cfg Drop python 2.6 classifier 2015-11-19 14:39:01 +02:00
setup.py Updated from global requirements 2015-09-22 10:45:07 +00:00
test-requirements.txt Updated from global requirements 2016-01-21 17:47:44 +00:00
tox.ini Documentation tox fix 2016-02-29 13:12:22 +00:00

README.rst

Rally

What is Rally

Rally is a Benchmark-as-a-Service project for OpenStack.

Rally is intended to provide the community with a benchmarking tool that is capable of performing specific, complicated and reproducible test cases on real deployment scenarios.

If you are here, you are probably familiar with OpenStack and you also know that it's a really huge ecosystem of cooperative services. When something fails, performs slowly or doesn't scale, it's really hard to answer different questions on "what", "why" and "where" has happened. Another reason why you could be here is that you would like to build an OpenStack CI/CD system that will allow you to improve SLA, performance and stability of OpenStack continuously.

The OpenStack QA team mostly works on CI/CD that ensures that new patches don't break some specific single node installation of OpenStack. On the other hand it's clear that such CI/CD is only an indication and does not cover all cases (e.g. if a cloud works well on a single node installation it doesn't mean that it will continue to do so on a 1k servers installation under high load as well). Rally aims to fix this and help us to answer the question "How does OpenStack work at scale?". To make it possible, we are going to automate and unify all steps that are required for benchmarking OpenStack at scale: multi-node OS deployment, verification, benchmarking & profiling.

Rally workflow can be visualized by the following diagram:

Rally Architecture

Who Is Using Rally

Who is Using Rally

Documentation

Rally documentation on ReadTheDocs is a perfect place to start learning about Rally. It provides you with an easy and illustrative guidance through this benchmarking tool. For example, check out the Rally step-by-step tutorial that explains, in a series of lessons, how to explore the power of Rally in benchmarking your OpenStack clouds.

Architecture

In terms of software architecture, Rally is built of 4 main components:

  1. Server Providers - provide servers (virtual servers), with ssh access, in one L3 network.
  2. Deploy Engines - deploy OpenStack cloud on servers that are presented by Server Providers
  3. Verification - component that runs tempest (or another specific set of tests) against a deployed cloud, collects results & presents them in human readable form.
  4. Benchmark engine - allows to write parameterized benchmark scenarios & run them against the cloud.

Use Cases

There are 3 major high level Rally Use Cases:

Rally Use Cases

Typical cases where Rally aims to help are:

  • Automate measuring & profiling focused on how new code changes affect the OS performance;
  • Using Rally profiler to detect scaling & performance issues;
  • Investigate how different deployments affect the OS performance:
    • Find the set of suitable OpenStack deployment architectures;
    • Create deployment specifications for different loads (amount of controllers, swift nodes, etc.);
  • Automate the search for hardware best suited for particular OpenStack cloud;
  • Automate the production cloud specification generation:
    • Determine terminal loads for basic cloud operations: VM start & stop, Block Device create/destroy & various OpenStack API methods;
    • Check performance of basic cloud operations in case of different loads.

Rally documentation:

http://rally.readthedocs.org/en/latest/

Rally step-by-step tutorial:

http://rally.readthedocs.org/en/latest/tutorial.html

RoadMap:

https://docs.google.com/a/mirantis.com/spreadsheets/d/16DXpfbqvlzMFaqaXAcJsBzzpowb_XpymaK2aFY2gA2g

Launchpad page:

https://launchpad.net/rally

Code is hosted on git.openstack.org:

http://git.openstack.org/cgit/openstack/rally

Code is mirrored on github:

https://github.com/openstack/rally