aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2018-11-09[docs] Resolve "document isn't included in any toctree" warningEmma Foley3-1/+12
Some test cases and test results weren't included in the test case lists. This change updates the lists of TC to included the previously omitted TCs and add test results to index. JIRA: YARDSTICK-1335 Change-Id: I5ca3b679b308889e60b7db2679629dc9144a3226 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-11-06[docs] Update mailing list to use #yardstickEmma Foley2-4/+4
The mailing list is on a new system that lets you use #topics instead of [topics]. The contact information has been updated to reflect this. JIRA: YARDSTICK-1335 Change-Id: Ida9af98f00761a3bff8903165fd2806163787ccd Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-11-06Merge changes from topic 'doc/nsb-qsg'Rex Lee3-159/+229
* changes: [docs][userguide] Update formatting for Influx instructions in ch04 [userguide] Update the directory structure listing [docs][devguide] Fix line lengths in devguide_nsb_prox.rst
2018-11-05Merge "[docs] Add vEPC test case preparation steps"Abhijit Sinha2-3/+157
2018-11-05[docs] Resolve "nested numbering in toctree?" warningEmma Foley2-2/+0
Signed-off-by: Emma Foley <emma.l.foley@intel.com> Change-Id: Id31c0484db2dc28c2237455b863d2eac9fcbc66a
2018-11-05Merge "[docs] Rename image tc014_pod_frase{e,}r.png"Rex Lee1-0/+0
2018-11-05Merge "[docs] Fix "Error in xxx directive" warning"Rex Lee3-5/+2
2018-11-05Merge "[docs] Fix docs {un,}indent warnings in Testcase definitions"Rex Lee17-110/+152
2018-11-05Merge "[docs] Update header levels"Rex Lee8-53/+115
2018-11-05Merge "[docs] Remove vtc results chapter and references"Rex Lee4-261/+0
2018-11-05Merge changes from topic 'docs/fix-warnings'Rex Lee13-40/+40
* changes: [docs] Fix unresolved reference warning [docs] Update broken and redirected links
2018-11-02[docs] Add vEPC test case preparation stepsOrest Voznyy2-3/+157
Add documentation to review the changes to original vEPC infrastructure files to configure NSB test run in a specific test setup. Add initial steps to prepare NSB to use Spirent Landslide for vEPC tests. JIRA: YARDSTICK-1459 Change-Id: I3b937b1a21d6ec6851a92946e46c679385fdff9c Signed-off-by: Orest Voznyy <orestx.voznyy@intel.com>
2018-10-31[docs] Test case documentation for vEPC testingAbhijit Sinha6-0/+810
JIRA: YARDSTICK-1349 The test case document will cover the following: - test purpose - test configuration - pre-test conditions - test sequence - test verdict Change-Id: I2841a7ff3d248bb3e4739579fad722dc02b5504f Signed-off-by: Abhijit Sinha <abhijit.sinha@intel.com>
2018-10-30[docs][userguide] Update formatting for Influx instructions in ch04Emma Foley1-15/+15
JIRA: YARDSTICK-1335 Change-Id: I2422d12a8c34fe2afaab349cbbb4dfe579057cb1 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-10-30[userguide] Update the directory structure listingEmma Foley1-12/+13
Change-Id: I4ff6f94a6d309e1604672a41c581d0768c91a5d2 JIRA: YARDSTICK-1335 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-10-30[docs][devguide] Fix line lengths in devguide_nsb_prox.rstEmma Foley1-132/+201
JIRA: YARDSTICK-1335 Change-Id: I863da3318a71dbcf2dc3f2b43fda6a92feed2089 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-10-30[docs] Rename image tc014_pod_frase{e,}r.pngEmma Foley1-0/+0
docs/release/results/tc014-cpu-processing-speed.rst includes the image tc014_pod_fraser.png. This image was incorrectly named tc014_pod_fraseer.png. This patch fixes the image name so that the link is valid. JIRA: YARDSTICK-1416 Change-Id: I37d8ee687f4dbd1a8b906e2934a4119f9fdd8041 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-10-30[docs] Fix "Error in xxx directive" warningEmma Foley3-5/+2
JIRA: YARDSTICK-1416 Signed-off-by: Emma Foley <emma.l.foley@intel.com> Change-Id: I58c511454e052496e0b72ea28142b331514475c5
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>