rally-openstack/samples/tasks/README.rst
Jesse Keating 1c04a50ee0 Update location to samples
With the docs reorg, the path to the samples/ directory changed. This updates
the tasks/code/docs that referenced it.

Change-Id: Ie1d6756b97ff631588e069ba58969dc505c1572c
2015-01-21 10:13:19 -08:00

50 lines
1.6 KiB
ReStructuredText

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 `samples/tasks/scenarios
<https://github.com/stackforge/rally/tree/master/samples/tasks/scenarios>`_.
Section "runners" specifies the way, how task should be run. To learn
more about runners configurations, see samples in `samples/tasks/runners
<https://github.com/stackforge/rally/tree/master/samples/tasks/runners>`_.
Section "context" defines different types of environments in which task can
be launched. Look at `samples/tasks/contexts
<https://github.com/stackforge/rally/tree/master/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 `samples/tasks/sla
<https://github.com/stackforge/rally/tree/master/samples/tasks/sla>`_ for
samples.
See a `detailed description of benchmark scenarios, contexts & runners
<https://github.com/stackforge/rally/tree/master/source/concepts.rst>`_.