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 VM image can be downloaded from:
  39 http://artifacts.opnfv.org/vswitchperf/vloop-vnf-ubuntu-14.04_20151216.qcow2
  40
  41 Other Requirements
  42 ------------------
  43 The test suite requires Python 3.3 and relies on a number of other
  44 packages. These need to be installed for the test suite to function.
  45
  46 Installation of required packages, preparation of Python 3 virtual
  47 environment and compilation of OVS, DPDK and QEMU is performed by
  48 script **systems/build_base_machine.sh**. It should be executed under
  49 user account, which will be used for vsperf execution.
  50
  51 **Please Note**: Password-less sudo access must be configured for given
  52 user account before script is executed.
  53
  54 Execution of installation script:
  55
  56 .. code:: bash
  57
  58     $ cd systems
  59     $ ./build_base_machine.sh
  60
  61 **Please Note**: you don't need to go into any of the systems subdirectories,
  62 simply run the top level **build_base_machine.sh**, your OS will be detected
  63 automatically.
  64
  65 Script **build_base_machine.sh** will install all the vsperf dependencies
  66 in terms of system packages, Python 3.x and required Python modules.
  67 In case of CentOS 7 it will install Python 3.3 from an additional repository
  68 provided by Software Collections (`a link`_). Installation script will also
  69 use `virtualenv`_ to create a vsperf virtual environment, which is isolated
  70 from the default Python environment. This environment will reside
  71 in a directory called **vsperfenv** in $HOME.
  72
  73 You will need to activate the virtual environment every time you start a
  74 new shell session. Its activation is specific to your OS:
  75
  76 CentOS 7
  77 ========
  78
  79 .. code:: bash
  80
  81     $ scl enable python33 bash
  82     $ cd $HOME/vsperfenv
  83     $ source bin/activate
  84
  85 Fedora and Ubuntu
  86 =================
  87
  88 .. code:: bash
  89
  90     $ cd $HOME/vsperfenv
  91     $ source bin/activate
  92
  93 Working Behind a Proxy
  94 ======================
  95
  96 If you're behind a proxy, you'll likely want to configure this before
  97 running any of the above. For example:
  98
  99   .. code:: bash
 100
 101     export http_proxy=proxy.mycompany.com:123
 102     export https_proxy=proxy.mycompany.com:123
 103
 104 .. _a link: http://www.softwarecollections.org/en/scls/rhscl/python33/
 105 .. _virtualenv: https://virtualenv.readthedocs.org/en/latest/