What is Rally?¶

How does amqp_rpc_single_reply_queue affect performance?¶

Rally allowed us to reveal a quite an interesting fact about Nova. We used NovaServers.boot_and_delete benchmark scenario to see how the amqp_rpc_single_reply_queue option affects VM bootup time (it turns on a kind of fast RPC). Some time ago it was shown that cloud performance can be boosted by setting it on, so we naturally decided to check this result with Rally. To make this test, we issued requests for booting and deleting VMs for a number of concurrent users ranging from 1 to 30 with and without the investigated option. For each group of users, a total number of 200 requests was issued. Averaged time per request is shown below:

So Rally has unexpectedly indicated that setting the *amqp_rpc_single_reply_queue* option apparently affects the cloud performance, but in quite an opposite way rather than it was thought before.

Performance of Nova list command¶

Another interesting result comes from the NovaServers.boot_and_list_server scenario, which enabled us to we launched the following benchmark with Rally:

• Benchmark environment (which we also call "Context"): 1 temporary OpenStack user.
• Benchmark scenario: boot a single VM from this user & list all VMs.
• Benchmark runner setting: repeat this procedure 200 times in a continuous way.

During the execution of this benchmark scenario, the user has more and more VMs on each iteration. Rally has shown that in this case, the performance of the VM list command in Nova is degrading much faster than one might expect:

Complex scenarios¶

In fact, the vast majority of Rally scenarios is expressed as a sequence of "atomic" actions. For example, NovaServers.snapshot is composed of 6 atomic actions:

1. boot VM
2. snapshot VM
3. delete VM
4. boot VM from snapshot
5. delete VM
6. delete snapshot

Rally measures not only the performance of the benchmark scenario as a whole, but also that of single atomic actions. As a result, Rally also plots the atomic actions performance data for each benchmark iteration in a quite detailed way:

rally-manage db create¶

Create Rally database.

rally-manage db downgrade¶

Downgrade Rally database.

Command arguments:

--revision <revision> (ref)

Downgrade to specified revision UUID. Current revision of DB could be found by calling 'rally-manage db revision'

rally-manage db recreate¶

Drop and create Rally database.

This will delete all existing data.

rally-manage db revision¶

Print current Rally database revision UUID.

rally-manage db upgrade¶

Upgrade Rally database to the latest state.

rally deployment check¶

Check keystone authentication and list all available services.

Command arguments:

--deployment <uuid> (ref)

UUID or name of the deployment.

Type: str

rally deployment config¶

Display configuration of the deployment.

Output is the configuration of the deployment in a pretty-printed JSON format.

Command arguments:

--deployment <uuid> (ref)

UUID or name of the deployment.

Type: str

rally deployment create¶

Create new deployment.

This command will create a new deployment record in rally database. In the case of ExistingCloud deployment engine it will use the cloud represented in the configuration. If the cloud doesn't exist, Rally can deploy a new one for you with Devstack or Fuel. Different deployment engines exist for these cases.

If you use the ExistingCloud deployment engine you can pass a deployment config by environment variables with --fromenv:

OS_USERNAME OS_PASSWORD OS_AUTH_URL OS_TENANT_NAME OS_ENDPOINT OS_REGION_NAME OS_CACERT OS_INSECURE

All other deployment engines need more complex configuration data, so it should be stored in a configuration file.

You can use physical servers, LXC containers, KVM virtual machines or virtual machines in OpenStack for deploying the cloud. Except physical servers, Rally can create cluster nodes for you. Interaction with virtualization software, OpenStack cloud or physical servers is provided by server providers.

Command arguments:

--name <name> (ref)

Name of the deployment.

Type: str

--fromenv (ref)

Read environment variables instead of config file.

--filename <path> (ref)

Path to the configuration file of the deployment.

Type: str

Default: None

--no-use (ref)

Don't set new deployment as default for future operations.

rally deployment destroy¶

Destroy existing deployment.

This will delete all containers, virtual machines, OpenStack instances or Fuel clusters created during Rally deployment creation. Also it will remove the deployment record from the Rally database.

Command arguments:

--deployment <uuid> (ref)

UUID or name of the deployment.

Type: str

rally deployment list¶

List existing deployments.

rally deployment recreate¶

Destroy and create an existing deployment.

Unlike 'deployment destroy', the deployment database record will not be deleted, so the deployment UUID stays the same.

Command arguments:

--deployment <uuid> (ref)

UUID or name of the deployment.

Type: str

rally deployment show¶

Show the credentials of the deployment.

Command arguments:

--deployment <uuid> (ref)

UUID or name of the deployment.

Type: str

rally deployment use¶

Set active deployment.

Command arguments:

--deployment <uuid> (ref)

UUID or name of a deployment.

Type: str

rally plugin list¶

List all Rally plugins that match name and namespace.

Command arguments:

--name <name> (ref)

List only plugins that match the given name.

Type: str

Default: None

--namespace <namespace> (ref)

List only plugins that are in the specified namespace.

Type: str

Default: None

rally plugin show¶

Show detailed information about a Rally plugin.

Command arguments:

--name <name> (ref)

Plugin name.

Type: str

--namespace <namespace> (ref)

Plugin namespace.

Type: str

Default: None

rally show flavors¶

Display available flavors.

Command arguments:

--deployment <uuid> (ref)

UUID or name of a deployment.

Type: str

rally show images¶

Display available images.

Command arguments:

--deployment <uuid> (ref)

UUID or name of a deployment.

Type: str

rally show keypairs¶

Display available ssh keypairs.

Command arguments:

--deployment <uuid> (ref)

UUID or name of a deployment.

Type: str

rally show networks¶

Display configured networks.

Command arguments:

--deployment <uuid> (ref)

UUID or name of a deployment.

Type: str

rally show secgroups¶

Display security groups.

Command arguments:

--deployment <uuid> (ref)

UUID or name of a deployment.

Type: str

rally task abort¶

Abort a running benchmarking task.

Command arguments:

--uuid <uuid> (ref)

UUID of task.

Type: str

--soft (ref)

Abort task after current scenario finishes execution.

rally task delete¶

Delete task and its results.

Command arguments:

--force (ref)

force delete

--uuid <task-id> (ref)

UUID of task or a list of task UUIDs.

Type: str

rally task detailed¶

Print detailed information about given task.

Command arguments:

--uuid <uuid> (ref)

UUID of task. If --uuid is "last" the results of the most recently created task will be displayed.

Type: str

--iterations-data (ref)

Print detailed results for each iteration.

rally task list¶

List tasks, started and finished.

Displayed tasks can be filtered by status or deployment. By default 'rally task list' will display tasks from the active deployment without filtering by status.

Command arguments:

--deployment <uuid> (ref)

UUID or name of a deployment.

Type: str

--all-deployments (ref)

