07bbc3094d
Rally should have detailed docstrings for: * Benchmark scenario classes * Benchmark scenarios * Deploy engines * Server providers * SLA Here we add such docstrings and also add a test suite that checks that Rally is 100% covered with docstrings and that these docstrings are correctly formed. We also change the interface of the following benchmark scenarios (for the sake of unification): * CinderVolumes.create_and_attach_volume * CinderVolumes.create_snapshot_and_attach_volume * CinderVolumes.create_nested_snapshots_and_attach_volume Finally, we refactor a bit NovaServers.boot_and_bounce_server. Change-Id: Ia38c8fc2d692a09719d3e068d332647d4b0da47f |
||
|---|---|---|
| .. | ||
| contexts | ||
| runners | ||
| scenarios | ||
| sla | ||
| support | ||
| README.rst | ||
Tasks Configuration Samples
To specify your tasks, use configuration files in json or yaml format.
General structure of configuration file: :
{
"ScenarioClass.scenario_method":
"args": {
...
},
"runner": {
...
},
"context": {
...
}
"sla": {
...
}
}
}ScanarioClass should be a subclass of the base Scenario class and scenario_method specifies what benchmark task should be run. Section "args" is also related to scenario. To learn more about scenarios configuration, see samples in doc/samples/tasks/scenarios.
Section "runners" specifies the way, how task should be run. To learn more about runners configurations, see samples in doc/samples/tasks/runners.
Section "context" defines different types of environments in which task can be launched. Look at doc/samples/tasks/contexts for samples.
Section "sla" defines details for determining compliance with contracted values such as maximum error rate or minimum response time. Look at doc/samples/tasks/sla for samples.
See a detailed description of benchmark scenarios, contexts & runners.