1 .. This work is licensed under a Creative Commons Attribution 4.0 International
3 .. http://creativecommons.org/licenses/by/4.0
4 .. (c) OPNFV, Ericsson AB, Huawei Technologies Co.,Ltd and others.
13 Yardstick supports installation by Docker or directly in Ubuntu. The
14 installation procedure for Docker and direct installation are detailed in
17 To use Yardstick you should have access to an OpenStack environment, with at
18 least Nova, Neutron, Glance, Keystone and Heat installed.
20 The steps needed to run Yardstick are:
23 2. Load OpenStack environment variables.
24 #. Create Yardstick flavor.
25 #. Build a guest image and load it into the OpenStack environment.
26 #. Create the test configuration ``.yaml`` file and run the test case/suite.
32 The OPNFV deployment is out of the scope of this document and can be found `here <http://artifacts.opnfv.org/opnfvdocs/colorado/docs/configguide/index.html>`_. The OPNFV platform is considered as the System Under Test (SUT) in this document.
34 Several prerequisites are needed for Yardstick:
36 #. A Jumphost to run Yardstick on
37 #. A Docker daemon or a virtual environment installed on the Jumphost
38 #. A public/external network created on the SUT
39 #. Connectivity from the Jumphost to the SUT public/external network
41 **NOTE:** *Jumphost* refers to any server which meets the previous
42 requirements. Normally it is the same server from where the OPNFV
43 deployment has been triggered.
45 **WARNING:** Connectivity from Jumphost is essential and it is of paramount
46 importance to make sure it is working before even considering to install
47 and run Yardstick. Make also sure you understand how your networking is
50 **NOTE:** If your Jumphost is operating behind a company http proxy and/or
51 Firewall, please consult first the section `Proxy Support (**Todo**)`_, towards
52 the end of this document. That section details some tips/tricks which
53 *may* be of help in a proxified environment.
56 Install Yardstick using Docker (**recommended**)
57 ---------------------------------------------------
59 Yardstick has a Docker image. It is recommended to use this Docker image to run Yardstick test.
61 Prepare the Yardstick container
62 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
64 .. _dockerhub: https://hub.docker.com/r/opnfv/yardstick/
66 Install docker on your guest system with the following command, if not done yet::
68 wget -qO- https://get.docker.com/ | sh
70 Pull the Yardstick Docker image (``opnfv/yardstick``) from the public dockerhub
71 registry under the OPNFV account: dockerhub_, with the following docker
74 docker pull opnfv/yardstick:stable
76 After pulling the Docker image, check that it is available with the
77 following docker command::
79 [yardsticker@jumphost ~]$ docker images
80 REPOSITORY TAG IMAGE ID CREATED SIZE
81 opnfv/yardstick stable a4501714757a 1 day ago 915.4 MB
83 Run the Docker image to get a Yardstick container::
85 docker run -itd --privileged -v /var/run/docker.sock:/var/run/docker.sock -p 8888:5000 --name yardstick opnfv/yardstick:stable
89 +----------------------------------------------+------------------------------+
90 | parameters | Detail |
91 +==============================================+==============================+
92 | -itd | -i: interactive, Keep STDIN |
93 | | open even if not attached. |
94 | | -t: allocate a pseudo-TTY. |
95 | | -d: run container in |
96 | | detached mode, in the |
98 +----------------------------------------------+------------------------------+
99 | --privileged | If you want to build |
100 | | ``yardstick-image`` in |
101 | | Yardstick container, this |
102 | | parameter is needed. |
103 +----------------------------------------------+------------------------------+
104 | -p 8888:5000 | If you want to call |
105 | | Yardstick API out of |
106 | | Yardstick container, this |
107 | | parameter is needed. |
108 +----------------------------------------------+------------------------------+
109 | -v /var/run/docker.sock:/var/run/docker.sock | If you want to use yardstick |
110 | | env grafana/influxdb to |
111 | | create a grafana/influxdb |
112 | | container out of Yardstick |
113 | | container, this parameter is |
115 +----------------------------------------------+------------------------------+
116 | --name yardstick | The name for this container, |
117 | | not needed and can be |
118 | | defined by the user. |
119 +----------------------------------------------+------------------------------+
121 Configure the Yardstick container environment
122 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
124 There are three ways to configure environments for running Yardstick, which will be shown in the following sections. Before that, enter the Yardstick container::
126 docker exec -it yardstick /bin/bash
128 and then configure Yardstick environments in the Yardstick container.
130 The first way (**recommended**)
131 ###################################
133 In the Yardstick container, the Yardstick repository is located in the ``/home/opnfv/repos`` directory. Yardstick provides a CLI to prepare OpenStack environment variables and create Yardstick flavor and guest images automatically::
135 yardstick env prepare
137 **NOTE**: Since Euphrates release, the above command will not able to automatically configure the /etc/yardstick/openstack.creds file.
138 So before running the above command, it is necessary to create the /etc/yardstick/openstack.creds file and save OpenStack environment variables into it manually.
139 If you have the openstack credential file saved outside the Yardstcik Docker container, you can do this easily by mapping the credential file into Yardstick container
140 using '-v /path/to/credential_file:/etc/yardstick/openstack.creds' when running the Yardstick container.
141 For details of the required OpenStack environment variables please refer to section **Export OpenStack environment variables**
143 The env prepare command may take up to 6-8 minutes to finish building
144 yardstick-image and other environment preparation. Meanwhile if you wish to
145 monitor the env prepare process, you can enter the Yardstick container in a new
146 terminal window and execute the following command::
148 tail -f /var/log/yardstick/uwsgi.log
154 Export OpenStack environment variables
155 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
157 Before running Yardstick it is necessary to export OpenStack environment variables::
161 Environment variables in the ``openrc`` file have to include at least:
167 * ``EXTERNAL_NETWORK``
169 A sample `openrc` file may look like this::
171 export OS_PASSWORD=console
172 export OS_TENANT_NAME=admin
173 export OS_AUTH_URL=http://172.16.1.222:35357/v2.0
174 export OS_USERNAME=admin
175 export OS_VOLUME_API_VERSION=2
176 export EXTERNAL_NETWORK=net04_ext
178 Manually create Yardstick falvor and guest images
179 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
181 Before executing Yardstick test cases, make sure that Yardstick flavor and guest image are available in OpenStack. Detailed steps about creating the Yardstick flavor and building the Yardstick guest image can be found below.
183 Most of the sample test cases in Yardstick are using an OpenStack flavor called
184 ``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``.
186 Create ``yardstick-flavor``::
188 nova flavor-create yardstick-flavor 100 512 3 1
190 Most of the sample test cases in Yardstick are using a guest image called
191 ``yardstick-image`` which deviates from an Ubuntu Cloud Server image
192 containing all the required tools to run test cases supported by Yardstick.
193 Yardstick has a tool for building this custom image. It is necessary to have
194 ``sudo`` rights to use this tool.
196 Also you may need install several additional packages to use this tool, by
197 follwing the commands below::
199 sudo apt-get update && sudo apt-get install -y qemu-utils kpartx
201 This image can be built using the following command in the directory where Yardstick is installed::
203 export YARD_IMG_ARCH='amd64'
204 sudo echo "Defaults env_keep += \'YARD_IMG_ARCH\'" >> /etc/sudoers
205 sudo tools/yardstick-img-modify tools/ubuntu-server-cloudimg-modify.sh
207 **Warning:** Before building the guest image inside the Yardstick container, make sure the container is granted with privilege. The script will create files by default in ``/tmp/workspace/yardstick`` and the files will be owned by root!
209 The created image can be added to OpenStack using the ``glance image-create`` or via the OpenStack Dashboard. Example command is::
211 glance --os-image-api-version 1 image-create \
212 --name yardstick-image --is-public true \
213 --disk-format qcow2 --container-format bare \
214 --file /tmp/workspace/yardstick/yardstick-image.img
216 .. _`Cirros 0.3.5`: http://download.cirros-cloud.net/0.3.5/cirros-0.3.5-x86_64-disk.img
217 .. _`Ubuntu 16.04`: https://cloud-images.ubuntu.com/xenial/current/xenial-server-cloudimg-amd64-disk1.img
219 Some Yardstick test cases use a `Cirros 0.3.5`_ image and/or a `Ubuntu 16.04`_ image. Add Cirros and Ubuntu images to OpenStack::
221 openstack image create \
222 --disk-format qcow2 \
223 --container-format bare \
224 --file $cirros_image_file \
227 openstack image create \
228 --disk-format qcow2 \
229 --container-format bare \
230 --file $ubuntu_image_file \
237 Similar to the second way, the first step is also to `Export OpenStack environment variables`_. Then the following steps should be done.
239 Automatically create Yardstcik flavor and guest images
240 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
242 Yardstick has a script for automatically creating Yardstick flavor and building
243 Yardstick guest images. This script is mainly used for CI and can be also used in the local environment::
245 source $YARDSTICK_REPO_DIR/tests/ci/load_images.sh
248 The Yardstick container GUI
249 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
251 In Euphrates release, Yardstick implemeted a GUI for Yardstick Docker container.
252 After booting up Yardstick container, you can visit the GUI at <container_host_ip>:8888/gui/index.html
254 For usage of Yardstick GUI, please watch our demo video at https://www.youtube.com/watch?v=M3qbJDp6QBk
255 **Note:** The Yardstick GUI is still in development, the GUI layout and features may change.
258 Delete the Yardstick container
259 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
261 If you want to uninstall Yardstick, just delete the Yardstick container::
263 docker stop yardstick && docker rm yardstick
266 Install Yardstick directly in Ubuntu
267 ---------------------------------------
269 .. _install-framework:
271 Alternatively you can install Yardstick framework directly in Ubuntu or in an Ubuntu Docker image. No matter which way you choose to install Yardstick, the following installation steps are identical.
273 If you choose to use the Ubuntu Docker image, you can pull the Ubuntu
274 Docker image from Docker hub::
276 docker pull ubuntu:16.04
280 ^^^^^^^^^^^^^^^^^^^^^
282 Prerequisite preparation::
284 apt-get update && apt-get install -y git python-setuptools python-pip
285 easy_install -U setuptools==30.0.0
286 pip install appdirs==1.4.0
287 pip install virtualenv
289 Create a virtual environment::
291 virtualenv ~/yardstick_venv
292 export YARDSTICK_VENV=~/yardstick_venv
293 source ~/yardstick_venv/bin/activate
295 Download the source code and install Yardstick from it::
297 git clone https://gerrit.opnfv.org/gerrit/yardstick
298 export YARDSTICK_REPO_DIR=~/yardstick
303 Configure the Yardstick environment (**Todo**)
304 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
306 For installing Yardstick directly in Ubuntu, the ``yardstick env`` command is not available. You need to prepare OpenStack environment variables and create Yardstick flavor and guest images manually.
310 ^^^^^^^^^^^^^^^^^^^^^^
312 For unistalling Yardstick, just delete the virtual environment::
314 rm -rf ~/yardstick_venv
317 Verify the installation
318 -----------------------------
320 It is recommended to verify that Yardstick was installed successfully
321 by executing some simple commands and test samples. Before executing Yardstick
322 test cases make sure ``yardstick-flavor`` and ``yardstick-image`` can be found in OpenStack and the ``openrc`` file is sourced. Below is an example
323 invocation of Yardstick ``help`` command and ``ping.py`` test sample::
326 yardstick task start samples/ping.yaml
328 **NOTE:** The above commands could be run in both the Yardstick container and the Ubuntu directly.
330 Each testing tool supported by Yardstick has a sample configuration file.
331 These configuration files can be found in the ``samples`` directory.
333 Default location for the output is ``/tmp/yardstick.out``.
336 Deploy InfluxDB and Grafana using Docker
337 -------------------------------------------
339 Without InfluxDB, Yardstick stores results for runnning test case in the file
340 ``/tmp/yardstick.out``. However, it's unconvenient to retrieve and display
341 test results. So we will show how to use InfluxDB to store data and use
342 Grafana to display data in the following sections.
344 Automatically deploy InfluxDB and Grafana containers (**recommended**)
345 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
347 Firstly, enter the Yardstick container::
349 docker exec -it yardstick /bin/bash
351 Secondly, create InfluxDB container and configure with the following command::
353 yardstick env influxdb
355 Thirdly, create and configure Grafana container::
357 yardstick env grafana
359 Then you can run a test case and visit http://host_ip:3000 (``admin``/``admin``) to see the results.
361 **NOTE:** Executing ``yardstick env`` command to deploy InfluxDB and Grafana requires Jumphost's docker API version => 1.24. Run the following command to check the docker API version on the Jumphost::
365 Manually deploy InfluxDB and Grafana containers
366 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
368 You could also deploy influxDB and Grafana containers manually on the Jumphost.
369 The following sections show how to do.
371 .. pull docker images
378 docker pull tutum/influxdb
379 docker pull grafana/grafana
381 Run and configure influxDB
382 ###############################
386 docker run -d --name influxdb \
387 -p 8083:8083 -p 8086:8086 --expose 8090 --expose 8099 \
389 docker exec -it influxdb bash
394 >CREATE USER root WITH PASSWORD 'root' WITH ALL PRIVILEGES
395 >CREATE DATABASE yardstick;
399 Run and configure Grafana
400 ###############################
404 docker run -d --name grafana -p 3000:3000 grafana/grafana
406 Log on http://{YOUR_IP_HERE}:3000 using ``admin``/``admin`` and configure database resource to be ``{YOUR_IP_HERE}:8086``.
408 .. image:: images/Grafana_config.png
410 :alt: Grafana data source configration
412 Configure ``yardstick.conf``
413 ##############################
417 docker exec -it yardstick /bin/bash
418 cp etc/yardstick/yardstick.conf.sample /etc/yardstick/yardstick.conf
419 vi /etc/yardstick/yardstick.conf
421 Modify ``yardstick.conf``::
425 dispatcher = influxdb
427 [dispatcher_influxdb]
429 target = http://{YOUR_IP_HERE}:8086
434 Now you can run Yardstick test cases and store the results in influxDB.
437 Deploy InfluxDB and Grafana directly in Ubuntu (**Todo**)
438 -----------------------------------------------------------
446 **yardstick testcase list**
448 This command line would list all test cases in yardstick.
449 It would show like below::
451 +---------------------------------------------------------------------------------------
452 | Testcase Name | Description
453 +---------------------------------------------------------------------------------------
454 | opnfv_yardstick_tc001 | Measure network throughput using pktgen
455 | opnfv_yardstick_tc002 | measure network latency using ping
456 | opnfv_yardstick_tc005 | Measure Storage IOPS, throughput and latency using fio.
457 | opnfv_yardstick_tc006 | Measure volume storage IOPS, throughput and latency using fio.
458 | opnfv_yardstick_tc008 | Measure network throughput and packet loss using Pktgen
459 | opnfv_yardstick_tc009 | Measure network throughput and packet loss using pktgen
460 | opnfv_yardstick_tc010 | measure memory read latency using lmbench.
461 | opnfv_yardstick_tc011 | Measure packet delay variation (jitter) using iperf3.
462 | opnfv_yardstick_tc012 | Measure memory read and write bandwidth using lmbench.
463 | opnfv_yardstick_tc014 | Measure Processing speed using unixbench.
464 | opnfv_yardstick_tc019 | Sample test case for the HA of controller node service.
466 +---------------------------------------------------------------------------------------
467 show a test case config file
468 >>>>>>>>>>>>>>>>>>>>>>>>>>>>
469 Take opnfv_yardstick_tc002 for an example. This test case measure network latency.
470 You just need to type in **yardstick testcase show opnfv_yardstick_tc002**, and the console
471 would show the config yaml of this test case::
472 ##############################################################################
473 # Copyright (c) 2017 kristian.hunt@gmail.com and others.
475 # All rights reserved. This program and the accompanying materials
476 # are made available under the terms of the Apache License, Version 2.0
477 # which accompanies this distribution, and is available at
478 # http://www.apache.org/licenses/LICENSE-2.0
479 ##############################################################################
482 schema: "yardstick:task:0.1"
484 Yardstick TC002 config file;
485 measure network latency using ping;
487 {% set image = image or "cirros-0.3.5" %}
489 {% set provider = provider or none %}
490 {% set physical_network = physical_network or 'physnet1' %}
491 {% set segmentation_id = segmentation_id or none %}
492 {% set packetsize = packetsize or 100 %}
495 {% for i in range(2) %}
499 packetsize: {{packetsize}}
516 flavor: yardstick-flavor
521 policy: "availability"
533 {% if provider == "vlan" %}
534 provider: {{provider}}
535 physical_network: {{physical_network}}å
536 {% if segmentation_id %}
537 segmentation_id: {{segmentation_id}}
541 start a task to run yardstick test case
542 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
543 If you want run a test case, then you need to use **yardstick task start <test_case_path>**
544 this command support some parameters as below:
546 +---------------------+--------------------------------------------------+
547 | Parameters | Detail |
548 +=====================+==================================================+
549 | -d | show debug log of yardstick running |
551 +---------------------+--------------------------------------------------+
552 | --task-args | If you want to customize test case parameters, |
553 | | use "--task-args" to pass the value. The format |
554 | | is a json string with parameter key-value pair. |
556 +---------------------+--------------------------------------------------+
557 | --task-args-file | If you want to use yardstick |
558 | | env prepare command(or |
559 | | related API) to load the |
560 +---------------------+--------------------------------------------------+
564 +---------------------+--------------------------------------------------+
565 | --output-file \ | Specify where to output the log. if not pass, |
566 | OUTPUT_FILE_PATH | the default value is |
567 | | "/tmp/yardstick/yardstick.log" |
569 +---------------------+--------------------------------------------------+
570 | --suite \ | run a test suite, TEST_SUITE_PATH speciy where |
571 | TEST_SUITE_PATH | the test suite locates |
573 +---------------------+--------------------------------------------------+
576 Run Yardstick in a local environment
577 ------------------------------------
579 We also have a guide about how to run Yardstick in a local environment.
580 This work is contributed by Tapio Tallgren.
581 You can find this guide at `here <https://wiki.opnfv.org/display/yardstick/How+to+run+Yardstick+in+a+local+environment>`_.
584 Create a test suite for Yardstick
585 ------------------------------------
587 A test suite in yardstick is a yaml file which include one or more test cases.
588 Yardstick is able to support running test suite task, so you can customize your
589 own test suite and run it in one task.
591 ``tests/opnfv/test_suites`` is the folder where Yardstick puts CI test suite. A typical test suite is like below (the ``fuel_test_suite.yaml`` example)::
594 # Fuel integration test task suite
596 schema: "yardstick:suite:0.1"
598 name: "fuel_test_suite"
599 test_cases_dir: "samples/"
604 file_name: iperf3.yaml
606 As you can see, there are two test cases in the ``fuel_test_suite.yaml``. The
607 ``schema`` and the ``name`` must be specified. The test cases should be listed
608 via the tag ``test_cases`` and their relative path is also marked via the tag
611 Yardstick test suite also supports constraints and task args for each test
612 case. Here is another sample (the ``os-nosdn-nofeature-ha.yaml`` example) to
613 show this, which is digested from one big test suite::
617 schema: "yardstick:suite:0.1"
619 name: "os-nosdn-nofeature-ha"
620 test_cases_dir: "tests/opnfv/test_cases/"
623 file_name: opnfv_yardstick_tc002.yaml
625 file_name: opnfv_yardstick_tc005.yaml
627 file_name: opnfv_yardstick_tc043.yaml
632 huawei-pod1: '{"pod_info": "etc/yardstick/.../pod.yaml",
633 "host": "node4.LF","target": "node5.LF"}'
635 As you can see in test case ``opnfv_yardstick_tc043.yaml``, there are two
636 tags, ``constraint`` and ``task_args``. ``constraint`` is to specify which
637 installer or pod it can be run in the CI environment. ``task_args`` is to
638 specify the task arguments for each pod.
640 All in all, to create a test suite in Yardstick, you just need to create a
641 yaml file and add test cases, constraint or task arguments if necessary.
644 Proxy Support (**Todo**)
645 ---------------------------