List tasks from all deployments.

--status <status> (ref)

List tasks with specified status. Available statuses: aborted, aborting, cleaning up, failed, finished, init, paused, running, setting up, soft_aborting, verifying

Type: str

Default: None

--uuids-only (ref)

List task UUIDs only.

rally task report¶

Generate report file for specified task.

Command arguments:

--tasks <tasks> (ref)

UUIDs of tasks, or JSON files with task results

Default: None

--out <path> (ref)

Path to output file.

Type: str

Default: None

--open (ref)

Open the output in a browser.

--html (ref)

Generate the report in HTML.

--html-static (ref)

Generate the report in HTML with embedded JS and CSS, so it will not depend on Internet availability.

--junit (ref)

Generate the report in the JUnit format.

rally task results¶

Display raw task results.

This will produce a lot of output data about every iteration.

Command arguments:

--uuid <uuid> (ref)

UUID of task.

Type: str

rally task sla_check¶

Display SLA check results table.

Command arguments:

--uuid <uuid> (ref)

UUID of task.

Type: str

--json (ref)

Output in JSON format.

rally task start¶

Start benchmark task.

If both task_args and task_args_file are specified, they will be merged. task_args has a higher priority so it will override values from task_args_file.

Command arguments:

--deployment <uuid> (ref)

UUID or name of a deployment.

Type: str

--task <path>, --filename <path> (ref)

Path to the input task file

--task-args <json> (ref)

Input task args (JSON dict). These args are used to render the Jinja2 template in the input task.

Default: None

--task-args-file <path> (ref)

Path to the file with input task args (dict in JSON/YAML). These args are used to render the Jinja2 template in the input task.

Default: None

--tag <tag> (ref)

Tag for this task

Default: None

--no-use (ref)

Don't set new task as default for future operations.

--abort-on-sla-failure (ref)

Abort the execution of a benchmark scenario whenany SLA check for it fails.

rally task status¶

Display the current status of a task.

Command arguments:

--uuid <uuid> (ref)

UUID of task

Type: str

rally task use¶

Set active task.

Command arguments:

--uuid <uuid> (ref)

UUID of the task

Type: str

--task (ref)

[Deprecated since Rally 0.2.0] Use '--uuid' instead.

Type: str

rally task validate¶

Validate a task configuration file.

This will check that task configuration file has valid syntax and all required options of scenarios, contexts, SLA and runners are set.

If both task_args and task_args_file are specified, they will be merged. task_args has a higher priority so it will override values from task_args_file.

Command arguments:

--deployment <uuid> (ref)

UUID or name of a deployment.

Type: str

--task <path>, --filename <path> (ref)

Path to the input task file.

--task-args <json> (ref)

Input task args (JSON dict). These args are used to render the Jinja2 template in the input task.

Default: None

--task-args-file <path> (ref)

Path to the file with input task args (dict in JSON/YAML). These args are used to render the Jinja2 template in the input task.

Default: None

rally verify compare¶

Compare two verification results.

Command arguments:

--uuid-1 <uuid_1> (ref)

UUID of the first verification

Type: str

Default: None

--uuid-2 <uuid_2> (ref)

UUID of the second verification

Type: str

Default: None

--csv (ref)

Display results in CSV format

--html (ref)

Display results in HTML format

--json (ref)

Display results in JSON format

--output-file <output_file> (ref)

Path to a file to save results

Type: str

Default: None

--threshold <threshold> (ref)

If specified, timing differences must exceed this percentage threshold to be included in output

Type: int

Default: 0

rally verify detailed¶

Display results table of a verification with detailed errors.

Command arguments:

--uuid <uuid> (ref)

UUID of a verification.

Type: str

--sort-by <sort_by> (ref)

Sort results by 'name' or 'duration'

Default: name

rally verify discover¶

Show a list of discovered tests.

Command arguments:

--deployment <uuid> (ref)

UUID or name of a deployment

Type: str

--pattern <pattern> (ref)

Test name pattern which can be used to match

Type: str

Default:

rally verify genconfig¶

Generate Tempest configuration file.

Command arguments:

--deployment <uuid> (ref)

UUID or name of a deployment.

Type: str

--tempest-config <path> (ref)

User-specified Tempest config file location

Type: str

Default: None

--override (ref)

Override existing Tempest config file

rally verify import¶

Import Tempest tests results into the Rally database.

Command arguments:

--deployment <uuid> (ref)

UUID or name of a deployment.

Type: str

--set <set_name> (ref)

Name of a Tempest test set. Available sets are full, scenario, smoke, baremetal, compute, database, data_processing, identity, image, messaging, network, object_storage, orchestration, telemetry, volume

Type: str

Default:

--file <path> (ref)

User specified Tempest log file location. Note, Tempest log file needs to be in subunit format

Type: str

Default: None

--no-use (ref)

Don't set new task as default for future operations

rally verify install¶

Install Tempest.

Command arguments:

--deployment <uuid> (ref)

UUID or name of a deployment.

Type: str

--source <source> (ref)

Path/URL to repo to clone Tempest from

Type: str

Default: None

--system-wide (ref)

Don't create a virtual env for Tempest. Note that all Tempest requirements have to be already installed in the local env!

rally verify list¶

List verification runs.

rally verify reinstall¶

Uninstall Tempest and install again.

Command arguments:

--deployment <uuid> (ref)

UUID or name of a deployment.

Type: str

--tempest-config <path> (ref)

[Deprecated since Rally 0.3.2] User-specified Tempest config file location. Note that in the future this argument will be removed! Use rally verify genconfig instead

Type: str

Default: None

--source <source> (ref)

Path/URL to repo to clone Tempest from

Type: str

Default: None

--system-wide (ref)

Don't create a virtual env for Tempest. Note that all Tempest requirements have to be already installed in the local env!

rally verify results¶

Display results of a verification.

Command arguments:

--uuid <uuid> (ref)

UUID of a verification.

Type: str

--html (ref)

Display results in HTML format.

--json (ref)

Display results in JSON format.

--output-file <path> (ref)

Path to a file to save results to.

Type: str

Default: None

rally verify show¶

Display results table of a verification.

Command arguments:

--uuid <uuid> (ref)

UUID of a verification

Type: str

--sort-by <query> (ref)

Sort results by 'name' or 'duration'

Type: str

Default: name

--detailed (ref)

Display detailed errors of failed tests

rally verify showconfig¶

Show configuration file of Tempest.

Command arguments:

--deployment <uuid> (ref)

UUID or name of a deployment.

Type: str

rally verify start¶

Start verification (run Tempest tests).

Command arguments:

--deployment <uuid> (ref)

UUID or name of a deployment.

Type: str

--set <set_name> (ref)

Name of a Tempest test set. Available sets are full, scenario, smoke, baremetal, compute, database, data_processing, identity, image, messaging, network, object_storage, orchestration, telemetry, volume

