summaryrefslogtreecommitdiffstats
path: root/docs/userguides/installation.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/userguides/installation.rst')
-rwxr-xr-xdocs/userguides/installation.rst49
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/userguides/installation.rst b/docs/userguides/installation.rst
new file mode 100755
index 00000000..96970bdb
--- /dev/null
+++ b/docs/userguides/installation.rst
@@ -0,0 +1,49 @@
+======================
+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.
+
+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/