docs/installation.md

   1 # Installing toit
   2
   3 The test suite requires Python 3.3 and relies on a number of other packages. These need to be installed for the test suite to function.
   4 To install Python 3.3 in CentOS 7, an additional repository, Software Collections (see https://www.softwarecollections.org/en/scls/rhscl/python33)
   5 should be enabled.
   6
   7 Install the requirements as specified below.
   8
   9 ---
  10 ## Enable Software Collections (SCL)
  11
  12 ```bash
  13 yum -y install scl-utils
  14 yum -y install https://www.softwarecollections.org/en/scls/rhscl/python33/epel-7-x86_64/download/rhscl-python33-epel-7-x86_64.noarch.rpm
  15 ```
  16
  17 ## System packages
  18
  19 There are a number of packages that must be installed using `yum`. These can be installed like so:
  20
  21 ```bash
  22 yum -y --exclude=python33-mod_wsgi* install python33-* pciutils
  23 ```
  24
  25 ---
  26
  27 ## Python 3 Packages
  28
  29 To avoid file permission errors and Python version issues, use virtualenv to create an isolated environment with Python3.
  30 The required Python 3 packages can be found in the `requirements.txt` file in the root of the test suite.
  31 They can be installed in your virtual environment like so:
  32
  33 ```bash
  34 scl enable python33 bash
  35 # Create virtual environment
  36 virtualenv vsperfenv
  37 cd vsperfenv
  38 source bin/activate
  39 pip install -r requirements.txt
  40 ```
  41
  42 You need to activate the virtual environment everytime you start a new shell session.
  43 To activate, simple run:
  44
  45 ```bash
  46 scl enable python33 bash
  47 cd vsperfenv
  48 source bin/activate
  49 ```
  50
  51 ---
  52
  53 # Working Behind a Proxy
  54
  55 If you're behind a proxy, you'll likely want to configure this before running any of the above. For example:
  56
  57 ```bash
  58 export http_proxy=proxy.mycompany.com:123
  59 export https_proxy=proxy.mycompany.com:123
  60 ```
  61
  62 ---