Type: str

Default:

--regex <regex> (ref)

Test name regular expression

Type: str

Default: None

--tests-file <path> (ref)

Path to a file with a list of Tempest tests

Type: str

Default: None

--tempest-config <path> (ref)

User-specified Tempest config file location

Type: str

Default: None

--xfails-file <path> (ref)

Path to a YAML file with a list of Tempest tests that are expected to fail

Type: str

Default: None

--no-use (ref)

Don't set the task as default for future operations

--system-wide (ref)

Don't create a virtual env when installing Tempest; use the local env instead of the Tempest virtual env when running the tests. Note that all Tempest requirements have to be already installed in the local env!

--concurrency N (ref)

How many processes to use to run Tempest tests. The default value (0) auto-detects your CPU count

Type: int

Default: 0

--failing (ref)

Re-run the tests that failed in the last execution

rally verify uninstall¶

Remove the deployment's local Tempest installation.

Command arguments:

--deployment <uuid> (ref)

UUID or name of a deployment.

Type: str

rally verify use¶

Set active verification.

Command arguments:

--uuid <uuid> (ref)

UUID of a verification

Type: str

rps [scenario runner]¶

Scenario runner that does the job with specified frequency.

Every single benchmark scenario iteration is executed with specified frequency (runs per second) in a pool of processes. The scenario will be launched for a fixed number of times in total (specified in the config).

An example of a rps scenario is booting 1 VM per second. This execution type is thus very helpful in understanding the maximal load that a certain cloud can handle.

Namespace: default

Module: rally.plugins.common.runners.rps

constant [scenario runner]¶

Creates constant load executing a scenario a specified number of times.

This runner will place a constant load on the cloud under test by executing each scenario iteration without pausing between iterations up to the number of times specified in the scenario config.

The concurrency parameter of the scenario config controls the number of concurrent scenarios which execute during a single iteration in order to simulate the activities of multiple users placing load on the cloud under test.

Namespace: default

Module: rally.plugins.common.runners.constant

constant_for_duration [scenario runner]¶

Creates constant load executing a scenario for an interval of time.

This runner will place a constant load on the cloud under test by executing each scenario iteration without pausing between iterations until a specified interval of time has elapsed.

The concurrency parameter of the scenario config controls the number of concurrent scenarios which execute during a single iteration in order to simulate the activities of multiple users placing load on the cloud under test.

Namespace: default

Module: rally.plugins.common.runners.constant

serial [scenario runner]¶

Scenario runner that executes benchmark scenarios serially.

Unlike scenario runners that execute in parallel, the serial scenario runner executes scenarios one-by-one in the same python interpreter process as Rally. This allows you to benchmark your scenario without introducing any concurrent operations as well as interactively debug the scenario from the same command that you use to start Rally.

Namespace: default

Module: rally.plugins.common.runners.serial

outliers [SLA]¶

Limit the number of outliers (iterations that take too much time).

The outliers are detected automatically using the computation of the mean and standard deviation (std) of the data.

Namespace: default

Module: rally.plugins.common.sla.outliers

max_avg_duration [SLA]¶

Maximum average duration of one iteration in seconds.

Namespace: default

Module: rally.plugins.common.sla.max_average_duration

failure_rate [SLA]¶

Failure rate minimum and maximum in percents.

Namespace: default

Module: rally.plugins.common.sla.failure_rate

max_seconds_per_iteration [SLA]¶

Maximum time for one iteration in seconds.

Namespace: default

Module: rally.plugins.common.sla.iteration_time

users [context]¶

Context class for generating temporary users/tenants for benchmarks.

Namespace: default

Module: rally.plugins.openstack.context.keystone.users

existing_users [context]¶

This context supports using existing users in Rally.

It uses information about deployment to properly initialize context["users"] and context["tenants"]

So there won't be big difference between usage of "users" and "existing_users" context.

Namespace: default

Module: rally.plugins.openstack.context.keystone.existing_users

flavors [context]¶

Context creates a list of flavors.

Namespace: default

Module: rally.plugins.openstack.context.nova.flavors

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.*uec$"
                },
                "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.*uec$"
                },
                "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"
                    }
                }
            }
        }
    ]
}

Namespace: default

Module: rally.plugins.openstack.context.api_versions

fuel_environments [context]¶

Context for generating Fuel environments.

Namespace: default

Module: rally.plugins.openstack.context.fuel

quotas [context]¶

Context class for updating benchmarks' tenants quotas.

Namespace: default

Module: rally.plugins.openstack.context.quotas.quotas

network [context]¶

Namespace: default

Module: rally.plugins.openstack.context.network.networks

existing_network [context]¶

This context supports using existing networks in Rally.

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

Namespace: default

Module: rally.plugins.openstack.context.network.existing_network

allow_ssh [context]¶

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

Namespace: default

Module: rally.plugins.openstack.context.network.allow_ssh

ec2_servers [context]¶

Context class for adding temporary servers for benchmarks.

Servers are added for each tenant.

Namespace: default

Module: rally.plugins.openstack.context.ec2.servers

lbaas [context]¶

Namespace: default

Module: rally.plugins.openstack.context.neutron.lbaas

tempest [context]¶

Namespace: default

Module: rally.plugins.openstack.context.not_for_production.tempest

admin_cleanup [context]¶

Context class for admin resources cleanup.

Namespace: default

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

cleanup [context]¶

Context class for user resources cleanup.

Namespace: default

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

swift_objects [context]¶

Namespace: default

Module: rally.plugins.openstack.context.swift.objects

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.

Namespace: default

Module: rally.plugins.openstack.context.heat.stacks

sahara_input_data_sources [context]¶

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

Namespace: default

Module: rally.plugins.openstack.context.sahara.sahara_input_data_sources

sahara_image [context]¶

Context class for adding and tagging Sahara images.

Namespace: default

Module: rally.plugins.openstack.context.sahara.sahara_image

sahara_cluster [context]¶

Context class for setting up the Cluster an EDP job.

Namespace: default

Module: rally.plugins.openstack.context.sahara.sahara_cluster

sahara_job_binaries [context]¶

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

Namespace: default

Module: rally.plugins.openstack.context.sahara.sahara_job_binaries

sahara_output_data_sources [context]¶

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

Namespace: default

Module: rally.plugins.openstack.context.sahara.sahara_output_data_sources

keypair [context]¶

Namespace: default

Module: rally.plugins.openstack.context.nova.keypairs

servers [context]¶

Context class for adding temporary servers for benchmarks.

Servers are added for each tenant.

Namespace: default

Module: rally.plugins.openstack.context.nova.servers

custom_image [context]¶

Base class for the contexts providing customized image with.

Every context class for the specific customization must implement the method _customize_image that is able to connect to the server using SSH and e.g. install applications inside it.

