Skip to content

Plugins for OpenStack

Processed releases: rally-openstack 1.0.0 - 1.2.0

Environment Component

Platform

existing [Platform]

Default plugin for OpenStack platform.

It may be used to test any existing OpenStack API compatible cloud.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "type": "object", 
    "properties": {
        "admin": {
            "$ref": "#/definitions/user"
        }, 
        "auth_url": {
            "type": "string"
        }, 
        "endpoint": {
            "type": [
                "string", 
                "null"
            ]
        }, 
        "endpoint_type": {
            "enum": [
                "public", 
                "internal", 
                "admin", 
                null
            ]
        }, 
        "https_cacert": {
            "type": "string"
        }, 
        "https_insecure": {
            "type": "boolean"
        }, 
        "profiler_conn_str": {
            "type": [
                "string", 
                "null"
            ]
        }, 
        "profiler_hmac_key": {
            "type": [
                "string", 
                "null"
            ]
        }, 
        "region_name": {
            "type": "string"
        }, 
        "users": {
            "type": "array", 
            "items": {
                "$ref": "#/definitions/user"
            }, 
            "minItems": 1
        }
    }, 
    "additionalProperties": false, 
    "anyOf": [
        {
            "description": "The case when the admin is specified and the users can be created via 'users@openstack' context or 'existing_users' will be used.", 
            "required": [
                "admin", 
                "auth_url"
            ]
        }, 
        {
            "description": "The case when the only existing users are specified.", 
            "required": [
                "users", 
                "auth_url"
            ]
        }
    ], 
    "definitions": {
        "user": {
            "type": "object", 
            "oneOf": [
                {
                    "description": "Keystone V2.0", 
                    "properties": {
                        "password": {
                            "type": "string"
                        }, 
                        "tenant_name": {
                            "type": "string"
                        }, 
                        "username": {
                            "type": "string"
                        }
                    }, 
                    "additionalProperties": false, 
                    "required": [
                        "username", 
                        "password", 
                        "tenant_name"
                    ]
                }, 
                {
                    "description": "Keystone V3.0", 
                    "properties": {
                        "domain_name": {
                            "type": "string"
                        }, 
                        "password": {
                            "type": "string"
                        }, 
                        "project_domain_name": {
                            "type": "string"
                        }, 
                        "project_name": {
                            "type": "string"
                        }, 
                        "user_domain_name": {
                            "type": "string"
                        }, 
                        "username": {
                            "type": "string"
                        }
                    }, 
                    "additionalProperties": false, 
                    "required": [
                        "username", 
                        "password", 
                        "project_name"
                    ]
                }
            ]
        }
    }
}

Module: rally_openstack.platforms.existing


Task Component

Chart

Base class for charts.

This is a base for all plugins that prepare data for specific charts in HTML report. Each chart must at least declare chart widget and prepare data that is suitable for rendering by JavaScript.

OSProfiler [Chart]

osprofiler content.

This plugin complete data of osprofiler

Platform: default

Module: rally_openstack.embedcharts.osprofilerchart


Context

allow_ssh [Context]

Sets up security groups for all users to access VM via SSH.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "type": "null"
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.network.allow_ssh


api_versions [Context]

Context for specifying OpenStack clients versions and service types.

Some OpenStack services support several API versions. To recognize the endpoints of each version, separate service types are provided in Keystone service catalog.

Rally has the map of default service names - service types. But since service type is an entity, which can be configured manually by admin( via keystone api) without relation to service name, such map can be insufficient.

Also, Keystone service catalog does not provide a map types to name (this statement is true for keystone < 3.3 ).

This context was designed for not-default service types and not-default API versions usage.

An example of specifying API version:

# In this example we will launch NovaKeypair.create_and_list_keypairs
# scenario on 2.2 api version.
{
    "NovaKeypair.create_and_list_keypairs": [
        {
            "args": {
                "key_type": "x509"
            },
            "runner": {
                "type": "constant",
                "times": 10,
                "concurrency": 2
            },
            "context": {
                "users": {
                    "tenants": 3,
                    "users_per_tenant": 2
                },
                "api_versions": {
                    "nova": {
                        "version": 2.2
                    }
                }
            }
        }
    ]
}

An example of specifying API version along with service type:

# In this example we will launch CinderVolumes.create_and_attach_volume
# scenario on Cinder V2
{
    "CinderVolumes.create_and_attach_volume": [
        {
            "args": {
                "size": 10,
                "image": {
                    "name": "^cirros.*-disk$"
                },
                "flavor": {
                    "name": "m1.tiny"
                },
                "create_volume_params": {
                    "availability_zone": "nova"
                }
            },
            "runner": {
                "type": "constant",
                "times": 5,
                "concurrency": 1
            },
            "context": {
                "users": {
                    "tenants": 2,
                    "users_per_tenant": 2
                },
                "api_versions": {
                    "cinder": {
                        "version": 2,
                        "service_type": "volumev2"
                    }
                }
            }
        }
    ]
}

Also, it possible to use service name as an identifier of service endpoint, but an admin user is required (Keystone can return map of service names - types, but such API is permitted only for admin). An example:

# Similar to the previous example, but `service_name` argument is used
# instead of `service_type`
{
    "CinderVolumes.create_and_attach_volume": [
        {
            "args": {
                "size": 10,
                "image": {
                    "name": "^cirros.*-disk$"
                },
                "flavor": {
                    "name": "m1.tiny"
                },
                "create_volume_params": {
                    "availability_zone": "nova"
                }
            },
            "runner": {
                "type": "constant",
                "times": 5,
                "concurrency": 1
            },
            "context": {
                "users": {
                    "tenants": 2,
                    "users_per_tenant": 2
                },
                "api_versions": {
                    "cinder": {
                        "version": 2,
                        "service_name": "cinderv2"
                    }
                }
            }
        }
    ]
}

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "patternProperties": {
        "^[a-z]+$": {
            "type": "object", 
            "oneOf": [
                {
                    "description": "version only", 
                    "properties": {
                        "version": {
                            "anyOf": [
                                {
                                    "type": "string", 
                                    "description": "a string-like version."
                                }, 
                                {
                                    "type": "number", 
                                    "description": "a number-like version."
                                }
                            ]
                        }
                    }, 
                    "additionalProperties": false, 
                    "required": [
                        "version"
                    ]
                }, 
                {
                    "description": "version and service_name", 
                    "properties": {
                        "service_name": {
                            "type": "string"
                        }, 
                        "version": {
                            "anyOf": [
                                {
                                    "type": "string", 
                                    "description": "a string-like version."
                                }, 
                                {
                                    "type": "number", 
                                    "description": "a number-like version."
                                }
                            ]
                        }
                    }, 
                    "additionalProperties": false, 
                    "required": [
                        "service_name"
                    ]
                }, 
                {
                    "description": "version and service_type", 
                    "properties": {
                        "service_type": {
                            "type": "string"
                        }, 
                        "version": {
                            "anyOf": [
                                {
                                    "type": "string", 
                                    "description": "a string-like version."
                                }, 
                                {
                                    "type": "number", 
                                    "description": "a number-like version."
                                }
                            ]
                        }
                    }, 
                    "additionalProperties": false, 
                    "required": [
                        "service_type"
                    ]
                }
            ]
        }
    }, 
    "minProperties": 1, 
    "additionalProperties": false
}

Module: rally_openstack.contexts.api_versions


audit_templates [Context]

Creates Watcher audit templates for tenants.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "audit_templates_per_admin": {
            "type": "integer", 
            "minimum": 1
        }, 
        "fill_strategy": {
            "enum": [
                "round_robin", 
                "random", 
                null
            ]
        }, 
        "params": {
            "type": "array", 
            "items": {
                "type": "object", 
                "properties": {
                    "goal": {
                        "type": "object", 
                        "properties": {
                            "name": {
                                "type": "string"
                            }
                        }, 
                        "additionalProperties": false
                    }, 
                    "strategy": {
                        "type": "object", 
                        "properties": {
                            "name": {
                                "type": "string"
                            }
                        }, 
                        "additionalProperties": false
                    }
                }, 
                "additionalProperties": false
            }, 
            "minItems": 1, 
            "uniqueItems": true
        }
    }, 
    "additionalProperties": false, 
    "required": [
        "params"
    ]
}

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.contexts.watcher.audit_templates


ca_certs [Context]

Creates ca certs.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "directory": {
            "type": "string"
        }
    }, 
    "additionalProperties": false
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.magnum.ca_certs


ceilometer [Context]

Creates ceilometer samples and resources.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "batch_size": {
            "type": "integer", 
            "minimum": 1
        }, 
        "batches_allow_lose": {
            "type": "integer", 
            "minimum": 0
        }, 
        "counter_name": {
            "type": "string"
        }, 
        "counter_type": {
            "type": "string"
        }, 
        "counter_unit": {
            "type": "string"
        }, 
        "counter_volume": {
            "type": "number", 
            "minimum": 0
        }, 
        "metadata_list": {
            "type": "array", 
            "items": {
                "type": "object", 
                "properties": {
                    "created_at": {
                        "type": "string"
                    }, 
                    "deleted": {
                        "type": "string"
                    }, 
                    "name": {
                        "type": "string"
                    }, 
                    "status": {
                        "type": "string"
                    }
                }, 
                "additionalProperties": false
            }
        }, 
        "resources_per_tenant": {
            "type": "integer", 
            "minimum": 1
        }, 
        "samples_per_resource": {
            "type": "integer", 
            "minimum": 1
        }, 
        "timestamp_interval": {
            "type": "integer", 
            "minimum": 1
        }
    }, 
    "additionalProperties": false, 
    "required": [
        "counter_name", 
        "counter_type", 
        "counter_unit", 
        "counter_volume"
    ]
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.ceilometer.samples


cluster_templates [Context]

Creates Magnum cluster template.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "coe": {
            "type": "string"
        }, 
        "dns_nameserver": {
            "type": "string"
        }, 
        "docker_storage_driver": {
            "type": "string"
        }, 
        "docker_volume_size": {
            "type": "integer"
        }, 
        "external_network_id": {
            "type": "string"
        }, 
        "fixed_network": {
            "type": "string"
        }, 
        "fixed_subnet": {
            "type": "string"
        }, 
        "flavor_id": {
            "type": "string"
        }, 
        "http_proxy": {
            "type": "string"
        }, 
        "https_proxy": {
            "type": "string"
        }, 
        "image_id": {
            "type": "string"
        }, 
        "labels": {
            "type": "string"
        }, 
        "master_flavor_id": {
            "type": "string"
        }, 
        "master_lb_enabled": {
            "type": "boolean"
        }, 
        "network_driver": {
            "type": "string"
        }, 
        "no_proxy": {
            "type": "string"
        }, 
        "public": {
            "type": "boolean"
        }, 
        "registry_enabled": {
            "type": "boolean"
        }, 
        "server_type": {
            "type": "string"
        }, 
        "tls_disabled": {
            "type": "boolean"
        }, 
        "volume_driver": {
            "type": "string"
        }
    }, 
    "additionalProperties": false, 
    "required": [
        "image_id", 
        "external_network_id", 
        "coe"
    ]
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.magnum.cluster_templates


clusters [Context]

Creates specified amount of Magnum clusters.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "cluster_template_uuid": {
            "type": "string"
        }, 
        "node_count": {
            "type": "integer", 
            "minimum": 1
        }
    }, 
    "additionalProperties": false
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.magnum.clusters


ec2_servers [Context]

Creates specified amount of nova servers in each tenant uses ec2 API.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "flavor": {
            "type": "object", 
            "properties": {
                "name": {
                    "type": "string"
                }
            }, 
            "additionalProperties": false
        }, 
        "image": {
            "type": "object", 
            "properties": {
                "name": {
                    "type": "string"
                }
            }, 
            "additionalProperties": false
        }, 
        "servers_per_tenant": {
            "type": "integer", 
            "minimum": 1
        }
    }, 
    "additionalProperties": false, 
    "required": [
        "image", 
        "flavor", 
        "servers_per_tenant"
    ]
}

Module: rally_openstack.contexts.ec2.servers


existing_network [Context]

This context supports using existing networks in Rally.

This context should be used on a deployment with existing users.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "additionalProperties": false
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.network.existing_network


flavors [Context]

Context creates a list of flavors.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "array", 
    "items": {
        "type": "object", 
        "properties": {
            "disk": {
                "type": "integer", 
                "minimum": 0
            }, 
            "ephemeral": {
                "type": "integer", 
                "minimum": 0
            }, 
            "extra_specs": {
                "type": "object", 
                "additionalProperties": {
                    "type": "string"
                }
            }, 
            "name": {
                "type": "string"
            }, 
            "ram": {
                "type": "integer", 
                "minimum": 1
            }, 
            "swap": {
                "type": "integer", 
                "minimum": 0
            }, 
            "vcpus": {
                "type": "integer", 
                "minimum": 1
            }
        }, 
        "additionalProperties": false, 
        "required": [
            "name", 
            "ram"
        ]
    }
}

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.contexts.nova.flavors


heat_dataplane [Context]

Context class for create stack by given template.

This context will create stacks by given template for each tenant and add details to context. Following details will be added:

  • id of stack;
  • template file contents;
  • files dictionary;
  • stack parameters;

Heat template should define a "gate" node which will interact with Rally by ssh and workload nodes by any protocol. To make this possible heat template should accept the following parameters:

  • network_id: id of public network
  • router_id: id of external router to connect "gate" node
  • key_name: name of nova ssh keypair to use for "gate" node

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "context_parameters": {
            "type": "object", 
            "additionalProperties": true
        }, 
        "files": {
            "type": "object", 
            "additionalProperties": true
        }, 
        "parameters": {
            "type": "object", 
            "additionalProperties": true
        }, 
        "stacks_per_tenant": {
            "type": "integer", 
            "minimum": 1
        }, 
        "template": {
            "oneOf": [
                {
                    "type": "string", 
                    "description": ""
                }, 
                {
                    "type": "array", 
                    "description": "", 
                    "items": {
                        "type": "string"
                    }, 
                    "minItems": 2, 
                    "maxItems": 2
                }
            ]
        }
    }, 
    "additionalProperties": false
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.dataplane.heat


image_command_customizer [Context]

Context class for generating image customized by a command execution.

Run a command specified by configuration to prepare image.

Use this script e.g. to download and install something.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "command": {
            "$ref": "#/definitions/commandDict"
        }, 
        "flavor": {
            "type": "object", 
            "properties": {
                "name": {
                    "type": "string"
                }
            }, 
            "additionalProperties": false
        }, 
        "floating_network": {
            "type": "string"
        }, 
        "image": {
            "type": "object", 
            "properties": {
                "name": {
                    "type": "string"
                }
            }, 
            "additionalProperties": false
        }, 
        "internal_network": {
            "type": "string"
        }, 
        "password": {
            "type": "string"
        }, 
        "port": {
            "type": "integer", 
            "minimum": 1, 
            "maximum": 65535
        }, 
        "userdata": {
            "type": "string"
        }, 
        "username": {
            "type": "string"
        }, 
        "workers": {
            "type": "integer", 
            "minimum": 1
        }
    }, 
    "additionalProperties": false, 
    "required": [
        "image", 
        "flavor"
    ], 
    "definitions": {
        "commandDict": {
            "oneOf": [
                {
                    "$ref": "#/definitions/scriptFile"
                }, 
                {
                    "$ref": "#/definitions/scriptInline"
                }, 
                {
                    "$ref": "#/definitions/commandPath"
                }
            ]
        }, 
        "commandPath": {
            "type": "object", 
            "properties": {
                "command_args": {
                    "$ref": "#/definitions/stringOrStringList"
                }, 
                "local_path": {
                    "type": "string"
                }, 
                "remote_path": {
                    "$ref": "#/definitions/stringOrStringList"
                }
            }, 
            "additionalProperties": false, 
            "required": [
                "remote_path"
            ]
        }, 
        "scriptFile": {
            "type": "object", 
            "properties": {
                "command_args": {
                    "$ref": "#/definitions/stringOrStringList"
                }, 
                "interpreter": {
                    "$ref": "#/definitions/stringOrStringList"
                }, 
                "script_file": {
                    "$ref": "#/definitions/stringOrStringList"
                }
            }, 
            "additionalProperties": false, 
            "required": [
                "script_file", 
                "interpreter"
            ]
        }, 
        "scriptInline": {
            "type": "object", 
            "properties": {
                "command_args": {
                    "$ref": "#/definitions/stringOrStringList"
                }, 
                "interpreter": {
                    "$ref": "#/definitions/stringOrStringList"
                }, 
                "script_inline": {
                    "type": "string"
                }
            }, 
            "additionalProperties": false, 
            "required": [
                "script_inline", 
                "interpreter"
            ]
        }, 
        "stringOrStringList": {
            "anyOf": [
                {
                    "type": "string", 
                    "description": "just a string"
                }, 
                {
                    "type": "array", 
                    "description": "just a list of strings", 
                    "items": {
                        "type": "string"
                    }
                }
            ]
        }
    }
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.vm.image_command_customizer


images [Context]

Uploads specified Glance images to every tenant.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "container_format": {
            "description": "Format of the image container.", 
            "enum": [
                "aki", 
                "ami", 
                "ari", 
                "bare", 
                "docker", 
                "ova", 
                "ovf"
            ]
        }, 
        "disk_format": {
            "description": "The format of the disk.", 
            "enum": [
                "qcow2", 
                "raw", 
                "vhd", 
                "vmdk", 
                "vdi", 
                "iso", 
                "aki", 
                "ari", 
                "ami"
            ]
        }, 
        "image_args": {
            "type": "object", 
            "description": "This param is deprecated since Rally-0.10.0, specify exact arguments in a root section of context instead.", 
            "additionalProperties": true
        }, 
        "image_container": {
            "type": "string", 
            "description": "This param is deprecated since Rally-0.10.0, use `container_format` instead."
        }, 
        "image_name": {
            "type": "string", 
            "description": "The name of image to create. NOTE: it will be ignored in case when `images_per_tenant` is bigger then 1."
        }, 
        "image_type": {
            "description": "This param is deprecated since Rally-0.10.0, use `disk_format` instead.", 
            "enum": [
                "qcow2", 
                "raw", 
                "vhd", 
                "vmdk", 
                "vdi", 
                "iso", 
                "aki", 
                "ari", 
                "ami"
            ]
        }, 
        "image_url": {
            "type": "string", 
            "description": "Location of the source to create image from."
        }, 
        "images_per_tenant": {
            "type": "integer", 
            "description": "The number of images to create per one single tenant.", 
            "minimum": 1
        }, 
        "min_disk": {
            "type": "integer", 
            "description": "Amount of disk space in GB", 
            "minimum": 0
        }, 
        "min_ram": {
            "type": "integer", 
            "description": "Amount of RAM in MB", 
            "minimum": 0
        }, 
        "visibility": {
            "description": "Visibility for this image ('shared' and 'community' are available only in case of Glance V2).", 
            "enum": [
                "public", 
                "private", 
                "shared", 
                "community"
            ]
        }
    }, 
    "additionalProperties": false, 
    "oneOf": [
        {
            "description": "It is been used since Rally 0.10.0", 
            "required": [
                "image_url", 
                "disk_format", 
                "container_format"
            ]
        }, 
        {
            "description": "One of backward compatible way", 
            "required": [
                "image_url", 
                "image_type", 
                "container_format"
            ]
        }, 
        {
            "description": "One of backward compatible way", 
            "required": [
                "image_url", 
                "disk_format", 
                "image_container"
            ]
        }, 
        {
            "description": "One of backward compatible way", 
            "required": [
                "image_url", 
                "image_type", 
                "image_container"
            ]
        }
    ]
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.glance.images


keypair [Context]

Create Nova KeyPair for each user.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "type": "object", 
    "additionalProperties": false
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.nova.keypairs


lbaas [Context]

Creates a lb-pool for every subnet created in network context.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "lbaas_version": {
            "type": "integer", 
            "minimum": 1
        }, 
        "pool": {
            "type": "object", 
            "additionalProperties": true
        }
    }, 
    "additionalProperties": false
}

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.contexts.neutron.lbaas


manila_security_services [Context]

This context creates 'security services' for Manila project.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "security_services": {
            "type": "array", 
            "description": "It is expected to be list of dicts with data for creation of security services.", 
            "items": {
                "type": "object", 
                "description": "Data for creation of security services. \n Example:\n\n   .. code-block:: json\n\n     {'type': 'LDAP', 'dns_ip': 'foo_ip', \n      'server': 'bar_ip', 'domain': 'quuz_domain',\n      'user': 'ololo', 'password': 'fake_password'}\n", 
                "properties": {
                    "type": {
                        "enum": [
                            "active_directory", 
                            "kerberos", 
                            "ldap"
                        ]
                    }
                }, 
                "additionalProperties": true, 
                "required": [
                    "type"
                ]
            }
        }
    }, 
    "additionalProperties": false
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.manila.manila_security_services


manila_share_networks [Context]

