diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/NEWS.md | 27 | ||||
| -rw-r--r-- | docs/installation.md | 62 | ||||
| -rw-r--r-- | docs/quickstart.md | 79 |
3 files changed, 168 insertions, 0 deletions
diff --git a/docs/NEWS.md b/docs/NEWS.md new file mode 100644 index 00000000..3ca47d6a --- /dev/null +++ b/docs/NEWS.md @@ -0,0 +1,27 @@ +#May 2015 + +This is the initial release of a re-designed version of the software based on +community feedback. This initial release supports only the Phy2Phy deployment +scenario and the LTD.Throughput.RFC2544.PacketLossRatio test - both described +in the OPNFV vswitchperf 'CHARACTERIZE VSWITCH PERFORMANCE FOR TELCO NFV USE +CASES LEVEL TEST DESIGN'. The intention is that more test cases will follow +once the community has digested the initial release. + +## New + +* CentOS7 support + * Verified on CentOS7 + * Install & Quickstart documentation + +* Better support for mixing tests types with Deployment Scenarios +* Re-work based on community feedback of TOIT + * Framework support for other vSwitches + * Framework support for non-Ixia traffic generators + * Framework support for different VNFs +* Python3 + +## Missing + +* Report generation is currently disabled +* xmlunit output is currently disabled +* VNF support. diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 00000000..e19d0371 --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,62 @@ +# Installing toit + +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 (see https://www.softwarecollections.org/en/scls/rhscl/python33) +should be enabled. + +Install the requirements as specified below. + +--- +## Enable Software Collections (SCL) + +```bash +yum -y install scl-utils +yum -y install https://www.softwarecollections.org/en/scls/rhscl/python33/epel-7-x86_64/download/rhscl-python33-epel-7-x86_64.noarch.rpm +``` + +## System packages + +There are a number of packages that must be installed using `yum`. These can be installed like so: + +```bash +yum -y --exclude=python33-mod_wsgi* install python33-* pciutils +``` + +--- + +## Python 3 Packages + +To avoid file permission errors and Python version issues, use virtualenv to create an isolated environment with Python3. +The required Python 3 packages can be found in the `requirements.txt` file in the root of the test suite. +They can be installed in your virtual environment like so: + +```bash +scl enable python33 bash +# Create virtual environment +virtualenv vsperfenv +cd vsperfenv +source bin/activate +pip install -r requirements.txt +``` + +You need to activate the virtual environment everytime you start a new shell session. +To activate, simple run: + +```bash +scl enable python33 bash +cd 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: + +```bash +export http_proxy=proxy.mycompany.com:123 +export https_proxy=proxy.mycompany.com:123 +``` + +--- diff --git a/docs/quickstart.md b/docs/quickstart.md new file mode 100644 index 00000000..5d71c77a --- /dev/null +++ b/docs/quickstart.md @@ -0,0 +1,79 @@ +# Getting Started with 'vsperf' + +## Installation + +Follow the [installation instructions] to install. + +--- + +## Configure the `./conf/10_custom.conf` file + +The supplied `10_custom.conf` file must be modified, as it contains +configuration items for which there are no reasonable default values. + +The configuration items that can be added is not limited to the initial +contents. Any configuration item mentioned in any .conf file in `./conf` +directory can be added and that item will be overridden by the custom +configuration value. + + +## Using a custom settings file + +Alternatively a custom settings file can be passed to `vsperf` via the +`--conf-file` argument. + +```bash +./vsperf --conf-file <path_to_settings_py> ... +``` + +Note that configuration passed in via the environment (`--load-env`) or via +another command line argument will override both the default and your custom +configuration files. This "priority hierarchy" can be described like so (1 = +max priority): + +1. Command line arguments +2. Environment variables +3. Configuration file(s) + +--- + +## Executing tests + +To list the available tests: + +```bash +./vsperf --list-tests +``` + +To run a group of tests, for example all tests with a name containing +'RFC2544': + +```bash +./vsperf --conf-file=user_settings.py --tests="RFC2544" +``` + +To run all tests: + +```bash +./vsperf --conf-file=user_settings.py +``` + +Some tests allow for configurable parameters, including test duration (in +seconds) as well as packet sizes (in bytes). + +```bash +./vsperf --conf-file user_settings.py + --tests RFC2544Tput + --test-param "rfc2544_duration=10;packet_sizes=128" +``` + +For all available options, check out the help dialog: + +```bash +./vsperf --help +``` + +--- + +[installation instructions]: installation.md + |