This is used e.g. to install the benchmark application using SSH access.

This base context class provides a way to prepare an image with custom preinstalled applications. Basically, this code boots a VM, calls the _customize_image and then snapshots the VM disk, removing the VM afterwards. The image UUID is stored in the user["custom_image"]["id"] and can be used afterwards by scenario.

Namespace: default

Module: rally.plugins.openstack.context.vm.custom_image

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.

Namespace: default

Module: rally.plugins.openstack.context.vm.image_command_customizer

ceilometer [context]¶

Context for creating samples and collecting resources for benchmarks.

Namespace: default

Module: rally.plugins.openstack.context.ceilometer.samples

roles [context]¶

Context class for adding temporary roles for benchmarks.

Namespace: default

Module: rally.plugins.openstack.context.keystone.roles

manila_share_networks [context]¶

This context creates resources specific for Manila project.

Namespace: default

Module: rally.plugins.openstack.context.manila.manila_share_networks

volumes [context]¶

Context class for adding volumes to each user for benchmarks.

Namespace: default

Module: rally.plugins.openstack.context.cinder.volumes

murano_packages [context]¶

Context class for uploading applications for murano.

Namespace: default

Module: rally.plugins.openstack.context.murano.murano_packages

images [context]¶

Context class for adding images to each user for benchmarks.

Namespace: default

Module: rally.plugins.openstack.context.glance.images

zones [context]¶

Context to add zones_per_tenant zones for each tenant.

Namespace: default

Module: rally.plugins.openstack.context.designate.zones

dummy_context [context]¶

Dummy context.

Namespace: default

Module: rally.plugins.common.context.dummy

Quotas.nova_update [scenario]¶

Update quotas for Nova.

Namespace: default

Parameters:

• max_quota: Max value to be updated for quota.

Module: rally.plugins.openstack.scenarios.quotas.quotas

Quotas.nova_update_and_delete [scenario]¶

Update and delete quotas for Nova.

Namespace: default

Parameters:

• max_quota: Max value to be updated for quota.

Module: rally.plugins.openstack.scenarios.quotas.quotas

Quotas.cinder_update [scenario]¶

Update quotas for Cinder.

Namespace: default

Parameters:

• max_quota: Max value to be updated for quota.

Module: rally.plugins.openstack.scenarios.quotas.quotas

Quotas.cinder_update_and_delete [scenario]¶

Update and Delete quotas for Cinder.

Namespace: default

Parameters:

• max_quota: Max value to be updated for quota.

Module: rally.plugins.openstack.scenarios.quotas.quotas

Quotas.neutron_update [scenario]¶

Update quotas for neutron.

Namespace: default

Parameters:

• max_quota: Max value to be updated for quota.

Module: rally.plugins.openstack.scenarios.quotas.quotas

EC2Servers.list_servers [scenario]¶

List all servers.

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

Namespace: default

Module: rally.plugins.openstack.scenarios.ec2.servers

EC2Servers.boot_server [scenario]¶

Boot a server.

Assumes that cleanup is done elsewhere.

Namespace: default

Parameters:

• image: image to be used to boot an instance
• flavor: flavor to be used to boot an instance
• kwargs: optional additional arguments for server creation

Module: rally.plugins.openstack.scenarios.ec2.servers

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.

Namespace: default

Parameters:

• security_group_create_args: dict, POST /v2.0/security-groups

  request options

Module: rally.plugins.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.

Namespace: default

Parameters:

• security_group_create_args: dict, POST /v2.0/security-groups

  request options

Module: rally.plugins.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.

Namespace: default

Parameters:

• security_group_create_args: dict, POST /v2.0/security-groups

  request options

• security_group_update_args: dict, POST /v2.0/security-groups

  update options

Module: rally.plugins.openstack.scenarios.neutron.security_groups

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.

Namespace: default

Parameters:

• pool_create_args: dict, POST /lb/pools request options

Module: rally.plugins.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.

Namespace: default

Parameters:

• pool_create_args: dict, POST /lb/pools request options

Module: rally.plugins.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.

Namespace: default

Parameters:

• pool_create_args: dict, POST /lb/pools request options
• pool_update_args: dict, POST /lb/pools update options

Module: rally.plugins.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.

Namespace: default

Parameters:

• vip_create_args: dict, POST /lb/vips request options
• pool_create_args: dict, POST /lb/pools request options

Module: rally.plugins.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.

Namespace: default

Parameters:

• pool_create_args: dict, POST /lb/pools request options
• vip_create_args: dict, POST /lb/vips request options

Module: rally.plugins.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.

Namespace: default

Parameters:

• pool_create_args: dict, POST /lb/pools request options
• vip_create_args: dict, POST /lb/vips request options
• vip_update_args: dict, POST /lb/vips update options

Module: rally.plugins.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.

Namespace: default

Parameters:

• healthmonitor_create_args: dict, POST /lb/healthmonitors request

options

Module: rally.plugins.openstack.scenarios.neutron.loadbalancer_v1

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.

Namespace: default

Parameters:

• healthmonitor_create_args: dict, POST /lb/healthmonitors request

options

Module: rally.plugins.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.

Namespace: default

Parameters:

• healthmonitor_create_args: dict, POST /lb/healthmonitors request

options

• healthmonitor_update_args: dict, POST /lb/healthmonitors update

options

Module: rally.plugins.openstack.scenarios.neutron.loadbalancer_v1

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.

Namespace: default

Parameters:

• network_create_args: dict, POST /v2.0/networks request options

Module: rally.plugins.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.

Namespace: default

Parameters:

• network_update_args: dict, PUT /v2.0/networks update request
• network_create_args: dict, POST /v2.0/networks request options

Module: rally.plugins.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.

Namespace: default

Parameters:

• network_create_args: dict, POST /v2.0/networks request options

Module: rally.plugins.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.

Namespace: default

Parameters:

• network_create_args: dict, POST /v2.0/networks request

  options. Deprecated

• subnet_create_args: dict, POST /v2.0/subnets request options

• subnet_cidr_start: str, start value for subnets CIDR

• subnets_per_network: int, number of subnets for one network

Module: rally.plugins.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.

Namespace: default

Parameters:

• subnet_update_args: dict, PUT /v2.0/subnets update options

• network_create_args: dict, POST /v2.0/networks request

  options. Deprecated.

• subnet_create_args: dict, POST /v2.0/subnets request options

• subnet_cidr_start: str, start value for subnets CIDR

• subnets_per_network: int, number of subnets for one network

Module: rally.plugins.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.

Namespace: default

Parameters:

• network_create_args: dict, POST /v2.0/networks request

  options. Deprecated.

• subnet_create_args: dict, POST /v2.0/subnets request options

• subnet_cidr_start: str, start value for subnets CIDR

