From dfdfe27c657c9f458c623f1d44c9a30438fed80b Mon Sep 17 00:00:00 2001 From: Maryam Tahhan Date: Mon, 25 Jan 2016 10:58:47 +0000 Subject: docs: updates and final fixes Migrate the installation guide for vsperf to a configguide directory, update the links to the installation guide. Re-add top level index.rst and remove the all directory. Update release documentation with vsperf Rel B support. Change-Id: Ib643b9d3581d8109b85c377027c8cc6be4b797fc Signed-off-by: Maryam Tahhan Reviewed-by: Martin Klozik Reviewed-by: Radek Zetik Reviewed-by: Dino Simeon Madarang Reviewed-by: Brian Castelli --- docs/configguide/installation.rst | 101 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 101 insertions(+) create mode 100755 docs/configguide/installation.rst (limited to 'docs/configguide/installation.rst') diff --git a/docs/configguide/installation.rst b/docs/configguide/installation.rst new file mode 100755 index 00000000..ebc73bad --- /dev/null +++ b/docs/configguide/installation.rst @@ -0,0 +1,101 @@ +====================== +Installing vswitchperf +====================== + +Supported Operating Systems +--------------------------- + +* CentOS 7 +* Fedora 20 +* Fedora 21 +* Fedora 22 +* Ubuntu 14.04 + +Supported vSwitches +------------------- +The vSwitch must support Open Flow 1.3 or greater. + +* OVS (built from source). +* OVS with DPDK (built from source). + +Supported Hypervisors +--------------------- + +* Qemu version 2.3. + +Available VNFs +-------------- +A simple VNF that forwards traffic through a VM, using: + +* DPDK testpmd +* Linux Brigde +* custom l2fwd module + +The VM image can be downloaded from: +http://artifacts.opnfv.org/vswitchperf/vloop-vnf-ubuntu-14.04_20151216.qcow2 + +Other Requirements +------------------ +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. + +Installation of required packages, preparation of Python 3 virtual +environment and compilation of OVS, DPDK and QEMU is performed by +script **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. + +Script **build_base_machine.sh** will install all the vsperf dependencies +in terms of system packages, Python 3.x and required Python modules. +In case of CentOS 7 it will install Python 3.3 from an additional repository +provided by Software Collections (`a link`_). Installation script will also +use `virtualenv`_ to create a vsperf virtual environment, which is isolated +from the default Python environment. 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. Its activation is specific to your OS: + +CentOS 7 +======== + +.. code:: bash + + $ scl enable python33 bash + $ cd $HOME/vsperfenv + $ source bin/activate + +Fedora and Ubuntu +================= + +.. code:: 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/ -- cgit 1.2.3-korg