1ceb1555f3
Modify Rally docs (for readthedocs), sticking to the following principles:
* Make the docs structure as simple as possible:
1. Overview
2. Install Rally
3. Rally step-by-step
4. User stories
5. Plugins
6. Contribute to Rally
7. Rally OS Gates
8. Request a New Feature
9. Project Info
* Keep in mind what questions different target groups usually have about Rally.
The new structure relates to these groups as follows:
1 -> Managers
2, 3, 4 -> QA
5, 6, 7, 8, 9 -> QA & Developers
* Make each docs page to be easy to get through;
* Prefer pictures over text;
* Use hyperlinks to easily navigate from page to page;
* Fix incorrect English & typos.
Also add a sample for SLA plugins.
Change-Id: I720d87be851c273689a21aaba87fc67eacf0f161
|
||
|---|---|---|
| contrib/devstack | ||
| doc | ||
| etc/rally | ||
| rally | ||
| rally-jobs | ||
| samples | ||
| tests | ||
| tools | ||
| .coveragerc | ||
| .gitignore | ||
| .gitreview | ||
| .testr.conf | ||
| Dockerfile | ||
| LICENSE | ||
| README.rst | ||
| babel.cfg | ||
| install_rally.sh | ||
| openstack-common.conf | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| test-requirements.txt | ||
| tox.ini | ||
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:
Architecture
In terms of software architecture, Rally is built of 4 main components:
- Server Providers - provide servers (virtual servers), with ssh access, in one L3 network.
- Deploy Engines - deploy OpenStack cloud on servers that are presented by Server Providers
- Verification - component that runs tempest (or another specific set of tests) against a deployed cloud, collects results & presents them in human readable form.
- Benchmark engine - allows to write parameterized benchmark scenarios & run them against the cloud.
Use Cases
There are 3 major high level 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.
Links
Wiki page:
Rally/HowTo:
Launchpad page:
Code is hosted on github:
Trello board: