OpenStack

check_api_versions [Validator]¶

Additional validation for api_versions context

Namespace: default

Module: rally.plugins.openstack.context.api_versions

check_cleanup_resources [Validator]¶

Validates that openstack resource managers exist

Namespace: default

Parameters:

admin_required [ref]

Describes access level to resource

Module: rally.plugins.openstack.context.cleanup.base

check_constant [Validator]¶

Additional schema validation for constant runner

Namespace: default

Module: rally.plugins.common.runners.constant

check_rps [Validator]¶

Additional schema validation for rps runner

Namespace: default

Module: rally.plugins.common.runners.rps

enum [Validator]¶

Checks that parameter is in a list.

Ensure a parameter has the right value. This value need to be defined in a list.

Namespace: default

Parameters:

param_name [ref]

Name of parameter to validate

values [ref]

List of values accepted

missed [ref]

Allow to accept optional parameter

case_insensitive [ref]

Ignore case in enum values

external_network_exists [Validator]¶

Validator checks that external network with given name exists.

Namespace: openstack

Parameters:

param_name [ref]

Name of validated network

image_exists [Validator]¶

Validator checks existed image or not

Namespace: openstack

Parameters:

param_name [ref]

Defines which variable should be used to get image id value.

nullable [ref]

Defines image id param is required

image_valid_on_flavor [Validator]¶

Returns validator for image could be used for current flavor

Namespace: openstack

Parameters:

flavor_param [ref]

Defines which variable should be used to get flavor id value.

image_param [ref]

Defines which variable should be used to get image id value.

validate_disk [ref]

Flag to indicate whether to validate flavor's disk. Should be True if instance is booted from image. Should be False if instance is booted from volume. Default value is True.

fail_on_404_image [ref]

Flag what indicate whether to validate image or not.

jsonschema [Validator]¶

JSON schema validator

Namespace: default

number [Validator]¶

Checks that parameter is a number that pass specified condition.

Ensure a parameter is within the range [minval, maxval]. This is a closed interval so the end points are included.

Namespace: default

Parameters:

param_name [ref]

Name of parameter to validate

minval [ref]

Lower endpoint of valid interval

maxval [ref]

Upper endpoint of valid interval

nullable [ref]

Allow parameter not specified, or parameter=None

integer_only [ref]

Only accept integers

old_validator [Validator]¶

Legacy validator for OpenStack scenarios

Namespace: openstack

Parameters:

fn [ref]

Function that performs validation

Module: rally.task.validation

required_api_versions [Validator]¶

Validator checks component API versions.

Namespace: openstack

Parameters:

component [ref]

Name of required component

versions [ref]

Version of required component

required_cinder_services [Validator]¶

Validator checks that specified Cinder service is available.

It uses Cinder client with admin permissions to call: 'cinder service-list' call

Namespace: openstack

Parameters:

services [ref]

Cinder service name

required_clients [Validator]¶

Validator checks if specified OpenStack clients are available.

Namespace: openstack

Parameters:

components [ref]

List of client components names

**kwargs [ref]

Optional parameters: admin - bool, whether to use admin clients

required_contexts [Validator]¶

Validator checks if required benchmark contexts are specified.

Namespace: default

Parameters:

contexts [ref]

List of strings and tuples with context names that should be specified. Tuple represent 'at least one of the'.

required_neutron_extensions [Validator]¶

Validator checks if the specified Neutron extension is available

Namespace: openstack

Parameters:

extensions [ref]

List of Neutron extensions

required_param_or_context [Validator]¶

Validator checks if required image is specified.

Namespace: openstack

Parameters:

param_name [ref]

Name of parameter

ctx_name [ref]

Name of context

required_params [Validator]¶

Scenario required parameter validator.

This allows us to search required parameters in subdict of config.

Namespace: default

Parameters:

subdict [ref]

Sub-dict of "config" to search. if not defined - will search in "config"

params [ref]

List of required parameters

required_platform [Validator]¶

Validates credentials for specified platform.

This allows us to create 4 kind of benchmarks:

platform independent (validator is not specified)
requires platform with admin
requires platform with admin + users
requires platform with users

