docs/configguide/installation.rst

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