This context creates share networks for Manila project.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "share_networks": {
            "type": "object", 
            "description": "\nThis context arg will be used only when context arg \"use_share_networks\" is\nset to True.\n\nIf context arg 'share_networks' has values then they will be used else share\nnetworks will be autocreated - one for each tenant network. If networks do not\nexist then will be created one share network for each tenant without network\ndata.\n\nExpected value is dict of lists where tenant Name or ID is key and list of\nshare_network Names or IDs is value. Example:\n\n   .. code-block:: json\n\n     \"context\": {\n         \"manila_share_networks\": {\n         \"use_share_networks\": true,\n         \"share_networks\": {\n             \"tenant_1_name_or_id\": [\"share_network_1_name_or_id\",\n                                     \"share_network_2_name_or_id\"],\n             \"tenant_2_name_or_id\": [\"share_network_3_name_or_id\"]}\n         }\n     }\n\nAlso, make sure that all 'existing users' in appropriate registered deployment\nhave share networks if its usage is enabled, else Rally will randomly take\nusers that does not satisfy criteria.\n", 
            "additionalProperties": true
        }, 
        "use_share_networks": {
            "type": "boolean", 
            "description": "Specifies whether manila should use share networks for share creation or not."
        }
    }, 
    "additionalProperties": false
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.manila.manila_share_networks


manila_shares [Context]

This context creates shares for Manila project.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "share_proto": {
            "type": "string"
        }, 
        "share_type": {
            "type": "string"
        }, 
        "shares_per_tenant": {
            "type": "integer", 
            "minimum": 1
        }, 
        "size": {
            "type": "integer", 
            "minimum": 1
        }
    }, 
    "additionalProperties": false
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.manila.manila_shares


monasca_metrics [Context]

Creates Monasca Metrics.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "dimensions": {
            "type": "object", 
            "properties": {
                "hostname": {
                    "type": "string"
                }, 
                "region": {
                    "type": "string"
                }, 
                "service": {
                    "type": "string"
                }, 
                "url": {
                    "type": "string"
                }
            }, 
            "additionalProperties": false
        }, 
        "metrics_per_tenant": {
            "type": "integer", 
            "minimum": 1
        }, 
        "name": {
            "type": "string"
        }, 
        "value_meta": {
            "type": "array", 
            "items": {
                "type": "object", 
                "properties": {
                    "value_meta_key": {
                        "type": "string"
                    }, 
                    "value_meta_value": {
                        "type": "string"
                    }
                }, 
                "additionalProperties": false
            }
        }
    }, 
    "additionalProperties": false
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.monasca.metrics


murano_environments [Context]

Context class for creating murano environments.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "environments_per_tenant": {
            "type": "integer", 
            "minimum": 1
        }
    }, 
    "additionalProperties": false, 
    "required": [
        "environments_per_tenant"
    ]
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.murano.murano_environments


murano_packages [Context]

Context class for uploading applications for murano.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "app_package": {
            "type": "string"
        }
    }, 
    "additionalProperties": false, 
    "required": [
        "app_package"
    ]
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.murano.murano_packages


network [Context]

Create networking resources.

This creates networks for all tenants, and optionally creates another resources like subnets and routers.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "dns_nameservers": {
            "type": "array", 
            "items": {
                "type": "string"
            }, 
            "uniqueItems": true
        }, 
        "dualstack": {
            "type": "boolean"
        }, 
        "network_create_args": {
            "type": "object", 
            "additionalProperties": true
        }, 
        "networks_per_tenant": {
            "type": "integer", 
            "minimum": 1
        }, 
        "router": {
            "type": "object", 
            "properties": {
                "external": {
                    "type": "boolean"
                }, 
                "external_gateway_info": {
                    "type": "object", 
                    "description": "The external gateway information .", 
                    "properties": {
                        "enable_snat": {
                            "type": "boolean"
                        }, 
                        "network_id": {
                            "type": "string"
                        }
                    }, 
                    "additionalProperties": false
                }
            }, 
            "additionalProperties": false
        }, 
        "start_cidr": {
            "type": "string"
        }, 
        "subnets_per_network": {
            "type": "integer", 
            "minimum": 1
        }
    }, 
    "additionalProperties": false
}

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.contexts.network.networks


profiles [Context]

Context creates a temporary profile for Senlin test.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "properties": {
            "type": "object", 
            "additionalProperties": true
        }, 
        "type": {
            "type": "string"
        }, 
        "version": {
            "type": "string"
        }
    }, 
    "additionalProperties": false, 
    "required": [
        "type", 
        "version", 
        "properties"
    ]
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.senlin.profiles


quotas [Context]

Sets OpenStack Tenants quotas.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "cinder": {
            "type": "object", 
            "properties": {
                "backup_gigabytes": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "backups": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "gigabytes": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "snapshots": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "volumes": {
                    "type": "integer", 
                    "minimum": -1
                }
            }, 
            "additionalProperties": false
        }, 
        "designate": {
            "type": "object", 
            "properties": {
                "domain_records": {
                    "type": "integer", 
                    "minimum": 1
                }, 
                "domain_recordsets": {
                    "type": "integer", 
                    "minimum": 1
                }, 
                "domains": {
                    "type": "integer", 
                    "minimum": 1
                }, 
                "recordset_records": {
                    "type": "integer", 
                    "minimum": 1
                }
            }, 
            "additionalProperties": false
        }, 
        "manila": {
            "type": "object", 
            "properties": {
                "gigabytes": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "share_networks": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "shares": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "snapshot_gigabytes": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "snapshots": {
                    "type": "integer", 
                    "minimum": -1
                }
            }, 
            "additionalProperties": false
        }, 
        "neutron": {
            "type": "object", 
            "properties": {
                "floatingip": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "health_monitor": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "network": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "pool": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "port": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "router": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "security_group": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "security_group_rule": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "subnet": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "vip": {
                    "type": "integer", 
                    "minimum": -1
                }
            }, 
            "additionalProperties": false
        }, 
        "nova": {
            "type": "object", 
            "properties": {
                "cores": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "fixed_ips": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "floating_ips": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "injected_file_content_bytes": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "injected_file_path_bytes": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "injected_files": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "instances": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "key_pairs": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "metadata_items": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "ram": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "security_group_rules": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "security_groups": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "server_group_members": {
                    "type": "integer", 
                    "minimum": -1
                }, 
                "server_groups": {
                    "type": "integer", 
                    "minimum": -1
                }
            }, 
            "additionalProperties": false
        }
    }, 
    "additionalProperties": false
}

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.contexts.quotas.quotas


roles [Context]

Context class for assigning roles for users.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "array", 
    "items": {
        "type": "string", 
        "description": "The name of role to assign to user"
    }
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.keystone.roles


router [Context]

Create networking resources.

This creates router for all tenants.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "admin_state_up ": {
            "type": "boolean", 
            "description": "A human-readable description for the resource"
        }, 
        "availability_zone_hints": {
            "type": "boolean", 
            "description": "Require router_availability_zone extension."
        }, 
        "distributed": {
            "type": "boolean", 
            "description": "Distributed router. Require dvr extension."
        }, 
        "external_fixed_ips": {
            "type": "array", 
            "description": "Ip(s) of the external gateway interface.", 
            "items": {
                "type": "object", 
                "properties": {
                    "ip_address": {
                        "type": "string"
                    }, 
                    "subnet_id": {
                        "type": "string"
                    }
                }, 
                "additionalProperties": false
            }
        }, 
        "external_gateway_info": {
            "type": "object", 
            "description": "The external gateway information .", 
            "properties": {
                "enable_snat": {
                    "type": "boolean"
                }, 
                "network_id": {
                    "type": "string"
                }
            }, 
            "additionalProperties": false
        }, 
        "ha": {
            "type": "boolean", 
            "description": "Highly-available router. Require l3-ha."
        }, 
        "network_id": {
            "type": "string", 
            "description": "Network ID"
        }, 
        "routers_per_tenant": {
            "type": "integer", 
            "minimum": 1
        }
    }, 
    "additionalProperties": false
}

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.contexts.network.routers


sahara_cluster [Context]

Context class for setting up the Cluster an EDP job.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "auto_security_group": {
            "type": "boolean"
        }, 
        "cluster_configs": {
            "type": "object", 
            "additionalProperties": true
        }, 
        "enable_anti_affinity": {
            "type": "boolean"
        }, 
        "enable_proxy": {
            "type": "boolean"
        }, 
        "flavor_id": {
            "type": "string"
        }, 
        "floating_ip_pool": {
            "type": "string"
        }, 
        "hadoop_version": {
            "type": "string"
        }, 
        "master_flavor_id": {
            "type": "string"
        }, 
        "node_configs": {
            "type": "object", 
            "additionalProperties": true
        }, 
        "plugin_name": {
            "type": "string"
        }, 
        "security_groups": {
            "type": "array", 
            "items": {
                "type": "string"
            }
        }, 
        "use_autoconfig": {
            "type": "boolean"
        }, 
        "volumes_per_node": {
            "type": "integer", 
            "minimum": 1
        }, 
        "volumes_size": {
            "type": "integer", 
            "minimum": 1
        }, 
        "worker_flavor_id": {
            "type": "string"
        }, 
        "workers_count": {
            "type": "integer", 
            "minimum": 1
        }
    }, 
    "additionalProperties": false, 
    "required": [
        "plugin_name", 
        "hadoop_version", 
        "workers_count", 
        "master_flavor_id", 
        "worker_flavor_id"
    ]
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.sahara.sahara_cluster


sahara_image [Context]

Context class for adding and tagging Sahara images.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "hadoop_version": {
            "type": "string"
        }, 
        "image_url": {
            "type": "string"
        }, 
        "image_uuid": {
            "type": "string"
        }, 
        "plugin_name": {
            "type": "string"
        }, 
        "username": {
            "type": "string"
        }
    }, 
    "additionalProperties": false, 
    "oneOf": [
        {
            "description": "Create an image.", 
            "required": [
                "image_url", 
                "username", 
                "plugin_name", 
                "hadoop_version"
            ]
        }, 
        {
            "description": "Use an existing image.", 
            "required": [
                "image_uuid"
            ]
        }
    ]
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.sahara.sahara_image


sahara_input_data_sources [Context]

Context class for setting up Input Data Sources for an EDP job.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "input_type": {
            "enum": [
                "swift", 
                "hdfs"
            ]
        }, 
        "input_url": {
            "type": "string"
        }, 
        "swift_files": {
            "type": "array", 
            "items": {
                "type": "object", 
                "properties": {
                    "download_url": {
                        "type": "string"
                    }, 
                    "name": {
                        "type": "string"
                    }
                }, 
                "additionalProperties": false, 
                "required": [
                    "name", 
                    "download_url"
                ]
            }
        }
    }, 
    "additionalProperties": false, 
    "required": [
        "input_type", 
        "input_url"
    ]
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.sahara.sahara_input_data_sources


sahara_job_binaries [Context]

Context class for setting up Job Binaries for an EDP job.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "libs": {
            "type": "array", 
            "items": {
                "type": "object", 
                "properties": {
                    "download_url": {
                        "type": "string"
                    }, 
                    "name": {
                        "type": "string"
                    }
                }, 
                "additionalProperties": false, 
                "required": [
                    "name", 
                    "download_url"
                ]
            }
        }, 
        "mains": {
            "type": "array", 
            "items": {
                "type": "object", 
                "properties": {
                    "download_url": {
                        "type": "string"
                    }, 
                    "name": {
                        "type": "string"
                    }
                }, 
                "additionalProperties": false, 
                "required": [
                    "name", 
                    "download_url"
                ]
            }
        }
    }, 
    "additionalProperties": false
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.sahara.sahara_job_binaries


sahara_output_data_sources [Context]

Context class for setting up Output Data Sources for an EDP job.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "output_type": {
            "enum": [
                "swift", 
                "hdfs"
            ]
        }, 
        "output_url_prefix": {
            "type": "string"
        }
    }, 
    "additionalProperties": false, 
    "required": [
        "output_type", 
        "output_url_prefix"
    ]
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.sahara.sahara_output_data_sources


servers [Context]

Creates specified amount of Nova Servers per each tenant.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "type": "object", 
    "properties": {
        "auto_assign_nic": {
            "type": "boolean", 
            "description": "True if NICs should be assigned."
        }, 
        "flavor": {
            "type": "object", 
            "description": "Name of flavor to boot server(s) with.", 
            "properties": {
                "name": {
                    "type": "string"
                }
            }, 
            "additionalProperties": false
        }, 
        "image": {
            "type": "object", 
            "description": "Name of image to boot server(s) from.", 
            "properties": {
                "name": {
                    "type": "string"
                }
            }, 
            "additionalProperties": false
        }, 
        "nics": {
            "type": "array", 
            "description": "List of networks to attach to server.", 
            "items": {
                "oneOf": [
                    {
                        "type": "object", 
                        "description": "Network ID in a format like OpenStack API expects to see.", 
                        "properties": {
                            "net-id": {
                                "type": "string"
                            }
                        }, 
                        "additionalProperties": false
                    }, 
                    {
                        "type": "string", 
                        "description": "Network ID."
                    }
                ]
            }, 
            "minItems": 1
        }, 
        "servers_per_tenant": {
            "type": "integer", 
            "description": "Number of servers to boot in each Tenant.", 
            "minimum": 1
        }
    }, 
    "additionalProperties": false, 
    "required": [
        "image", 
        "flavor"
    ]
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.nova.servers


stacks [Context]

Context class for create temporary stacks with resources.

Stack generator allows to generate arbitrary number of stacks for each tenant before test scenarios. In addition, it allows to define number of resources (namely OS::Heat::RandomString) that will be created inside each stack. After test execution the stacks will be automatically removed from heat.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "resources_per_stack": {
            "type": "integer", 
            "minimum": 1
        }, 
        "stacks_per_tenant": {
            "type": "integer", 
            "minimum": 1
        }
    }, 
    "additionalProperties": false
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.heat.stacks


swift_objects [Context]

Create containers and objects in each tenant.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "containers_per_tenant": {
            "type": "integer", 
            "minimum": 1
        }, 
        "object_size": {
            "type": "integer", 
            "minimum": 1
        }, 
        "objects_per_container": {
            "type": "integer", 
            "minimum": 1
        }, 
        "resource_management_workers": {
            "type": "integer", 
            "minimum": 1
        }
    }, 
    "additionalProperties": false
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.swift.objects


users [Context]

Creates specified amount of keystone users and tenants.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "anyOf": [
        {
            "description": "Create new temporary users and tenants.", 
            "properties": {
                "project_domain": {
                    "type": "string", 
                    "description": "ID of domain in which projects will be created."
                }, 
                "resource_management_workers": {
                    "type": "integer", 
                    "description": "The number of concurrent threads to use for serving users context.", 
                    "minimum": 1
                }, 
                "tenants": {
                    "type": "integer", 
                    "description": "The number of tenants to create.", 
                    "minimum": 1
                }, 
                "user_choice_method": {
                    "$ref": "#/definitions/user_choice_method"
                }, 
                "user_domain": {
                    "type": "string", 
                    "description": "ID of domain in which users will be created."
                }, 
                "users_per_tenant": {
                    "type": "integer", 
                    "description": "The number of users to create per one tenant.", 
                    "minimum": 1
                }
            }, 
            "additionalProperties": false
        }, 
        {
            "description": "Use existing users and tenants.", 
            "properties": {
                "user_choice_method": {
                    "$ref": "#/definitions/user_choice_method"
                }
            }, 
            "additionalProperties": false
        }
    ], 
    "definitions": {
        "user_choice_method": {
            "description": "The mode of balancing usage of users between scenario iterations.", 
            "enum": [
                "random", 
                "round_robin"
            ]
        }
    }
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.keystone.users


volume_types [Context]

Adds cinder volumes types.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "array", 
    "items": {
        "type": "string"
    }
}

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.contexts.cinder.volume_types


volumes [Context]

Creates volumes for each tenant.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "size": {
            "type": "integer", 
            "minimum": 1
        }, 
        "type": {
            "oneOf": [
                {
                    "type": "string", 
                    "description": "a string-like type of volume to create."
                }, 
                {
                    "type": "null", 
                    "description": "Use default type for volume to create."
                }
            ]
        }, 
        "volumes_per_tenant": {
            "type": "integer", 
            "minimum": 1
        }
    }, 
    "additionalProperties": false, 
    "required": [
        "size"
    ]
}

Module: rally_openstack.contexts.cinder.volumes


zones [Context]

Context to add zones_per_tenant zones for each tenant.

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "zones_per_tenant": {
            "type": "integer", 
            "minimum": 1
        }
    }, 
    "additionalProperties": false
}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.contexts.designate.zones


Hook Action

Factory for hook classes.

fault_injection [Hook Action]

Performs fault injection using os-faults library.

Configuration:

  • action - string that represents an action (more info in [1])
  • verify - whether to verify connection to cloud nodes or not

This plugin discovers extra config of ExistingCloud and looks for "cloud_config" field. If cloud_config is present then it will be used to connect to the cloud by os-faults.

Another option is to provide os-faults config file through OS_FAULTS_CONFIG env variable. Format of the config can be found in [1].

[1] http://os-faults.readthedocs.io/en/latest/usage.html

Platform: openstack

The input of this plugin should be valid to the following JSONSchema
{
    "$schema": "http://json-schema.org/draft-04/schema", 
    "type": "object", 
    "properties": {
        "action": {
            "type": "string"
        }, 
        "verify": {
            "type": "boolean"
        }
    }, 
    "additionalProperties": false, 
    "required": [
        "action"
    ]
}

Module: rally_openstack.hook.fault_injection


Scenario

This is base class for any scenario.

All Scenario Plugins should be subclass of this class.

Authenticate.keystone [Scenario]

Check Keystone Client.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.authenticate.authenticate


Authenticate.validate_ceilometer [Scenario]

Check Ceilometer Client to ensure validation of token.

Creation of the client does not ensure validation of the token. We have to do some minimal operation to make sure token gets validated.

Platform: openstack

Parameters
Argument Description
repetitions [ref] number of times to validate

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.authenticate.authenticate


Authenticate.validate_cinder [Scenario]

Check Cinder Client to ensure validation of token.

Creation of the client does not ensure validation of the token. We have to do some minimal operation to make sure token gets validated.

Platform: openstack

Parameters
Argument Description
repetitions [ref] number of times to validate

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.authenticate.authenticate


Authenticate.validate_glance [Scenario]

Check Glance Client to ensure validation of token.

Creation of the client does not ensure validation of the token. We have to do some minimal operation to make sure token gets validated. In following we are checking for non-existent image.

Platform: openstack

Parameters
Argument Description
repetitions [ref] number of times to validate

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.authenticate.authenticate


Authenticate.validate_heat [Scenario]

Check Heat Client to ensure validation of token.

Creation of the client does not ensure validation of the token. We have to do some minimal operation to make sure token gets validated.

Platform: openstack

Parameters
Argument Description
repetitions [ref] number of times to validate

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.authenticate.authenticate


Authenticate.validate_monasca [Scenario]

Check Monasca Client to ensure validation of token.

Creation of the client does not ensure validation of the token. We have to do some minimal operation to make sure token gets validated.

Platform: openstack

Parameters
Argument Description
repetitions [ref] number of times to validate

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.authenticate.authenticate


Authenticate.validate_neutron [Scenario]

Check Neutron Client to ensure validation of token.

Creation of the client does not ensure validation of the token. We have to do some minimal operation to make sure token gets validated.

Platform: openstack

Parameters
Argument Description
repetitions [ref] number of times to validate

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.authenticate.authenticate


Authenticate.validate_nova [Scenario]

Check Nova Client to ensure validation of token.

Creation of the client does not ensure validation of the token. We have to do some minimal operation to make sure token gets validated.

Platform: openstack

Parameters
Argument Description
repetitions [ref] number of times to validate

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.authenticate.authenticate


CeilometerAlarms.create_alarm [Scenario]

Create an alarm.

This scenarios test POST /v2/alarms. meter_name and threshold are required parameters for alarm creation. kwargs stores other optional parameters like 'ok_actions', 'project_id' etc that may be passed while creating an alarm.

Platform: openstack

Parameters
Argument Description
meter_name [ref] specifies meter name of the alarm
threshold [ref] specifies alarm threshold
kwargs [ref] specifies optional arguments for alarm creation.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ceilometer.alarms


CeilometerAlarms.create_alarm_and_get_history [Scenario]

Create an alarm, get and set the state and get the alarm history.

This scenario makes following queries:

  • GET /v2/alarms/{alarm_id}/history
  • GET /v2/alarms/{alarm_id}/state
  • PUT /v2/alarms/{alarm_id}/state

Initially alarm is created and then get the state of the created alarm using its alarm_id. Then get the history of the alarm. And finally the state of the alarm is updated using given state. meter_name and threshold are required parameters for alarm creation. kwargs stores other optional parameters like 'ok_actions', 'project_id' etc that may be passed while alarm creation.

Platform: openstack

Parameters
Argument Description
meter_name [ref] specifies meter name of the alarm
threshold [ref] specifies alarm threshold
state [ref] an alarm state to be set
timeout [ref] The number of seconds for which to attempt a successful check of the alarm state
kwargs [ref] specifies optional arguments for alarm creation.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ceilometer.alarms


CeilometerAlarms.create_and_delete_alarm [Scenario]

Create and delete the newly created alarm.

This scenarios test DELETE /v2/alarms/(alarm_id) Initially alarm is created and then the created alarm is deleted using its alarm_id. meter_name and threshold are required parameters for alarm creation. kwargs stores other optional parameters like 'ok_actions', 'project_id' etc that may be passed while alarm creation.

Platform: openstack

Parameters
Argument Description
meter_name [ref] specifies meter name of the alarm
threshold [ref] specifies alarm threshold
kwargs [ref] specifies optional arguments for alarm creation.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ceilometer.alarms


CeilometerAlarms.create_and_get_alarm [Scenario]

Create and get the newly created alarm.

