rally/doc/source/deploy_engines.rst

Deploy engines

Introduction

One of the core entities in Rally architecture are the Deploy engines. The task of a deploy engine is to control the process of deploying some OpenStack distribution like DevStack or FUEL before any benchmarking procedures take place. Every deploy engine should implement the following fairly simple interface:

constuctor, which takes a deployment entity as its only parameter;

deploy(), which should deploy the appropriate OpenStack distribution given the cloud config from the deployment object the engine was initialized with (possibly using one of available server providers <server_providers>). The method should also return a dictionary with endpoints of the deployed OpenStack distribution;

cleanup(), which should clean up the OpenStack deployment (again, possibly using one of available server providers <server_providers>).

Below you will find a short but informative description of deploy engines implemented in Rally.

Available Deploy engines

ExistingCloud

Description

This engine in fact does not deploy anything, but uses an existing OpenStack installation. It may be useful in case you have a preconfigured OpenStack deployment ready to launch benchmark scenarios.

Configuration Example

{
    "type": "ExistingCloud",
    "endpoint": {
         "auth_url": "http://192.168.122.22:5000/v2.0/",
         "username": "admin",
         "password": "password",
         "tenant_name": "admin",
         "use_public_urls": True
    }
}

Or using keystone v3 API endpoint:

{
    "type": "ExistingCloud,
    "endpoint": {
        "auth_url": "http://localhost:5000/v3/,
        "username": "engineer1,
        "user_domain_name": "qa,
        "project_name": "qa_admin_project,
        "project_domain_name": "qa,
        "password": "password,
        "region_name": "RegionOne,
        "use_public_urls": False,
        "admin_port": 35357
    }
}

use_public_urls option will be used later for switching access method to the cloud.

Because in some use-cases cloud may be accessible only by public endpoints.

All you should specify in the config is the OpenStack cloud endpoint: the auth_url and also admin credentials, including tenant name. Rally will use the specified admin account to manage temporary non-admin tenants and users exploited while launching benchmark scenarios.

DevstackEngine

Description

This engine deploys a Devstack cloud using the given Devstack repository.

Configuration Example

{
    "type": "DevstackEngine",
    "localrc": {
        "ADMIN_PASSWORD": "secret",
        "NOVA_REPO": "git://example.com/nova/",
        ...
    },
    "devstack_repo": "git://example.com/devstack/",
    "type": {
        "name": "${PROVIDER_NAME}",
        ...
    }
}

The localrc field of the Devstack engine configuration will be used to initialize the Devstack's localrc file. As this deploy engine does not use an existing cloud, it also needs a concrete server provider <server_providers> specification: the type of the used provider (${PROVIDER_NAME}), followed by provider-specific fields configuration.

Note

More Deploy engines are to come in future releases, namely deploy engines for FUEL, Tripple-O etc. Stay tuned.