aboutsummaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2019-01-16[docs][userguide] Update NSB intro in ch12Emma Foley2-21/+28
This change removes the duplicated NSB entry in ch13 of the userguide, and updates the intro in ch12. This gives a better overview of NSB, and removes the duplicated intro. JIRA: YARDSTICK-1335 Change-Id: Id40f998e4ae2c5256643b683c2e4d19ef472bbcf Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2019-01-16[docs] Make heading levels consistentEmma Foley12-118/+226
Update the symbols used to denote different headings to make them consistent across the userguide. JIRA: YARDSTICK-1335 Change-Id: Ib5ab1f14bbaa819cf882dc00d68bc27da3f1eadb Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2019-01-11Merge "[docs][userguide] Update formatting on userguide chapters 12-14"Volodymyr Mytnyk3-305/+273
2018-12-28Merge "[docs][glossary] Update the glossary"Volodymyr Mytnyk1-3/+57
2018-12-19Add report generate-nsb commandPatrice Buriez1-5/+21
JIRA: YARDSTICK-1367 Topic: report/html_table (8 of 12) Change-Id: I8a2f96224a745334b67dd71875bebb3b69b9adc3 Signed-off-by: Emma Foley <emma.l.foley@intel.com> Signed-off-by: Patrice Buriez <patrice.buriez@intel.com>
2018-12-19Merge "Use Chart.js for graphs in HTML reports"Volodymyr Mytnyk1-2/+2
2018-12-19Use Chart.js for graphs in HTML reportsPatrice Buriez1-2/+2
This JavaScript library is available under MIT license. Also adjusted version for jQuery and jsTree, and added fallback font-family names. JIRA: YARDSTICK-1367 Topic: report/html_table (6 of 12) Change-Id: Ibe8b7e3d1f1365d2cbc019bfc22762aaa365a4e1 Signed-off-by: Patrice Buriez <patrice.buriez@intel.com>
2018-12-18Remove .rst extension in the list of TCMytnyk, Volodymyr1-3/+3
YARDSTICK-1540 Change-Id: I8418754a34bd3e543db85dadf8386c928eee771c Signed-off-by: Mytnyk, Volodymyr <volodymyrx.mytnyk@intel.com>
2018-12-17Merge "[docs] Update influxDB container setup"Abhijit Sinha1-2/+2
2018-12-17Merge "Add vFW TCs description"Emma Foley4-0/+455
2018-12-13[docs] Update influxDB container setupEmma Foley1-2/+2
JIRA: YARDSTICK-1335 Change-Id: I87b95d686f2d7ad204076845505b2fb6d502dedc Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-12-13Yardstick Gambia 7.1.0 release notesrexlee87761-42/+22
Change-Id: I25ee28d62f43a3e2edaaad49762fdf3ce603dac8 Signed-off-by: rexlee8776 <limingjiang@huawei.com>
2018-12-11Add vFW TCs descriptionMytnyk, Volodymyr4-0/+455
JIRA: YARDSTICK-1540 Change-Id: Ia5657f2b04dafe010812a3ad8d0bdb89de67ca7e Signed-off-by: Mytnyk, Volodymyr <volodymyrx.mytnyk@intel.com>
2018-12-10Merge "Docs for vPE"Abhijit Sinha2-0/+30
2018-12-07Merge "Update NSB PROX devguide"Abhijit Sinha10-118/+202
2018-11-28[docs][glossary] Update the glossaryEmma Foley1-3/+57
Add some new terms (barometer, collectd, context, flavor, Grafana, InfluxDB, MPLS, NSB, runner, SampleVNF, scenario, testcase). JIRA: YARDSTICK-1335 Change-Id: I8ed1431e57eacde5c9bf20ae0f1fa09f4773eeba Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-11-28[docs][userguide] Update formatting on userguide chapters 12-14Emma Foley3-305/+273
* Update rst headers * Fix line length * Update some links. JIRA: YARDSTICK-1335 Change-Id: Ib02c67876ad4bbf0cb520e2ccd5c91c1827a9469 Signed-off-by: Emma Foley <emma.l.foley@intel.com>
2018-11-27Update NSB PROX devguideDanielMartinBuckley10-118/+202
JIRA: YARDSTICK-1241 Add latest updates about updated dashboard Added Information on Standalone mode (SRIOV and OVS-DPDK) Added Information on Override traffic profile in test file Added Information on new Grafana updates Added information NFVI metrics Change-Id: Ifcf55ac93d1c9f8c92f3d9dd7eb68d49a6117ffe Signed-off-by: Daniel Martin Buckley <daniel.m.buckley@intel.com>
2018-11-27Docs for vPEJohn O Loughlin2-0/+30
JIRA: YARDSTICK-1529 Change-Id: I1a95bca8ff3713660874c395c6ad6525011ad8c6 Signed-off-by: John O Loughlin <john.oloughlin@intel.com>
2018-11-22Remove Django from requirements and update docsPatrice Buriez1-7/+11
Since ``yardstick report generate`` now uses Jinja2, there is no need for python-django, which was only being used for that command. Update docs accordingly, and provide links to InfluxDB, Jinja2 and Highcharts. JIRA: YARDSTICK-1367 Topic: report/html_table (3 of 11) Change-Id: I63ab03e0b57901f250920487760507062825d812 Signed-off-by: Emma Foley <emma.l.foley@intel.com> Signed-off-by: Patrice Buriez <patrice.buriez@intel.com>
2018-11-20Make VM machine type as a user configurationMytnyk, Volodymyr1-0/+37
For backward compatibility, the default value of this option has been left unchanged. JIRA: YARDSTICK-1528 Change-Id: I42ceca96501f1136cba27d85c2d82240bd45c10c Signed-off-by: Mytnyk, Volodymyr <volodymyrx.mytnyk@intel.com>
2018-11-09Merge "[docs] Resolve "nested numbering in toctree?" warning"Rex Lee2-2/+0
2018-11-09Merge "[docs] Resolve "document isn't included in any toctree" warning"Rex Lee3-1/+12
2018-11-09[docs] Add release notes for GambiaEmma Foley1-300/+124
Change-Id: If3e209ac3d2e80baadef0f4b76494028f8594f8b Signed-off-by: Emma Foley <emma.l.foley@intel.com>
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>