These scenarios test GET /v2/alarms/(alarm_id) Initially an alarm is created and then its detailed information is fetched using its alarm_id. meter_name and threshold are required parameters for alarm creation. kwargs stores other optional parameters like 'ok_actions', 'project_id' etc. that may be passed while creating an alarm.

Platform: openstack

Parameters
Argument Description
meter_name [ref] specifies meter name of the alarm
threshold [ref] specifies alarm threshold
kwargs [ref] specifies optional arguments for alarm creation.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ceilometer.alarms


CeilometerAlarms.create_and_list_alarm [Scenario]

Create and get the newly created alarm.

This scenarios test GET /v2/alarms/(alarm_id) Initially alarm is created and then the created alarm is fetched using its alarm_id. meter_name and threshold are required parameters for alarm creation. kwargs stores other optional parameters like 'ok_actions', 'project_id' etc. that may be passed while creating an alarm.

Platform: openstack

Parameters
Argument Description
meter_name [ref] specifies meter name of the alarm
threshold [ref] specifies alarm threshold
kwargs [ref] specifies optional arguments for alarm creation.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ceilometer.alarms


CeilometerAlarms.create_and_update_alarm [Scenario]

Create and update the newly created alarm.

This scenarios test PUT /v2/alarms/(alarm_id) Initially alarm is created and then the created alarm is updated using its alarm_id. meter_name and threshold are required parameters for alarm creation. kwargs stores other optional parameters like 'ok_actions', 'project_id' etc that may be passed while alarm creation.

Platform: openstack

Parameters
Argument Description
meter_name [ref] specifies meter name of the alarm
threshold [ref] specifies alarm threshold
kwargs [ref] specifies optional arguments for alarm creation.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ceilometer.alarms


CeilometerAlarms.list_alarms [Scenario]

Fetch all alarms.

This scenario fetches list of all alarms using GET /v2/alarms.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ceilometer.alarms


CeilometerEvents.create_user_and_get_event [Scenario]

Create user and gets event.

This scenario creates user to store new event and fetches one event using GET /v2/events/.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.ceilometer.events


CeilometerEvents.create_user_and_list_event_types [Scenario]

Create user and fetch all event types.

This scenario creates user to store new event and fetches list of all events types using GET /v2/event_types.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.ceilometer.events


CeilometerEvents.create_user_and_list_events [Scenario]

Create user and fetch all events.

This scenario creates user to store new event and fetches list of all events using GET /v2/events.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.ceilometer.events


CeilometerMeters.list_matched_meters [Scenario]

Get meters that matched fields from context and args.

Platform: openstack

Parameters
Argument Description
filter_by_user_id [ref] flag for query by user_id
filter_by_project_id [ref] flag for query by project_id
filter_by_resource_id [ref] flag for query by resource_id
metadata_query [ref] dict with metadata fields and values for query
limit [ref] count of resources in response

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ceilometer.meters


CeilometerMeters.list_meters [Scenario]

Check all available queries for list resource request.

Platform: openstack

Parameters
Argument Description
metadata_query [ref] dict with metadata fields and values
limit [ref] limit of meters in response

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ceilometer.meters


CeilometerQueries.create_and_query_alarm_history [Scenario]

Create an alarm and then query for its history.

This scenario tests POST /v2/query/alarms/history An alarm is first created and then its alarm_id is used to fetch the history of that specific alarm.

Platform: openstack

Parameters
Argument Description
meter_name [ref] specifies meter name of alarm
threshold [ref] specifies alarm threshold
orderby [ref] optional param for specifying ordering of results
limit [ref] optional param for maximum number of results returned
kwargs [ref] optional parameters for alarm creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ceilometer.queries


CeilometerQueries.create_and_query_alarms [Scenario]

Create an alarm and then query it with specific parameters.

This scenario tests POST /v2/query/alarms An alarm is first created and then fetched using the input query.

Platform: openstack

Parameters
Argument Description
meter_name [ref] specifies meter name of alarm
threshold [ref] specifies alarm threshold
filter [ref] optional filter query dictionary
orderby [ref] optional param for specifying ordering of results
limit [ref] optional param for maximum number of results returned
kwargs [ref] optional parameters for alarm creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ceilometer.queries


CeilometerQueries.create_and_query_samples [Scenario]

Create a sample and then query it with specific parameters.

This scenario tests POST /v2/query/samples A sample is first created and then fetched using the input query.

Platform: openstack

Parameters
Argument Description
counter_name [ref] specifies name of the counter
counter_type [ref] specifies type of the counter
counter_unit [ref] specifies unit of the counter
counter_volume [ref] specifies volume of the counter
resource_id [ref] specifies resource id for the sample created
filter [ref] optional filter query dictionary
orderby [ref] optional param for specifying ordering of results
limit [ref] optional param for maximum number of results returned
kwargs [ref] parameters for sample creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ceilometer.queries


CeilometerResource.get_tenant_resources [Scenario]

Get all tenant resources.

This scenario retrieves information about tenant resources using GET /v2/resources/(resource_id)

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ceilometer.resources


CeilometerResource.list_matched_resources [Scenario]

Get resources that matched fields from context and args.

Platform: openstack

Parameters
Argument Description
filter_by_user_id [ref] flag for query by user_id
filter_by_project_id [ref] flag for query by project_id
filter_by_resource_id [ref] flag for query by resource_id
metadata_query [ref] dict with metadata fields and values for query
start_time [ref] lower bound of resource timestamp in isoformat
end_time [ref] upper bound of resource timestamp in isoformat
limit [ref] count of resources in response

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ceilometer.resources


CeilometerResource.list_resources [Scenario]

Check all available queries for list resource request.

This scenario fetches list of all resources using GET /v2/resources.

Platform: openstack

Parameters
Argument Description
metadata_query [ref] dict with metadata fields and values for query
start_time [ref] lower bound of resource timestamp in isoformat
end_time [ref] upper bound of resource timestamp in isoformat
limit [ref] count of resources in response

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ceilometer.resources


CeilometerSamples.list_matched_samples [Scenario]

Get list of samples that matched fields from context and args.

Platform: openstack

Parameters
Argument Description
filter_by_user_id [ref] flag for query by user_id
filter_by_project_id [ref] flag for query by project_id
filter_by_resource_id [ref] flag for query by resource_id
metadata_query [ref] dict with metadata fields and values for query
limit [ref] count of samples in response

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ceilometer.samples


CeilometerSamples.list_samples [Scenario]

Fetch all available queries for list sample request.

Platform: openstack

Parameters
Argument Description
metadata_query [ref] dict with metadata fields and values for query
limit [ref] count of samples in response

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ceilometer.samples


CeilometerStats.create_meter_and_get_stats [Scenario]

Create a meter and fetch its statistics.

Meter is first created and then statistics is fetched for the same using GET /v2/meters/(meter_name)/statistics.

Platform: openstack

Parameters
Argument Description
kwargs [ref] contains optional arguments to create a meter

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ceilometer.stats


CeilometerStats.get_stats [Scenario]

Fetch statistics for certain meter.

Statistics is fetched for the using GET /v2/meters/(meter_name)/statistics.

Platform: openstack

Parameters
Argument Description
meter_name [ref] meter to take statistic for
filter_by_user_id [ref] flag for query by user_id
filter_by_project_id [ref] flag for query by project_id
filter_by_resource_id [ref] flag for query by resource_id
metadata_query [ref] dict with metadata fields and values for query
period [ref] the length of the time range covered by these stats
groupby [ref] the fields used to group the samples
aggregates [ref] name of function for samples aggregation

Returns:
list of statistics data

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ceilometer.stats


CeilometerTraits.create_user_and_list_trait_descriptions [Scenario]

Create user and fetch all trait descriptions.

This scenario creates user to store new event and fetches list of all traits for certain event type using GET /v2/event_types//traits.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.ceilometer.traits


CeilometerTraits.create_user_and_list_traits [Scenario]

Create user and fetch all event traits.

This scenario creates user to store new event and fetches list of all traits for certain event type and trait name using GET /v2/event_types//traits/.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.ceilometer.traits


CinderQos.create_and_get_qos [Scenario]

Create a qos, then get details of the qos.

Platform: openstack

Parameters
Argument Description
consumer [ref] Consumer behavior
write_iops_sec [ref] random write limitation
read_iops_sec [ref] random read limitation

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.cinder.qos_specs


CinderQos.create_and_list_qos [Scenario]

Create a qos, then list all qos.

Platform: openstack

Parameters
Argument Description
consumer [ref] Consumer behavior
write_iops_sec [ref] random write limitation
read_iops_sec [ref] random read limitation

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.cinder.qos_specs


CinderQos.create_and_set_qos [Scenario]

Create a qos, then Add/Update keys in qos specs.

Platform: openstack

Parameters
Argument Description
consumer [ref] Consumer behavior
write_iops_sec [ref] random write limitation
read_iops_sec [ref] random read limitation
set_consumer [ref] update Consumer behavior
set_write_iops_sec [ref] update random write limitation
set_read_iops_sec [ref] update random read limitation

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.cinder.qos_specs


CinderQos.create_qos_associate_and_disassociate_type [Scenario]

Create a qos, Associate and Disassociate the qos from volume type.

Platform: openstack

Parameters
Argument Description
consumer [ref] Consumer behavior
write_iops_sec [ref] random write limitation
read_iops_sec [ref] random read limitation

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.cinder.qos_specs


CinderVolumeBackups.create_incremental_volume_backup [Scenario]

Create a incremental volume backup.

The scenario first create a volume, the create a backup, the backup is full backup. Because Incremental backup must be based on the full backup. finally create a incremental backup.

Platform: openstack

Parameters
Argument Description
size [ref] volume size in GB
do_delete [ref] deletes backup and volume after creating if True
create_volume_kwargs [ref] optional args to create a volume
create_backup_kwargs [ref] optional args to create a volume backup

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volume_backups


CinderVolumeTypes.create_and_delete_encryption_type [Scenario]

Create and delete encryption type.

This scenario firstly creates an encryption type for a given volume type, then deletes the created encryption type.

Platform: openstack

Parameters
Argument Description
create_specs [ref] the encryption type specifications to add
provider [ref] The class that provides encryption support. For example, LuksEncryptor.
cipher [ref] The encryption algorithm or mode.
key_size [ref] Size of encryption key, in bits.
control_location [ref] Notional service where encryption is performed. Valid values are "front-end" or "back-end."

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.cinder.volume_types


CinderVolumeTypes.create_and_delete_volume_type [Scenario]

Create and delete a volume Type.

Platform: openstack

Parameters
Argument Description
description [ref] Description of the volume type
is_public [ref] Volume type visibility

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.cinder.volume_types


CinderVolumeTypes.create_and_get_volume_type [Scenario]

Create a volume Type, then get the details of the type.

Platform: openstack

Parameters
Argument Description
description [ref] Description of the volume type
is_public [ref] Volume type visibility

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.cinder.volume_types


CinderVolumeTypes.create_and_list_encryption_type [Scenario]

Create and list encryption type.

This scenario firstly creates a volume type, secondly creates an encryption type for the volume type, thirdly lists all encryption types.

Platform: openstack

Parameters
Argument Description
create_specs [ref] The encryption type specifications to add. DEPRECATED, specify arguments explicitly.
provider [ref] The class that provides encryption support. For example, LuksEncryptor.
cipher [ref] The encryption algorithm or mode.
key_size [ref] Size of encryption key, in bits.
control_location [ref] Notional service where encryption is performed. Valid values are "front-end" or "back-end."
search_opts [ref] Options used when search for encryption types

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.cinder.volume_types


CinderVolumeTypes.create_and_list_volume_types [Scenario]

Create a volume Type, then list all types.

Platform: openstack

Parameters
Argument Description
description [ref] Description of the volume type
is_public [ref] Volume type visibility

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.cinder.volume_types


CinderVolumeTypes.create_and_set_volume_type_keys [Scenario]

Create and set a volume type's extra specs.

Platform: openstack

Parameters
Argument Description
volume_type_key [ref] A dict of key/value pairs to be set
description [ref] Description of the volume type
is_public [ref] Volume type visibility

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.cinder.volume_types


CinderVolumeTypes.create_and_update_encryption_type [Scenario]

Create and update encryption type.

This scenario firstly creates a volume type, secondly creates an encryption type for the volume type, thirdly updates the encryption type.

Platform: openstack

Parameters
Argument Description
create_provider [ref] The class that provides encryption support. For example, LuksEncryptor.
create_cipher [ref] The encryption algorithm or mode.
create_key_size [ref] Size of encryption key, in bits.
create_control_location [ref] Notional service where encryption is performed. Valid values are "front-end" or "back-end."
update_provider [ref] The class that provides encryption support. For example, LuksEncryptor.
update_cipher [ref] The encryption algorithm or mode.
update_key_size [ref] Size of encryption key, in bits.
update_control_location [ref] Notional service where encryption is performed. Valid values are "front-end" or "back-end."

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.cinder.volume_types


CinderVolumeTypes.create_and_update_volume_type [Scenario]

create a volume type, then update the type.

Platform: openstack

Parameters
Argument Description
description [ref] Description of the volume type
is_public [ref] Volume type visibility
update_name [ref] if True, can update name by generating random name. if False, don't update name.
update_description [ref] update Description of the volume type
update_is_public [ref] update Volume type visibility

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.cinder.volume_types


CinderVolumeTypes.create_get_and_delete_encryption_type [Scenario]

Create get and delete an encryption type.

This scenario firstly creates an encryption type for a volume type created in the context, then gets detailed information of the created encryption type, finally deletes the created encryption type.

Platform: openstack

Parameters
Argument Description
provider [ref] The class that provides encryption support. For example, LuksEncryptor.
cipher [ref] The encryption algorithm or mode.
key_size [ref] Size of encryption key, in bits.
control_location [ref] Notional service where encryption is performed. Valid values are "front-end" or "back-end."

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.cinder.volume_types


CinderVolumeTypes.create_volume_type_add_and_list_type_access [Scenario]

Add and list volume type access for the given project.

This scenario first creates a private volume type, then add project access and list project access to it.

Platform: openstack

Parameters
Argument Description
description [ref] Description of the volume type
is_public [ref] Volume type visibility

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.cinder.volume_types


CinderVolumeTypes.create_volume_type_and_encryption_type [Scenario]

Create encryption type.

This scenario first creates a volume type, then creates an encryption type for the volume type.

Platform: openstack

Parameters
Argument Description
create_specs [ref] The encryption type specifications to add. DEPRECATED, specify arguments explicitly.
provider [ref] The class that provides encryption support. For example, LuksEncryptor.
cipher [ref] The encryption algorithm or mode.
key_size [ref] Size of encryption key, in bits.
control_location [ref] Notional service where encryption is performed. Valid values are "front-end" or "back-end."
description [ref] Description of the volume type
is_public [ref] Volume type visibility

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.cinder.volume_types


CinderVolumes.create_and_accept_transfer [Scenario]

Create a volume transfer, then accept it.

Measure the "cinder transfer-create" and "cinder transfer-accept" command performace.

Platform: openstack

Parameters
Argument Description
size [ref] volume size (integer, in GB)
image [ref] image to be used to create initial volume
kwargs [ref] optional args to create a volume

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.create_and_attach_volume [Scenario]

Create a VM and attach a volume to it.

Simple test to create a VM and attach a volume, then detach the volume and delete volume/VM.

Platform: openstack

Parameters
Argument Description
size [ref] volume size (integer, in GB) or dictionary, must contain two values: min - minimum size volumes will be created as; max - maximum size volumes will be created as.
image [ref] Glance image name to use for the VM
flavor [ref] VM flavor name
create_volume_params [ref] optional arguments for volume creation
create_vm_params [ref] optional arguments for VM creation
kwargs [ref] (deprecated) optional arguments for VM creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.create_and_delete_snapshot [Scenario]

Create and then delete a volume-snapshot.

Optional 'min_sleep' and 'max_sleep' parameters allow the scenario to simulate a pause between snapshot creation and deletion (of random duration from [min_sleep, max_sleep]).

Platform: openstack

Parameters
Argument Description
force [ref] when set to True, allows snapshot of a volume when the volume is attached to an instance
min_sleep [ref] minimum sleep time between snapshot creation and deletion (in seconds)
max_sleep [ref] maximum sleep time between snapshot creation and deletion (in seconds)
kwargs [ref] optional args to create a snapshot

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.create_and_delete_volume [Scenario]

Create and then delete a volume.

Good for testing a maximal bandwidth of cloud. Optional 'min_sleep' and 'max_sleep' parameters allow the scenario to simulate a pause between volume creation and deletion (of random duration from [min_sleep, max_sleep]).

Platform: openstack

Parameters
Argument Description
size [ref] volume size (integer, in GB) or dictionary, must contain two values: min - minimum size volumes will be created as; max - maximum size volumes will be created as.
image [ref] image to be used to create volume
min_sleep [ref] minimum sleep time between volume creation and deletion (in seconds)
max_sleep [ref] maximum sleep time between volume creation and deletion (in seconds)
kwargs [ref] optional args to create a volume

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.create_and_extend_volume [Scenario]

Create and extend a volume and then delete it.

Platform: openstack

Parameters
Argument Description
size [ref] volume size (in GB) or dictionary, must contain two values: min - minimum size volumes will be created as; max - maximum size volumes will be created as.
new_size [ref] volume new size (in GB) or dictionary, must contain two values: min - minimum size volumes will be created as; max - maximum size volumes will be created as. to extend. Notice: should be bigger volume size
min_sleep [ref] minimum sleep time between volume extension and deletion (in seconds)
max_sleep [ref] maximum sleep time between volume extension and deletion (in seconds)
kwargs [ref] optional args to extend the volume

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.create_and_get_volume [Scenario]

Create a volume and get the volume.

Measure the "cinder show" command performance.

Platform: openstack

Parameters
Argument Description
size [ref] volume size (integer, in GB) or dictionary, must contain two values: min - minimum size volumes will be created as; max - maximum size volumes will be created as.
image [ref] image to be used to create volume
kwargs [ref] optional args to create a volume

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.create_and_list_snapshots [Scenario]

Create and then list a volume-snapshot.

Platform: openstack

Parameters
Argument Description
force [ref] when set to True, allows snapshot of a volume when the volume is attached to an instance
detailed [ref] True if detailed information about snapshots should be listed
kwargs [ref] optional args to create a snapshot

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.create_and_list_volume [Scenario]

Create a volume and list all volumes.

Measure the "cinder volume-list" command performance.

If you have only 1 user in your context, you will add 1 volume on every iteration. So you will have more and more volumes and will be able to measure the performance of the "cinder volume-list" command depending on the number of images owned by users.

Platform: openstack

Parameters
Argument Description
size [ref] volume size (integer, in GB) or dictionary, must contain two values: min - minimum size volumes will be created as; max - maximum size volumes will be created as.
detailed [ref] determines whether the volume listing should contain detailed information about all of them
image [ref] image to be used to create volume
kwargs [ref] optional args to create a volume

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.create_and_list_volume_backups [Scenario]

Create and then list a volume backup.

Platform: openstack

Parameters
Argument Description
size [ref] volume size in GB
detailed [ref] True if detailed information about backup should be listed
do_delete [ref] if True, a volume backup will be deleted
create_volume_kwargs [ref] optional args to create a volume
create_backup_kwargs [ref] optional args to create a volume backup

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.create_and_restore_volume_backup [Scenario]

Restore volume backup.

Platform: openstack

Parameters
Argument Description
size [ref] volume size in GB
do_delete [ref] if True, the volume and the volume backup will be deleted after creation.
create_volume_kwargs [ref] optional args to create a volume
create_backup_kwargs [ref] optional args to create a volume backup

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.create_and_update_volume [Scenario]

Create a volume and update its name and description.

Platform: openstack

Parameters
Argument Description
size [ref] volume size (integer, in GB)
image [ref] image to be used to create volume
create_volume_kwargs [ref] dict, to be used to create volume
update_volume_kwargs [ref] dict, to be used to update volume update_volume_kwargs["update_name"]=True, if updating the name of volume. update_volume_kwargs["description"]="desp", if updating the description of volume.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.create_and_upload_volume_to_image [Scenario]

Create and upload a volume to image.

Platform: openstack

Parameters
Argument Description
size [ref] volume size (integers, in GB), or dictionary, must contain two values: min - minimum size volumes will be created as; max - maximum size volumes will be created as.
image [ref] image to be used to create volume.
force [ref] when set to True volume that is attached to an instance could be uploaded to image
container_format [ref] image container format
disk_format [ref] disk format for image
do_delete [ref] deletes image and volume after uploading if True
kwargs [ref] optional args to create a volume

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.create_from_volume_and_delete_volume [Scenario]

Create volume from volume and then delete it.

Scenario for testing volume clone.Optional 'min_sleep' and 'max_sleep' parameters allow the scenario to simulate a pause between volume creation and deletion (of random duration from [min_sleep, max_sleep]).

Platform: openstack

Parameters
Argument Description
size [ref] volume size (in GB), or dictionary, must contain two values: min - minimum size volumes will be created as; max - maximum size volumes will be created as. Should be equal or bigger source volume size
min_sleep [ref] minimum sleep time between volume creation and deletion (in seconds)
max_sleep [ref] maximum sleep time between volume creation and deletion (in seconds)
kwargs [ref] optional args to create a volume

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.create_nested_snapshots_and_attach_volume [Scenario]

Create a volume from snapshot and attach/detach the volume.

This scenario create vm, volume, create it's snapshot, attach volume, then create new volume from existing snapshot and so on, with defined nested level, after all detach and delete them. volume->snapshot->volume->snapshot->volume ...

