summaryrefslogtreecommitdiffstats
path: root/docs/requirements
AgeCommit message (Collapse)AuthorFilesLines
2017-03-22Revert "Moved doc files to testing document structureTrevor Cooper13-0/+8113
This reverts commit 32a5263216d79ad34041dca55357278f092bb931. Change-Id: I641b967badffd52ffd9e249b75e67bb7c82a8150 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2017-03-21Moved doc files to testing document structure testing/user ... ↵Trevor Cooper13-8113/+0
testing/developer and modified doc index to match dir structure Change-Id: I4b1a535808a48773505fa7874c61707cd349fced Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2017-02-17license: Add license info to all project filesgoldammx2-0/+14
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-42/+40
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 Klozik8-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-12docs: Fix links to default test parametersMartin Klozik1-20/+28
Links to the default test parameters were fixed. JIRA: VSPERF-442 Change-Id: I775d5598799050fe44a5f0fc23a28716e24c2c76 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>
2016-11-09cli: Modify configuration via CLIMartin Klozik1-1/+1
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-10-10IETF Draft: Comments from IETF-96Al Morton1-0/+1027
JIRA: VSPERF-410 x Ramki on OVS features - the scope of benchmarking does not include the ever-growing list of OVS features, only the general and switch-agnostic features will be assessed. x Justify the length of SOAK tests (with variability allowed), mention that the goal is stability characterization, not the typical short term benchmarks of performance. x Fix the LTD Reference to point to Brahmaputra version (which is frozen in the release docs) Change-Id: I2f795cd42e7ec2e06e5cd35bbf0c1f336a5e43ca Signed-off-by: Al Morton <acmorton@att.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Billy O'Mahony<billy.o.mahony@intel.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com>
2016-09-06Merge "docs: Fix links and formatting"Martin Klozik2-44/+89
2016-09-05docs: Fix links and formattingMartin Klozik2-44/+89
Documentation was updated as follows: * section decorators were fixed in LTD * links to testcase and deployment descriptions were fixed * duplicate labels removed from LTP&LTD * fixed typos in formatting and text * links to scalability and stress tests fixed after their renaming JIRA: VSPERF-349 Change-Id: I86c2b723231431388b69d3d696805de2a4e12435 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-09-01test_spec: Remove formatted text file verions of IETF DraftAl Morton3-3696/+0
Remove files with IETF copyrights (Internet Draft .txt files). I assume these files have to be removed in C-stable branch... JIRA: VSPERF-387 Change-Id: I76709ab055f845cec0bec8d07b14c29dec349f54 Signed-off-by: Al Morton <acmorton@att.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Bill Michalowski <bmichalo@redhat.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Antonio Fischetti <antonio.fischetti@intel.com>
2016-08-14docs: add vm2vm testing methodologyMaryam Tahhan5-0/+42
Change-Id: I8a89ee3eedd3b439f0243eaef2fafc50ee807739 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
2016-08-12docs: add LTP to index.rstMaryam Tahhan3-30/+26
Fix build issues and add the LTP to index.rst. JIRA: DOCS-95 Change-Id: I2d22646af935c544645c01600b92a5f51ede39ec Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
2016-08-10Merge "docs: split LTD into LTP and LTD."Maryam Tahhan2-1050/+1327
2016-08-10docs: split LTD into LTP and LTD.Maryam Tahhan2-1050/+1327
Change-Id: Id0b2ce7460e76ffb3d478bd255a7e5b8e75ba001 Signed-off-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-08-09test_spec: LTD: MatchAction Performance testingAl Morton1-0/+122
One of the new tests we agreed by working on Etherpad was MatchAction. Maryam led the development, and many provided comments there. This is another chance for comments before we merge. JIRA: VSPERF-242 Change-Id: I9da74efb703d5f221280567159e4ed6d830eb92c Signed-off-by: Al Morton <acmorton@att.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Billy O'Mahony<billy.o.mahony@intel.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com>
2016-07-21docs: Remove trailing whitespacesMartin Klozik1-21/+21
Wrong whitespace characters breaks automatic generation of VSPERF documentation. It is necessary to remove wrong characters before merge of the draft into VSPERF doc, e.g. by filtering through tr -d '\014' JIRA: VSPERF-324 Change-Id: Ie280f5a443c89d4235cae5eb89fdceae74ea4213 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-15New IETF Draft WG versionAl Morton2-0/+2248
JIRA: VSPERF-?? Change-Id: I1f07a70bf3c8604df890defd8493f107550bf8f3 Signed-off-by: Al Morton <acmorton@att.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Billy O'Mahony<billy.o.mahony@intel.com>
2016-06-10Throughput and Latency Profile Test: ClarifyBilly O'Mahony1-5/+5
Make clear that 'max' refers to RFC2544 Throughput not line rate. Change-Id: I968c1f99920b6ab0a3009622cb16c67daf5e3373 Signed-off-by: Billy O'Mahony<billy.o.mahony@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Gurpreet Singh <gurpreet.singh@spirent.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com>
2016-04-12docs: rename scalability testMaryam Tahhan1-3/+3
Rename LTD.Scalability.RFC2544.0PacketLoss to LTD.Scalability.Flows.RFC2544.0PacketLoss to indicate what is being scaled. Change-Id: I398cbccf319fc09b621e7a68d7f81e4ff8d0b050 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Martin Klozik <martinx.klozik@intel.com>
2016-04-07doc: Fix typos in documentationMartin Klozik2-29/+35
A few fixes in documentation to assure clean pdf build. Change-Id: Ib42818820f18ee96efb98d2016f4d6d9ee3e2b62 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: Brian Castelli <brian.castelli@spirent.com>
2016-04-04LTD: Add Overlay Network TestAl Morton1-0/+78
Following development on the Etherpad, this is one of the new test cases for Release C. modified: docs/requirements/vswitchperf_ltd.rst not sure if conf/01_testcases.conf also needs update, or other conf files? JIRA: VSPERF-241 Change-Id: Ib747c4ed729b5af96ae141493beb8f033e940ba5 Signed-off-by: Al Morton <acmorton@att.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com>
2016-03-30docs: update test summary list.Maryam Tahhan1-1/+6
Update test summary list to include: * LTD.Scalability.VNF.RFC2544.PacketLossProfile * LTD.Scalability.VNF.RFC2544.PacketLossRatio * LTD.Stress.RFC2544.0PacketLoss JIRA: VSPERF-238 Change-Id: I62ff23c00243cadc8c818d09079dcd38a587a922 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Martin Klozik <martinx.klozik@intel.com>
2016-03-30IETF Draft: Address last BMWG meeting CommentsAl Morton2-0/+2248
Final version submitted as -02 On branch IETF-95draft_1b Changes to be committed: new file: docs/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnfv-02.xml new file: docs/requirements/ietf_draft/draft-vsperf-bmwg-vswitch-opnf-02.txt JIRA: VSPERF-246 Change-Id: I69262f3392cc9865be46ddff0f12ba85091d947d Signed-off-by: Al Morton <acmorton@att.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com>
2016-03-26LTD: Add Rationale for 10^-7 % Loss RatioAl Morton1-1/+9
This expanded item in the Throughput RFC description explains a choice we made in Release A. modified: docs/requirements/vswitchperf_ltd.rst JIRA: VSPERF-2?? (having trouble with JIRA on 3/26) Change-Id: Icf5132f55c8b00f99c41439ca644655dfcdf017d Signed-off-by: Al Morton <acmorton@att.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com>
2016-03-23IETF Draft: Address IETF-94 BMWG meeting CommentsAl Morton1-23/+75
Several Comments from the IETF-94 meeting, many are captured in the meeting notes. Section 6 of the meeting notes gives the comments: https://www.ietf.org/proceedings/94/minutes/minutes-94-bmwg JIRA: VSPERF-246 Change-Id: Ibe77b67789024ac48cce00147ce94cf2270d8106 Signed-off-by: Al Morton <acmorton@att.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com>
2016-03-04docs: add Scalability Tests for VMs in SeriesMaryam Tahhan1-1/+160
Add LTD.Scalability.VNF.RFC2544.PacketLossProfile and LTD.Scalability.VNF.RFC2544.PacketLossRatio to LTD. JIRA: VSPERF-238 Change-Id: I26e2b9e06d7bdaf4cc5ab8de7d6ecf261e0a03d4 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com> Signed-off-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com>
2016-03-03docs: update LTD.CPU.RFC2544.0PacketLossMaryam Tahhan1-8/+8
Rename and update LTD.CPU.RFC2544.0PacketLoss to LTD.Stress.RFC2544.0PacketLoss and adding the memory stressing app also. JIRA: VSPERF-252 Change-Id: Ib79249f5cfeb304e03ce7f21b5c97a8030edade3 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com>
2016-02-05docs: adding license to all rst files.Maryam Tahhan2-0/+7
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-25docs: update links in LTD and doc versioningMaryam Tahhan1-6/+12
JIRA: VSPERF-60 Change-Id: I2c04faa13a2182e3e28619d23ec68ac52c7a7be9 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Radek Zetik <radekx.zetik@intel.com>
2016-01-13test_spec: LTD: RFC.WorstN-BestN testMiroslav Miklus1-0/+91
- Test ID: LTD.Throughput.RFC2544.WorstN-BestN JIRA: VSPERF-123 Change-Id: Ief04d8c415a77f4a9b77ba0d2a52653376b37ff1 Signed-off-by: Miroslav Miklus <mmiklus@cisco.com> Signed-off-by: Maciek Konstantynowicz <mkonstan@cisco.com> Reviewed-by: Billy O Mahony <billy.o.mahony@intel.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Al Morton <acmorton@att.com>
2016-01-13test_spec: LTD: UpdatesMiroslav Miklus1-13/+20
- document updates JIRA: VSPERF-123 Change-Id: Ic156bb43dbb04e8895ac3e194c0f485517af93ef Signed-off-by: Miroslav Miklus <mmiklus@cisco.com> Signed-off-by: Maciek Konstantynowicz <mkonstan@cisco.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com>
2015-12-21docs: updates and move traffic gens to separate docMaryam Tahhan5-0/+5365
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>