• subnets_per_network: int, number of subnets for one network

Module: rally.plugins.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.

Namespace: default

Parameters:

• network_create_args: dict, POST /v2.0/networks request

  options. Deprecated.

• subnet_create_args: dict, POST /v2.0/subnets request options

• subnet_cidr_start: str, start value for subnets CIDR

• subnets_per_network: int, number of subnets for one network

• router_create_args: dict, POST /v2.0/routers request options

Module: rally.plugins.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.

Namespace: default

Parameters:

• router_update_args: dict, PUT /v2.0/routers update options

• network_create_args: dict, POST /v2.0/networks request

  options. Deprecated.

• subnet_create_args: dict, POST /v2.0/subnets request options

• subnet_cidr_start: str, start value for subnets CIDR

• subnets_per_network: int, number of subnets for one network

• router_create_args: dict, POST /v2.0/routers request options

Module: rally.plugins.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.

Namespace: default

Parameters:

• network_create_args: dict, POST /v2.0/networks request

  options. Deprecated.

• subnet_create_args: dict, POST /v2.0/subnets request options

• subnet_cidr_start: str, start value for subnets CIDR

• subnets_per_network: int, number of subnets for one network

• router_create_args: dict, POST /v2.0/routers request options

Module: rally.plugins.openstack.scenarios.neutron.network

NeutronNetworks.create_and_list_ports [scenario]¶

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

Namespace: default

Parameters:

• network_create_args: dict, POST /v2.0/networks request

  options. Deprecated.

• port_create_args: dict, POST /v2.0/ports request options

• ports_per_network: int, number of ports for one network

Module: rally.plugins.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.

Namespace: default

Parameters:

• port_update_args: dict, PUT /v2.0/ports update request options

• network_create_args: dict, POST /v2.0/networks request

  options. Deprecated.

• port_create_args: dict, POST /v2.0/ports request options

• ports_per_network: int, number of ports for one network

Module: rally.plugins.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.

Namespace: default

Parameters:

• network_create_args: dict, POST /v2.0/networks request

  options. Deprecated.

• port_create_args: dict, POST /v2.0/ports request options

• ports_per_network: int, number of ports for one network

Module: rally.plugins.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.

Namespace: default

Parameters:

• floating_network: str, external network for floating IP creation
• floating_ip_args: dict, POST /floatingips request options

Module: rally.plugins.openstack.scenarios.neutron.network

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.

Namespace: default

Parameters:

• floating_network: str, external network for floating IP creation
• floating_ip_args: dict, POST /floatingips request options

Module: rally.plugins.openstack.scenarios.neutron.network

IronicNodes.create_and_list_node [scenario]¶

Create and list nodes.

Namespace: default

Parameters:

• associated: Optional. 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: Optional. 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").

• marker: Optional, the UUID of a node, eg the last

  node from a previous result set. Return the next result set.

