docs/configguide/installation.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) OPNFV, Intel Corporation, AT&T and others.
   4
   5 ======================
   6 Installing vswitchperf
   7 ======================
   8
   9 Supported Operating Systems
  10 ---------------------------
  11
  12 * CentOS 7
  13 * Fedora 20
  14 * Fedora 21
  15 * Fedora 22
  16 * Ubuntu 14.04
  17
  18 Supported vSwitches
  19 -------------------
  20 The vSwitch must support Open Flow 1.3 or greater.
  21
  22 * OVS (built from source).
  23 * OVS with DPDK (built from source).
  24
  25 Supported Hypervisors
  26 ---------------------
  27
  28 * Qemu version 2.3.
  29
  30 Available VNFs
  31 --------------
  32 A simple VNF that forwards traffic through a VM, using:
  33
  34 * DPDK testpmd
  35 * Linux Brigde
  36 * custom l2fwd module
  37
  38 The official VM image is called vloop-vnf and it is available for free
  39 download at OPNFV website.
  40
  41 vloop-vnf changelog:
  42 ====================
  43
  44 * `vloop-vnf-ubuntu-14.04_20160303`_
  45
  46   * snmpd service is disabled by default to avoid error messages during VM boot
  47   * security updates applied
  48
  49 * `vloop-vnf-ubuntu-14.04_20151216`_
  50
  51   * version with development tools required for build of DPDK and l2fwd
  52
  53 Other Requirements
  54 ------------------
  55 The test suite requires Python 3.3 and relies on a number of other
  56 packages. These need to be installed for the test suite to function.
  57
  58 Installation of required packages, preparation of Python 3 virtual
  59 environment and compilation of OVS, DPDK and QEMU is performed by
  60 script **systems/build_base_machine.sh**. It should be executed under
  61 user account, which will be used for vsperf execution.
  62
  63 **Please Note**: Password-less sudo access must be configured for given
  64 user account before script is executed.
  65
  66 Execution of installation script:
  67
  68 .. code:: bash
  69
  70     $ cd systems
  71     $ ./build_base_machine.sh
  72
  73 **Please Note**: you don't need to go into any of the systems subdirectories,
  74 simply run the top level **build_base_machine.sh**, your OS will be detected
  75 automatically.
  76
  77 Script **build_base_machine.sh** will install all the vsperf dependencies
  78 in terms of system packages, Python 3.x and required Python modules.
  79 In case of CentOS 7 it will install Python 3.3 from an additional repository
  80 provided by Software Collections (`a link`_). Installation script will also
  81 use `virtualenv`_ to create a vsperf virtual environment, which is isolated
  82 from the default Python environment. This environment will reside
  83 in a directory called **vsperfenv** in $HOME.
  84
  85 You will need to activate the virtual environment every time you start a
  86 new shell session. Its activation is specific to your OS:
  87
  88 CentOS 7
  89 ========
  90
  91 .. code:: bash
  92
  93     $ scl enable python33 bash
  94     $ cd $HOME/vsperfenv
  95     $ source bin/activate
  96
  97 Fedora and Ubuntu
  98 =================
  99
 100 .. code:: bash
 101
 102     $ cd $HOME/vsperfenv
 103     $ source bin/activate
 104
 105 Working Behind a Proxy
 106 ======================
 107
 108 If you're behind a proxy, you'll likely want to configure this before
 109 running any of the above. For example:
 110
 111   .. code:: bash
 112
 113     export http_proxy=proxy.mycompany.com:123
 114     export https_proxy=proxy.mycompany.com:123
 115
 116 .. _a link: http://www.softwarecollections.org/en/scls/rhscl/python33/
 117 .. _virtualenv: https://virtualenv.readthedocs.org/en/latest/
 118 .. _vloop-vnf-ubuntu-14.04_20160303: http://artifacts.opnfv.org/vswitchperf/vnf/vloop-vnf-ubuntu-14.04_20160303.qcow2
 119 .. _vloop-vnf-ubuntu-14.04_20151216: http://artifacts.opnfv.org/vswitchperf/vnf/vloop-vnf-ubuntu-14.04_20151216.qcow2