aboutsummaryrefslogtreecommitdiffstats
path: root/docs/userguides/installation.rst
blob: bd47519a487892ddf8a31b475a231bd9f8366c46 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
======================
Installing vswitchperf
======================

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. To
install Python 3.3 in CentOS 7, an additional repository, Software
Collections (`a link`_) should be enabled.

Installation of required packages and preparation of Python 3 virtual
environment is performed by systems/build_base_machine.sh. It should be
executed under user account, which will be used for vsperf execution.
Please Note: Password-less sudo access must be configured for given
user account before script is executed.

Execution of installation script:

.. code:: bash

    $ cd systems
    $ ./build_base_machine.sh

Please note: you don't need to go into any of the systems subdirectories,
simply run the top level build_base_machine.sh, your OS will be detected
automatically.

build_base_machine.sh will install all the vsperf dependencies in terms of
system packages and Python modules, it will also use `virtualenv`_ to create a
vsperf virtual environment that's isolated from the default Python env. This
environment will reside in a directory called vsperfenv in $HOME.

You will need to activate the virtual environment every time you start a
new shell session. To activate, simple run:

.. code:: bash

    $ scl enable python33 bash
    $ cd $HOME/vsperfenv
    $ source bin/activate

--------------

Working Behind a Proxy
======================

If you're behind a proxy, you'll likely want to configure this before
running any of the above. For example:

  .. code:: bash

    export http_proxy=proxy.mycompany.com:123
    export https_proxy=proxy.mycompany.com:123

.. _a link: http://www.softwarecollections.org/en/scls/rhscl/python33/
.. _virtualenv: https://virtualenv.readthedocs.org/en/latest/