Platform: openstack

Parameters
Argument Description
image [ref] Glance image name to use for the VM
flavor [ref] VM flavor name
size [ref] Volume size - dictionary, contains two values: min - minimum size volumes will be created as; max - maximum size volumes will be created as. default values: {"min": 1, "max": 5}
nested_level [ref] amount of nested levels
create_volume_kwargs [ref] optional args to create a volume
create_snapshot_kwargs [ref] optional args to create a snapshot
create_vm_params [ref] optional arguments for VM creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.create_snapshot_and_attach_volume [Scenario]

Create vm, volume, snapshot and attach/detach volume.

Platform: openstack

Parameters
Argument Description
image [ref] Glance image name to use for the VM
flavor [ref] VM flavor name
volume_type [ref] Name of volume type to use
size [ref] Volume size - dictionary, contains two values: min - minimum size volumes will be created as; max - maximum size volumes will be created as. default values: {"min": 1, "max": 5}
create_vm_params [ref] optional arguments for VM creation
kwargs [ref] Optional parameters used during volume snapshot creation.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.create_volume [Scenario]

Create a volume.

Good test to check how influence amount of active volumes on performance of creating new.

Platform: openstack

Parameters
Argument Description
size [ref] volume size (integer, in GB) or dictionary, must contain two values: min - minimum size volumes will be created as; max - maximum size volumes will be created as.
image [ref] image to be used to create volume
kwargs [ref] optional args to create a volume

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.create_volume_and_clone [Scenario]

Create a volume, then clone it to another volume.

This creates a volume, then clone it to anothor volume, and then clone the new volume to next volume...

  1. create source volume (from image)
  2. clone source volume to volume1
  3. clone volume1 to volume2
  4. clone volume2 to volume3
  5. ...

Platform: openstack

Parameters
Argument Description
size [ref] volume size (integer, in GB) or dictionary, must contain two values: min - minimum size volumes will be created as; max - maximum size volumes will be created as.
image [ref] image to be used to create initial volume
nested_level [ref] amount of nested levels
kwargs [ref] optional args to create volumes

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.create_volume_and_update_readonly_flag [Scenario]

Create a volume and then update its readonly flag.

Platform: openstack

Parameters
Argument Description
size [ref] volume size (integer, in GB)
image [ref] image to be used to create volume
read_only [ref] The value to indicate whether to update volume to read-only access mode
kwargs [ref] optional args to create a volume

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.create_volume_backup [Scenario]

Create a volume backup.

Platform: openstack

Parameters
Argument Description
size [ref] volume size in GB
do_delete [ref] if True, a volume and a volume backup will be deleted after creation.
create_volume_kwargs [ref] optional args to create a volume
create_backup_kwargs [ref] optional args to create a volume backup

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.create_volume_from_snapshot [Scenario]

Create a volume-snapshot, then create a volume from this snapshot.

Platform: openstack

Parameters
Argument Description
do_delete [ref] if True, a snapshot and a volume will be deleted after creation.
create_snapshot_kwargs [ref] optional args to create a snapshot
kwargs [ref] optional args to create a volume

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.list_transfers [Scenario]

List all transfers.

This simple scenario tests the "cinder transfer-list" command by listing all the volume transfers.

Platform: openstack

Parameters
Argument Description
detailed [ref] If True, detailed information about volume transfer should be listed
search_opts [ref] Search options to filter out volume transfers.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.list_types [Scenario]

List all volume types.

This simple scenario tests the cinder type-list command by listing all the volume types.

Platform: openstack

Parameters
Argument Description
search_opts [ref] Options used when search for volume types
is_public [ref] If query public volume type

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.list_volumes [Scenario]

List all volumes.

This simple scenario tests the cinder list command by listing all the volumes.

Platform: openstack

Parameters
Argument Description
detailed [ref] True if detailed information about volumes should be listed

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


CinderVolumes.modify_volume_metadata [Scenario]

Modify a volume's metadata.

This requires a volume to be created with the volumes context. Additionally, sets * set_size must be greater than or equal to deletes * delete_size.

Platform: openstack

Parameters
Argument Description
sets [ref] how many set_metadata operations to perform
set_size [ref] number of metadata keys to set in each set_metadata operation
deletes [ref] how many delete_metadata operations to perform
delete_size [ref] number of metadata keys to delete in each delete_metadata operation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.cinder.volumes


DesignateBasic.create_and_delete_domain [Scenario]

Create and then delete a domain.

Measure the performance of creating and deleting domains with different level of load.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.designate.basic


DesignateBasic.create_and_delete_records [Scenario]

Create and then delete records.

Measure the performance of creating and deleting records with different level of load.

Platform: openstack

Parameters
Argument Description
records_per_domain [ref] Records to create pr domain.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.designate.basic


DesignateBasic.create_and_delete_recordsets [Scenario]

Create and then delete recordsets.

Measure the performance of creating and deleting recordsets with different level of load.

Platform: openstack

Parameters
Argument Description
recordsets_per_zone [ref] recordsets to create pr zone.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.designate.basic


DesignateBasic.create_and_delete_server [Scenario]

Create and then delete a server.

Measure the performance of creating and deleting servers with different level of load.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.designate.basic


DesignateBasic.create_and_delete_zone [Scenario]

Create and then delete a zone.

Measure the performance of creating and deleting zones with different level of load.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.designate.basic


DesignateBasic.create_and_list_domains [Scenario]

Create a domain and list all domains.

Measure the "designate domain-list" command performance.

If you have only 1 user in your context, you will add 1 domain on every iteration. So you will have more and more domain and will be able to measure the performance of the "designate domain-list" command depending on the number of domains owned by users.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.designate.basic


DesignateBasic.create_and_list_records [Scenario]

Create and then list records.

If you have only 1 user in your context, you will add 1 record on every iteration. So you will have more and more records and will be able to measure the performance of the "designate record-list" command depending on the number of domains/records owned by users.

Platform: openstack

Parameters
Argument Description
records_per_domain [ref] Records to create pr domain.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.designate.basic


DesignateBasic.create_and_list_recordsets [Scenario]

Create and then list recordsets.

If you have only 1 user in your context, you will add 1 recordset on every iteration. So you will have more and more recordsets and will be able to measure the performance of the "openstack recordset list" command depending on the number of zones/recordsets owned by users.

Platform: openstack

Parameters
Argument Description
recordsets_per_zone [ref] recordsets to create pr zone.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.designate.basic


DesignateBasic.create_and_list_servers [Scenario]

Create a Designate server and list all servers.

If you have only 1 user in your context, you will add 1 server on every iteration. So you will have more and more server and will be able to measure the performance of the "designate server-list" command depending on the number of servers owned by users.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.designate.basic


DesignateBasic.create_and_list_zones [Scenario]

Create a zone and list all zones.

Measure the "openstack zone list" command performance.

If you have only 1 user in your context, you will add 1 zone on every iteration. So you will have more and more zone and will be able to measure the performance of the "openstack zone list" command depending on the number of zones owned by users.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.designate.basic


DesignateBasic.create_and_update_domain [Scenario]

Create and then update a domain.

Measure the performance of creating and updating domains with different level of load.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.designate.basic


DesignateBasic.list_domains [Scenario]

List Designate domains.

This simple scenario tests the designate domain-list command by listing all the domains.

Suppose if we have 2 users in context and each has 2 domains uploaded for them we will be able to test the performance of designate domain-list command in this case.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.designate.basic


DesignateBasic.list_records [Scenario]

List Designate records.

This simple scenario tests the designate record-list command by listing all the records in a domain.

Suppose if we have 2 users in context and each has 2 domains uploaded for them we will be able to test the performance of designate record-list command in this case.

Platform: openstack

Parameters
Argument Description
domain_id [ref] Domain ID

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.designate.basic


DesignateBasic.list_recordsets [Scenario]

List Designate recordsets.

This simple scenario tests the openstack recordset list command by listing all the recordsets in a zone.

Platform: openstack

Parameters
Argument Description
zone_id [ref] Zone ID

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.designate.basic


DesignateBasic.list_servers [Scenario]

List Designate servers.

This simple scenario tests the designate server-list command by listing all the servers.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.designate.basic


DesignateBasic.list_zones [Scenario]

List Designate zones.

This simple scenario tests the openstack zone list command by listing all the zones.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.designate.basic


Dummy.openstack [Scenario]

Do nothing and sleep for the given number of seconds (0 by default).

Dummy.dummy can be used for testing performance of different ScenarioRunners and of the ability of rally to store a large amount of results.

Platform: openstack

Parameters
Argument Description
sleep [ref] idle time of method (in seconds).

Module: rally_openstack.scenarios.dummy


EC2Servers.boot_server [Scenario]

Boot a server.

Assumes that cleanup is done elsewhere.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
kwargs [ref] optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ec2.servers


EC2Servers.list_servers [Scenario]

List all servers.

This simple scenario tests the EC2 API list function by listing all the servers.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.ec2.servers


ElasticsearchLogging.log_instance [Scenario]

Create nova instance and check it indexed in elasticsearch.

Platform: openstack

Introduced in: 1.2.0

Parameters
Argument Description
image [ref] image for server
flavor [ref] flavor for server
logging_vip [ref] logging system IP to check server name in elasticsearch index
elasticsearch_port [ref] elasticsearch port to use for check server
sleep_time [ref] sleep time in seconds between elasticsearch request
retries_total [ref] total number of retries to check server name in elasticsearch

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.elasticsearch.logging


GlanceImages.create_and_deactivate_image [Scenario]

Create an image, then deactivate it.

Platform: openstack

Parameters
Argument Description
container_format [ref] container format of image. Acceptable formats: ami, ari, aki, bare, and ovf
image_location [ref] image file location
disk_format [ref] disk format of image. Acceptable formats: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, and iso
visibility [ref] The access permission for the created image
min_disk [ref] The min disk of created images
min_ram [ref] The min ram of created images

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.glance.images


GlanceImages.create_and_delete_image [Scenario]

Create and then delete an image.

Platform: openstack

Parameters
Argument Description
container_format [ref] container format of image. Acceptable formats: ami, ari, aki, bare, and ovf
image_location [ref] image file location
disk_format [ref] disk format of image. Acceptable formats: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, and iso
visibility [ref] The access permission for the created image
min_disk [ref] The min disk of created images
min_ram [ref] The min ram of created images
properties [ref] A dict of image metadata properties to set on the image

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.glance.images


GlanceImages.create_and_download_image [Scenario]

Create an image, then download data of the image.

Platform: openstack

Parameters
Argument Description
container_format [ref] container format of image. Acceptable formats: ami, ari, aki, bare, and ovf
image_location [ref] image file location
disk_format [ref] disk format of image. Acceptable formats: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, and iso
visibility [ref] The access permission for the created image
min_disk [ref] The min disk of created images
min_ram [ref] The min ram of created images
properties [ref] A dict of image metadata properties to set on the image

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.glance.images


GlanceImages.create_and_get_image [Scenario]

Create and get detailed information of an image.

Platform: openstack

Parameters
Argument Description
container_format [ref] container format of image. Acceptable formats: ami, ari, aki, bare, and ovf
image_location [ref] image file location
disk_format [ref] disk format of image. Acceptable formats: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, and iso
visibility [ref] The access permission for the created image
min_disk [ref] The min disk of created images
min_ram [ref] The min ram of created images
properties [ref] A dict of image metadata properties to set on the image

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.glance.images


GlanceImages.create_and_list_image [Scenario]

Create an image and then list all images.

Measure the "glance image-list" command performance.

If you have only 1 user in your context, you will add 1 image on every iteration. So you will have more and more images and will be able to measure the performance of the "glance image-list" command depending on the number of images owned by users.

Platform: openstack

Parameters
Argument Description
container_format [ref] container format of image. Acceptable formats: ami, ari, aki, bare, and ovf
image_location [ref] image file location
disk_format [ref] disk format of image. Acceptable formats: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, and iso
visibility [ref] The access permission for the created image
min_disk [ref] The min disk of created images
min_ram [ref] The min ram of created images
properties [ref] A dict of image metadata properties to set on the image

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.glance.images


GlanceImages.create_and_update_image [Scenario]

Create an image then update it.

Measure the "glance image-create" and "glance image-update" commands performance.

Platform: openstack

Parameters
Argument Description
container_format [ref] container format of image. Acceptable formats: ami, ari, aki, bare, and ovf
image_location [ref] image file location
disk_format [ref] disk format of image. Acceptable formats: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, and iso
remove_props [ref] List of property names to remove. (It is only supported by Glance v2.)
visibility [ref] The access permission for the created image
create_min_disk [ref] The min disk of created images
create_min_ram [ref] The min ram of created images
create_properties [ref] A dict of image metadata properties to set on the created image
update_min_disk [ref] The min disk of updated images
update_min_ram [ref] The min ram of updated images

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.glance.images


GlanceImages.create_image_and_boot_instances [Scenario]

Create an image and boot several instances from it.

Platform: openstack

Parameters
Argument Description
container_format [ref] container format of image. Acceptable formats: ami, ari, aki, bare, and ovf
image_location [ref] image file location
disk_format [ref] disk format of image. Acceptable formats: ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, and iso
visibility [ref] The access permission for the created image
min_disk [ref] The min disk of created images
min_ram [ref] The min ram of created images
properties [ref] A dict of image metadata properties to set on the image
flavor [ref] Nova flavor to be used to launch an instance
number_instances [ref] number of Nova servers to boot
boot_server_kwargs [ref] optional parameters to boot server
kwargs [ref] optional parameters to create server (deprecated)

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.glance.images


GlanceImages.list_images [Scenario]

List all images.

This simple scenario tests the glance image-list command by listing all the images.

Suppose if we have 2 users in context and each has 2 images uploaded for them we will be able to test the performance of glance image-list command in this case.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.glance.images


Gnocchi.get_status [Scenario]

Get the status of measurements processing.

Platform: openstack

Parameters
Argument Description
detailed [ref] get detailed output

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.gnocchi.status


Gnocchi.list_capabilities [Scenario]

List supported aggregation methods.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.gnocchi.capabilities


GnocchiArchivePolicy.create_archive_policy [Scenario]

Create archive policy.

Platform: openstack

Parameters
Argument Description
definition [ref] List of definitions
aggregation_methods [ref] List of aggregation methods

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.gnocchi.archive_policy


GnocchiArchivePolicy.create_delete_archive_policy [Scenario]

Create archive policy and then delete it.

Platform: openstack

Parameters
Argument Description
definition [ref] List of definitions
aggregation_methods [ref] List of aggregation methods

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.gnocchi.archive_policy


GnocchiArchivePolicy.list_archive_policy [Scenario]

List archive policies.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.gnocchi.archive_policy


GnocchiArchivePolicyRule.create_archive_policy_rule [Scenario]

Create archive policy rule.

Platform: openstack

Parameters
Argument Description
metric_pattern [ref] Pattern for matching metrics
archive_policy_name [ref] Archive policy name

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.gnocchi.archive_policy_rule


GnocchiArchivePolicyRule.create_delete_archive_policy_rule [Scenario]

Create archive policy rule and then delete it.

Platform: openstack

Parameters
Argument Description
metric_pattern [ref] Pattern for matching metrics
archive_policy_name [ref] Archive policy name

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.gnocchi.archive_policy_rule


GnocchiArchivePolicyRule.list_archive_policy_rule [Scenario]

List archive policy rules.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.gnocchi.archive_policy_rule


GnocchiMetric.create_delete_metric [Scenario]

Create metric and then delete it.

Platform: openstack

Introduced in: 1.1.0

Parameters
Argument Description
archive_policy_name [ref] Archive policy name
resource_id [ref] The resource ID to attach the metric to
unit [ref] The unit of the metric

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.gnocchi.metric


GnocchiMetric.create_metric [Scenario]

Create metric.

Platform: openstack

Introduced in: 1.1.0

Parameters
Argument Description
archive_policy_name [ref] Archive policy name
resource_id [ref] The resource ID to attach the metric to
unit [ref] The unit of the metric

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.gnocchi.metric


GnocchiMetric.list_metric [Scenario]

List metrics.

Platform: openstack

Introduced in: 1.1.0

Parameters
Argument Description
limit [ref] Maximum number of metrics to list

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.gnocchi.metric


GnocchiResource.create_delete_resource [Scenario]

Create resource and then delete it.

Platform: openstack

Introduced in: 1.1.0

Parameters
Argument Description
resource_type [ref] Type of the resource

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.gnocchi.resource


GnocchiResource.create_resource [Scenario]

Create resource.

Platform: openstack

Introduced in: 1.1.0

Parameters
Argument Description
resource_type [ref] Type of the resource

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.gnocchi.resource


GnocchiResourceType.create_delete_resource_type [Scenario]

Create resource type and then delete it.

Platform: openstack

Parameters
Argument Description
attributes [ref] List of attributes

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.gnocchi.resource_type


GnocchiResourceType.create_resource_type [Scenario]

Create resource type.

Platform: openstack

Parameters
Argument Description
attributes [ref] List of attributes

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.gnocchi.resource_type


GnocchiResourceType.list_resource_type [Scenario]

List resource types.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.gnocchi.resource_type


GrafanaMetrics.push_metric_from_instance [Scenario]

Create nova instance with pushing metric script as userdata.

Push metric to metrics storage using Pushgateway and check it in Grafana.

Platform: openstack

Introduced in: 1.2.0

Parameters
Argument Description
image [ref] image for server with userdata script
flavor [ref] flavor for server with userdata script
monitor_vip [ref] monitoring system IP to push metric
pushgateway_port [ref] Pushgateway port to use for pushing metric
grafana [ref] Grafana dict with creds and port to use for checking metric. Format: {user: admin, password: pass, port: 9902}
datasource_id [ref] metrics storage datasource ID in Grafana
job_name [ref] job name to push metric in it
sleep_time [ref] sleep time between checking metrics in seconds
retries_total [ref] total number of retries to check metric in Grafana

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.grafana.metrics


GrafanaMetrics.push_metric_locally [Scenario]

Push random metric to Pushgateway locally and check it in Grafana.

Platform: openstack

Introduced in: 1.2.0

Parameters
Argument Description
monitor_vip [ref] monitoring system IP to push metric
pushgateway_port [ref] Pushgateway port to use for pushing metric
grafana [ref] Grafana dict with creds and port to use for checking metric. Format: {user: admin, password: pass, port: 9902}
datasource_id [ref] metrics storage datasource ID in Grafana
job_name [ref] job name to push metric in it
sleep_time [ref] sleep time between checking metrics in seconds
retries_total [ref] total number of retries to check metric in Grafana

Module: rally_openstack.scenarios.grafana.metrics


HeatStacks.create_and_delete_stack [Scenario]

Create and then delete a stack.

Measure the "heat stack-create" and "heat stack-delete" commands performance.

Platform: openstack

Parameters
Argument Description
template_path [ref] path to stack template file
parameters [ref] parameters to use in heat template
files [ref] files used in template
environment [ref] stack environment definition

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.heat.stacks


HeatStacks.create_and_list_stack [Scenario]

Create a stack and then list all stacks.

Measure the "heat stack-create" and "heat stack-list" commands performance.

Platform: openstack

Parameters
Argument Description
template_path [ref] path to stack template file
parameters [ref] parameters to use in heat template
files [ref] files used in template
environment [ref] stack environment definition

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.heat.stacks


HeatStacks.create_check_delete_stack [Scenario]

Create, check and delete a stack.

Measure the performance of the following commands: - heat stack-create - heat action-check - heat stack-delete

Platform: openstack

Parameters
Argument Description
template_path [ref] path to stack template file
parameters [ref] parameters to use in heat template
files [ref] files used in template
environment [ref] stack environment definition

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.heat.stacks


HeatStacks.create_snapshot_restore_delete_stack [Scenario]

Create, snapshot-restore and then delete a stack.

Measure performance of the following commands: heat stack-create heat stack-snapshot heat stack-restore heat stack-delete

Platform: openstack

Parameters
Argument Description
template_path [ref] path to stack template file
parameters [ref] parameters to use in heat template
files [ref] files used in template
environment [ref] stack environment definition

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.heat.stacks


HeatStacks.create_stack_and_list_output [Scenario]

Create stack and list outputs by using new algorithm.

Measure performance of the following commands: heat stack-create heat output-list

Platform: openstack

Parameters
Argument Description
template_path [ref] path to stack template file
parameters [ref] parameters to use in heat template
files [ref] files used in template
environment [ref] stack environment definition

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.heat.stacks


HeatStacks.create_stack_and_list_output_via_API [Scenario]

Create stack and list outputs by using old algorithm.

Measure performance of the following commands: heat stack-create heat output-list

Platform: openstack

Parameters
Argument Description
template_path [ref] path to stack template file
parameters [ref] parameters to use in heat template
files [ref] files used in template
environment [ref] stack environment definition

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.heat.stacks


HeatStacks.create_stack_and_scale [Scenario]

Create an autoscaling stack and invoke a scaling policy.

Measure the performance of autoscaling webhooks.

Platform: openstack

Parameters
Argument Description
template_path [ref] path to template file that includes an OS::Heat::AutoScalingGroup resource
output_key [ref] the stack output key that corresponds to the scaling webhook
delta [ref] the number of instances the stack is expected to change by.
parameters [ref] parameters to use in heat template
files [ref] files used in template (dict of file name to file path)
environment [ref] stack environment definition (dict)

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.heat.stacks


HeatStacks.create_stack_and_show_output [Scenario]