Namespace: default

Parameters:

platform [ref]

Name of the platform

admin [ref]

Requires admin credential

users [ref]

Requires user credentials

Module: rally.common.validation

required_services [Validator]¶

Validator checks if specified OpenStack services are available.

Namespace: openstack

Parameters:

services [ref]

List with names of required services

restricted_parameters [Validator]¶

Validates that parameters is not set.

Namespace: default

Parameters:

param_names [ref]

Parameter or parameters list to be validated.

subdict [ref]

Sub-dict of "config" to search for param_names. if not defined - will search in "config"

validate_heat_template [Validator]¶

Validates heat template.

Namespace: openstack

Parameters:

params [ref]

List of parameters to be validated.

volume_type_exists [Validator]¶

Returns validator for volume types.

Namespace: openstack

Parameters:

param_name [ref]

Defines variable to be used as the flag to determine if volume types should be checked for existence.

Deployment ¶

Engines ¶

ExistingCloud [Engine]¶

Platform independent deployment engine.

This deployment engine allows specifing list of credentials for one or more platforms.

Example configuration:

{
    "type": "ExistingCloud",
    "creds": {
        "openstack": {
            "auth_url": "http://localhost:5000/v3/",
            "region_name": "RegionOne",
            "endpoint_type": "public",
            "admin": {
                "username": "admin",
                "password": "admin",
                "user_domain_name": "admin",
                "project_name": "admin",
                "project_domain_name": "admin",
            },
            "https_insecure": False,
            "https_cacert": "",
        }
    }
}

To specify extra options use can use special "extra" parameter:

{
    "type": "ExistingCloud",
    ...
    "extra": {"some_var": "some_value"}
}

It also support deprecated version of configuration that supports only OpenStack.

keystone v2:

{
    "type": "ExistingCloud",
    "auth_url": "http://localhost:5000/v2.0/",
    "region_name": "RegionOne",
    "endpoint_type": "public",
    "admin": {
        "username": "admin",
        "password": "password",
        "tenant_name": "demo"
    },
    "https_insecure": False,
    "https_cacert": "",
}

keystone v3 API endpoint:

{
    "type": "ExistingCloud",
    "auth_url": "http://localhost:5000/v3/",
    "region_name": "RegionOne",
    "endpoint_type": "public",
    "admin": {
        "username": "admin",
        "password": "admin",
        "user_domain_name": "admin",
        "project_name": "admin",
        "project_domain_name": "admin",
    },
    "https_insecure": False,
    "https_cacert": "",
}

Namespace: default

Note

One of the following groups of parameters should be provided.

Option 1 of parameters:

Deprecated schema (openstack only)

endpoint (string/null) [ref]

users (list) [ref]

Elements of the list should follow format(s) described below:

Type: dict. Format:

 {
    "oneOf": [
        {
            "additionalProperties": false,
            "required": [
                "username",
                "password",
                "tenant_name"
            ],
            "description": "Keystone V2.0",
            "properties": {
                "username": {
                    "type": "string"
                },
                "tenant_name": {
                    "type": "string"
                },
                "password": {
                    "type": "string"
                }
            }
        },
        {
            "additionalProperties": false,
            "required": [
                "username",
                "password",
                "project_name"
            ],
            "description": "Keystone V3.0",
            "properties": {
                "username": {
                    "type": "string"
                },
                "project_name": {
                    "type": "string"
                },
                "user_domain_name": {
                    "type": "string"
                },
                "domain_name": {
                    "type": "string"
                },
                "password": {
                    "type": "string"
                },
                "project_domain_name": {
                    "type": "string"
                }
            }
        }
    ],
    "type": "object"
}

https_insecure (bool) [ref]

extra (dict) [ref]

admin (dict) [ref]

https_cacert (str) [ref]

profiler_hmac_key (string/null) [ref]

endpoint_type [ref]

Set of expected values: 'admin', 'internal', 'public', 'None'.

auth_url (str) [ref]

type (str) [ref]

region_name (str) [ref]

Option 2 of parameters:

New schema for multiplatform deployment

type [ref]