• limit: The maximum number of results to return per

  request, if:

  1. limit > 0, the maximum number of nodes to return.
  2. limit == 0, return the entire list of nodes.
  3. limit param is NOT specified (None), the number of items returned respect the maximum imposed by the Ironic API (see Ironic's api.max_limit option).

• detail: Optional, boolean whether to return detailed

  information about nodes.

• sort_key: Optional, field used for sorting.

• sort_dir: Optional, direction of sorting, either 'asc' (the

  default) or 'desc'.

• kwargs: Optional additional arguments for node creation

Module: rally.plugins.openstack.scenarios.ironic.nodes

IronicNodes.create_and_delete_node [scenario]¶

Create and delete node.

Namespace: default

Parameters:

• kwargs: Optional additional arguments for node creation

Module: rally.plugins.openstack.scenarios.ironic.nodes

SwiftObjects.create_container_and_object_then_list_objects [scenario]¶

Create container and objects then list all objects.

Namespace: default

Parameters:

• objects_per_container: int, number of objects to upload
• object_size: int, temporary local object size
• kwargs: dict, optional parameters to create container

Module: rally.plugins.openstack.scenarios.swift.objects

SwiftObjects.create_container_and_object_then_delete_all [scenario]¶

Create container and objects then delete everything created.

Namespace: default

Parameters:

• objects_per_container: int, number of objects to upload
• object_size: int, temporary local object size
• kwargs: dict, optional parameters to create container

Module: rally.plugins.openstack.scenarios.swift.objects

SwiftObjects.create_container_and_object_then_download_object [scenario]¶

Create container and objects then download all objects.

Namespace: default

Parameters:

• objects_per_container: int, number of objects to upload
• object_size: int, temporary local object size
• kwargs: dict, optional parameters to create container

Module: rally.plugins.openstack.scenarios.swift.objects

SwiftObjects.list_objects_in_containers [scenario]¶

List objects in all containers.

Namespace: default

Module: rally.plugins.openstack.scenarios.swift.objects

SwiftObjects.list_and_download_objects_in_containers [scenario]¶

List and download objects in all containers.

Namespace: default

Module: rally.plugins.openstack.scenarios.swift.objects

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.

Namespace: default

Parameters:

• template_path: path to stack template file
• parameters: parameters to use in heat template
• files: files used in template
• environment: stack environment definition

Module: rally.plugins.openstack.scenarios.heat.stacks

HeatStacks.list_stacks_and_resources [scenario]¶

List all resources from tenant stacks.

Namespace: default

Module: rally.plugins.openstack.scenarios.heat.stacks

HeatStacks.create_and_delete_stack [scenario]¶

Create and then delete a stack.

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

Namespace: default

Parameters:

• template_path: path to stack template file
• parameters: parameters to use in heat template
• files: files used in template
• environment: stack environment definition

Module: rally.plugins.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

Namespace: default

Parameters:

• template_path: path to stack template file
• parameters: parameters to use in heat template
• files: files used in template
• environment: stack environment definition

Module: rally.plugins.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.

Namespace: default

Parameters:

• template_path: path to stack template file

• updated_template_path: path to updated stack template file

• parameters: parameters to use in heat template

• updated_parameters: parameters to use in updated heat template

  If not specified then parameters will be used instead

• files: files used in template

• updated_files: files used in updated template. If not specified

  files value will be used instead

• environment: stack environment definition

• updated_environment: environment definition for updated stack

Module: rally.plugins.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.

Namespace: default

Parameters:

• template_path: path to template file that includes an

  OS::Heat::AutoScalingGroup resource

• output_key: the stack output key that corresponds to

  the scaling webhook

• delta: the number of instances the stack is expected to

  change by.

• parameters: parameters to use in heat template

• files: files used in template (dict of file name to

  file path)

• environment: stack environment definition (dict)

Module: rally.plugins.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

Namespace: default

Parameters:

• template_path: path to stack template file
• parameters: parameters to use in heat template
• files: files used in template
• environment: stack environment definition

Module: rally.plugins.openstack.scenarios.heat.stacks

HeatStacks.list_stacks_and_events [scenario]¶

List events from tenant stacks.

Namespace: default

Module: rally.plugins.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

Namespace: default

Parameters:

• template_path: path to stack template file
• parameters: parameters to use in heat template
• files: files used in template
• environment: stack environment definition

Module: rally.plugins.openstack.scenarios.heat.stacks

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.

Namespace: default

Parameters:

• flavor: Nova flavor that will be for nodes in the

  created node groups

• plugin_name: name of a provisioning plugin

• hadoop_version: version of Hadoop distribution supported by

  the specified plugin.

Module: rally.plugins.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

Namespace: default

Parameters:

• flavor: Nova flavor that will be for nodes in the

  created node groups

• plugin_name: name of a provisioning plugin

• hadoop_version: version of Hadoop distribution supported by

  the specified plugin.

Module: rally.plugins.openstack.scenarios.sahara.node_group_templates

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.

Namespace: default

Parameters:

• job_type: type of the Data Processing Job

• configs: config dict that will be passed to a Job Execution

• job_idx: 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.plugins.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.

Namespace: default

Parameters:

• jobs: list of jobs that should be executed in one context

Module: rally.plugins.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.

Namespace: default

Parameters:

• jobs: list of jobs that should be executed in one context

• deltas: list of integers which will be used to add or

  remove worker nodes from the cluster

Module: rally.plugins.openstack.scenarios.sahara.jobs

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.

Namespace: default

Parameters:

• flavor: Nova flavor that will be for nodes in the

  created node groups. Deprecated.

• master_flavor: Nova flavor that will be used for the master

  instance of the cluster

• worker_flavor: Nova flavor that will be used for the workers of

  the cluster

• workers_count: number of worker instances in a cluster

• plugin_name: name of a provisioning plugin

• hadoop_version: version of Hadoop distribution supported by

  the specified plugin.

• floating_ip_pool: 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: number of Cinder volumes that will be

  attached to every cluster node

• volumes_size: size of each Cinder volume in GB

• auto_security_group: boolean value. If set to True Sahara will

  create a Security Group for each Node Group in the Cluster automatically.

• security_groups: 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: config dict that will be passed to each Node

  Group

• cluster_configs: config dict that will be passed to the

  Cluster

• enable_anti_affinity: If set to true the vms will be scheduled

  one per compute node.

• enable_proxy: Use Master Node of a Cluster as a Proxy node and

  do not assign floating ips to workers.

Module: rally.plugins.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

Namespace: default

Parameters:

• flavor: Nova flavor that will be for nodes in the

  created node groups. Deprecated.

• master_flavor: Nova flavor that will be used for the master

  instance of the cluster

• worker_flavor: Nova flavor that will be used for the workers of

  the cluster

• workers_count: number of worker instances in a cluster

• plugin_name: name of a provisioning plugin

• hadoop_version: version of Hadoop distribution supported by

  the specified plugin.

• deltas: list of integers which will be used to add or

  remove worker nodes from the cluster

• floating_ip_pool: 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: 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: number of Cinder volumes that will be

  attached to every cluster node

• volumes_size: size of each Cinder volume in GB

• auto_security_group: boolean value. If set to True Sahara will

  create a Security Group for each Node Group in the Cluster automatically.

• security_groups: 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: configs dict that will be passed to each Node

  Group

• cluster_configs: configs dict that will be passed to the

  Cluster

• enable_anti_affinity: If set to true the vms will be scheduled

  one per compute node.

• enable_proxy: Use Master Node of a Cluster as a Proxy node and

  do not assign floating ips to workers.

Module: rally.plugins.openstack.scenarios.sahara.clusters

NovaAvailabilityZones.list_availability_zones [scenario]¶

List all availability zones.

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

Namespace: default

Parameters:

• detailed: True if the availability-zone listing should contain

  detailed information about all of them

Module: rally.plugins.openstack.scenarios.nova.availability_zones

NovaAggregates.list_aggregates [scenario]¶

List all nova aggregates.

Measure the "nova aggregate-list" command performance.

Namespace: default

Module: rally.plugins.openstack.scenarios.nova.aggregates

NovaFloatingIpsBulk.create_and_list_floating_ips_bulk [scenario]¶

Create nova floating IP by range and list it.

This scenario creates a floating IP by range and then lists all.

Namespace: default

Parameters:

• start_cidr: Floating IP range
• kwargs: Optional additional arguments for range IP creation

Module: rally.plugins.openstack.scenarios.nova.floating_ips_bulk

NovaFloatingIpsBulk.create_and_delete_floating_ips_bulk [scenario]¶

Create nova floating IP by range and delete it.

This scenario creates a floating IP by range and then delete it.

Namespace: default

Parameters:

• start_cidr: Floating IP range
• kwargs: Optional additional arguments for range IP creation

Module: rally.plugins.openstack.scenarios.nova.floating_ips_bulk

NovaAgents.list_agents [scenario]¶

List all builds.

Measure the "nova agent-list" command performance.

Namespace: default

Parameters:

• hypervisor: List agent builds on a specific hypervisor.

  None (default value) means list for all hypervisors

Module: rally.plugins.openstack.scenarios.nova.agents

NovaServices.list_services [scenario]¶

List all nova services.

Measure the "nova service-list" command performance.

Namespace: default

Parameters:

• host: List nova services on host
• binary: List nova services matching given binary

Module: rally.plugins.openstack.scenarios.nova.services

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.

Namespace: default

Parameters:

• kwargs: Optional additional arguments for keypair creation

Module: rally.plugins.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.

Namespace: default

Parameters:

• kwargs: Optional additional arguments for keypair creation

Module: rally.plugins.openstack.scenarios.nova.keypairs

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

Namespace: default

Parameters:

• image: ID of the image to be used for server creation

• flavor: ID of the flavor to be used for server creation

• boot_server_kwargs: Optional additional arguments for VM

  creation

• server_kwargs: Deprecated alias for boot_server_kwargs

• kwargs: Optional additional arguments for keypair creation

Module: rally.plugins.openstack.scenarios.nova.keypairs

NovaNetworks.create_and_list_networks [scenario]¶

Create nova network and list all networks.

Namespace: default

Parameters:

• start_cidr: IP range
• kwargs: Optional additional arguments for network creation

Module: rally.plugins.openstack.scenarios.nova.networks

NovaNetworks.create_and_delete_network [scenario]¶

Create nova network and delete it.

Namespace: default

Parameters:

• start_cidr: IP range
• kwargs: Optional additional arguments for network creation

Module: rally.plugins.openstack.scenarios.nova.networks

NovaHypervisors.list_hypervisors [scenario]¶

List hypervisors.

Measure the "nova hypervisor-list" command performance.

Namespace: default

Parameters:

• detailed: True if the hypervisor listing should contain

  detailed information about all of them

Module: rally.plugins.openstack.scenarios.nova.hypervisors

NovaHosts.list_hosts [scenario]¶

List all nova hosts.

Measure the "nova host-list" command performance.

Namespace: default

Parameters:

• zone: List nova hosts in an availibility-zone.

  None (default value) means list hosts in all availibility-zones

Module: rally.plugins.openstack.scenarios.nova.hosts

NovaFlavors.list_flavors [scenario]¶

List all flavors.

Measure the "nova flavor-list" command performance.

Namespace: default

Parameters:

• detailed: True if the flavor listing

  should contain detailed information

• kwargs: Optional additional arguments for flavor listing

Module: rally.plugins.openstack.scenarios.nova.flavors

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.

Namespace: default

Parameters:

• image: image to be used to boot an instance

• flavor: flavor to be used to boot an instance

• detailed: True if the server listing should contain

  detailed information about all of them

• kwargs: Optional additional arguments for server creation

Module: rally.plugins.openstack.scenarios.nova.servers

NovaServers.list_servers [scenario]¶

List all servers.

This simple scenario test the nova list command by listing all the servers.

Namespace: default

Parameters:

• detailed: True if detailed information about servers

  should be listed

Module: rally.plugins.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]).

