summaryrefslogtreecommitdiffstats
path: root/docs/design
AgeCommit message (Collapse)AuthorFilesLines
2017-03-22Moved design to developer dirTrevor Cooper6-1108/+0
Change-Id: I487619deca2658d5239cccd41098751cc8245b34 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2017-02-17license: Add license info to all project filesgoldammx1-0/+2
All files were updated with license header. In case of binary files is license stored in LICENSE file stored in the same directory. Packages.txt was removed, because file has not been used.List of packages differs according OS distribution, all of neccesary packages are include in instalation scripts JIRA: VSPERF-489 Change-Id: I6ecae21b8db2a0f22fa5a66f9525352080f1fcc0 Signed-off-by: Martin Goldammer <martinx.goldammer@intel.com> Reviewed-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Bill Michalowski <bmichalo@redhat.com> Reviewed-by: Antonio Fischetti <antonio.fischetti@intel.com> Reviewed-by: Sridhar Rao <sridhar.rao@spirent.com>
2017-01-30docs: Remove hyperlinks to docs in artifactsMartin Klozik3-22/+13
It is possible to use sphinx cross referencing feature in case, that only one level of toctree is used. Thus documentation was reorganized to utilize just one top level index with toctree. After that it was possible to use rst native syntax to create a cross links among vsperf documentation chapters. As a result only 2 hyperlinks to the yardstick documentation are version specific. JIRA: VSPERF-442 Change-Id: I15c2f53922e88765506448de61af4a299f5d53c5 Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Bill Michalowski <bmichalo@redhat.com> Reviewed-by: Antonio Fischetti <antonio.fischetti@intel.com> Reviewed-by: Sridhar Rao <sridhar.rao@spirent.com> Reviewed-by: Martin Goldammer <martinx.goldammer@intel.com> Reviewed-by: Trevor Cooper <trevor.cooper@intel.com>
2017-01-24docs: Installation doc updatedMartin Klozik2-4/+5
Documentation was updated as follows: * description of vsperf downloading was added * VNF section was updated * additions to installation and virtualnev related parts * file permissions of all documentaton files was unified on 644 * README.md was updated with links to doc files and online docs * 3rd_party/readme was renamed and updated to follow markdown syntax JIRA: VSPERF-441 Change-Id: I648c6a8f0bb283bbc0875fd6fecd2539ca0c9056 Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Bill Michalowski <bmichalo@redhat.com> Reviewed-by: Antonio Fischetti <antonio.fischetti@intel.com> Reviewed-by: Sridhar Rao <sridhar.rao@spirent.com> Reviewed-by: Martin Goldammer <martinx.goldammer@intel.com>
2017-01-16traffic: Configurable traffic detailsMartin Klozik2-11/+133
Traffic generated by traffic generator is based on default values and their modifications specific to particular testing scenario. Traffic default values were defined inside VSPERF code and it was not possible to change them. This patch introduces new TRAFFIC dictionary inside 03_traffic.conf. Thus user can modify any of TRAFFIC values either in configuration file or by CLI or by 'Parameters' section of testcase definition. Following CLI options were obsoleted by this patch: 'bidirectional', 'traffic_type', 'iload', 'multistream', 'stream_type' and 'pre-installed_flows' Following CLI option was renamed to be consistent with other options: 'tunnel_type' => 'TUNNEL_TYPE' Following sections of testcase definition were obsoleted: "Traffic Type", "biDirectional", "MultiStream", "Stream Type", "Pre-installed Flows", "Flow Type" and "iLoad" New TRAFFIC dictionary should be used instead of old CLI options and old testcase definition sections. Testcase definitons, yardstick sample testcases and documentation were updated to reflect configuration changes. JIRA: VSPERF-433 Change-Id: I03a388c766491d5688e715f6d7b51e8e0377ec27 Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Bill Michalowski <bmichalo@redhat.com> Reviewed-by: Antonio Fischetti <antonio.fischetti@intel.com> Reviewed-by: <sridhar.rao@spirent.com>
2017-01-06rhel73_install: Provide installer script for RHEL 7.3Christian Trautman1-0/+4
Adds installer scripts for RHEL 7.3 OS. Modified dpdk makefile to allow upstream dpdk to build. Prevents upstream OVS from building due to kernel incompatibilities. Provides instructions on setting up RHEL 7.3 for usage with binary OVS packages when testing with OVS Vanilla. Tested under RHEL 7.3 JIRA: VSPerf-322 Change-Id: If294d465f28f60a1c514a7b661ce4696ac3b5b73 Signed-off-by: Christian Trautman <ctrautma@redhat.com>
2016-12-07conf:Traffic-type naming convention and consistencySridhar K. N. Rao1-1/+2
Following changes are added following first review 1. Descriptions in integration/01_testcases.conf 2. Comment in conf/01_testcases.conf 3. Checking all cases of traffic types in traffic_controller_rfc2544.py 4. Removing whitespaces 5. Missing changes (throughput->rfc2544_throughput) 6. Syntax error in core/traffic_controller_rfc2544.py Currently the traffic-type values that are provided as part of the test case definition needs some fix to support additional traffic - apart from rfc2544. The Current and the proposed changed is summarized in the below table: |--------------------------------------------------------------------| | Parameter | Existing traffic_type value | Changed to | ---------------------------------------------------------------------- | Throughput | rfc2544 OR throughput | rfc2544_throughput | ---------------------------------------------------------------------- | Back2Back | back2back | rfc2544_back2back | ---------------------------------------------------------------------- | Continuous | continuous | rfc2544_continuous | ---------------------------------------------------------------------- JIRA: VSPERF-420 Change-Id: I22bd897f6389d2b568a6a3735c67f0003e813445 Signed-off-by: Sridhar K. N. Rao <sridhar.rao@spirent.com>
2016-11-09cli: Modify configuration via CLIMartin Klozik1-1/+2
In the past, only a few configuration parameters could be modified via --test-params CLI argument and it was not easy to find out their complete list. This patch adds support for generic modification of any configuration parameter via CLI argument --test-params or by "Parameters" section of testcase definition. Thus it is possible to customize a vsperf configuration environment per testcase or for each vsperf execution. Old CLI parameters duration, pkt_sizes, rfc2544_tests and rfc2889_trials were renamed to TRAFFICGEN_DURATION, TRAFFICGEN_PKT_SIZES, TRAFFICGEN_RFC2544_TESTS and TRAFFICGEN_RFC2889_TRIALS to be consistent with other configuration parameters. JIRA: VSPERF-375 Change-Id: I50a1f4ff7250d754aa8af0295a9c7c1be8151175 Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Bill Michalowski <bmichalo@redhat.com> Reviewed-by: Antonio Fischetti <antonio.fischetti@intel.com> Reviewed-by: <sridhar.rao@spirent.com>
2016-09-15paths: Support binary packagesMartin Klozik1-0/+158
Currently VSPERF supports OVS, DPDK and QEMU built from the source code only. In some cases it is required to support installation of these tools from binary packages available for given linux distribution. Thus VSPERF configuration and code was modified to suport both source and binary versions of tools. This can be configured perf tool, so various combinations of source and binary version are supported. Together with new configuration also a handling of kernel modules was modified to automatically detect and load module dependencies. JIRA: VSPERF-340 JIRA: VSPERF-339 Change-Id: I855cb438cbd8998bdc499613ea5e7de2526299d7 Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Bill Michalowski <bmichalo@redhat.com> Reviewed-by: Otto Sabart <osabart@redhat.com>
2016-09-01multi VM: Multi VMs in serial or parallelMartin Klozik1-2/+295
Support for deployment scenarios with any number of VMs in both serial and parallel configuration. Detailed content of the patch: * VswitchControllerPXP class for multi VM support * pvvpxx and pvpvxx deployments for xx VMs in serial respective parallel configuration * special GUEST_ options expansion to requested number of VMs; * support of GUEST_ options specific macros #VMINDEX, #MAC(), #IP() and #EVAL() * all GUEST specific options are turned to lists to be VM specific * support for VM with 1 NIC * support for VM with multiple NIC pairs; traffic is routed in serial or parallel between NIC paris based on deployment scenario * support for PVVP and PVPV scenarios using VMs with different numbers of NICs JIRA: VSPERF-361 Change-Id: I05bedbdfa9a81ea0166d9b03d83ae49d6cb8b19b Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Bill Michalowski <bmichalo@redhat.com> Reviewed-by: Antonio Fischetti <antonio.fischetti@intel.com>
2016-08-04bugfix: Harmonize test/trial RFC2544 terminologyMartin Klozik2-10/+10
VSPERF framework was updated to follow RFC2544 definition of 'test' and 'trial' terms. Test parameter 'rfc2544_trials' was replaced by new parameter 'rfc2544_tests'. Both code and documentation were updated to reflect these changes. JIRA: VSPERF-300 Change-Id: I144a28359fd06394f1f87ef324458bafd5aad45f Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: <bmichalo@redhat.com>
2016-03-11bugfix: Cleanup of traffic gen api and default traffic valuesMartin Klozik1-6/+43
Both documentation and traffic generator API are updated to match current code logic. Additional default values are added into TRAFFIC_DEFAULTS dictionary. Constructor of TestCase class uses default values from TRAFFIC_DEFAULTS instead of magic numbers. Change-Id: Id2f4983945e4b123adddbc9a2a832f4a735b27f6 JIRA: VSPERF-253 Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com>
2016-02-05docs: adding license to rest of rst filesMaryam Tahhan1-0/+4
Add Creative Commons Creative Commons license to missed documentation in vsperf. One of these files is not on the stable Brahmaputra branch. JIRA: VSPERF-239 Change-Id: If1420c3b84ba5ba9e1b4c1f9d75347f1b6e6117f Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Billy O Mahony <billy.o.mahony@intel.com> Reviewed-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Brian Castelli <brian.castelli@spirent.com>
2016-02-05docs: adding license to all rst files.Maryam Tahhan2-0/+8
Add Creative Commons Creative Commons license to all documentation in vsperf. JIRA: VSPERF-239 Change-Id: I88721205a36078f6e0d4a4c5dd842907729d2b6b Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Billy O Mahony <billy.o.mahony@intel.com> Reviewed-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Brian Castelli <brian.castelli@spirent.com>
2016-01-28docs: traffic generator integration guideMartin Klozik2-0/+201
Simple guide with description of integration of new traffic generator into the VSPERF. Change-Id: Iab84d1356dbf3ef3405817606c094ffe31355b9f JIRA: VSPERF-174 Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Brian Castelli <brian.castelli@spirent.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com>
2016-01-25VSPERF docs: Patches for Design DocumentRadek Zetik1-2/+11
Routing Table Figure has an odd description for the table#1 description. Connectivity to the DUT is assumed, could provide example directions. Suggest a new section. JIRA: VSPERF-178 JIRA: VSPERF-179 Change-Id: I38e48034a9029d4a8969affdddef5b281dc8eba3 Signed-off-by: Radek Zetik <radekx.zetik@intel.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Brian Castelli <brian.castelli@spirent.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Tv Rao <tv.rao@freescale.com>
2016-01-21Add testpmd as vswitch classRobert Wojciechowicz1-6/+19
The purpose of using testpmd instead of OVS is to get the baseline of the DUT when performing hardware offloading operations. There are supported different checksum calculation and txq flags settings. Change-Id: I93c9b45dcb31eaa1f610b7e061f3dd5936b0e6ec JIRA: VSPERF-193 Signed-off-by: Robert Wojciechowicz <robertx.wojciechowicz@intel.com> Reviewed-by: Dino Simeon Madarang <dino.simeonx.madarang@intel.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Brian Castelli <brian.castelli@spirent.com>
2015-12-23docs: update design docs after reviewingMaryam Tahhan1-13/+13
Review and update design documentation for Release B. JIRA: VSPERF-160 Change-Id: I2c2167b5ac9161e30aacd277060da22a559dd0c2 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
2015-12-21docs: updates and move traffic gens to separate docMaryam Tahhan5-60/+106
Move the traffic gen instructions to a separate user guide and add information on usage of the Dummy traffic generator. Update docs to fix PDF build failure and do general clean-up. Removed the numbering from the LTD and added the numbered directive to automate numbering for sections and headers. Add comment anchors that reflect the section numbers. Change-Id: I984ca38456a891c439697ebc1da041bc1d828a15 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
2015-11-26doc: update template and conf filesRyota MIBU1-16/+2
JIRA: RELENG-16 Change-Id: I0aaac15c1d1a1031cbc113db594a342c60b7eb1d Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2015-11-04docs: reorganize docs for the sphinx buildRamprasad Velavarthipati2-0/+231
Reorganize docs into the appropriate folders for the new sphinx build. JIRA: VSPERF-80 Change-Id: I9dcd74e092ce52546a0986b92a1ebb2b5b7419bf Signed-off-by: Ramprasad Velavarthipati <ram.v@freescale.com> Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Trinath Somanchi <trinath.somanchi@gmail.com>