docs/userguides/installation.rst

   1 ======================
   2 Installing vswitchperf
   3 ======================
   4
   5 The test suite requires Python 3.3 and relies on a number of other
   6 packages. These need to be installed for the test suite to function.
   7
   8 Installation of required packages, preparation of Python 3 virtual
   9 environment and compilation of OVS, DPDK and QEMU is performed by
  10 script **systems/build_base_machine.sh**. It should be executed under
  11 user account, which will be used for vsperf execution.
  12
  13 Please Note: Password-less sudo access must be configured for given
  14 user account before script is executed.
  15
  16 Execution of installation script:
  17
  18 .. code:: bash
  19
  20     $ cd systems
  21     $ ./build_base_machine.sh
  22
  23 Please note: you don't need to go into any of the systems subdirectories,
  24 simply run the top level **build_base_machine.sh**, your OS will be detected
  25 automatically.
  26
  27 Currently supported operating systems are:
  28
  29     - CentOS 7
  30     - Fedora 20
  31     - Fedora 21
  32     - Fedora 22
  33     - Ubuntu 14.04
  34
  35 Script **build_base_machine.sh** will install all the vsperf dependencies
  36 in terms of system packages, Python 3.x and required Python modules.
  37 In case of CentOS 7 it will install Python 3.3 from an additional repository
  38 provided by Software Collections (`a link`_). Installation script will also
  39 use `virtualenv`_ to create a vsperf virtual environment, which is isolated
  40 from the default Python environment. This environment will reside
  41 in a directory called **vsperfenv** in $HOME.
  42
  43 You will need to activate the virtual environment every time you start a
  44 new shell session. Its activation is specific to your OS:
  45
  46 CentOS 7:
  47
  48 .. code:: bash
  49
  50     $ scl enable python33 bash
  51     $ cd $HOME/vsperfenv
  52     $ source bin/activate
  53
  54 Fedora and Ubuntu:
  55
  56 .. code:: bash
  57
  58     $ cd $HOME/vsperfenv
  59     $ source bin/activate
  60
  61
  62 --------------
  63
  64 Working Behind a Proxy
  65 ======================
  66
  67 If you're behind a proxy, you'll likely want to configure this before
  68 running any of the above. For example:
  69
  70   .. code:: bash
  71
  72     export http_proxy=proxy.mycompany.com:123
  73     export https_proxy=proxy.mycompany.com:123
  74
  75 .. _a link: http://www.softwarecollections.org/en/scls/rhscl/python33/
  76 .. _virtualenv: https://virtualenv.readthedocs.org/en/latest/