Set of expected values: 'ExistingCloud'.

creds (dict) [ref]

extra (dict) [ref]

Module: rally.deployment.engines.existing

Task Component ¶

Charts ¶

Lines [Chart]¶

Display results as generic chart with lines.

This plugin processes additive data and displays it in HTML report as linear chart with X axis bound to iteration number. Complete output data is displayed as linear chart as well, without any processing.

Examples of using this plugin in Scenario, for saving output data:

self.add_output(
    additive={"title": "Additive data as stacked area",
              "description": "Iterations trend for foo and bar",
              "chart_plugin": "Lines",
              "data": [["foo", 12], ["bar", 34]]},
    complete={"title": "Complete data as stacked area",
              "description": "Data is shown as stacked area, as-is",
              "chart_plugin": "Lines",
              "data": [["foo", [[0, 5], [1, 42], [2, 15], [3, 7]]],
                       ["bar", [[0, 2], [1, 1.3], [2, 5], [3, 9]]]],
              "label": "Y-axis label text",
              "axis_label": "X-axis label text"})

Namespace: default

Pie [Chart]¶

Display results as pie, calculate average values for additive data.

This plugin processes additive data and calculate average values. Both additive and complete data are displayed in HTML report as pie chart.

Examples of using this plugin in Scenario, for saving output data:

self.add_output(
    additive={"title": "Additive output",
              "description": ("Pie with average data "
                              "from all iterations values"),
              "chart_plugin": "Pie",
              "data": [["foo", 12], ["bar", 34], ["spam", 56]]},
    complete={"title": "Complete output",
              "description": "Displayed as a pie, as-is",
              "chart_plugin": "Pie",
              "data": [["foo", 12], ["bar", 34], ["spam", 56]]})

Namespace: default

StackedArea [Chart]¶

Display results as stacked area.

This plugin processes additive data and displays it in HTML report as stacked area with X axis bound to iteration number. Complete output data is displayed as stacked area as well, without any processing.

Keys "description", "label" and "axis_label" are optional.

Examples of using this plugin in Scenario, for saving output data:

self.add_output(
    additive={"title": "Additive data as stacked area",
              "description": "Iterations trend for foo and bar",
              "chart_plugin": "StackedArea",
              "data": [["foo", 12], ["bar", 34]]},
    complete={"title": "Complete data as stacked area",
              "description": "Data is shown as stacked area, as-is",
              "chart_plugin": "StackedArea",
              "data": [["foo", [[0, 5], [1, 42], [2, 15], [3, 7]]],
                       ["bar", [[0, 2], [1, 1.3], [2, 5], [3, 9]]]],
              "label": "Y-axis label text",
              "axis_label": "X-axis label text"})

Namespace: default

StatsTable [Chart]¶

Calculate statistics for additive data and display it as table.

This plugin processes additive data and compose statistics that is displayed as table in HTML report.

Examples of using this plugin in Scenario, for saving output data:

self.add_output(
    additive={"title": "Statistics",
              "description": ("Table with statistics generated "
                              "from all iterations values"),
              "chart_plugin": "StatsTable",
              "data": [["foo stat", 12], ["bar", 34], ["spam", 56]]})

Namespace: default

Table [Chart]¶

Display complete output as table, can not be used for additive data.

Use this plugin for complete output data to display it in HTML report as table. This plugin can not be used for additive data because it does not contain any processing logic.

Examples of using this plugin in Scenario, for saving output data:

self.add_output(
    complete={"title": "Arbitrary Table",
              "description": "Just show columns and rows as-is",
              "chart_plugin": "Table",
              "data": {"cols": ["foo", "bar", "spam"],
                       "rows": [["a row", 1, 2], ["b row", 3, 4],
                                ["c row", 5, 6]]}})

Namespace: default

TextArea [Chart]¶

Arbitrary text

This plugin processes complete data and displays of output in HTML report.

Examples of using this plugin in Scenario, for saving output data:

self.add_output(
    complete={"title": "Script Inline",
              "chart_plugin": "TextArea",
              "data": ["first output", "second output",
                       "third output"]]})

Namespace: default