Yardstick currently supports installation on Ubuntu 14.04 or by using a Docker image. Detailed steps about installing Yardstick using both of these options can be found below.

To use Yardstick you should have access to an OpenStack environment, with at least Nova, Neutron, Glance, Keystone and Heat installed.

The steps needed to run Yardstick are:

  1. Install Yardstick and create the test configuration .yaml file.
  2. Build a guest image and load the image into the OpenStack environment.
  3. Create a Neutron external network and load OpenStack environment variables.
  4. Run the test case.

Installing Yardstick on Ubuntu 14.04

Installing Yardstick framework

Install dependencies:

sudo apt-get install python-virtualenv python-dev
sudo apt-get install libffi-dev libssl-dev git

Create a python virtual environment, source it and update setuptools:

virtualenv ~/yardstick_venv
source ~/yardstick_venv/bin/activate
easy_install -U setuptools

Download source code and install python dependencies:

git clone
cd yardstick
python install

There is also a YouTube video, showing the above steps:

Installing extra tools


Yardstick has an internal plotting tool yardstick-plot, which can be installed using the following command:

python develop easy_install yardstick[plot]

Building a guest image

Yardstick has a tool for building an Ubuntu Cloud Server image containing all the required tools to run test cases supported by Yardstick. It is necessary to have sudo rights to use this tool.

This image can be built using the following command while in the directory where Yardstick is installed (~/yardstick if the framework is installed by following the commands above):

sudo ./tools/yardstick-img-modify tools/

Warning: the script will create files by default in: /tmp/workspace/yardstick and the files will be owned by root!

The created image can be added to OpenStack using the glance image-create or via the OpenStack Dashboard.

Example command:

glance image-create --name yardstick-trusty-server --is-public true \
--disk-format qcow2 --container-format bare \
--file /tmp/workspace/yardstick/yardstick-trusty-server.img

Installing Yardstick using Docker

Yardstick has two Docker images, first one (Yardstick-framework) serves as a replacement for installing the Yardstick framework in a virtual environment (for example as done in Installing Yardstick framework), while the other image is mostly for CI purposes (Yardstick-CI).

Yardstick-framework image

Download the source code:

git clone

Build the Docker image and tag it as yardstick-framework:

cd yardstick
docker build -t yardstick-framework .

Run the Docker instance:

docker run --name yardstick_instance -i -t yardstick-framework

To build a guest image for Yardstick, see Building a guest image.

Yardstick-CI image

Pull the Yardstick-CI Docker image from Docker hub:

docker pull opnfv/yardstick-ci

Run the Docker image:

docker run \
 --privileged=true \
  --rm \
  -t \
  opnfv/yardstick-ci \

Where ${INSTALLER_TYPE} can be fuel, foreman or compass and ${INSTALLER_IP} is the installer master node IP address (i.e. is default for fuel).

Basic steps performed by the Yardstick-CI container:

  1. clone yardstick and releng repos
  2. setup OS credentials (releng scripts)
  3. install yardstick and dependencies
  4. build yardstick cloud image and upload it to glance
  5. upload cirros-0.3.3 cloud image to glance
  6. run yardstick test scenarios
  7. cleanup

OpenStack parameters and credentials


Most of the sample test cases in Yardstick are using an OpenStack flavor called yardstick-flavor which deviates from the OpenStack standard m1.tiny flavor by the disk size - instead of 1GB it has 3GB. Other parameters are the same as in m1.tiny.

Environment variables

Before running Yardstick it is necessary to export OpenStack environment variables from the OpenStack openrc file (using the source command) and export the external network name export EXTERNAL_NETWORK="external-network-name", the default name for the external network is net04_ext.

Credential environment variables in the openrc file have to include at least:


Yardstick default key pair

Yardstick uses a SSH key pair to connect to the guest image. This key pair can be found in the resources/files directory. To run the ping-hot.yaml test sample, this key pair needs to be imported to the OpenStack environment.

Examples and verifying the install

It is recommended to verify that Yardstick was installed successfully by executing some simple commands and test samples. Below is an example invocation of yardstick help command and test sample:

yardstick –h
yardstick task start samples/ping.yaml

Each testing tool supported by Yardstick has a sample configuration file. These configuration files can be found in the samples directory.

Example invocation of yardstick-plot tool:

yardstick-plot -i /tmp/yardstick.out -o /tmp/plots/

Default location for the output is /tmp/yardstick.out.

More info about the tool can be found by executing:

yardstick-plot -h