rally/doc/samples/tasks
Rohan Kanade dde561addb Allow user specified tempest.conf
* Allow user specified tempest.conf in tempest benchmark tasks

Change-Id: I2591aa2febef3313cfcf0060566d17349d5da5ac
Closes-Bug: #1369407
2014-10-16 08:04:29 +02:00
..
contexts Renames *.rst files in /rally/doc/samples/tasks 2014-08-03 10:28:40 +05:30
runners Renames *.rst files in /rally/doc/samples/tasks 2014-08-03 10:28:40 +05:30
scenarios Allow user specified tempest.conf 2014-10-16 08:04:29 +02:00
sla User_stories and feature requests appended to sphinx 2014-09-12 06:49:26 +03:00
support Renames *.rst files in /rally/doc/samples/tasks 2014-08-03 10:28:40 +05:30
README.rst Renames *.rst files in /rally/doc/samples/tasks 2014-08-03 10:28:40 +05:30

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/context 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.