docs/source/user_guides/framework/03-installation.rst

   1 ..
   2    TODO As things will change, then this document has to be revised before the
   3    next release. Steps:
   4    1. Verify that the instructions below are correct and have not been changed.
   5    2. Add everything that is currently missing and should be included in this document.
   6    3. Make sure each title has a paragraph or an introductory sentence under it.
   7    4. Make sure each sentence is grammatically correct and easily understandable.
   8    5. Remove this comment section.
   9
  10 Installation
  11 ==============
  12
  13 Yardstick currently supports installation on Ubuntu 14.04 or by using a Docker
  14 image. Detailed steps about installing Yardstick using both of these options
  15 can be found below.
  16
  17 To use Yardstick you should have access to an OpenStack environment,
  18 with at least Nova, Neutron, Glance, Keystone and Heat installed.
  19
  20 The steps needed to run Yardstick are:
  21
  22 1. Install Yardstick and create the test configuration .yaml file.
  23 2. Build a guest image and load the image into the OpenStack environment.
  24 3. Create a Neutron external network and load OpenStack environment variables.
  25 4. Run the test case.
  26
  27
  28 Installing Yardstick on Ubuntu 14.04
  29 ------------------------------------
  30
  31 .. _install-framework:
  32
  33 Installing Yardstick framework
  34 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  35 Install dependencies:
  36 ::
  37
  38   sudo apt-get install python-virtualenv python-dev
  39   sudo apt-get install libffi-dev libssl-dev git
  40
  41 Create a python virtual environment, source it and update setuptools:
  42 ::
  43
  44   virtualenv ~/yardstick_venv
  45   source ~/yardstick_venv/bin/activate
  46   easy_install -U setuptools
  47
  48 Download source code and install python dependencies:
  49 ::
  50
  51   git clone https://gerrit.opnfv.org/gerrit/yardstick
  52   cd yardstick
  53   python setup.py install
  54
  55 There is also a YouTube video, showing the above steps:
  56
  57 .. image:: http://img.youtube.com/vi/4S4izNolmR0/0.jpg
  58    :alt: http://www.youtube.com/watch?v=4S4izNolmR0
  59    :target: http://www.youtube.com/watch?v=4S4izNolmR0
  60
  61 Installing extra tools
  62 ^^^^^^^^^^^^^^^^^^^^^^
  63 yardstick-plot
  64 """"""""""""""
  65 Yardstick has an internal plotting tool ``yardstick-plot``, which can be installed
  66 using the following command:
  67 ::
  68
  69   python setup.py develop easy_install yardstick[plot]
  70
  71 .. _guest-image:
  72
  73 Building a guest image
  74 ^^^^^^^^^^^^^^^^^^^^^^
  75 Yardstick has a tool for building an Ubuntu Cloud Server image containing all
  76 the required tools to run test cases supported by Yardstick. It is necessary to
  77 have sudo rights to use this tool.
  78
  79 This image can be built using the following command while in the directory where
  80 Yardstick is installed (``~/yardstick`` if the framework is installed
  81 by following the commands above):
  82 ::
  83
  84   sudo ./tools/yardstick-img-modify tools/ubuntu-server-cloudimg-modify.sh
  85
  86 **Warning:** the script will create files by default in:
  87 ``/tmp/workspace/yardstick`` and the files will be owned by root!
  88
  89 The created image can be added to OpenStack using the ``glance image-create`` or
  90 via the OpenStack Dashboard.
  91
  92 Example command:
  93 ::
  94
  95   glance image-create --name yardstick-trusty-server --is-public true \
  96   --disk-format qcow2 --container-format bare \
  97   --file /tmp/workspace/yardstick/yardstick-trusty-server.img
  98
  99
 100 Installing Yardstick using Docker
 101 ---------------------------------
 102
 103 Yardstick has two Docker images, first one (**Yardstick-framework**) serves as a
 104 replacement for installing the Yardstick framework in a virtual environment (for
 105 example as done in :ref:`install-framework`), while the other image is mostly for
 106 CI purposes (**Yardstick-CI**).
 107
 108 Yardstick-framework image
 109 ^^^^^^^^^^^^^^^^^^^^^^^^^
 110 Download the source code:
 111
 112 ::
 113
 114   git clone https://gerrit.opnfv.org/gerrit/yardstick
 115
 116 Build the Docker image and tag it as *yardstick-framework*:
 117
 118 ::
 119
 120   cd yardstick
 121   docker build -t yardstick-framework .
 122
 123 Run the Docker instance:
 124
 125 ::
 126
 127   docker run --name yardstick_instance -i -t yardstick-framework
 128
 129 To build a guest image for Yardstick, see :ref:`guest-image`.
 130
 131 Yardstick-CI image
 132 ^^^^^^^^^^^^^^^^^^
 133 Pull the Yardstick-CI Docker image from Docker hub:
 134
 135 ::
 136
 137   docker pull opnfv/yardstick-ci
 138
 139 Run the Docker image:
 140
 141 ::
 142
 143   docker run \
 144    --privileged=true \
 145     --rm \
 146     -t \
 147     -e "INSTALLER_TYPE=${INSTALLER_TYPE}" \
 148     -e "INSTALLER_IP=${INSTALLER_IP}" \
 149     opnfv/yardstick-ci \
 150     run_benchmarks
 151
 152 Where ``${INSTALLER_TYPE}`` can be fuel, foreman or compass and ``${INSTALLER_IP}``
 153 is the installer master node IP address (i.e. 10.20.0.2 is default for fuel).
 154
 155 Basic steps performed by the **Yardstick-CI** container:
 156
 157 1. clone yardstick and releng repos
 158 2. setup OS credentials (releng scripts)
 159 3. install yardstick and dependencies
 160 4. build yardstick cloud image and upload it to glance
 161 5. upload cirros-0.3.3 cloud image to glance
 162 6. run yardstick test scenarios
 163 7. cleanup
 164
 165
 166 OpenStack parameters and credentials
 167 ------------------------------------
 168
 169 Yardstick-flavor
 170 ^^^^^^^^^^^^^^^^
 171 Most of the sample test cases in Yardstick are using an OpenStack flavor called
 172 *yardstick-flavor* which deviates from the OpenStack standard m1.tiny flavor by the
 173 disk size - instead of 1GB it has 3GB. Other parameters are the same as in m1.tiny.
 174
 175 Environment variables
 176 ^^^^^^^^^^^^^^^^^^^^^
 177 Before running Yardstick it is necessary to export OpenStack environment variables
 178 from the OpenStack *openrc* file (using the ``source`` command) and export the
 179 external network name ``export EXTERNAL_NETWORK="external-network-name"``,
 180 the default name for the external network is ``net04_ext``.
 181
 182 Credential environment variables in the *openrc* file have to include at least:
 183
 184 * OS_AUTH_URL
 185 * OS_USERNAME
 186 * OS_PASSWORD
 187 * OS_TENANT_NAME
 188
 189 Yardstick default key pair
 190 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 191 Yardstick uses a SSH key pair to connect to the guest image. This key pair can
 192 be found in the ``resources/files`` directory. To run the ``ping-hot.yaml`` test
 193 sample, this key pair needs to be imported to the OpenStack environment.
 194
 195
 196 Examples and verifying the install
 197 ----------------------------------
 198
 199 It is recommended to verify that Yardstick was installed successfully
 200 by executing some simple commands and test samples. Below is an example invocation
 201 of yardstick help command and ping.py test sample:
 202 ::
 203
 204   yardstick –h
 205   yardstick task start samples/ping.yaml
 206
 207 Each testing tool supported by Yardstick has a sample configuration file.
 208 These configuration files can be found in the **samples** directory.
 209
 210 Example invocation of ``yardstick-plot`` tool:
 211 ::
 212
 213   yardstick-plot -i /tmp/yardstick.out -o /tmp/plots/
 214
 215 Default location for the output is ``/tmp/yardstick.out``.
 216
 217 More info about the tool can be found by executing:
 218 ::
 219
 220   yardstick-plot -h