Create stack and show output by using new algorithm.

Measure performance of the following commands: heat stack-create heat output-show

Platform: openstack

Parameters
Argument Description
template_path [ref] path to stack template file
output_key [ref] the stack output key that corresponds to the scaling webhook
parameters [ref] parameters to use in heat template
files [ref] files used in template
environment [ref] stack environment definition

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.heat.stacks


HeatStacks.create_stack_and_show_output_via_API [Scenario]

Create stack and show output by using old algorithm.

Measure performance of the following commands: heat stack-create heat output-show

Platform: openstack

Parameters
Argument Description
template_path [ref] path to stack template file
output_key [ref] the stack output key that corresponds to the scaling webhook
parameters [ref] parameters to use in heat template
files [ref] files used in template
environment [ref] stack environment definition

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.heat.stacks


HeatStacks.create_suspend_resume_delete_stack [Scenario]

Create, suspend-resume and then delete a stack.

Measure performance of the following commands: heat stack-create heat action-suspend heat action-resume heat stack-delete

Platform: openstack

Parameters
Argument Description
template_path [ref] path to stack template file
parameters [ref] parameters to use in heat template
files [ref] files used in template
environment [ref] stack environment definition

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.heat.stacks


HeatStacks.create_update_delete_stack [Scenario]

Create, update and then delete a stack.

Measure the "heat stack-create", "heat stack-update" and "heat stack-delete" commands performance.

Platform: openstack

Parameters
Argument Description
template_path [ref] path to stack template file
updated_template_path [ref] path to updated stack template file
parameters [ref] parameters to use in heat template
updated_parameters [ref] parameters to use in updated heat template If not specified then parameters will be used instead
files [ref] files used in template
updated_files [ref] files used in updated template. If not specified files value will be used instead
environment [ref] stack environment definition
updated_environment [ref] environment definition for updated stack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.heat.stacks


HeatStacks.list_stacks_and_events [Scenario]

List events from tenant stacks.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.heat.stacks


HeatStacks.list_stacks_and_resources [Scenario]

List all resources from tenant stacks.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.heat.stacks


IronicNodes.create_and_delete_node [Scenario]

Create and delete node.

Platform: openstack

Parameters
Argument Description
driver [ref] The name of the driver used to manage this Node.
properties [ref] Key/value pair describing the physical characteristics of the node.
kwargs [ref] Optional additional arguments for node creation

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.ironic.nodes


IronicNodes.create_and_list_node [Scenario]

Create and list nodes.

Platform: openstack

Parameters
Argument Description
driver [ref] The name of the driver used to manage this Node.
properties [ref] Key/value pair describing the physical characteristics of the node.
associated [ref] Optional argument of list request. Either a Boolean or a string representation of a Boolean that indicates whether to return a list of associated (True or "True") or unassociated (False or "False") nodes.
maintenance [ref] Optional argument of list request. Either a Boolean or a string representation of a Boolean that indicates whether to return nodes in maintenance mode (True or "True"), or not in maintenance mode (False or "False").
detail [ref] Optional, boolean whether to return detailed information about nodes.
sort_dir [ref] Optional, direction of sorting, either 'asc' (the default) or 'desc'.
marker [ref] DEPRECATED since Rally 0.10.0
limit [ref] DEPRECATED since Rally 0.10.0
sort_key [ref] DEPRECATED since Rally 0.10.0
kwargs [ref] Optional additional arguments for node creation

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.ironic.nodes


K8sPods.create_pods [Scenario]

create pods and wait for them to be ready.

Platform: openstack

Parameters
Argument Description
manifests [ref] manifest files used to create the pods

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.magnum.k8s_pods


K8sPods.create_rcs [Scenario]

create rcs and wait for them to be ready.

Platform: openstack

Parameters
Argument Description
manifests [ref] manifest files use to create the rcs

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.magnum.k8s_pods


K8sPods.list_pods [Scenario]

List all pods.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.magnum.k8s_pods


KeystoneBasic.add_and_remove_user_role [Scenario]

Create a user role add to a user and disassociate.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.authenticate_user_and_validate_token [Scenario]

Authenticate and validate a keystone token.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.create_add_and_list_user_roles [Scenario]

Create user role, add it and list user roles for given user.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.create_and_delete_ec2credential [Scenario]

Create and delete keystone ec2-credential.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.create_and_delete_role [Scenario]

Create a user role and delete it.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.create_and_delete_service [Scenario]

Create and delete service.

Platform: openstack

Parameters
Argument Description
service_type [ref] type of the service
description [ref] description of the service

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.create_and_get_role [Scenario]

Create a user role and get it detailed information.

Platform: openstack

Parameters
Argument Description
kwargs [ref] Optional additional arguments for roles creation

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.create_and_list_ec2credentials [Scenario]

Create and List all keystone ec2-credentials.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.create_and_list_roles [Scenario]

Create a role, then list all roles.

Platform: openstack

Parameters
Argument Description
create_role_kwargs [ref] Optional additional arguments for roles create
list_role_kwargs [ref] Optional additional arguments for roles list

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.create_and_list_services [Scenario]

Create and list services.

Platform: openstack

Parameters
Argument Description
service_type [ref] type of the service
description [ref] description of the service

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.create_and_list_tenants [Scenario]

Create a keystone tenant with random name and list all tenants.

Platform: openstack

Parameters
Argument Description
kwargs [ref] Other optional parameters

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.create_and_list_users [Scenario]

Create a keystone user with random name and list all users.

Platform: openstack

Parameters
Argument Description
kwargs [ref] Other optional parameters to create users like "tenant_id", "enabled".

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.create_and_update_user [Scenario]

Create user and update the user.

Platform: openstack

Parameters
Argument Description
create_user_kwargs [ref] Optional additional arguments for user creation
update_user_kwargs [ref] Optional additional arguments for user updation

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.create_delete_user [Scenario]

Create a keystone user with random name and then delete it.

Platform: openstack

Parameters
Argument Description
kwargs [ref] Other optional parameters to create users like "tenant_id", "enabled".

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.create_tenant [Scenario]

Create a keystone tenant with random name.

Platform: openstack

Parameters
Argument Description
kwargs [ref] Other optional parameters

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.create_tenant_with_users [Scenario]

Create a keystone tenant and several users belonging to it.

Platform: openstack

Parameters
Argument Description
users_per_tenant [ref] number of users to create for the tenant
kwargs [ref] Other optional parameters for tenant creation

Returns:
keystone tenant instance

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.create_update_and_delete_tenant [Scenario]

Create, update and delete tenant.

Platform: openstack

Parameters
Argument Description
kwargs [ref] Other optional parameters for tenant creation

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.create_user [Scenario]

Create a keystone user with random name.

Platform: openstack

Parameters
Argument Description
kwargs [ref] Other optional parameters to create users like "tenant_id", "enabled".

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.create_user_set_enabled_and_delete [Scenario]

Create a keystone user, enable or disable it, and delete it.

Platform: openstack

Parameters
Argument Description
enabled [ref] Initial state of user 'enabled' flag. The user will be created with 'enabled' set to this value, and then it will be toggled.
kwargs [ref] Other optional parameters to create user.

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.create_user_update_password [Scenario]

Create user and update password for that user.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.keystone.basic


KeystoneBasic.get_entities [Scenario]

Get instance of a tenant, user, role and service by id's.

An ephemeral tenant, user, and role are each created. By default, fetches the 'keystone' service. This can be overridden (for instance, to get the 'Identity Service' service on older OpenStack), or None can be passed explicitly to service_name to create a new service and then query it by ID.

Platform: openstack

Parameters
Argument Description
service_name [ref] The name of the service to get by ID; or None, to create an ephemeral service and get it by ID.

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.keystone.basic


MagnumClusterTemplates.list_cluster_templates [Scenario]

List all cluster_templates.

Measure the "magnum cluster_template-list" command performance.

Platform: openstack

