rally/samples/tasks

Tasks Configuration Samples

To specify your tasks, use configuration files in json or yaml format.

For humans:

{
    "version": 2,
    "title": "Task title",
    "description": "Task description",
    "tags": ["tag1", "tag2"],
    "subtasks": [
        {
            "title": "Subtask title",
            "scenario": {
                "ScenarioClass.scenario_method": {
                    ...
                }
            },
            "runner": {
                ...
            },
            "contexts": {
                ...
            },
            "sla": {
                ...
            }
        }
    ]
}

Scenario Plugin should be a subclass of the base Scenario class and implement run() method. The scenario arguments are passed as the value of the single key inside the "scenario" section. To learn more about scenarios configuration, see samples in samples/tasks/scenarios.

Section "runner" specifies the way, how task should be run. To learn more about runners configurations, see samples in samples/tasks/runners.

Section "contexts" defines different types of environments in which task can be launched. Look at 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 for samples.

See a detailed description of scenarios, contexts & runners.