Namespace: default

Parameters:

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

Module: rally.plugins.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.

Namespace: default

Parameters:

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

Module: rally.plugins.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]).

Namespace: default

Parameters:

• image: image to be used to boot an instance
• flavor: flavor to be used to boot an instance
• volume_size: volume size (in GB)
• min_sleep: Minimum sleep time in seconds (non-negative)
• max_sleep: Maximum sleep time in seconds (non-negative)
• force_delete: True if force_delete should be used
• kwargs: Optional additional arguments for server creation

Module: rally.plugins.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' and 'rescue_unrescue'. Delete server after all actions were completed.

Namespace: default

Parameters:

• image: image to be used to boot an instance

• flavor: flavor to be used to boot an instance

• force_delete: True if force_delete should be used

• actions: list of action dictionaries, where each action

  dictionary speicifes an action to be performed in the following format: {"action_name": <no_of_iterations>}

• kwargs: Optional additional arguments for server creation

Module: rally.plugins.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).

Namespace: default

Parameters:

• image: image to be used to boot an instance

• flavor: flavor to be used to boot an instance

• min_sleep: Minimum sleep time between locking and unlocking

  in seconds

• max_sleep: Maximum sleep time between locking and unlocking

  in seconds

• force_delete: True if force_delete should be used

• kwargs: Optional additional arguments for server creation

Module: rally.plugins.openstack.scenarios.nova.servers

NovaServers.snapshot_server [scenario]¶

Boot a server, make its snapshot and delete both.

Namespace: default

Parameters:

• image: image to be used to boot an instance
• flavor: flavor to be used to boot an instance
• force_delete: True if force_delete should be used
• kwargs: Optional additional arguments for server creation

Module: rally.plugins.openstack.scenarios.nova.servers

NovaServers.boot_server [scenario]¶

Boot a server.

Assumes that cleanup is done elsewhere.

Namespace: default

Parameters:

• image: image to be used to boot an instance
• flavor: flavor to be used to boot an instance
• auto_assign_nic: True if NICs should be assigned
• kwargs: Optional additional arguments for server creation

Module: rally.plugins.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.

Namespace: default

Parameters:

• image: image to be used to boot an instance
• flavor: flavor to be used to boot an instance
• volume_size: volume size (in GB)
• auto_assign_nic: True if NICs should be assigned
• kwargs: Optional additional arguments for server creation

Module: rally.plugins.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.

Namespace: default

Parameters:

• image: image to be used to boot an instance
• flavor: flavor to be used to boot an instance
• to_flavor: flavor to be used to resize the booted instance
• force_delete: True if force_delete should be used
• kwargs: Optional additional arguments for server creation

Module: rally.plugins.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]).

Namespace: default

Parameters:

• image: Glance image name to use for the VM

• flavor: VM flavor name

• to_flavor: flavor to be used to resize the booted instance

• volume_size: volume size (in GB)

• min_sleep: Minimum sleep time in seconds (non-negative)

• max_sleep: Maximum sleep time in seconds (non-negative)

• force_delete: True if force_delete should be used

• confirm: True if need to confirm resize else revert resize

• do_delete: True if resources needs to be deleted explicitly

  else use rally cleanup to remove resources

• boot_server_kwargs: optional arguments for VM creation

• create_volume_kwargs: optional arguments for volume creation

Module: rally.plugins.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.

Namespace: default

Parameters:

• image: image to be used to boot an instance

• flavor: flavor to be used to boot an instance

• to_flavor: flavor to be used to resize the booted instance

• volume_size: volume size (in GB)

• min_sleep: Minimum sleep time in seconds (non-negative)

• max_sleep: Maximum sleep time in seconds (non-negative)

• force_delete: True if force_delete should be used

• confirm: True if need to confirm resize else revert resize

• do_delete: True if resources needs to be deleted explicitly

  else use rally cleanup to remove resources

• boot_server_kwargs: optional arguments for VM creation

• create_volume_kwargs: optional arguments for volume creation

Module: rally.plugins.openstack.scenarios.nova.servers

NovaServers.suspend_and_resume_server [scenario]¶

Create a server, suspend, resume and then delete it

Namespace: default

Parameters:

• image: image to be used to boot an instance
• flavor: flavor to be used to boot an instance
• force_delete: True if force_delete should be used
• kwargs: Optional additional arguments for server creation

Module: rally.plugins.openstack.scenarios.nova.servers

NovaServers.pause_and_unpause_server [scenario]¶

Create a server, pause, unpause and then delete it

Namespace: default

Parameters:

• image: image to be used to boot an instance
• flavor: flavor to be used to boot an instance
• force_delete: True if force_delete should be used
• kwargs: Optional additional arguments for server creation

Module: rally.plugins.openstack.scenarios.nova.servers

NovaServers.shelve_and_unshelve_server [scenario]¶

Create a server, shelve, unshelve and then delete it

Namespace: default

Parameters:

• image: image to be used to boot an instance
• flavor: flavor to be used to boot an instance
• force_delete: True if force_delete should be used
• kwargs: Optional additional arguments for server creation

Module: rally.plugins.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]).

Namespace: default

Parameters:

• image: image to be used to boot an instance

• flavor: flavor to be used to boot an instance

• block_migration: Specifies the migration type

• disk_over_commit: Specifies whether to allow overcommit

  on migrated instance or not

• min_sleep: Minimum sleep time in seconds (non-negative)

• max_sleep: Maximum sleep time in seconds (non-negative)

