StorPerf User Guide

1. StorPerf Installation Guide

1.1. OpenStack Prerequisites

If you do not have an Ubuntu 14.04 image in Glance, you will need to add one. A key pair for launching agents is also required.

# Put an Ubuntu Image in glance
glance image-create --name 'Ubuntu 14.04' --visibility public --disk-format=qcow2 --container-format=bare --file=trusty-server-cloudimg-amd64-disk1.img

# Create a key pair for the agents.
nova keypair-add StorPerf > StorPerf.pem

# Or, if you have access to the StorPerf repository you may import the StorPerf key
nova keypair-add --pub_key StorPerf

1.2. Planning

StorPerf is delivered as a Docker container. There are two possible methods for installation in your environment:

  1. Run container on Jump Host
  2. Run container in a VM

1.3. Running StorPerf on Jump Host


  • Docker must be installed
  • Jump Host must have access to the OpenStack Controller API
  • Jump Host must have internet connectivity for downloading docker image
  • Enough floating IPs must be available to match your agent count

Running StorPerf in a VM


  • VM has docker installed
  • VM has OpenStack Controller credentials and can communicate with the Controller API
  • VM has internet connectivity for downloading the docker image
  • Enough floating IPs must be available to match your agent count

1.3.1. VM Creation

The following procedure will create the VM in your environment

# Create the StorPerf VM itself.  Here we use the network ID generated by OPNFV FUEL.
ADMIN_NET_ID=`neutron net-list | grep 'admin_internal_net ' | awk '{print $2}'`

nova boot --nic net-id=$ADMIN_NET_ID --flavor m1.small --key-name=StorPerf --image 'Ubuntu 14.04' 'StorPerf Master'

At this point, you may associate a floating IP with the StorPerf master VM.

1.3.2. VM Docker Installation

The following procedure will install Docker on Ubuntu 14.04.

sudo apt-key adv --keyserver hkp:// --recv-keys 58118E89F3A912897C070ADBF76221572C52609D
cat << EOF | sudo tee /etc/apt/sources.list.d/docker.list
deb ubuntu-trusty main

sudo apt-get update
sudo apt-get install -y docker-engine
sudo usermod -aG docker ubuntu

1.4. Running StorPerf Container

You must have your OpenStack Controller environment variables defined and passatd to the StorPerf container. The easiest way to do this is to put the rc file contents into a clean file the looks similar to this:

Additionally, if you want your results published to the common OPNFV Test Results
DB, add the following:

There are some ports that the container can expose:

  • 22 for SSHD. Username and password are root/storperf. This is used for CLI access only
  • 5000 for StorPerf ReST API.
  • 8000 for StorPerf’s Graphite Web Server

You might want to have the local disk used for storage as the default size of the docker container is only 10g. This is done with the -v option, mounting under /opt/graphite/storage/whisper

mkdir -p ~/carbon
sudo chown 33:33 ~/carbon

1.5. Container with SSH

Running the StorPerf Container with all ports open and a local disk for the result storage. This is not recommended as the SSH port is open.

docker run -t --env-file admin-rc -p 5022:22 -p 5000:5000 -p 8000:8000 -v ~/carbon:/opt/graphite/storage/whisper --name storperf opnfv/storperf

This will then permit ssh to localhost port 5022 for CLI access.

1.6. Docker Exec

Instead of exposing port 5022 externally, you can use the exec method in docker. This provides a slightly more secure method of running StorPerf container without having to expose port 22.

docker run -t --env-file admin-rc -p 5000:5000 -p 8000:8000 -v ~/carbon:/opt/graphite/storage/whisper --name storperf opnfv/storperf

If needed, the container can be entered with docker exec. This is not normally required.

docker exec -it