summaryrefslogtreecommitdiffstats
path: root/docs/userguide/yardstick.rst
AgeCommit message (Collapse)AuthorFilesLines
2017-03-22Moved userguide to user directoryTrevor Cooper1-250/+0
Change-Id: I35f2cbbab8ce7daec26fed63fa92cf7c17cd37b3 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2017-01-30docs: Remove hyperlinks to docs in artifactsMartin Klozik1-7/+3
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 Klozik1-0/+0
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 Klozik1-18/+11
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>
2016-12-14conf: traffic type naming step2Martin Klozik1-2/+3
Update of the rest of old traffic type names. JIRA: VSPERF-420 Change-Id: Icf4bab7afad09f9b48ee25b9ff020c83cf2e02bd 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-11-30yardstick: CLI params support for yardstick TCsMartin Klozik1-56/+93
Vswitchperf specific class in yardstick was updated to reflect new functionality of --test-params. These changes have impact on vsperf documentation and yardstick samples. As part of this fix following changes were made: * trafficgen mode can be executed with default configuration * yardstick specific TC samples were updated * dummy traffic generator was enhanced to support back2back * dummy traffic generator was enhanced to accept traffic results from configuration JIRA: VSPERF-422 JIRA: VSPERF-205 Change-Id: Ibeaa6ef46bde453e3ca5dee6e4568fc8c3853521 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-02docs: Remove links to Brahmaputra documentationMartin Klozik1-2/+2
Hyperlinks to the yardstick documentation were updated to refer to files generated from the master branch. JIRA: VSPERF-349 Change-Id: I248795b6a951377885492515fa9b96a694c9da5d 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>
2016-08-04bugfix: Harmonize test/trial RFC2544 terminologyMartin Klozik1-1/+1
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-07-13docs: Update yardstick userguideMartin Klozik1-2/+2
Documentation update based on review comments received after the merge of original patch. JIRA: VSPERF-288 Change-Id: I86305fa064cc07e2e0797276a7b89b1d4b23d126 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> Reviewed-by: <sridhar.rao@spirent.com>
2016-07-08yardstick: Documentation and YAML testcase definitionsMartin Klozik1-0/+223
Yardstick supports execution of vsperf specific testcases. These testcases are specified by YAML files located inside yardstick/tests directory. Documentation describing yardstick usage and execution of vsperf testcases is part of the userguide. JIRA: VSPERF-288 Change-Id: I5a575d28d344e0f3e0a1c8434e2f3231fd312d31 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> Reviewed-by: <sridhar.rao@spirent.com>