• kwargs: Optional additional arguments for server creation

Module: rally.plugins.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]).

Namespace: default

Parameters:

• image: image to be used to boot an instance

• flavor: flavor to be used to boot an instance

• volume_size: volume size (in GB)

• block_migration: Specifies the migration type

• disk_over_commit: Specifies whether to allow overcommit

  on migrated instance or not

• force_delete: True if force_delete should be used

• min_sleep: Minimum sleep time in seconds (non-negative)

• max_sleep: Maximum sleep time in seconds (non-negative)

• kwargs: Optional additional arguments for server creation

Module: rally.plugins.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]).

Namespace: default

Parameters:

• image: Glance image name to use for the VM

• flavor: VM flavor name

• size: volume size (in GB)

• block_migration: Specifies the migration type

• disk_over_commit: Specifies whether to allow overcommit

  on migrated instance or not

• boot_server_kwargs: optional arguments for VM creation

• create_volume_kwargs: optional arguments for volume creation

• min_sleep: Minimum sleep time in seconds (non-negative)

• max_sleep: Maximum sleep time in seconds (non-negative)

Module: rally.plugins.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 stops the VM, and then migrates the VM to another compute node on the same availability zone.

Namespace: default

Parameters:

• image: image to be used to boot an instance
• flavor: flavor to be used to boot an instance
• kwargs: Optional additional arguments for server creation

Module: rally.plugins.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.

Namespace: default

Parameters:

• from_image: image to be used to boot an instance
• to_image: image to be used to rebuild the instance
• flavor: flavor to be used to boot an instance
• kwargs: Optional additional arguments for server creation

Module: rally.plugins.openstack.scenarios.nova.servers

NovaServers.boot_and_associate_floating_ip [scenario]¶

Boot a server and associate a floating IP to it.

Namespace: default

Parameters:

• image: image to be used to boot an instance
• flavor: flavor to be used to boot an instance
• kwargs: Optional additional arguments for server creation

Module: rally.plugins.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.

Namespace: default

Parameters:

• image: image to be used to boot an instance
• flavor: flavor to be used to boot an instance
• kwargs: Optional additional arguments for server creation

Returns: Server details

Module: rally.plugins.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.

Namespace: default

Parameters:

• image: image to be used to boot an instance

• flavor: flavor to be used to boot an instance

• length: The number of tail log lines you would like to retrieve.

  None (default value) or -1 means unlimited length.

• kwargs: Optional additional arguments for server creation

Returns: Text console log output for server

Module: rally.plugins.openstack.scenarios.nova.servers

NovaSecGroup.create_and_delete_secgroups [scenario]¶

Create and delete security groups.

This scenario creates N security groups with M rules per group and then deletes them.

Namespace: default

Parameters:

• security_group_count: Number of security groups
• rules_per_security_group: Number of rules per security group

Module: rally.plugins.openstack.scenarios.nova.security_group

NovaSecGroup.create_and_list_secgroups [scenario]¶

Create and list security groups.

This scenario creates N security groups with M rules per group and then lists them.

Namespace: default

Parameters:

• security_group_count: Number of security groups
• rules_per_security_group: Number of rules per security group

Module: rally.plugins.openstack.scenarios.nova.security_group

NovaSecGroup.create_and_update_secgroups [scenario]¶

Create and update security groups.

This scenario creates 'security_group_count' security groups then updates their name and description.

Namespace: default

Parameters:

• security_group_count: Number of security groups

Module: rally.plugins.openstack.scenarios.nova.security_group

NovaSecGroup.boot_and_delete_server_with_secgroups [scenario]¶

Boot and delete server with security groups attached.

Plan of this scenario:

• create N security groups with M rules per group vm with security groups)
• boot a VM with created security groups
• get list of attached security groups to server
• delete server
• delete all security groups
• check that all groups were attached to server

Namespace: default

Parameters:

• image: ID of the image to be used for server creation
• flavor: ID of the flavor to be used for server creation
• security_group_count: Number of security groups
• rules_per_security_group: Number of rules per security group
• **kwargs: Optional arguments for booting the instance

Module: rally.plugins.openstack.scenarios.nova.security_group

NovaImages.list_images [scenario]¶

List all images.

Measure the "nova image-list" command performance.

Namespace: default

Parameters:

• detailed: True if the image listing

  should contain detailed information

• kwargs: Optional additional arguments for image listing

Module: rally.plugins.openstack.scenarios.nova.images

VMTasks.boot_runcommand_delete [scenario]¶

Boot a server, run script specified in command and delete server.

Example Script in samples/tasks/support/instance_dd_test.sh

The script to be executed is provided like command['remote_path'] or command['local_path'] and interpreter in command['interpreter'] respectively.

Namespace: default

Parameters:

• image: glance image name to use for the vm

• flavor: VM flavor name

• username: ssh username on server, str

• password: Password on SSH authentication

• command: 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:

  # 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: volume args for booting server from volume

• floating_network: external network name, for floating ip

• port: ssh port for SSH connection

• use_floating_ip: bool, floating or fixed IP for SSH connection

• force_delete: whether to use force_delete for servers

• wait_for_ping: whether to check connectivity on server creation

• **kwargs: extra arguments for booting the server

• max_log_length: The number of tail nova console-log lines user

  would like to retrieve

Returns: dictionary with keys `data' and `errors': data: dict, JSON output from the script errors: str, raw data from the script's stderr stream

Module: rally.plugins.openstack.scenarios.vm.vmtasks

VMTasks.boot_runcommand_delete_custom_image [scenario]¶

Boot a server from a custom image, run a command that outputs JSON.

Example Script in rally-jobs/extra/install_benchmark.sh

Namespace: default

Module: rally.plugins.openstack.scenarios.vm.vmtasks

VMTasks.runcommand_heat [scenario]¶

Run workload on stack deployed by heat.

Workload can be either file or resource:

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.

Namespace: default

Parameters:

• workload: workload to run
• template: path to heat template file
• files: additional template files
• parameters: parameters for heat template

Module: rally.plugins.openstack.scenarios.vm.vmtasks

CeilometerSamples.list_matched_samples [scenario]¶

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

Namespace: default

Parameters:

• filter_by_user_id: flag for query by user_id
• filter_by_project_id: flag for query by project_id
• filter_by_resource_id: flag for query by resource_id
• metadata_query: dict with metadata fields and values for query
• limit: count of samples in response

Module: rally.plugins.openstack.scenarios.ceilometer.samples

CeilometerSamples.list_samples [scenario]¶

Fetch all available queries for list sample request.

Namespace: default

Parameters:

• metadata_query: dict with metadata fields and values for query
• limit: count of samples in response

Module: rally.plugins.openstack.scenarios.ceilometer.samples

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.

Namespace: default

Module: rally.plugins.openstack.scenarios.ceilometer.events