docs: reorganize docs for the sphinx build
[vswitchperf.git] / docs / guides / installation.rst
1 Installing vswitchperf
2 ======================
3
4 The test suite requires Python 3.3 and relies on a number of other
5 packages. These need to be installed for the test suite to function. To
6 install Python 3.3 in CentOS 7, an additional repository, Software
7 Collections (see
8 https://www.softwarecollections.org/en/scls/rhscl/python33) should be
9 enabled.
10
11 Installation of required packages and preparation of Python 3 virtual
12 environment is performed by systems/build_base_machine.sh. It should be
13 executed under user account, which will be used for vsperf execution.
14 Password less sudo access must be configured for given user account
15 before script is executed.
16
17 Execution of installation script:
18
19 .. code:: bash
20
21     cd systems
22     ./build_base_machine.sh
23
24 You need to activate the virtual environment every time you start a new
25 shell session. To activate, simple run:
26
27 .. code:: bash
28
29     scl enable python33 bash
30     cd vsperfenv
31     source bin/activate
32
33 --------------
34
35 Working Behind a Proxy
36 ======================
37
38 If you're behind a proxy, you'll likely want to configure this before
39 running any of the above. For example:
40
41   .. code:: bash
42
43     export http_proxy=proxy.mycompany.com:123
44     export https_proxy=proxy.mycompany.com:123