aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2018-10-30[docs] Fix docs {un,}indent warnings in Testcase definitionsEmma Foley17-110/+152
Mostly, the issues were with un/indentation. This has been fixed, and `tox -e docs` now issues less warnings. JIRA: YARDSTICK-1416 Change-Id: Ie58a8dba42e9868357e1dce414cb1a01af8ad1f4 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-10-30[docs] Update header levelsEmma Foley8-53/+115
JIRA: YARDSTICK-1335 Change-Id: I202634a7427a409f0e2ca786c8bb5e05a5b4351d Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-10-30[docs] Remove vtc results chapter and referencesEmma Foley4-261/+0
The vTC chapter in the userguide was previously removed [1] Some references and results still remained and needed to be removed. [1] https://gerrit.opnfv.org/gerrit/gitweb?p=yardstick.git;a=commit;h=114a486558c96152fffb5050840460a54de64d15 JIRA: YARDSTICK-1335 Change-Id: I17806d90ae8bc4dbf813ef89bbc22dc012b4a686 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-10-30[docs] Fix unresolved reference warningEmma Foley1-2/+2
JIRA: YARDSTICK-1416 Change-Id: Ibdc9b48e31aff171c59278f9ca19767392f4eeba Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-10-30[docs] Update broken and redirected linksEmma Foley12-38/+38
A number of links were broken, or permenently redirected. Some literal include directives pointed to the wrong location. These have been updated, so the links are valid. JIRA: YARDSTICK-1416 Change-Id: Icd20113e0ab099850fa58fa41bb27a00670f57ca Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-10-30Merge "[docs] Fix links to remove references to submodules"Emma Foley2-6/+6
2018-10-30[docs] Fix links to remove references to submodulesAric Gardner2-6/+6
All references to submodules must be removed for docs to work going forward. Can be tested once your project has a local tox file Change-Id: Id74581cc584f70ae0b31e31c9dd91593c7be6615 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2018-10-30[docs] Update on Yardstick installationStepan Andrushko2-0/+113
Added details how to install Yardstick using install.yaml. Updated: - 04-installation.rst - 13-nsb-installation.rst JIRA: YARDSTICK-1335 Change-Id: I526c328f1b197833a2cf496cfef15ba89c11fab1 Signed-off-by: Stepan Andrushko <stepanx.andrushko@intel.com>
2018-10-30Merge "[docs] Add developer guidelines for contribution"Rex Lee1-0/+89
2018-10-30Merge "[docs] Add conventions for writing unit tests."Rex Lee1-0/+51
2018-10-30[docs] Add conventions for writing unit tests.Emma Foley1-0/+51
Added details of conventions used when writing unit tests. JIRA: YARDSTICK-1335 Change-Id: I7bb141126968c88c8a2d7e0dce4f33ed6f79cee4 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-10-30[docs] Add developer guidelines for contributionEmma Foley1-0/+89
A new section was added to the devguide, stating expectations for code contributions. * What to include in a change * Code style guidelines * How to run tests JIRA: YARDSTICK-1335 Change-Id: Idfe7790042a3a3fe6cd8763374b10f2268bd63cd Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-10-30[docs] Update the glossaryEmma Foley1-13/+62
Add some new terms (OpenStack, Docker, PROX). JIRA: YARDSTICK-1335 Change-Id: I948957cf7b1540f7a027ab9da2d829e5e05c87c8 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-10-17Merge "[docs] Transition to local docs build job."Rex Lee4-0/+26
2018-10-16Merge "Adds option parameters to TC074"Kubi1-0/+11
2018-10-09[docs] Transition to local docs build job.Emma Foley4-0/+26
Docs builds have transitioned to using local build jobs. This allows Yardstick docs to be built and verified locally. The time taken to build and verify docs in the gate for new changes should be reduced, as the docs for each project will be built separately. This change also allow contributers to test their docs builds locally, using tox:: tox -e docs tox -e docs-linkcheck TODO: Update the dev guide to include new tox environment Related: DOCS-191 JIRA: YARDSTICK-1415 Signed-off-by: Emma Foley <emma.l.foley@intel.com> Change-Id: Ib8bab85475dcd5127a2c41a2d55dce8f8d9da574
2018-10-03Adds option parameters to TC074Ameed Ashour1-0/+11
Add option parameters to TC074 to allow the user to specify volume type, volume count, availability zone, stack name, and subnet cidr. JIRA:YARDSTICK-1294 Change-Id: I161f44b5f2c7e70fcfb80a3b916efc34bd06824c Signed-off-by: Ameed Ashour <Ameed.Ashour.Ext@nokia.com>
2018-08-29Updated documentation for stanalone contextStepan Andrushko1-15/+85
Added details about hosts configurations in order to run tests for standalone context. Changes made to '13-nsb-installation.rst'. JIRA: YARDSTICK-1402 Change-Id: I4e3304065343014a80b85fc712cdde3ca62d8b2e Signed-off-by: Stepan Andrushko <stepanx.andrushko@intel.com>
2018-08-16Merge "Disk Initialization and Custom Workload"Rex Lee1-19/+53
2018-08-10Disk Initialization and Custom Workloadmbeierl1-19/+53
Removes the deprecated nowarm and nosdd parameters from the call to StorPerf. Adds a call to initialize the disk right after the stack creation is complete so that the results from the performance run are valid and not skewed by a disk that is not operating at a consistent level of performance. Adds the jobs API v2.0 when the custom parameter 'workloads' is used instead of workload. Improves documentation and adds more info about the workload and workloads parameters. Co-Authored-By: Ameed Ashour <Ameed.Ashour.Ext@nokia.com> Change-Id: I17e96028f6a82e2c800c8f73c7be866e1cab6ad8 JIRA: YARDSTICK-1322 Signed-off-by: mbeierl <mark.beierl@dell.com>
2018-07-23[docs] Remove the VTC chapter in the userguideEmma Foley7-139/+1
Other references to VTC have also been removed. Change-Id: Ia5592e29ddca1bf05cefa5b1364e0757ac78bc79 JIRA: YARDSTICK-1335 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-07-16Propose the backporting processEmma Foley1-0/+26
Change-Id: I0b0fddf8dfdd68fa144b28dba911352e9a4974fd JIRA: YARDSTICK-1253 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-07-04Merge "Fix up formatting on devguide"Rodolfo Alonso Hernandez1-77/+151
2018-07-01Yardstick Fraser Release notes - 6.2.1rexlee87761-0/+17
JIRA: YARDSTICK-1278 Change-Id: I96d54b06f0ef794c9c0ec26d78eb54ebcc6462ed Signed-off-by: rexlee8776 <limingjiang@huawei.com>
2018-06-29Merge "Update PROX_NSB_DEVGUIDE for F Release"Rodolfo Alonso Hernandez10-25/+119
2018-06-29Update PROX_NSB_DEVGUIDE for F ReleaseDanielMartinBuckley10-25/+119
Contains Updates :- New Description of Grafana output New Description of ProxDuration Runner Update Description of Openstack Network Change-Id: I861bb7eab4aeed207c0151be6766c48c5f10c6ef Signed-off-by: Daniel Martin Buckley <daniel.m.buckley@intel.com>
2018-06-29Fix up formatting on devguideEmma Foley1-77/+151
* Change the notation used for heading levels and add a key at the top of the file. * Wrap lines at 80 characters. * Highlight keywords Change-Id: Ic6e7194270bbffb3ddaf688c774b632287b0c201 JIRA: YARDSTICK-1253 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-06-29Yardstick Fraser Release notes - 6.2.0rexlee87761-5/+98
JIRA: YARDSTICK-1261 Change-Id: I61adeaea8a727605481ffce9dae9646f160bf401 Signed-off-by: rexlee8776 <limingjiang@huawei.com>
2018-06-27Corrected scale-up command line argumentsChornyi, TarasX1-1/+1
Change-Id: If308fde797dcb01e58f37ad81bb116fde542366a Signed-off-by: Chornyi, TarasX <tarasx.chornyi@intel.com>
2018-06-21Merge "Add scale out TCs with availability zone support"Rodolfo Alonso Hernandez1-1/+111
2018-06-21Merge "Document for Fraser test case results"Jing Lu26-17/+1962
2018-06-18Update pmd/lcore mask for OVS-DPDK contextStepan Andrushko1-0/+36
Added default values for pmd/lcore mask to the SampleVNF test case for Trex TG. lcore mask - specifies the CPU cores used for non-datapath OVS-DPDK threads. pmd mask - specifies the CPU cores used for data path packet processing. Updated documentation for Standalone OVS-DPDK context. JIRA: YARDSTICK-1246 Change-Id: I8d008a185c94d2047ffa4769d7974bc4d283fd7f Signed-off-by: Stepan Andrushko <stepanx.andrushko@intel.com>
2018-05-25Merge "[release] Yardstick release note 6.1.0"Ross Brattain1-6/+35
2018-05-25Add scale out TCs with availability zone supportMytnyk, Volodymyr1-1/+111
Add PROX and vFW scale out TCs with availability zone configuration. To be able to specify the availability zone for specific VNF or TG the following example of command line option shoud be used: yardstick -d task start --task-args='{ "num_vnfs": 2, "availability_zone": { "vnf_0": "az_0", "tg_0": "az_0", "vnf_1": "az_1", "tg_1": "az_1", ... }}' <SCALE-OUT-TC-FILE> The steps to run new scale-out TCs is documented in the userguide. JIRA: YARDSTICK-1203 Change-Id: Ib3878485c5483981fe9b48ab02995712bcc31ae5 Signed-off-by: Mytnyk, Volodymyr <volodymyrx.mytnyk@intel.com>
2018-05-23Test case spec for SDN controller resilience in HA configGeorg Kunz2-0/+197
This is the test case specification for verifying the HA capabilities of a SDN controller running in a HA configuration. JIRA: HA-33 JIRA: YARDSTICK-955 Change-Id: I016ec1ef7bb51b79f8c21440abf8f04c923ef9dc Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2018-05-23[release] Yardstick release note 6.1.0rexlee87761-6/+35
JIRA: YARDSTICK-1182 Change-Id: I3baca52e9bc0360b43f2ce61ea2f166a70e8c90a Signed-off-by: rexlee8776 <limingjiang@huawei.com>
2018-05-20Merge "Test case spec for SDN Virtual Switch resilience."Emma Foley2-0/+185
2018-05-17Document for Fraser test case resultsJingLu526-17/+1962
JIRA: YARDSTICK-1132 In B and C releases, Yardstick provides an overview of the results of test cases developed by Yardstick, executed on OPNFV community labs. This work has not been done for the D and E releases, although result analysis for Euphrates is available at (https://wiki.opnfv.org/display/yardstick/Euphrates+release+test+results+analysis). We plan to restart to provide a basic test case results analysis for Fraser and compare performance data with Euphrates. This JIRA ticket will be resolved into 3 commits: 1. Document for E release test case data; 2. Document for F release test case data; 3. Document for results analysis. Change-Id: I3c59851c8878ba37145e6ad6958272a62bad3f52 Signed-off-by: JingLu5 <lvjing5@huawei.com>
2018-05-16Merge "Test case description and configuration file for yardstick_tc088"Jing Lu1-0/+129
2018-05-16Merge "Test case description and configuration file for yardstick_tc089"Jing Lu1-0/+129
2018-05-15Merge "Document for Euphrates test case results"Jing Lu36-2886/+2086
2018-05-11[docs] Add info on gerrit groups to the devguide.Emma Foley1-1/+2
Added the yardstick-reviewers and yardstick-committers groups as an alternative to adding individual developers to a code review. Change-Id: I1ebba56ba27dac00f7e7af7858b3c599a0f1eae8 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-05-07Test case spec for SDN Virtual Switch resilience.Dimitrios Markou2-0/+185
This is a test case for verifying the proper functionality of SDN Vswitches which are located in the Compute nodes of an OpenStack environment. This test case is unaware of the configuration (non-HA,HA) JIRA: HA-34 JIRA: YARDSTICK-955 Change-Id: I701bf1f9527b1a31b9cb52e102734e10c4162766 Signed-off-by: Dimitrios Markou <mardim@intracom-telecom.com>
2018-05-04Add IxNetwork API Python Binding packageRodolfo Alonso Hernandez2-75/+41
Add IxNetwork python package to the requirements list. This module is needed for the "NSPerf" scenarios using IXIA as traffic generator, when IxNetwork is the program used to handle the IXIA generator. The latest version of this module is 8.40.1124.9 [1]. The license type is MIT. [1] https://pypi.python.org/pypi/ixnetwork JIRA: YARDSTICK-1106 Change-Id: I279933c95994f5120930256a104c4192a0b9900d Signed-off-by: Rodolfo Alonso Hernandez <rodolfo.alonso.hernandez@intel.com>
2018-04-26[release] Yardstick Fraser 6.0.0 Release notesrexlee87761-305/+209
JIRA: YARDSTICK-1129 Change-Id: I5adb2e9547c58b90d3eafb0e2b90015ce5472cfa Signed-off-by: rexlee8776 <limingjiang@huawei.com> Signed-off-by: Ross Brattain <ross.b.brattain@intel.com>
2018-04-24Document for Euphrates test case resultsJingLu536-2886/+2086
JIRA: YARDSTICK-1132 In B and C releases, Yardstick provides an overview of the results of test cases developed by Yardstick, executed on OPNFV community labs. This work has not been done for the D and E releases, although result analysis for Euphrates is available at (https://wiki.opnfv.org/display/yardstick/Euphrates+release+test+results+analysis). We plan to restart to provide a basic test case results analysis for Fraser and compare performance data with Euphrates. This JIRA ticket will be resolved into 3 commits: 1. Document for E release test case data; 2. Document for F release test case data; 3. Document for results analysis. Change-Id: I372a60807ac3dfaab87e70cdb956c1059b019f7a Signed-off-by: JingLu5 <lvjing5@huawei.com>
2018-04-23Merge "[docs] Updated baremetal instalation instructions"Rodolfo Alonso Hernandez1-0/+9
2018-04-13Bugfix: interface down HA tc050 attack and monitor logistic wrongrexlee87761-27/+25
1. simplify the attack to be one interface 2. move monitor step before attack 3. update rst doc to match JIRA: YARDSTICK-1120 Change-Id: Icfa21d58e7ccdbeaca8a9a1a3098cceb21c981c3 Signed-off-by: rexlee8776 <limingjiang@huawei.com>
2018-04-06[docs] Updated baremetal instalation instructionsChornyi, TarasX1-0/+9
JIRA: YARDSTICK-1111 Change-Id: Iefab24f74c87a0855c2d70090ac34256ffa9200c Signed-off-by: Chornyi, TarasX <tarasx.chornyi@intel.com>
2018-04-03[userguide] Use literalinclude directive in 05-operationEmma Foley1-75/+9
Uses literalinclude directive instead of having a copy of the file content in documentation. This means that any update to this file is detected, and the most up-to-date content is used. If a testcase is updated, the updates wil be picked up. The examples used are ones that are tested reqularly. JIRA: YARDSTICK-1066 Change-Id: I15d967eb04d1e6f4348683d8746fa9989dceda94 Signed-off-by: Emma Foley <emma.l.foley@intel.com>