Parameters
Argument Description
limit [ref] (Optional) The maximum number of results to return per request, if: 1) limit > 0, the maximum number of cluster_templates to return. 2) limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Magnum API (see Magnum's api.max_limit option).
kwargs [ref] optional additional arguments for cluster_templates listing

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.magnum.cluster_templates


MagnumClusters.create_and_list_clusters [Scenario]

create cluster and then list all clusters.

Platform: openstack

Parameters
Argument Description
node_count [ref] the cluster node count.
cluster_template_uuid [ref] optional, if user want to use an existing cluster_template
kwargs [ref] optional additional arguments for cluster creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.magnum.clusters


MagnumClusters.list_clusters [Scenario]

List all clusters.

Measure the "magnum clusters-list" command performance.

Platform: openstack

Parameters
Argument Description
limit [ref] (Optional) The maximum number of results to return per request, if: 1) limit > 0, the maximum number of clusters to return. 2) limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Magnum API (see Magnum's api.max_limit option).
kwargs [ref] optional additional arguments for clusters listing

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.magnum.clusters


ManilaShares.attach_security_service_to_share_network [Scenario]

Attaches security service to share network.

Platform: openstack

Parameters
Argument Description
security_service_type [ref] type of security service to use. Should be one of following: 'ldap', 'kerberos' or 'active_directory'.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.manila.shares


ManilaShares.create_and_delete_share [Scenario]

Create and delete a share.

Optional 'min_sleep' and 'max_sleep' parameters allow the scenario to simulate a pause between share creation and deletion (of random duration from [min_sleep, max_sleep]).

Platform: openstack

Parameters
Argument Description
share_proto [ref] share protocol, valid values are NFS, CIFS, GlusterFS and HDFS
size [ref] share size in GB, should be greater than 0
min_sleep [ref] minimum sleep time in seconds (non-negative)
max_sleep [ref] maximum sleep time in seconds (non-negative)
kwargs [ref] optional args to create a share

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.manila.shares


ManilaShares.create_and_extend_share [Scenario]

Create and extend a share.

Platform: openstack

Parameters
Argument Description
share_proto [ref] share protocol for new share available values are NFS, CIFS, CephFS, GlusterFS and HDFS.
size [ref] size in GiB
new_size [ref] new size of the share in GiB
snapshot_id [ref] ID of the snapshot
description [ref] description of a share
metadata [ref] optional metadata to set on share creation
share_network [ref] either instance of ShareNetwork or text with ID
share_type [ref] either instance of ShareType or text with ID
is_public [ref] whether to set share as public or not.
availability_zone [ref] availability zone of the share
share_group_id [ref] ID of the share group to which the share should belong

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.manila.shares


ManilaShares.create_and_list_share [Scenario]

Create a share and list all shares.

Optional 'min_sleep' and 'max_sleep' parameters allow the scenario to simulate a pause between share creation and list (of random duration from [min_sleep, max_sleep]).

Platform: openstack

Parameters
Argument Description
share_proto [ref] share protocol, valid values are NFS, CIFS, GlusterFS and HDFS
size [ref] share size in GB, should be greater than 0
min_sleep [ref] minimum sleep time in seconds (non-negative)
max_sleep [ref] maximum sleep time in seconds (non-negative)
detailed [ref] defines whether to get detailed list of shares or not
kwargs [ref] optional args to create a share

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.manila.shares


ManilaShares.create_and_shrink_share [Scenario]

Create and shrink a share.

Platform: openstack

Parameters
Argument Description
share_proto [ref] share protocol for new share available values are NFS, CIFS, CephFS, GlusterFS and HDFS.
size [ref] size in GiB
new_size [ref] new size of the share in GiB
snapshot_id [ref] ID of the snapshot
description [ref] description of a share
metadata [ref] optional metadata to set on share creation
share_network [ref] either instance of ShareNetwork or text with ID
share_type [ref] either instance of ShareType or text with ID
is_public [ref] whether to set share as public or not.
availability_zone [ref] availability zone of the share
share_group_id [ref] ID of the share group to which the share should belong

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.manila.shares


ManilaShares.create_security_service_and_delete [Scenario]

Creates security service and then deletes.

Platform: openstack

Parameters
Argument Description
security_service_type [ref] security service type, permitted values are 'ldap', 'kerberos' or 'active_directory'.
dns_ip [ref] dns ip address used inside tenant's network
server [ref] security service server ip address or hostname
domain [ref] security service domain
user [ref] security identifier used by tenant
password [ref] password used by user
description [ref] security service description

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.manila.shares


ManilaShares.create_share_network_and_delete [Scenario]

Creates share network and then deletes.

Platform: openstack

Parameters
Argument Description
neutron_net_id [ref] ID of Neutron network
neutron_subnet_id [ref] ID of Neutron subnet
nova_net_id [ref] ID of Nova network
description [ref] share network description

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.manila.shares


ManilaShares.create_share_network_and_list [Scenario]

Creates share network and then lists it.

Platform: openstack

Parameters
Argument Description
neutron_net_id [ref] ID of Neutron network
neutron_subnet_id [ref] ID of Neutron subnet
nova_net_id [ref] ID of Nova network
description [ref] share network description
detailed [ref] defines either to return detailed list of objects or not.
search_opts [ref] container of search opts such as "name", "nova_net_id", "neutron_net_id", etc.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.manila.shares


ManilaShares.create_share_then_allow_and_deny_access [Scenario]

Create a share and allow and deny access to it.

Platform: openstack

Parameters
Argument Description
share_proto [ref] share protocol for new share available values are NFS, CIFS, CephFS, GlusterFS and HDFS.
access_type [ref] represents the access type (e.g: 'ip', 'domain'...)
access [ref] represents the object (e.g: '127.0.0.1'...)
access_level [ref] access level to the share (e.g: 'rw', 'ro')
size [ref] size in GiB
new_size [ref] new size of the share in GiB
snapshot_id [ref] ID of the snapshot
description [ref] description of a share
metadata [ref] optional metadata to set on share creation
share_network [ref] either instance of ShareNetwork or text with ID
share_type [ref] either instance of ShareType or text with ID
is_public [ref] whether to set share as public or not.
availability_zone [ref] availability zone of the share
share_group_id [ref] ID of the share group to which the share should belong

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.manila.shares


ManilaShares.list_share_servers [Scenario]

Lists share servers.

Requires admin creds.

Platform: openstack

Parameters
Argument Description
search_opts [ref] container of following search opts: "host", "status", "share_network" and "project_id".

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.manila.shares


ManilaShares.list_shares [Scenario]

Basic scenario for 'share list' operation.

Platform: openstack

Parameters
Argument Description
detailed [ref] defines either to return detailed list of objects or not.
search_opts [ref] container of search opts such as "name", "host", "share_type", etc.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.manila.shares


ManilaShares.set_and_delete_metadata [Scenario]

Sets and deletes share metadata.

This requires a share to be created with the shares context. Additionally, sets * set_size must be greater than or equal to deletes * delete_size.

Platform: openstack

Parameters
Argument Description
sets [ref] how many set_metadata operations to perform
set_size [ref] number of metadata keys to set in each set_metadata operation
delete_size [ref] number of metadata keys to delete in each delete_metadata operation
key_min_length [ref] minimal size of metadata key to set
key_max_length [ref] maximum size of metadata key to set
value_min_length [ref] minimal size of metadata value to set
value_max_length [ref] maximum size of metadata value to set

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.manila.shares


MistralExecutions.create_execution_from_workbook [Scenario]

Scenario tests execution creation and deletion.

This scenario is a very useful tool to measure the "mistral execution-create" and "mistral execution-delete" commands performance.

Platform: openstack

Parameters
Argument Description
definition [ref] string (yaml string) representation of given file content (Mistral workbook definition)
workflow_name [ref] string the workflow name to execute. Should be one of the to workflows in the definition. If no workflow_name is passed, one of the workflows in the definition will be taken.
wf_input [ref] file containing a json string of mistral workflow input
params [ref] file containing a json string of mistral params (the string is the place to pass the environment)
do_delete [ref] if False than it allows to check performance in "create only" mode.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.mistral.executions


MistralExecutions.list_executions [Scenario]

Scenario test mistral execution-list command.

This simple scenario tests the Mistral execution-list command by listing all the executions.

Platform: openstack

Parameters
Argument Description
marker [ref] The last execution uuid of the previous page, displays list of executions after "marker".
limit [ref] number Maximum number of executions to return in a single result.
sort_keys [ref] id,description
sort_dirs [ref] [SORT_DIRS] Comma-separated list of sort directions. Default: asc.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.mistral.executions


MistralWorkbooks.create_workbook [Scenario]

Scenario tests workbook creation and deletion.

This scenario is a very useful tool to measure the "mistral workbook-create" and "mistral workbook-delete" commands performance.

Platform: openstack

Parameters
Argument Description
definition [ref] string (yaml string) representation of given file content (Mistral workbook definition)
do_delete [ref] if False than it allows to check performance in "create only" mode.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.mistral.workbooks


MistralWorkbooks.list_workbooks [Scenario]

Scenario test mistral workbook-list command.

This simple scenario tests the Mistral workbook-list command by listing all the workbooks.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.mistral.workbooks


MonascaMetrics.list_metrics [Scenario]

Fetch user's metrics.

Platform: openstack

Parameters
Argument Description
kwargs [ref] optional arguments for list query: name, dimensions, start_time, etc

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.monasca.metrics


MuranoEnvironments.create_and_delete_environment [Scenario]

Create environment, session and delete environment.

Platform: openstack

Module: rally_openstack.scenarios.murano.environments


MuranoEnvironments.create_and_deploy_environment [Scenario]

Create environment, session and deploy environment.

Create environment, create session, add app to environment packages_per_env times, send environment to deploy.

Platform: openstack

Parameters
Argument Description
packages_per_env [ref] number of packages per environment

Module: rally_openstack.scenarios.murano.environments


MuranoEnvironments.list_environments [Scenario]

List the murano environments.

Run murano environment-list for listing all environments.

Platform: openstack

Module: rally_openstack.scenarios.murano.environments


MuranoPackages.import_and_delete_package [Scenario]

Import Murano package and then delete it.

Measure the "murano import-package" and "murano package-delete" commands performance. It imports Murano package from "package" (if it is not a zip archive then zip archive will be prepared) and deletes it.

Platform: openstack

Parameters
Argument Description
package [ref] path to zip archive that represents Murano application package or absolute path to folder with package components

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.murano.packages


MuranoPackages.import_and_filter_applications [Scenario]

Import Murano package and then filter packages by some criteria.

Measure the performance of package import and package filtering commands. It imports Murano package from "package" (if it is not a zip archive then zip archive will be prepared) and filters packages by some criteria.

Platform: openstack

Parameters
Argument Description
package [ref] path to zip archive that represents Murano application package or absolute path to folder with package components
filter_query [ref] dict that contains filter criteria, lately it will be passed as **kwargs to filter method e.g. {"category": "Web"}

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.murano.packages


MuranoPackages.import_and_list_packages [Scenario]

Import Murano package and get list of packages.

Measure the "murano import-package" and "murano package-list" commands performance. It imports Murano package from "package" (if it is not a zip archive then zip archive will be prepared) and gets list of imported packages.

Platform: openstack

Parameters
Argument Description
package [ref] path to zip archive that represents Murano application package or absolute path to folder with package components
include_disabled [ref] specifies whether the disabled packages will be included in a the result or not. Default value is False.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.murano.packages


MuranoPackages.package_lifecycle [Scenario]

Import Murano package, modify it and then delete it.

Measure the Murano import, update and delete package commands performance. It imports Murano package from "package" (if it is not a zip archive then zip archive will be prepared), modifies it (using data from "body") and deletes.

Platform: openstack

Parameters
Argument Description
package [ref] path to zip archive that represents Murano application package or absolute path to folder with package components
body [ref] dict object that defines what package property will be updated, e.g {"tags": ["tag"]} or {"enabled": "true"}
operation [ref] string object that defines the way of how package property will be updated, allowed operations are "add", "replace" or "delete". Default value is "replace".

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.murano.packages


NeutronBGPVPN.create_and_delete_bgpvpns [Scenario]

Create bgpvpn and delete the bgpvpn.

Measure the "neutron bgpvpn-create" and neutron bgpvpn-delete command performance.

Platform: openstack

Parameters
Argument Description
route_targets [ref] Route Targets that will be both imported and used for export
import_targets [ref] Additional Route Targets that will be imported
export_targets [ref] Additional Route Targets that will be used for export.
route_distinguishers [ref] List of route distinguisher strings
bgpvpn_type [ref] type of VPN and the technology behind it. Acceptable formats: l2 and l3

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.neutron.bgpvpn


NeutronBGPVPN.create_and_list_bgpvpns [Scenario]

Create a bgpvpn and then list all bgpvpns.

Measure the "neutron bgpvpn-list" command performance.

Platform: openstack

Parameters
Argument Description
route_targets [ref] Route Targets that will be both imported and used for export
import_targets [ref] Additional Route Targets that will be imported
export_targets [ref] Additional Route Targets that will be used for export.
route_distinguishers [ref] List of route distinguisher strings
bgpvpn_type [ref] type of VPN and the technology behind it. Acceptable formats: l2 and l3

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.neutron.bgpvpn


NeutronBGPVPN.create_and_list_networks_associations [Scenario]

Associate a network and list networks associations.

Measure the "neutron bgpvpn-create", "neutron bgpvpn-net-assoc-create" and "neutron bgpvpn-net-assoc-list" command performance.

Platform: openstack

Parameters
Argument Description
route_targets [ref] Route Targets that will be both imported and used for export
import_targets [ref] Additional Route Targets that will be imported
export_targets [ref] Additional Route Targets that will be used for export.
route_distinguishers [ref] List of route distinguisher strings
bgpvpn_type [ref] type of VPN and the technology behind it. Acceptable formats: l2 and l3

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.neutron.bgpvpn


NeutronBGPVPN.create_and_list_routers_associations [Scenario]

Associate a router and list routers associations.

Measure the "neutron bgpvpn-create", "neutron bgpvpn-router-assoc-create" and "neutron bgpvpn-router-assoc-list" command performance.

Platform: openstack

Parameters
Argument Description
route_targets [ref] Route Targets that will be both imported and used for export
import_targets [ref] Additional Route Targets that will be imported
export_targets [ref] Additional Route Targets that will be used for export.
route_distinguishers [ref] List of route distinguisher strings
bgpvpn_type [ref] type of VPN and the technology behind it. Acceptable formats: l2 and l3

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.neutron.bgpvpn


NeutronBGPVPN.create_and_update_bgpvpns [Scenario]

Create and Update bgpvpns.

Measure the "neutron bgpvpn-update" command performance.

Platform: openstack

Parameters
Argument Description
update_name [ref] bool, whether or not to modify BGP VPN name
route_targets [ref] Route Targets that will be both imported and used for export
updated_route_targets [ref] Updated Route Targets that will be both imported and used for export
import_targets [ref] Additional Route Targets that will be imported
updated_import_targets [ref] Updated additional Route Targets that will be imported
export_targets [ref] additional Route Targets that will be used for export.
updated_export_targets [ref] Updated additional Route Targets that will be used for export.
route_distinguishers [ref] list of route distinguisher strings
updated_route_distinguishers [ref] Updated list of route distinguisher strings
bgpvpn_type [ref] type of VPN and the technology behind it. Acceptable formats: l2 and l3

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.neutron.bgpvpn


NeutronBGPVPN.create_bgpvpn_assoc_disassoc_networks [Scenario]

Associate a network and disassociate it from a BGP VPN.

Measure the "neutron bgpvpn-create", "neutron bgpvpn-net-assoc-create" and "neutron bgpvpn-net-assoc-delete" command performance.

Platform: openstack

Parameters
Argument Description
route_targets [ref] Route Targets that will be both imported and used for export
import_targets [ref] Additional Route Targets that will be imported
export_targets [ref] Additional Route Targets that will be used for export.
route_distinguishers [ref] List of route distinguisher strings
bgpvpn_type [ref] type of VPN and the technology behind it. Acceptable formats: l2 and l3

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.neutron.bgpvpn


NeutronBGPVPN.create_bgpvpn_assoc_disassoc_routers [Scenario]

Associate a router and disassociate it from a BGP VPN.

Measure the "neutron bgpvpn-create", "neutron bgpvpn-router-assoc-create" and "neutron bgpvpn-router-assoc-delete" command performance.

Platform: openstack

Parameters
Argument Description
route_targets [ref] Route Targets that will be both imported and used for export
import_targets [ref] Additional Route Targets that will be imported
export_targets [ref] Additional Route Targets that will be used for export.
route_distinguishers [ref] List of route distinguisher strings
bgpvpn_type [ref] type of VPN and the technology behind it. Acceptable formats: l2 and l3

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.neutron.bgpvpn


NeutronLoadbalancerV1.create_and_delete_healthmonitors [Scenario]

Create a healthmonitor(v1) and delete healthmonitors(v1).

Measure the "neutron lb-healthmonitor-create" and "neutron lb-healthmonitor-delete" command performance. The scenario creates healthmonitors and deletes those healthmonitors.

Platform: openstack

Parameters
Argument Description
healthmonitor_create_args [ref] dict, POST /lb/healthmonitors request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.loadbalancer_v1


NeutronLoadbalancerV1.create_and_delete_pools [Scenario]

Create pools(v1) and delete pools(v1).

Measure the "neutron lb-pool-create" and "neutron lb-pool-delete" command performance. The scenario creates a pool for every subnet and then deletes those pools.

Platform: openstack

Parameters
Argument Description
pool_create_args [ref] dict, POST /lb/pools request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.loadbalancer_v1


NeutronLoadbalancerV1.create_and_delete_vips [Scenario]

Create a vip(v1) and then delete vips(v1).

Measure the "neutron lb-vip-create" and "neutron lb-vip-delete" command performance. The scenario creates a vip for pool and then deletes those vips.

Platform: openstack

Parameters
Argument Description
pool_create_args [ref] dict, POST /lb/pools request options
vip_create_args [ref] dict, POST /lb/vips request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.loadbalancer_v1


NeutronLoadbalancerV1.create_and_list_healthmonitors [Scenario]

Create healthmonitors(v1) and list healthmonitors(v1).

Measure the "neutron lb-healthmonitor-list" command performance. This scenario creates healthmonitors and lists them.

Platform: openstack

Parameters
Argument Description
healthmonitor_create_args [ref] dict, POST /lb/healthmonitors request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.loadbalancer_v1


NeutronLoadbalancerV1.create_and_list_pools [Scenario]

Create a pool(v1) and then list pools(v1).

Measure the "neutron lb-pool-list" command performance. The scenario creates a pool for every subnet and then lists pools.

Platform: openstack

Parameters
Argument Description
pool_create_args [ref] dict, POST /lb/pools request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.loadbalancer_v1


NeutronLoadbalancerV1.create_and_list_vips [Scenario]

Create a vip(v1) and then list vips(v1).

Measure the "neutron lb-vip-create" and "neutron lb-vip-list" command performance. The scenario creates a vip for every pool created and then lists vips.

Platform: openstack

Parameters
Argument Description
vip_create_args [ref] dict, POST /lb/vips request options
pool_create_args [ref] dict, POST /lb/pools request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.loadbalancer_v1


NeutronLoadbalancerV1.create_and_update_healthmonitors [Scenario]

Create a healthmonitor(v1) and update healthmonitors(v1).

Measure the "neutron lb-healthmonitor-create" and "neutron lb-healthmonitor-update" command performance. The scenario creates healthmonitors and then updates them.

Platform: openstack

Parameters
Argument Description
healthmonitor_create_args [ref] dict, POST /lb/healthmonitors request options
healthmonitor_update_args [ref] dict, POST /lb/healthmonitors update options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.loadbalancer_v1


NeutronLoadbalancerV1.create_and_update_pools [Scenario]

Create pools(v1) and update pools(v1).

Measure the "neutron lb-pool-create" and "neutron lb-pool-update" command performance. The scenario creates a pool for every subnet and then update those pools.

Platform: openstack

Parameters
Argument Description
pool_create_args [ref] dict, POST /lb/pools request options
pool_update_args [ref] dict, POST /lb/pools update options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.loadbalancer_v1


NeutronLoadbalancerV1.create_and_update_vips [Scenario]

Create vips(v1) and update vips(v1).

Measure the "neutron lb-vip-create" and "neutron lb-vip-update" command performance. The scenario creates a pool for every subnet and then update those pools.

Platform: openstack

Parameters
Argument Description
pool_create_args [ref] dict, POST /lb/pools request options
vip_create_args [ref] dict, POST /lb/vips request options
vip_update_args [ref] dict, POST /lb/vips update options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.loadbalancer_v1


NeutronLoadbalancerV2.create_and_list_loadbalancers [Scenario]

Create a loadbalancer(v2) and then list loadbalancers(v2).

Measure the "neutron lbaas-loadbalancer-list" command performance. The scenario creates a loadbalancer for every subnet and then lists loadbalancers.

Platform: openstack

Parameters
Argument Description
lb_create_args [ref] dict, POST /lbaas/loadbalancers request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.loadbalancer_v2


NeutronNetworks.create_and_delete_floating_ips [Scenario]

Create and delete floating IPs.

Measure the "neutron floating-ip-create" and "neutron floating-ip-delete" commands performance.

Platform: openstack

Parameters
Argument Description
floating_network [ref] str, external network for floating IP creation
floating_ip_args [ref] dict, POST /floatingips request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.network


NeutronNetworks.create_and_delete_networks [Scenario]

Create and delete a network.

Measure the "neutron net-create" and "net-delete" command performance.

Platform: openstack

Parameters
Argument Description
network_create_args [ref] dict, POST /v2.0/networks request options

Module: rally_openstack.scenarios.neutron.network


NeutronNetworks.create_and_delete_ports [Scenario]

Create and delete a port.

Measure the "neutron port-create" and "neutron port-delete" commands performance.

Platform: openstack

Parameters
Argument Description
network_create_args [ref] dict, POST /v2.0/networks request options. Deprecated.
port_create_args [ref] dict, POST /v2.0/ports request options
ports_per_network [ref] int, number of ports for one network

Module: rally_openstack.scenarios.neutron.network


NeutronNetworks.create_and_delete_routers [Scenario]

Create and delete a given number of routers.

Create a network, a given number of subnets and routers and then delete all routers.

Platform: openstack

Parameters
Argument Description
network_create_args [ref] dict, POST /v2.0/networks request options. Deprecated.
subnet_create_args [ref] dict, POST /v2.0/subnets request options
subnet_cidr_start [ref] str, start value for subnets CIDR
subnets_per_network [ref] int, number of subnets for one network
router_create_args [ref] dict, POST /v2.0/routers request options

Module: rally_openstack.scenarios.neutron.network


NeutronNetworks.create_and_delete_subnets [Scenario]

Create and delete a given number of subnets.

The scenario creates a network, a given number of subnets and then deletes subnets.

Platform: openstack

Parameters
Argument Description
network_create_args [ref] dict, POST /v2.0/networks request options. Deprecated.
subnet_create_args [ref] dict, POST /v2.0/subnets request options
subnet_cidr_start [ref] str, start value for subnets CIDR
subnets_per_network [ref] int, number of subnets for one network

Module: rally_openstack.scenarios.neutron.network


NeutronNetworks.create_and_list_floating_ips [Scenario]

Create and list floating IPs.

Measure the "neutron floating-ip-create" and "neutron floating-ip-list" commands performance.

Platform: openstack

Parameters
Argument Description
floating_network [ref] str, external network for floating IP creation
floating_ip_args [ref] dict, POST /floatingips request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.network


NeutronNetworks.create_and_list_networks [Scenario]

Create a network and then list all networks.

Measure the "neutron net-list" command performance.

If you have only 1 user in your context, you will add 1 network on every iteration. So you will have more and more networks and will be able to measure the performance of the "neutron net-list" command depending on the number of networks owned by users.

Platform: openstack

Parameters
Argument Description
network_create_args [ref] dict, POST /v2.0/networks request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.network


NeutronNetworks.create_and_list_ports [Scenario]

Create and a given number of ports and list all ports.

Platform: openstack

Parameters
Argument Description
network_create_args [ref] dict, POST /v2.0/networks request options. Deprecated.
port_create_args [ref] dict, POST /v2.0/ports request options
ports_per_network [ref] int, number of ports for one network

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.network


NeutronNetworks.create_and_list_routers [Scenario]

Create and a given number of routers and list all routers.

Create a network, a given number of subnets and routers and then list all routers.

Platform: openstack

Parameters
Argument Description
network_create_args [ref] dict, POST /v2.0/networks request options. Deprecated.
subnet_create_args [ref] dict, POST /v2.0/subnets request options
subnet_cidr_start [ref] str, start value for subnets CIDR
subnets_per_network [ref] int, number of subnets for one network
router_create_args [ref] dict, POST /v2.0/routers request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.network


NeutronNetworks.create_and_list_subnets [Scenario]

Create and a given number of subnets and list all subnets.

The scenario creates a network, a given number of subnets and then lists subnets.

Platform: openstack

Parameters
Argument Description
network_create_args [ref] dict, POST /v2.0/networks request options. Deprecated
subnet_create_args [ref] dict, POST /v2.0/subnets request options
subnet_cidr_start [ref] str, start value for subnets CIDR
subnets_per_network [ref] int, number of subnets for one network

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.network


NeutronNetworks.create_and_show_network [Scenario]

Create a network and show network details.

Measure the "neutron net-show" command performance.

Platform: openstack

Parameters
Argument Description
network_create_args [ref] dict, POST /v2.0/networks request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.network


NeutronNetworks.create_and_show_ports [Scenario]

Create a given number of ports and show created ports in trun.

Measure the "neutron port-create" and "neutron port-show" commands performance.

Platform: openstack

Parameters
Argument Description
network_create_args [ref] dict, POST /v2.0/networks request options.
port_create_args [ref] dict, POST /v2.0/ports request options
ports_per_network [ref] int, number of ports for one network

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.network


NeutronNetworks.create_and_show_routers [Scenario]

Create and show a given number of routers.

Create a network, a given number of subnets and routers and then show all routers.

Platform: openstack

Parameters
Argument Description
network_create_args [ref] dict, POST /v2.0/networks request options
subnet_create_args [ref] dict, POST /v2.0/subnets request options
subnet_cidr_start [ref] str, start value for subnets CIDR
subnets_per_network [ref] int, number of subnets for each network
router_create_args [ref] dict, POST /v2.0/routers request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.network


NeutronNetworks.create_and_show_subnets [Scenario]

Create and show a subnet details.

The scenario creates a network, a given number of subnets and show the subnet details. This scenario measures the "neutron subnet-show" command performance.

Platform: openstack

Parameters
Argument Description
network_create_args [ref] dict, POST /v2.0/networks request options.
subnet_create_args [ref] dict, POST /v2.0/subnets request options
subnet_cidr_start [ref] str, start value for subnets CIDR
subnets_per_network [ref] int, number of subnets for one network

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.network


NeutronNetworks.create_and_update_networks [Scenario]

Create and update a network.

Measure the "neutron net-create and net-update" command performance.

Platform: openstack

Parameters
Argument Description
network_update_args [ref] dict, PUT /v2.0/networks update request
network_create_args [ref] dict, POST /v2.0/networks request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.network


NeutronNetworks.create_and_update_ports [Scenario]

Create and update a given number of ports.

Measure the "neutron port-create" and "neutron port-update" commands performance.

Platform: openstack

Parameters
Argument Description
port_update_args [ref] dict, PUT /v2.0/ports update request options
network_create_args [ref] dict, POST /v2.0/networks request options. Deprecated.
port_create_args [ref] dict, POST /v2.0/ports request options
ports_per_network [ref] int, number of ports for one network

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.network


NeutronNetworks.create_and_update_routers [Scenario]

Create and update a given number of routers.

Create a network, a given number of subnets and routers and then updating all routers.

Platform: openstack

Parameters
Argument Description
router_update_args [ref] dict, PUT /v2.0/routers update options
network_create_args [ref] dict, POST /v2.0/networks request options. Deprecated.
subnet_create_args [ref] dict, POST /v2.0/subnets request options
subnet_cidr_start [ref] str, start value for subnets CIDR
subnets_per_network [ref] int, number of subnets for one network
router_create_args [ref] dict, POST /v2.0/routers request options

Module: rally_openstack.scenarios.neutron.network


NeutronNetworks.create_and_update_subnets [Scenario]

Create and update a subnet.

The scenario creates a network, a given number of subnets and then updates the subnet. This scenario measures the "neutron subnet-update" command performance.

Platform: openstack

Parameters
Argument Description
subnet_update_args [ref] dict, PUT /v2.0/subnets update options
network_create_args [ref] dict, POST /v2.0/networks request options. Deprecated.
subnet_create_args [ref] dict, POST /v2.0/subnets request options
subnet_cidr_start [ref] str, start value for subnets CIDR
subnets_per_network [ref] int, number of subnets for one network

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.network


NeutronNetworks.list_agents [Scenario]

List all neutron agents.

This simple scenario tests the "neutron agent-list" command by listing all the neutron agents.

Platform: openstack

Parameters
Argument Description
agent_args [ref] dict, POST /v2.0/agents request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.network


NeutronNetworks.set_and_clear_router_gateway [Scenario]

Set and Remove the external network gateway from a router.

create an external network and a router, set external network gateway for the router, remove the external network gateway from the router.

Platform: openstack

Parameters
Argument Description
enable_snat [ref] True if enable snat
network_create_args [ref] dict, POST /v2.0/networks request options
router_create_args [ref] dict, POST /v2.0/routers request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.network


NeutronSecurityGroup.create_and_delete_security_group_rule [Scenario]

Create and delete Neutron security-group-rule.

Measure the "neutron security-group-rule-create" and "neutron security-group-rule-delete" command performance.

Platform: openstack

Parameters
Argument Description
security_group_args [ref] dict, POST /v2.0/security-groups request options
security_group_rule_args [ref] dict, POST /v2.0/security-group-rules request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.security_groups


NeutronSecurityGroup.create_and_delete_security_groups [Scenario]

Create and delete Neutron security-groups.

Measure the "neutron security-group-create" and "neutron security-group-delete" command performance.

Platform: openstack

Parameters
Argument Description
security_group_create_args [ref] dict, POST /v2.0/security-groups request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.security_groups


NeutronSecurityGroup.create_and_list_security_group_rules [Scenario]

Create and list Neutron security-group-rules.

Measure the "neutron security-group-rule-create" and "neutron security-group-rule-list" command performance.

Platform: openstack

Parameters
Argument Description
security_group_args [ref] dict, POST /v2.0/security-groups request options
security_group_rule_args [ref] dict, POST /v2.0/security-group-rules request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.security_groups


NeutronSecurityGroup.create_and_list_security_groups [Scenario]

Create and list Neutron security-groups.

Measure the "neutron security-group-create" and "neutron security-group-list" command performance.

Platform: openstack

Parameters
Argument Description
security_group_create_args [ref] dict, POST /v2.0/security-groups request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.security_groups


NeutronSecurityGroup.create_and_show_security_group [Scenario]

Create and show Neutron security-group.

Measure the "neutron security-group-create" and "neutron security-group-show" command performance.

Platform: openstack

Parameters
Argument Description
security_group_create_args [ref] dict, POST /v2.0/security-groups request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.security_groups


NeutronSecurityGroup.create_and_show_security_group_rule [Scenario]

Create and show Neutron security-group-rule.

Measure the "neutron security-group-rule-create" and "neutron security-group-rule-show" command performance.

Platform: openstack

Parameters
Argument Description
security_group_args [ref] dict, POST /v2.0/security-groups request options
security_group_rule_args [ref] dict, POST /v2.0/security-group-rules request options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.security_groups


NeutronSecurityGroup.create_and_update_security_groups [Scenario]

Create and update Neutron security-groups.

Measure the "neutron security-group-create" and "neutron security-group-update" command performance.

Platform: openstack

Parameters
Argument Description
security_group_create_args [ref] dict, POST /v2.0/security-groups request options
security_group_update_args [ref] dict, PUT /v2.0/security-groups update options

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.security_groups


NeutronSubnets.delete_subnets [Scenario]

Delete a subnet that belongs to each precreated network.

Each runner instance picks a specific subnet from the list based on its positional location in the list of users. By doing so, we can start multiple threads with sufficient number of users created and spread delete requests across all of them, so that they hit different subnets concurrently.

Concurrent execution of this scenario should help reveal any race conditions and other concurrency issues in Neutron IP allocation layer, among other things.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.neutron.network


NovaAgents.list_agents [Scenario]

List all builds.

Measure the "nova agent-list" command performance.

Platform: openstack

Parameters
Argument Description
hypervisor [ref] List agent builds on a specific hypervisor. None (default value) means list for all hypervisors

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.agents


NovaAggregates.create_aggregate_add_and_remove_host [Scenario]

Create an aggregate, add a host to and remove the host from it.

Measure "nova aggregate-add-host" and "nova aggregate-remove-host" command performance.

Platform: openstack

Parameters
Argument Description
availability_zone [ref] The availability zone of the aggregate

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.aggregates


NovaAggregates.create_aggregate_add_host_and_boot_server [Scenario]

Scenario to create and verify an aggregate.

This scenario creates an aggregate, adds a compute host and metadata to the aggregate, adds the same metadata to the flavor and creates an instance. Verifies that instance host is one of the hosts in the aggregate.

Platform: openstack

Parameters
Argument Description
image [ref] The image ID to boot from
metadata [ref] The metadata to be set as flavor extra specs
availability_zone [ref] The availability zone of the aggregate
ram [ref] Memory in MB for the flavor
vcpus [ref] Number of VCPUs for the flavor
disk [ref] Size of local disk in GB
boot_server_kwargs [ref] Optional additional arguments to verify host aggregates

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.nova.aggregates


NovaAggregates.create_and_delete_aggregate [Scenario]

Create an aggregate and then delete it.

This scenario first creates an aggregate and then delete it.

Platform: openstack

Parameters
Argument Description
availability_zone [ref] The availability zone of the aggregate

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.aggregates


NovaAggregates.create_and_get_aggregate_details [Scenario]

Create an aggregate and then get its details.

This scenario first creates an aggregate and then get details of it.

Platform: openstack

Parameters
Argument Description
availability_zone [ref] The availability zone of the aggregate

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.aggregates


NovaAggregates.create_and_list_aggregates [Scenario]

Create a aggregate and then list all aggregates.

This scenario creates a aggregate and then lists all aggregates.

Platform: openstack

Parameters
Argument Description
availability_zone [ref] The availability zone of the aggregate

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.aggregates


NovaAggregates.create_and_update_aggregate [Scenario]

Create an aggregate and then update its name and availability_zone.

This scenario first creates an aggregate and then update its name and availability_zone

Platform: openstack

Parameters
Argument Description
availability_zone [ref] The availability zone of the aggregate

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.aggregates


NovaAggregates.list_aggregates [Scenario]

List all nova aggregates.

Measure the "nova aggregate-list" command performance.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.aggregates


NovaAvailabilityZones.list_availability_zones [Scenario]

List all availability zones.

Measure the "nova availability-zone-list" command performance.

Platform: openstack

Parameters
Argument Description
detailed [ref] True if the availability-zone listing should contain detailed information about all of them

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.availability_zones


NovaFlavors.create_and_delete_flavor [Scenario]

Create flavor and delete the flavor.

Platform: openstack

Parameters
Argument Description
ram [ref] Memory in MB for the flavor
vcpus [ref] Number of VCPUs for the flavor
disk [ref] Size of local disk in GB
flavorid [ref] ID for the flavor (optional). You can use the reserved value ``"auto"`` to have Nova generate a UUID for the flavor in cases where you cannot simply pass ``None``.
ephemeral [ref] Ephemeral space size in GB (default 0).
swap [ref] Swap space in MB
rxtx_factor [ref] RX/TX factor
is_public [ref] Make flavor accessible to the public (default true).

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.flavors


NovaFlavors.create_and_get_flavor [Scenario]

Create flavor and get detailed information of the flavor.

Platform: openstack

Parameters
Argument Description
ram [ref] Memory in MB for the flavor
vcpus [ref] Number of VCPUs for the flavor
disk [ref] Size of local disk in GB
flavorid [ref] ID for the flavor (optional). You can use the reserved value ``"auto"`` to have Nova generate a UUID for the flavor in cases where you cannot simply pass ``None``.
ephemeral [ref] Ephemeral space size in GB (default 0).
swap [ref] Swap space in MB
rxtx_factor [ref] RX/TX factor
is_public [ref] Make flavor accessible to the public (default true).

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.flavors


NovaFlavors.create_and_list_flavor_access [Scenario]

Create a non-public flavor and list its access rules.

Platform: openstack

Parameters
Argument Description
ram [ref] Memory in MB for the flavor
vcpus [ref] Number of VCPUs for the flavor
disk [ref] Size of local disk in GB
flavorid [ref] ID for the flavor (optional). You can use the reserved value ``"auto"`` to have Nova generate a UUID for the flavor in cases where you cannot simply pass ``None``.
ephemeral [ref] Ephemeral space size in GB (default 0).
swap [ref] Swap space in MB
rxtx_factor [ref] RX/TX factor
is_public [ref] Make flavor accessible to the public (default true).

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.flavors


NovaFlavors.create_flavor [Scenario]

Create a flavor.

Platform: openstack

Parameters
Argument Description
ram [ref] Memory in MB for the flavor
vcpus [ref] Number of VCPUs for the flavor
disk [ref] Size of local disk in GB
flavorid [ref] ID for the flavor (optional). You can use the reserved value ``"auto"`` to have Nova generate a UUID for the flavor in cases where you cannot simply pass ``None``.
ephemeral [ref] Ephemeral space size in GB (default 0).
swap [ref] Swap space in MB
rxtx_factor [ref] RX/TX factor
is_public [ref] Make flavor accessible to the public (default true).

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.flavors


NovaFlavors.create_flavor_and_add_tenant_access [Scenario]

Create a flavor and Add flavor access for the given tenant.

Platform: openstack

Parameters
Argument Description
ram [ref] Memory in MB for the flavor
vcpus [ref] Number of VCPUs for the flavor
disk [ref] Size of local disk in GB
flavorid [ref] ID for the flavor (optional). You can use the reserved value ``"auto"`` to have Nova generate a UUID for the flavor in cases where you cannot simply pass ``None``.
ephemeral [ref] Ephemeral space size in GB (default 0).
swap [ref] Swap space in MB
rxtx_factor [ref] RX/TX factor
is_public [ref] Make flavor accessible to the public (default true).

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.flavors


NovaFlavors.create_flavor_and_set_keys [Scenario]

Create flavor and set keys to the flavor.

Measure the "nova flavor-key" command performance. the scenario first create a flavor,then add the extra specs to it.

Platform: openstack

Parameters
Argument Description
ram [ref] Memory in MB for the flavor
vcpus [ref] Number of VCPUs for the flavor
disk [ref] Size of local disk in GB
extra_specs [ref] additional arguments for flavor set keys
flavorid [ref] ID for the flavor (optional). You can use the reserved value ``"auto"`` to have Nova generate a UUID for the flavor in cases where you cannot simply pass ``None``.
ephemeral [ref] Ephemeral space size in GB (default 0).
swap [ref] Swap space in MB
rxtx_factor [ref] RX/TX factor
is_public [ref] Make flavor accessible to the public (default true).

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.flavors


NovaFlavors.list_flavors [Scenario]

List all flavors.

Measure the "nova flavor-list" command performance.

Platform: openstack

Parameters
Argument Description
detailed [ref] Whether flavor needs to be return with details (optional).
is_public [ref] Filter flavors with provided access type (optional). None means give all flavors and only admin has query access to all flavor types.
marker [ref] Begin returning flavors that appear later in the flavor list than that represented by this flavor id (optional).
min_disk [ref] Filters the flavors by a minimum disk space, in GiB.
min_ram [ref] Filters the flavors by a minimum RAM, in MB.
limit [ref] maximum number of flavors to return (optional).
sort_key [ref] Flavors list sort key (optional).
sort_dir [ref] Flavors list sort direction (optional).

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.flavors


NovaHypervisors.list_and_get_hypervisors [Scenario]

List and Get hypervisors.

The scenario first lists all hypervisors, then get detailed information of the listed hypervisors in turn.

Measure the "nova hypervisor-show" command performance.

Platform: openstack

Parameters
Argument Description
detailed [ref] True if the hypervisor listing should contain detailed information about all of them

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.hypervisors


NovaHypervisors.list_and_get_uptime_hypervisors [Scenario]

List hypervisors,then display the uptime of it.

The scenario first list all hypervisors,then display the uptime of the listed hypervisors in turn.

Measure the "nova hypervisor-uptime" command performance.

Platform: openstack

Parameters
Argument Description
detailed [ref] True if the hypervisor listing should contain detailed information about all of them

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.hypervisors


NovaHypervisors.list_and_search_hypervisors [Scenario]

List all servers belonging to specific hypervisor.

The scenario first list all hypervisors,then find its hostname, then list all servers belonging to the hypervisor

Measure the "nova hypervisor-servers " command performance.

Platform: openstack

Parameters
Argument Description
detailed [ref] True if the hypervisor listing should contain detailed information about all of them

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.hypervisors


NovaHypervisors.list_hypervisors [Scenario]

List hypervisors.

Measure the "nova hypervisor-list" command performance.

Platform: openstack

Parameters
Argument Description
detailed [ref] True if the hypervisor listing should contain detailed information about all of them

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.hypervisors


NovaHypervisors.statistics_hypervisors [Scenario]

Get hypervisor statistics over all compute nodes.

Measure the "nova hypervisor-stats" command performance.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.hypervisors


NovaImages.list_images [Scenario]

[DEPRECATED] List all images.

Measure the "nova image-list" command performance.

Platform: openstack

Parameters
Argument Description
detailed [ref] True if the image listing should contain detailed information
kwargs [ref] Optional additional arguments for image listing

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.images


NovaKeypair.boot_and_delete_server_with_keypair [Scenario]

Boot and delete server with keypair.

Plan of this scenario:

  • create a keypair
  • boot a VM with created keypair
  • delete server
  • delete keypair

Platform: openstack

Parameters
Argument Description
image [ref] ID of the image to be used for server creation
flavor [ref] ID of the flavor to be used for server creation
boot_server_kwargs [ref] Optional additional arguments for VM creation
server_kwargs [ref] Deprecated alias for boot_server_kwargs
kwargs [ref] Optional additional arguments for keypair creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.keypairs


NovaKeypair.create_and_delete_keypair [Scenario]

Create a keypair with random name and delete keypair.

This scenario creates a keypair and then delete that keypair.

Platform: openstack

Parameters
Argument Description
kwargs [ref] Optional additional arguments for keypair creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.keypairs


NovaKeypair.create_and_get_keypair [Scenario]

Create a keypair and get the keypair details.

Platform: openstack

Parameters
Argument Description
kwargs [ref] Optional additional arguments for keypair creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.keypairs


NovaKeypair.create_and_list_keypairs [Scenario]

Create a keypair with random name and list keypairs.

This scenario creates a keypair and then lists all keypairs.

Platform: openstack

Parameters
Argument Description
kwargs [ref] Optional additional arguments for keypair creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.keypairs


NovaServerGroups.create_and_delete_server_group [Scenario]

Create a server group, then delete it.

Measure the "nova server-group-create" and "nova server-group-delete" command performance.

Platform: openstack

Parameters
Argument Description
policies [ref] Server group policy
kwargs [ref] The server group specifications to add. DEPRECATED, specify arguments explicitly.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.server_groups


NovaServerGroups.create_and_get_server_group [Scenario]

Create a server group, then get its detailed information.

Measure the "nova server-group-create" and "nova server-group-get" command performance.

Platform: openstack

Parameters
Argument Description
policies [ref] Server group policy
kwargs [ref] The server group specifications to add. DEPRECATED, specify arguments explicitly.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.server_groups


NovaServerGroups.create_and_list_server_groups [Scenario]

Create a server group, then list all server groups.

Measure the "nova server-group-create" and "nova server-group-list" command performance.

Platform: openstack

Parameters
Argument Description
policies [ref] Server group policy
all_projects [ref] If True, display server groups from all projects(Admin only)
kwargs [ref] The server group specifications to add. DEPRECATED, specify arguments explicitly.

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.server_groups


NovaServers.boot_and_associate_floating_ip [Scenario]

Boot a server and associate a floating IP to it.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
create_floating_ip_args [ref] Optional additional arguments for floating ip creation
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_and_bounce_server [Scenario]

Boot a server and run specified actions against it.

Actions should be passed into the actions parameter. Available actions are 'hard_reboot', 'soft_reboot', 'stop_start', 'rescue_unrescue', 'pause_unpause', 'suspend_resume', 'lock_unlock' and 'shelve_unshelve'. Delete server after all actions were completed.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
force_delete [ref] True if force_delete should be used
actions [ref] list of action dictionaries, where each action dictionary speicifes an action to be performed in the following format: {"action_name": }
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_and_delete_multiple_servers [Scenario]

Boot multiple servers in a single request and delete them.

Deletion is done in parallel with one request per server, not with a single request for all servers.

Platform: openstack

Parameters
Argument Description
image [ref] The image to boot from
flavor [ref] Flavor used to boot instance
count [ref] Number of instances to boot
min_sleep [ref] Minimum sleep time in seconds (non-negative)
max_sleep [ref] Maximum sleep time in seconds (non-negative)
force_delete [ref] True if force_delete should be used
kwargs [ref] Optional additional arguments for instance creation

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_and_delete_server [Scenario]

Boot and delete a server.

Optional 'min_sleep' and 'max_sleep' parameters allow the scenario to simulate a pause between volume creation and deletion (of random duration from [min_sleep, max_sleep]).

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
min_sleep [ref] Minimum sleep time in seconds (non-negative)
max_sleep [ref] Maximum sleep time in seconds (non-negative)
force_delete [ref] True if force_delete should be used
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_and_get_console_output [Scenario]

Get text console output from server.

This simple scenario tests the nova console-log command by retrieving the text console log output.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
length [ref] The number of tail log lines you would like to retrieve. None (default value) or -1 means unlimited length.
kwargs [ref] Optional additional arguments for server creation

Returns:
Text console log output for server

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_and_get_console_url [Scenario]

Retrieve a console url of a server.

This simple scenario tests retrieving the console url of a server.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
console_type [ref] type can be novnc/xvpvnc for protocol vnc; spice-html5 for protocol spice; rdp-html5 for protocol rdp; serial for protocol serial. webmks for protocol mks (since version 2.8).
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_and_list_server [Scenario]

Boot a server from an image and then list all servers.

Measure the "nova list" command performance.

If you have only 1 user in your context, you will add 1 server on every iteration. So you will have more and more servers and will be able to measure the performance of the "nova list" command depending on the number of servers owned by users.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
detailed [ref] True if the server listing should contain detailed information about all of them
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_and_live_migrate_server [Scenario]

Live Migrate a server.

This scenario launches a VM on a compute node available in the availability zone and then migrates the VM to another compute node on the same availability zone.

Optional 'min_sleep' and 'max_sleep' parameters allow the scenario to simulate a pause between VM booting and running live migration (of random duration from range [min_sleep, max_sleep]).

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
block_migration [ref] Specifies the migration type
disk_over_commit [ref] Specifies whether to allow overcommit on migrated instance or not
min_sleep [ref] Minimum sleep time in seconds (non-negative)
max_sleep [ref] Maximum sleep time in seconds (non-negative)
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_and_migrate_server [Scenario]

Migrate a server.

This scenario launches a VM on a compute node available in the availability zone, and then migrates the VM to another compute node on the same availability zone.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_and_rebuild_server [Scenario]

Rebuild a server.

This scenario launches a VM, then rebuilds that VM with a different image.

Platform: openstack

Parameters
Argument Description
from_image [ref] image to be used to boot an instance
to_image [ref] image to be used to rebuild the instance
flavor [ref] flavor to be used to boot an instance
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_and_show_server [Scenario]

Show server details.

This simple scenario tests the nova show command by retrieving the server details.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
kwargs [ref] Optional additional arguments for server creation

Returns:
Server details

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_and_update_server [Scenario]

Boot a server, then update its name and description.

The scenario first creates a server, then update it. Assumes that cleanup is done elsewhere.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
description [ref] update the server description
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_lock_unlock_and_delete [Scenario]

Boot a server, lock it, then unlock and delete it.

Optional 'min_sleep' and 'max_sleep' parameters allow the scenario to simulate a pause between locking and unlocking the server (of random duration from min_sleep to max_sleep).

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
min_sleep [ref] Minimum sleep time between locking and unlocking in seconds
max_sleep [ref] Maximum sleep time between locking and unlocking in seconds
force_delete [ref] True if force_delete should be used
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_server [Scenario]

Boot a server.

Assumes that cleanup is done elsewhere.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
auto_assign_nic [ref] True if NICs should be assigned
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_server_and_attach_interface [Scenario]

Create server and subnet, then attach the interface to it.

This scenario measures the "nova interface-attach" command performance.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
network_create_args [ref] dict, POST /v2.0/networks request options.
subnet_create_args [ref] dict, POST /v2.0/subnets request options
subnet_cidr_start [ref] str, start value for subnets CIDR
boot_server_args [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_server_and_list_interfaces [Scenario]

Boot a server and list interfaces attached to it.

Measure the "nova boot" and "nova interface-list" command performance.

Platform: openstack

Parameters
Argument Description
image [ref] ID of the image to be used for server creation
flavor [ref] ID of the flavor to be used for server creation
**kwargs [ref] Optional arguments for booting the instance

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_server_associate_and_dissociate_floating_ip [Scenario]

Boot a server associate and dissociate a floating IP from it.

The scenario first boot a server and create a floating IP. then associate the floating IP to the server.Finally dissociate the floating IP.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
create_floating_ip_args [ref] Optional additional arguments for floating ip creation
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_server_attach_created_volume_and_live_migrate [Scenario]

Create a VM, attach a volume to it and live migrate.

Simple test to create a VM and attach a volume, then migrate the VM, detach the volume and delete volume/VM.

Optional 'min_sleep' and 'max_sleep' parameters allow the scenario to simulate a pause between attaching a volume and running live migration (of random duration from range [min_sleep, max_sleep]).

Platform: openstack

Parameters
Argument Description
image [ref] Glance image name to use for the VM
flavor [ref] VM flavor name
size [ref] volume size (in GB)
block_migration [ref] Specifies the migration type
disk_over_commit [ref] Specifies whether to allow overcommit on migrated instance or not
boot_server_kwargs [ref] optional arguments for VM creation
create_volume_kwargs [ref] optional arguments for volume creation
min_sleep [ref] Minimum sleep time in seconds (non-negative)
max_sleep [ref] Maximum sleep time in seconds (non-negative)

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_server_attach_created_volume_and_resize [Scenario]

Create a VM from image, attach a volume to it and resize.

Simple test to create a VM and attach a volume, then resize the VM, detach the volume then delete volume and VM. Optional 'min_sleep' and 'max_sleep' parameters allow the scenario to simulate a pause between attaching a volume and running resize (of random duration from range [min_sleep, max_sleep]).

Platform: openstack

Parameters
Argument Description
image [ref] Glance image name to use for the VM
flavor [ref] VM flavor name
to_flavor [ref] flavor to be used to resize the booted instance
volume_size [ref] volume size (in GB)
min_sleep [ref] Minimum sleep time in seconds (non-negative)
max_sleep [ref] Maximum sleep time in seconds (non-negative)
force_delete [ref] True if force_delete should be used
confirm [ref] True if need to confirm resize else revert resize
do_delete [ref] True if resources needs to be deleted explicitly else use rally cleanup to remove resources
boot_server_kwargs [ref] optional arguments for VM creation
create_volume_kwargs [ref] optional arguments for volume creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_server_attach_volume_and_list_attachments [Scenario]

Create a VM, attach N volume to it and list server's attachemnt.

Measure the "nova volume-attachments" command performance.

Platform: openstack

Parameters
Argument Description
image [ref] Glance image name to use for the VM
flavor [ref] VM flavor name
volume_size [ref] volume size (in GB), default 1G
volume_num [ref] the num of attached volume
boot_server_kwargs [ref] optional arguments for VM creation
create_volume_kwargs [ref] optional arguments for volume creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_server_from_volume [Scenario]

Boot a server from volume.

The scenario first creates a volume and then a server. Assumes that cleanup is done elsewhere.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
volume_size [ref] volume size (in GB)
volume_type [ref] specifies volume type when there are multiple backends
auto_assign_nic [ref] True if NICs should be assigned
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_server_from_volume_and_delete [Scenario]

Boot a server from volume and then delete it.

The scenario first creates a volume and then a server. Optional 'min_sleep' and 'max_sleep' parameters allow the scenario to simulate a pause between volume creation and deletion (of random duration from [min_sleep, max_sleep]).

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
volume_size [ref] volume size (in GB)
volume_type [ref] specifies volume type when there are multiple backends
min_sleep [ref] Minimum sleep time in seconds (non-negative)
max_sleep [ref] Maximum sleep time in seconds (non-negative)
force_delete [ref] True if force_delete should be used
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_server_from_volume_and_live_migrate [Scenario]

Boot a server from volume and then migrate it.

The scenario first creates a volume and a server booted from the volume on a compute node available in the availability zone and then migrates the VM to another compute node on the same availability zone.

Optional 'min_sleep' and 'max_sleep' parameters allow the scenario to simulate a pause between VM booting and running live migration (of random duration from range [min_sleep, max_sleep]).

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
volume_size [ref] volume size (in GB)
volume_type [ref] specifies volume type when there are multiple backends
block_migration [ref] Specifies the migration type
disk_over_commit [ref] Specifies whether to allow overcommit on migrated instance or not
force_delete [ref] True if force_delete should be used
min_sleep [ref] Minimum sleep time in seconds (non-negative)
max_sleep [ref] Maximum sleep time in seconds (non-negative)
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_server_from_volume_and_resize [Scenario]

Boot a server from volume, then resize and delete it.

The scenario first creates a volume and then a server. Optional 'min_sleep' and 'max_sleep' parameters allow the scenario to simulate a pause between volume creation and deletion (of random duration from [min_sleep, max_sleep]).

This test will confirm the resize by default, or revert the resize if confirm is set to false.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
to_flavor [ref] flavor to be used to resize the booted instance
volume_size [ref] volume size (in GB)
min_sleep [ref] Minimum sleep time in seconds (non-negative)
max_sleep [ref] Maximum sleep time in seconds (non-negative)
force_delete [ref] True if force_delete should be used
confirm [ref] True if need to confirm resize else revert resize
do_delete [ref] True if resources needs to be deleted explicitly else use rally cleanup to remove resources
boot_server_kwargs [ref] optional arguments for VM creation
create_volume_kwargs [ref] optional arguments for volume creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.boot_server_from_volume_snapshot [Scenario]

Boot a server from a snapshot.

The scenario first creates a volume and creates a snapshot from this volume, then boots a server from the created snapshot. Assumes that cleanup is done elsewhere.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
volume_size [ref] volume size (in GB)
volume_type [ref] specifies volume type when there are multiple backends
auto_assign_nic [ref] True if NICs should be assigned
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.list_servers [Scenario]

List all servers.

This simple scenario test the nova list command by listing all the servers.

Platform: openstack

Parameters
Argument Description
detailed [ref] True if detailed information about servers should be listed

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.pause_and_unpause_server [Scenario]

Create a server, pause, unpause and then delete it.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
force_delete [ref] True if force_delete should be used
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.resize_server [Scenario]

Boot a server, then resize and delete it.

This test will confirm the resize by default, or revert the resize if confirm is set to false.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
to_flavor [ref] flavor to be used to resize the booted instance
force_delete [ref] True if force_delete should be used
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.resize_shutoff_server [Scenario]

Boot a server and stop it, then resize and delete it.

This test will confirm the resize by default, or revert the resize if confirm is set to false.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
to_flavor [ref] flavor to be used to resize the booted instance
confirm [ref] True if need to confirm resize else revert resize
force_delete [ref] True if force_delete should be used
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.shelve_and_unshelve_server [Scenario]

Create a server, shelve, unshelve and then delete it.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
force_delete [ref] True if force_delete should be used
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.snapshot_server [Scenario]

Boot a server, make its snapshot and delete both.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
force_delete [ref] True if force_delete should be used
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServers.suspend_and_resume_server [Scenario]

Create a server, suspend, resume and then delete it.

Platform: openstack

Parameters
Argument Description
image [ref] image to be used to boot an instance
flavor [ref] flavor to be used to boot an instance
force_delete [ref] True if force_delete should be used
kwargs [ref] Optional additional arguments for server creation

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.nova.servers


NovaServices.list_services [Scenario]

List all nova services.

Measure the "nova service-list" command performance.

Platform: openstack

Parameters
Argument Description
host [ref] List nova services on host
binary [ref] List nova services matching given binary

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.nova.services


Quotas.cinder_get [Scenario]

Get quotas for Cinder.

Measure the "cinder quota-show" command performance

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.quotas.quotas


Quotas.cinder_update [Scenario]

Update quotas for Cinder.

Platform: openstack

Parameters
Argument Description
max_quota [ref] Max value to be updated for quota.

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.quotas.quotas


Quotas.cinder_update_and_delete [Scenario]

Update and Delete quotas for Cinder.

Platform: openstack

Parameters
Argument Description
max_quota [ref] Max value to be updated for quota.

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.quotas.quotas


Quotas.neutron_update [Scenario]

Update quotas for neutron.

Platform: openstack

Parameters
Argument Description
max_quota [ref] Max value to be updated for quota.

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.quotas.quotas


Quotas.nova_get [Scenario]

Get quotas for nova.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.quotas.quotas


Quotas.nova_update [Scenario]

Update quotas for Nova.

Platform: openstack

Parameters
Argument Description
max_quota [ref] Max value to be updated for quota.

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.quotas.quotas


Quotas.nova_update_and_delete [Scenario]

Update and delete quotas for Nova.

Platform: openstack

Parameters
Argument Description
max_quota [ref] Max value to be updated for quota.

Requires platform(s):

  • openstack with the next options: {"admin": true, "users": true}

Module: rally_openstack.scenarios.quotas.quotas


SaharaClusters.create_and_delete_cluster [Scenario]

Launch and delete a Sahara Cluster.

This scenario launches a Hadoop cluster, waits until it becomes 'Active' and deletes it.

Platform: openstack

Parameters
Argument Description
flavor [ref] Nova flavor that will be for nodes in the created node groups. Deprecated.
master_flavor [ref] Nova flavor that will be used for the master instance of the cluster
worker_flavor [ref] Nova flavor that will be used for the workers of the cluster
workers_count [ref] number of worker instances in a cluster
plugin_name [ref] name of a provisioning plugin
hadoop_version [ref] version of Hadoop distribution supported by the specified plugin.
floating_ip_pool [ref] floating ip pool name from which Floating IPs will be allocated. Sahara will determine automatically how to treat this depending on its own configurations. Defaults to None because in some cases Sahara may work w/o Floating IPs.
volumes_per_node [ref] number of Cinder volumes that will be attached to every cluster node
volumes_size [ref] size of each Cinder volume in GB
auto_security_group [ref] boolean value. If set to True Sahara will create a Security Group for each Node Group in the Cluster automatically.
security_groups [ref] list of security groups that will be used while creating VMs. If auto_security_group is set to True, this list can be left empty.
node_configs [ref] config dict that will be passed to each Node Group
cluster_configs [ref] config dict that will be passed to the Cluster
enable_anti_affinity [ref] If set to true the vms will be scheduled one per compute node.
enable_proxy [ref] Use Master Node of a Cluster as a Proxy node and do not assign floating ips to workers.
use_autoconfig [ref] If True, instances of the node group will be automatically configured during cluster creation. If False, the configuration values should be specify manually

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.sahara.clusters


SaharaClusters.create_scale_delete_cluster [Scenario]

Launch, scale and delete a Sahara Cluster.

This scenario launches a Hadoop cluster, waits until it becomes 'Active'. Then a series of scale operations is applied. The scaling happens according to numbers listed in

Platform: openstack

Parameters
Argument Description
flavor [ref] Nova flavor that will be for nodes in the created node groups. Deprecated.
master_flavor [ref] Nova flavor that will be used for the master instance of the cluster
worker_flavor [ref] Nova flavor that will be used for the workers of the cluster
workers_count [ref] number of worker instances in a cluster
plugin_name [ref] name of a provisioning plugin
hadoop_version [ref] version of Hadoop distribution supported by the specified plugin.
deltas [ref] list of integers which will be used to add or remove worker nodes from the cluster
floating_ip_pool [ref] floating ip pool name from which Floating IPs will be allocated. Sahara will determine automatically how to treat this depending on its own configurations. Defaults to None because in some cases Sahara may work w/o Floating IPs.
neutron_net_id [ref] id of a Neutron network that will be used for fixed IPs. This parameter is ignored when Nova Network is set up.
volumes_per_node [ref] number of Cinder volumes that will be attached to every cluster node
volumes_size [ref] size of each Cinder volume in GB
auto_security_group [ref] boolean value. If set to True Sahara will create a Security Group for each Node Group in the Cluster automatically.
security_groups [ref] list of security groups that will be used while creating VMs. If auto_security_group is set to True this list can be left empty.
node_configs [ref] configs dict that will be passed to each Node Group
cluster_configs [ref] configs dict that will be passed to the Cluster
enable_anti_affinity [ref] If set to true the vms will be scheduled one per compute node.
enable_proxy [ref] Use Master Node of a Cluster as a Proxy node and do not assign floating ips to workers.
use_autoconfig [ref] If True, instances of the node group will be automatically configured during cluster creation. If False, the configuration values should be specify manually

Module: rally_openstack.scenarios.sahara.clusters


SaharaJob.create_launch_job [Scenario]

Create and execute a Sahara EDP Job.

This scenario Creates a Job entity and launches an execution on a Cluster.

Platform: openstack

Parameters
Argument Description
job_type [ref] type of the Data Processing Job
configs [ref] config dict that will be passed to a Job Execution
job_idx [ref] index of a job in a sequence. This index will be used to create different atomic actions for each job in a sequence

Module: rally_openstack.scenarios.sahara.jobs


SaharaJob.create_launch_job_sequence [Scenario]

Create and execute a sequence of the Sahara EDP Jobs.

This scenario Creates a Job entity and launches an execution on a Cluster for every job object provided.

Platform: openstack

Parameters
Argument Description
jobs [ref] list of jobs that should be executed in one context

Module: rally_openstack.scenarios.sahara.jobs


SaharaJob.create_launch_job_sequence_with_scaling [Scenario]

Create and execute Sahara EDP Jobs on a scaling Cluster.

This scenario Creates a Job entity and launches an execution on a Cluster for every job object provided. The Cluster is scaled according to the deltas values and the sequence is launched again.

Platform: openstack

Parameters
Argument Description
jobs [ref] list of jobs that should be executed in one context
deltas [ref] list of integers which will be used to add or remove worker nodes from the cluster

Module: rally_openstack.scenarios.sahara.jobs


SaharaNodeGroupTemplates.create_and_list_node_group_templates [Scenario]

Create and list Sahara Node Group Templates.

This scenario creates two Node Group Templates with different set of node processes. The master Node Group Template contains Hadoop's management processes. The worker Node Group Template contains Hadoop's worker processes.

By default the templates are created for the vanilla Hadoop provisioning plugin using the version 1.2.1

After the templates are created the list operation is called.

Platform: openstack

Parameters
Argument Description
flavor [ref] Nova flavor that will be for nodes in the created node groups
plugin_name [ref] name of a provisioning plugin
hadoop_version [ref] version of Hadoop distribution supported by the specified plugin.
use_autoconfig [ref] If True, instances of the node group will be automatically configured during cluster creation. If False, the configuration values should be specify manually

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.sahara.node_group_templates


SaharaNodeGroupTemplates.create_delete_node_group_templates [Scenario]

Create and delete Sahara Node Group Templates.

This scenario creates and deletes two most common types of Node Group Templates.

By default the templates are created for the vanilla Hadoop provisioning plugin using the version 1.2.1

Platform: openstack

Parameters
Argument Description
flavor [ref] Nova flavor that will be for nodes in the created node groups
plugin_name [ref] name of a provisioning plugin
hadoop_version [ref] version of Hadoop distribution supported by the specified plugin.
use_autoconfig [ref] If True, instances of the node group will be automatically configured during cluster creation. If False, the configuration values should be specify manually

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.sahara.node_group_templates


SenlinClusters.create_and_delete_cluster [Scenario]

Create a cluster and then delete it.

Measure the "senlin cluster-create" and "senlin cluster-delete" commands performance.

Platform: openstack

Parameters
Argument Description
desired_capacity [ref] The capacity or initial number of nodes owned by the cluster
min_size [ref] The minimum number of nodes owned by the cluster
max_size [ref] The maximum number of nodes owned by the cluster. -1 means no limit
timeout [ref] The timeout value in seconds for cluster creation
metadata [ref] A set of key value pairs to associate with the cluster

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.senlin.clusters


SwiftObjects.create_container_and_object_then_delete_all [Scenario]

Create container and objects then delete everything created.

Platform: openstack

Parameters
Argument Description
objects_per_container [ref] int, number of objects to upload
object_size [ref] int, temporary local object size
kwargs [ref] dict, optional parameters to create container

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.swift.objects


SwiftObjects.create_container_and_object_then_download_object [Scenario]

Create container and objects then download all objects.

Platform: openstack

Parameters
Argument Description
objects_per_container [ref] int, number of objects to upload
object_size [ref] int, temporary local object size
kwargs [ref] dict, optional parameters to create container

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.swift.objects


SwiftObjects.create_container_and_object_then_list_objects [Scenario]

Create container and objects then list all objects.

Platform: openstack

Parameters
Argument Description
objects_per_container [ref] int, number of objects to upload
object_size [ref] int, temporary local object size
kwargs [ref] dict, optional parameters to create container

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.swift.objects


SwiftObjects.list_and_download_objects_in_containers [Scenario]

List and download objects in all containers.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.swift.objects


SwiftObjects.list_objects_in_containers [Scenario]

List objects in all containers.

Platform: openstack

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.swift.objects


VMTasks.boot_runcommand_delete [Scenario]

Boot a server, run script specified in command and delete server.

Platform: openstack

Parameters
Argument Description
image [ref] glance image name to use for the vm. Optional in case of specified "image_command_customizer" context
flavor [ref] VM flavor name
username [ref] ssh username on server, str
password [ref] Password on SSH authentication
command [ref] Command-specifying dictionary that either specifies remote command path via `remote_path' (can be uploaded from a local file specified by `local_path`), an inline script via `script_inline' or a local script file path using `script_file'. Both `script_file' and `local_path' are checked to be accessible by the `file_exists' validator code. The `script_inline' and `script_file' both require an `interpreter' value to specify the interpreter script should be run with. Note that any of `interpreter' and `remote_path' can be an array prefixed with environment variables and suffixed with args for the `interpreter' command. `remote_path's last component must be a path to a command to execute (also upload destination if a `local_path' is given). Uploading an interpreter is possible but requires that `remote_path' and `interpreter' path do match. Examples: .. code-block:: python # Run a `local_script.pl' file sending it to a remote # Perl interpreter command = { "script_file": "local_script.pl", "interpreter": "/usr/bin/perl" } # Run an inline script sending it to a remote interpreter command = { "script_inline": "echo 'Hello, World!'", "interpreter": "/bin/sh" } # Run a remote command command = { "remote_path": "/bin/false" } # Copy a local command and run it command = { "remote_path": "/usr/local/bin/fio", "local_path": "/home/foobar/myfiodir/bin/fio" } # Copy a local command and run it with environment variable command = { "remote_path": ["HOME=/root", "/usr/local/bin/fio"], "local_path": "/home/foobar/myfiodir/bin/fio" } # Run an inline script sending it to a remote interpreter command = { "script_inline": "echo "Hello, ${NAME:-World}"", "interpreter": ["NAME=Earth", "/bin/sh"] } # Run an inline script sending it to an uploaded remote # interpreter command = { "script_inline": "echo "Hello, ${NAME:-World}"", "interpreter": ["NAME=Earth", "/tmp/sh"], "remote_path": "/tmp/sh", "local_path": "/home/user/work/cve/sh-1.0/bin/sh" }
volume_args [ref] volume args for booting server from volume
floating_network [ref] external network name, for floating ip
port [ref] ssh port for SSH connection
use_floating_ip [ref] bool, floating or fixed IP for SSH connection
force_delete [ref] whether to use force_delete for servers
wait_for_ping [ref] whether to check connectivity on server creation
max_log_length [ref] The number of tail nova console-log lines user would like to retrieve
kwargs [ref] extra arguments for booting the server

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.vm.vmtasks


VMTasks.dd_load_test [Scenario]

Boot a server from a custom image and performs dd load test.

Note

dd load test is prepared script by Rally team. It checks writing and reading metrics from the VM.

Platform: openstack

Parameters
Argument Description
image [ref] glance image name to use for the vm. Optional in case of specified "image_command_customizer" context
flavor [ref] VM flavor name
username [ref] ssh username on server, str
password [ref] Password on SSH authentication
interpreter [ref] the interpreter to execute script with dd load test (defaults to /bin/sh)
command [ref] DEPRECATED. use interpreter instead.
volume_args [ref] volume args for booting server from volume
floating_network [ref] external network name, for floating ip
port [ref] ssh port for SSH connection
use_floating_ip [ref] bool, floating or fixed IP for SSH connection
force_delete [ref] whether to use force_delete for servers
wait_for_ping [ref] whether to check connectivity on server creation
max_log_length [ref] The number of tail nova console-log lines user would like to retrieve
kwargs [ref] extra arguments for booting the server

Requires platform(s):

  • openstack with the next options: {"users": true}

Module: rally_openstack.scenarios.vm.vmtasks


VMTasks.runcommand_heat [Scenario]

Run workload on stack deployed by heat.

Workload can be either file or resource:

{"file": "/path/to/file.sh"}
{"resource": ["package.module", "workload.py"]}

Also it should contain "username" key.

Given file will be uploaded to gate_node and started. This script should print key value pairs separated by colon. These pairs will be presented in results.

Gate node should be accessible via ssh with keypair key_name, so heat template should accept parameter key_name.

Platform: openstack

Parameters
Argument Description
workload [ref] workload to run
template [ref] path to heat template file
files [ref] additional template files
parameters [ref] parameters for heat template

Module: rally_openstack.scenarios.vm.vmtasks


Watcher.create_audit_and_delete [Scenario]

Create and delete audit.

Create Audit, wait until whether Audit is in SUCCEEDED state or in FAILED and delete audit.

Platform: openstack

Module: rally_openstack.scenarios.watcher.basic


Watcher.create_audit_template_and_delete [Scenario]

Create audit template and delete it.

Platform: openstack

Parameters
Argument Description
goal [ref] The goal audit template is based on
strategy [ref] The strategy used to provide resource optimization algorithm

Requires platform(s):

  • openstack with the next options: {"admin": true}

Module: rally_openstack.scenarios.watcher.basic


Watcher.list_audit_templates [Scenario]

List existing audit templates.

Audit templates are being created by Audit Template Context.

Platform: openstack

Parameters
Argument Description
name [ref] Name of the audit template
goal [ref] Name of the goal
strategy [ref] Name of the strategy
limit [ref] The maximum number of results to return per request, if: 1) limit > 0, the maximum number of audit templates to return. 2) limit == 0, return the entire list of audit_templates. 3) limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Watcher API (see Watcher's api.max_limit option).
sort_key [ref] Optional, field used for sorting.
sort_dir [ref] Optional, direction of sorting, either 'asc' (the default) or 'desc'.
detail [ref] Optional, boolean whether to return detailed information about audit_templates.

Module: rally_openstack.scenarios.watcher.basic


ZaqarBasic.create_queue [Scenario]

Create a Zaqar queue with a random name.

Platform: openstack

Parameters
Argument Description
kwargs [ref] other optional parameters to create queues like "metadata"

Module: rally_openstack.scenarios.zaqar.basic


ZaqarBasic.producer_consumer [Scenario]

Serial message producer/consumer.

Creates a Zaqar queue with random name, sends a set of messages and then retrieves an iterator containing those.

Platform: openstack

Parameters
Argument Description
min_msg_count [ref] min number of messages to be posted
max_msg_count [ref] max number of messages to be posted
kwargs [ref] other optional parameters to create queues like "metadata"

Module: rally_openstack.scenarios.zaqar.basic


Validator

A base class for all validators.

check_api_versions [Validator]

Additional validation for api_versions context.

Platform: default

Module: rally_openstack.contexts.api_versions


check_cleanup_resources [Validator]

Validates that openstack resource managers exist.

Platform: default

Parameters
Argument Description
admin_required [ref] describes access level to resource

Module: rally_openstack.contexts.cleanup.base


external_network_exists [Validator]

Validator checks that external network with given name exists.

Platform: openstack

Parameters
Argument Description
param_name [ref] name of validated network

Module: rally_openstack.validators


flavor_exists [Validator]

Returns validator for flavor.

Platform: openstack

Parameters
Argument Description
param_name [ref] defines which variable should be used to get flavor id value.

Module: rally_openstack.validators


image_exists [Validator]

Validator checks existed image or not.

Platform: openstack

Parameters
Argument Description
param_name [ref] defines which variable should be used to get image id value.
nullable [ref] defines image id param is required

Module: rally_openstack.validators


image_valid_on_flavor [Validator]

Returns validator for image could be used for current flavor.

Platform: openstack

Parameters
Argument Description
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.

Module: rally_openstack.validators


required_api_versions [Validator]

Validator checks component API versions.

Platform: openstack

Parameters
Argument Description
component [ref] name of required component
versions [ref] version of required component

Module: rally_openstack.validators


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

Platform: openstack

Parameters
Argument Description
services [ref] Cinder service name

Module: rally_openstack.validators


required_clients [Validator]

Validator checks if specified OpenStack clients are available.

Platform: openstack

Parameters
Argument Description
components [ref] list of client components names
**kwargs [ref] optional parameters: admin - bool, whether to use admin clients

Module: rally_openstack.validators


required_neutron_extensions [Validator]

Validator checks if the specified Neutron extension is available.

Platform: openstack

Parameters
Argument Description
extensions [ref] list of Neutron extensions

Module: rally_openstack.validators


required_services [Validator]

Validator checks if specified OpenStack services are available.

Platform: openstack

Parameters
Argument Description
services [ref] list with names of required services

Module: rally_openstack.validators


valid_command [Validator]

Checks that parameter is a proper command-specifying dictionary.

Ensure that the command dictionary is a proper command-specifying dictionary described in 'vmtasks.VMTasks.boot_runcommand_delete' docstring.

Platform: openstack

Parameters
Argument Description
param_name [ref] Name of parameter to validate
required [ref] Boolean indicating that the command dictionary is required

Module: rally_openstack.scenarios.vm.vmtasks


validate_heat_template [Validator]

Validates heat template.

Platform: openstack

Parameters
Argument Description
params [ref] list of parameters to be validated.

Module: rally_openstack.validators


volume_type_exists [Validator]

Returns validator for volume types.

Platform: openstack

Parameters
Argument Description
param_name [ref] defines variable to be used as the flag to determine if volume types should be checked for existence.
nullable [ref] defines volume_type param is required

Module: rally_openstack.validators


workbook_contains_workflow [Validator]

Validate that workflow exist in workbook when workflow is passed.

Platform: openstack

Parameters
Argument Description
workbook_param [ref] parameter containing the workbook definition
workflow_param [ref] parameter containing the workflow name

Module: rally_openstack.validators


Verification Component

Verifier Manager

Verifier base class.

This class provides an interface for operating specific tool.

tempest [Verifier Manager]

Tempest verifier.

Description:

Quote from official documentation:

This is a set of integration tests to be run against a live OpenStack cluster. Tempest has batteries of tests for OpenStack API validation, Scenarios, and other specific tests useful in validating an OpenStack deployment.

Rally supports features listed below:

  • cloning Tempest: repository and version can be specified
  • installation: system-wide with checking existence of required packages or in virtual environment
  • configuration: options are discovered via OpenStack API, but you can override them if you need
  • running: pre-creating all required resources(i.e images, tenants, etc), prepare arguments, launching Tempest, live-progress output
  • results: all verifications are stored in db, you can built reports, compare verification at whatever you want time.

Appeared in Rally 0.8.0 (actually, it appeared long time ago with first revision of Verification Component, but 0.8.0 is mentioned since it is first release after Verification Component redesign)

Running arguments:

  • concurrency: Number of processes to be used for launching tests. In case of 0 value, number of processes will be equal to number of CPU cores.
  • load_list: a list of tests to launch.
  • pattern: a regular expression of tests to launch.
  • set: Name of predefined set of tests. Known names: full, smoke, baremetal, clustering, compute, database, data_processing, identity, image, messaging, network, object_storage, orchestration, telemetry, volume, scenario
  • skip_list: a list of tests to skip (actually, it is a dict where keys are names of tests, values are reasons).
  • xfail_list: a list of tests that are expected to fail (actually, it is a dict where keys are names of tests, values are reasons).

Installation arguments:

  • system_wide: Whether or not to use the system-wide environment for verifier instead of a virtual environment. Defaults to False.
  • source: Path or URL to the repo to clone verifier from. Defaults to https://git.openstack.org/openstack/tempest
  • version: Branch, tag or commit ID to checkout before verifier installation. Defaults to 'master'.

Platform: openstack

Module: rally_openstack.verification.tempest.manager