framework: Add reworked framework to repo

This commit adds the vSwitch Integration Test Framework whose
design, based off TOIT, is outlined in the HLD previously made
availiable to the community for review.

The design of this framework allows developers to add different
implementations of components, specifically vSwitches, Traffic
Generators, Metrics Collectors and VNFs, easily.

The goal of this design is that all testcases should run regardless of
what is "under the hood".

This commit adds support for running the framework for a phy to phy
RFC2544 testcase only. More testcases will be added by the community.

vSwitches supported at this time:
* Intel DPDK (r) accelerated OpenvSwitch

Traffic Generators supported at this time:
* IxNet - IxNetwork Implementation
* Ixia - IxExplorer Implementation
* Dummy - Manual Implementation

Metrics Collectors supported at this time:
* Linux Metrics

No VNFs are supported at this time but the framework outlines how they
should be integrated and provides APIs for them to adhere to.

JIRA: VSPERF-27
Change-Id: I312e1a1199487ffee8f824be06cd97d4f793eee0
Signed-off-by: Stephen Finucane <Stephen.Finucane@intel.com>
Signed-off-by: Meghan Halton <Meghan.Halton@intel.com>
Signed-off-by: Christopher Nolan <Christopher.Nolan@intel.com>
Signed-off-by: Maryam Tahhan <Maryam.Tahhan@intel.com>
Signed-off-by: Ciara Loftus <Ciara.Loftus@intel.com>
Signed-off-by: Mark Kavanagh <Mark.B.Kavanagh@intel.com>
Signed-off-by: Cian Ferriter <Cian.Ferriter@intel.com>
Signed-off-by: Timo Puha <TimoX.Puha@intel.com>
Signed-off-by: Billy O'Mahony <billy.o.mahony@intel.com>
Signed-off-by: Michal Weglicki <MichalX.Weglicki@intel.com>
Signed-off-by: Rory Sexton <Rory.Sexton@intel.com>
Signed-off-by: Ian Stokes <Ian.Stokes@intel.com>
Signed-off-by: Kevin Traynor <Kevin.Traynor@intel.com>
Signed-off-by: Dino Simeon Madarang <dino.simeonx.madarang@intel.com>
Reviewed-by: Eugene Snider <Eugene.Snider@huawei.com>
Reviewed-by: Aihua Li <aihua.li@huawei.com>

1 files changed, 79 insertions, 0 deletions

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
+