rally/samples/tasks
Jenkins 3424527d50 Merge "Add cinder.CreateAndSetQos scenario" 2017-05-26 00:52:52 +00:00
..
contexts [Magnum] Context and scenario for Kubernetes 2017-05-19 17:36:19 +02:00
runners [Core] Add support for default platform and rally self job 2017-03-27 20:04:14 +03:00
scenarios Merge "Add cinder.CreateAndSetQos scenario" 2017-05-26 00:52:52 +00:00
sla Implement new random name generator for keystone scenarios 2015-10-16 08:00:21 -05:00
support [Plugins] Replace instance_dd_test.sh with instance_test.sh 2016-10-06 16:55:48 +03:00
README.rst Update stackforge to openstack 2015-04-20 14:02:43 +05:30

README.rst

Tasks Configuration Samples

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

JSON schema of input task format:

:

{
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema",
    "patternProperties": {
        ".*": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "args": {
                        "type": "object"
                    },
                    "runner": {
                        "type": "object",
                        "properties": {
                            "type": {"type": "string"}
                        },
                        "required": ["type"]
                    },
                    "context": {
                        "type": "object"
                    },
                    "sla": {
                        "type": "object"
                    },
                },
                "additionalProperties": False
            }
        }
    }
}

For humans:

::
{
"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.

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

Section "context" 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 benchmark scenarios, contexts & runners.