summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2016-02-19Yardstick input for Release central docAna C1-0/+37
This change adds a file, userguide.rst, that will be used by the release central document as a summary of the Yardstick Project. This file shall not be included in the index of the userguide. The file has been renamed to testusage.rst, as per request. Change-Id: Id8099349a7e626be3d800499bf98171d23239ded Signed-off-by: Ana C <ana.cunha@ericsson.com> (cherry picked from commit 3bcd8816da2d38f5c0d3c4358a47aac2ac19f873)
2016-02-11Add license info and update structureAna C38-176/+448
This change adds license to all .rst files under userguide. It also combines all configguide files into user guide. New reference.rst with list of links. Updated glossary, removed separate directories for apexlake and yardstick framework. Change-Id: I6532ed073905b0fa85a17e759ea7dc3c24acb91f Signed-off-by: Ana C <ana.cunha@ericsson.com> (cherry picked from commit 702eebbf78b29fb9046436dd71575b4f210f4731)
2016-01-29Add directory for code documentationAna C2-0/+16
This change adds a folder for yardstick code documentation under docs, apidocs. An index.rst file is added, and a modules.rst to list the modules. The documentation will be automatically generated from code docstrings, using sphinx autodoc directive. JIRA:YARDSTICK-161 Change-Id: I56ff1904c319a00352842be5ba7bb0cb52bbc3d6 Signed-off-by: Ana C <ana.cunha@ericsson.com> (cherry picked from commit f879c91a15dfd0de24367dd098c8c796851f9769)
2016-01-19Fix Apexlake DocumentationVincenzo Riccobene2-89/+75
Change-Id: If9519d1660fe21bc13307ce35711424c6e2b8176 Signed-off-by: Vincenzo Riccobene <vincenzox.m.riccobene@intel.com> (cherry picked from commit 19caefaa3505a67bea77cf082168f29cbcf41ba9)
2016-01-17Fixed documentation for ApexLakeVincenzo Riccobene3-0/+331
Integration of ApexLake documentation into the main docs directory Change-Id: I3398acc16cc2ff4bb039783fc5bcb6a10afda4e1 Signed-off-by: Vincenzo Riccobene <vincenzox.m.riccobene@intel.com> (cherry picked from commit 58f3b57faedfda7033383b5807fb6553acaa6a2f)
2016-01-15Adds desription for TC024, the CPU load/mpstat test casePer Holmgren2-0/+65
Change-Id: Ifbc571e3e216349d065ac21df1a3f10fe94d4e9a JIRA: - (cherry picked from commit bb82fb8c9198d6e792b8558bf6eaf4f53710c7fe)
2016-01-15Correct some typoswym_libra1-12/+14
Change-Id: Ia9fd31580ff75663514aebbb46a8b87021cb01de Signed-off-by: wym_libra <yimin.wang@huawei.com> (cherry picked from commit 9028f681b95ca213f6702536cf740f07490e4b45)
2016-01-15Add test case description and task file for TC011wym_libra2-0/+84
Add test case description for Packet delay variation between VMs (TC011) and test case .yaml task file. ** Please note that the SLA value has not yet been determined. ** Change-Id: I68a374224946d46c173ad477c14cb79d573b1eee Signed-off-by: wym_libra <yimin.wang@huawei.com> (cherry picked from commit 09c6f91228759e22a08bd9344962d65c1818e6b3)
2016-01-15HeatContext model update to match heat code updateQiLiang2-2/+2
In Heat Liberty release OS::Nova::Server will always use the user pre-configured in the image (e.g. "fedora" for stock Fedora cloud images, "ubuntu" for stock Ubuntu cloud images, "cloud-user" for stock CentOS cloud images etc) Change all ec2-user -> ubuntu Add admin-user in Heat model for backwards compatibility. Refer below links for detalis: https://etherpad.opnfv.org/p/yardstick_release_b_troubleshooting https://github.com/openstack/heat/commit/e423bec7f10b0f5d07f05d195b3b7860f6bceb00 http://blog.scottlowe.org/2015/04/23/ubuntu-openstack-heat-cloud-init/ JIRA: - Change-Id: I6b8b2b21daf113a3a86aee1126b0c3e74737ef4f Signed-off-by: QiLiang <liangqi1@huawei.com> (cherry picked from commit 9d36842e3966185e97cc5732aa7a0edd2050bfe2)
2016-01-14Add template for test results reportAna C1-0/+71
This change is a proposal for a report for yardstick test case reesults. One report for all the executed tests, summarizing the results and the labs where the tests were executed. JIRA: - Change-Id: I7cdfdc82d6ee07d2b9da426f33ce34b86362b5b4 Signed-off-by: Ana C <ana.cunha@ericsson.com> (cherry picked from commit 3871a2c4f61b1da9a8512135bf0cf6e9e35d7e8d)
2016-01-12Fix minor format details in tc descriptionsAna C3-28/+58
This change fixes minor formating in TC025, remove one extra line in TC028 and update 03-list-of-tcs. The formating caused the pdf to fail. Change-Id: I304335277b1fbc33b10d9a07245ebeef0612fc80 Signed-off-by: Ana C <ana.cunha@ericsson.com> (cherry picked from commit 5c4c8667e0c0a8e039d7682f235b022f39149d56)
2016-01-12Rename tc019/tc025 & fix description for tc005QiLiang4-2/+4
Added tc019 and tc025 to index of test cases in 03-list-of-tcs. JIRA: - Change-Id: I02696dc408d2d5c20becba29c49b3cff2a7049a9 Signed-off-by: QiLiang <liangqi1@huawei.com> (cherry picked from commit 25095fb4e6d6a0e71581eee18f50c7d61f6a270d)
2016-01-12Add test case description for TC028-kvmQiLiang2-0/+67
JIRA: YARDSTICK-188 Change-Id: I16f8c5ac3a3997640ce96a77984c4dbe9ccb2804 Signed-off-by: QiLiang <liangqi1@huawei.com> (cherry picked from commit ef353b91b2527580a642da561a387d67b71e753d)
2016-01-12Add test case description and task file for TC025wym_libra1-0/+99
Add test case description for HA of OpenStack Controll Node abnormally shutdown (TC025) and the sample .yaml task file. ** Please note that the SLA value has not yet been determined. ** JIRA: YARDSTICK-135 Change-Id: I70f1afb0c9cfa5446aac08b7b13e543a9ec20898 Signed-off-by: wym_libra <yimin.wang@huawei.com> (cherry picked from commit 83d895e535b700790497429ac6cbd46fb0fef9e5)
2016-01-12Add test case description and task file for TC019wym_libra1-0/+129
Add test case description for Control node-OpenStack service down (TC019) and test case .yaml task file. ** Please note that the SLA value has not yet been determined. ** JIRA: YARDSTICK-135 Change-Id: Id512159034929dc197d2c7fdf6cc672ecddfb996 Signed-off-by: wym_libra <yimin.wang@huawei.com> (cherry picked from commit 32b39d0f576dc5c71678fd0b6b8feab6f2173939)
2016-01-12Include vTC overview in Yardstick documentationAna C10-124/+198
This change includes the vTC overview in Yardstick configguide, the original vTC/README has been renamed to 04-vTC-overview and added in the configguide. The vTC/abbreviations is deleted, all included in glossary.rst Index and 03-list-of-tcs are updated. JIRA:- Change-Id: Ifc5cf1cc258dee6743af189f347e8adbbec6a32f Signed-off-by: Ana C <ana.cunha@ericsson.com> (cherry picked from commit 12521edea1e40e73e2fb04f4f230760de324521b)
2016-01-11Implementation of opnfv-yardstick-tc021 in YardstickVincenzo Riccobene1-0/+148
Includes - Yardstick Scenario for integration with ApexLake - Yardstick Task .yaml file - Documentation JIRA: YARDSTICK-219 Change-Id: I0554d0a211392902207ba9ceccf0b98dc3c2cdf1 Signed-off-by: Vincenzo Riccobene <vincenzox.m.riccobene@intel.com> (cherry picked from commit e749d09788edbd1040dabb082e13bd1a1cbc3a7a)
2016-01-11Implementation of opnfv-yardstick-tc020 in YardstickVincenzo Riccobene1-0/+135
Includes - Yardstick Scenario for integration with ApexLake - Yardstick Task .yaml file - Documentation JIRA: YARDSTICK-219 Change-Id: Ibbba1d9864e788fb6c81cc00c503e9f69e885651 Signed-off-by: Vincenzo Riccobene <vincenzox.m.riccobene@intel.com> (cherry picked from commit 884e58ab48d0dcdc5e57b87ea181c0a4b8151fc8)
2016-01-11Implementation of yardstick-tc007 in YardstickVincenzo Riccobene1-0/+156
Includes - Yardstick Scenario for integration with ApexLake - Yardstick Task .yaml file - Documentation JIRA: YARDSTICK-219 Change-Id: Ifa2555336098e68d0fad8045e2f759aed587ad92 Signed-off-by: Vincenzo Riccobene <vincenzox.m.riccobene@intel.com> (cherry picked from commit bde7eae17a1fc9ec163451b8d62825daa2fec297)
2016-01-11Implementation of yardstick-tc006 in YardstickVincenzo Riccobene1-0/+136
Includes - Yardstick Scenario for integration with ApexLake - Yardstick Task .yaml file - Documentation JIRA: YARDSTICK-219 Change-Id: Iabde8fa63f346cf1e4a02691f22d1761de79a239 Signed-off-by: Vincenzo Riccobene <vincenzox.m.riccobene@intel.com> (cherry picked from commit 6f6ed9af46d616b073481799c157ed3bc88a8810)
2016-01-11IPv6 connectivity between nodes on the tenant networkkubi2-0/+68
Test case yaml and .rst file for ipv6 Change-Id: Ib9a554dc05445023687efb0ac608c7cbd0da4c21 Signed-off-by: kubi <jean.gaoliang@huawei.com>
2016-01-11Test case to measure processing speed(score)kubi2-0/+70
run unixbench to get the score of processing performance This patch includes the .yaml for the test case and the .rst for test case description. JIRA:YARDSTICK-116 Signed-off-by: kubi <jean.gaoliang@huawei.com> Change-Id: Ic75119d1db19dacc57edfa4dce607e0e29ae8db4 Signed-off-by: kubi <jean.gaoliang@huawei.com> (cherry picked from commit db643f9a2a416c0888931a347488a51264350c8f)
2016-01-11Test Case 040 Verify Parser Yang-to-Toscakubi2-0/+61
running Parser Yang-to-Tosca module as a tool, validating output against expected outcome. this patch is about task yaml and rst for test case description. JIRA:YARDSTICK-224 Signed-off-by: kubi <jean.gaoliang@huawei.com> Change-Id: Id254c5cf45de33b023bef889a58044a21ed0db43 Signed-off-by: kubi <jean.gaoliang@huawei.com> (cherry picked from commit 45e85a7f6df63ca4ca702f519ca19e5bcbb1bc23)
2016-01-11Add test case description and task file for TC005QiLiang2-0/+73
JIRA: YARDSTICK-93 Change-Id: I74adef0e6bae52a7080479d7054a92342f7324a7 Signed-off-by: QiLiang <liangqi1@huawei.com> (cherry picked from commit 738fb0942c39e5f1ecad87ae9dd776f1019d2491)
2016-01-08Rename folders in yardstick/docsAna C19-0/+0
Adapt the naming of the folders under yardstick/docs to the naming adopted by the release documentation defined by opnfvdocs. JIRA: - Change-Id: Icc57720d585abbbf7252bcbf76e2f2a403cb1732 Signed-off-by: Ana C <ana.cunha@ericsson.com> (cherry picked from commit 463a69e878d891b897fe70af15434615baf6a2e9)
2016-01-08Fix description for TC037 and TC038Ana C3-44/+68
Update rst files for TC037 and TC038 for latest template format. Added TC037 and TC038 to index of test cases in 03-list-of-tcs. JIRA: - Change-Id: I32657b564ff1c393f8048a74e676b3f5791d6d0d Signed-by: Ana C <ana.cunha@ericsson.com> (cherry picked from commit 6e0daa70bfe87253da6658433f11313475e5e204)
2016-01-08Fix glance yardstick-image cmd in installation docKristian Hunt1-1/+2
Glance image-create command should use --os-image-api-version 1 flag for the is-public argument. JIRA: YARDSTICK-68 Change-Id: I43a60a7dac186ae7c586aa98b6e5de9821caee60 Signed-off-by: Kristian Hunt <kristian.hunt@gmail.com> (cherry picked from commit 136762959413c038d2527c11efa8904c135f9278)
2016-01-08Add test case description and task file for TC038Jo¶rgen Karlsson1-0/+88
JIRA: YARDSTICK-214 Change-Id: I3a2358e8c36755a684f09524bd6fc8af9bf43f60 Signed-off-by: Jo¶rgen Karlsson <jorgen.w.karlsson@ericsson.com> (cherry picked from commit c27b74456831c0f7c827b4840649a898d66cd52f)
2016-01-08Add test case description and task file for TC037Jo¶rgen Karlsson1-0/+88
JIRA: YARDSTICK-213 Change-Id: I3f1f521da6a824c96cbc8712a098c61ff6b0540d Signed-off-by: Jo¶rgen Karlsson <jorgen.w.karlsson@ericsson.com> (cherry picked from commit 605d252b9c72c0d41a720c45774d4481bb902c77)
2016-01-08Structure test case descriptionsAna C14-133/+717
This commit structures the test case descriptions. The file index.rst lists the subsequent chapters. 01-introduction.rst contains an overview of the project and deliverables. 02-methodology.rst describes the methodology for the generic test cases. 03-list-of-tcs.rst contains a list of merged generic test cases and a sub-chapter for the feature test cases. Glossary extracts definitions and abbreviations. TC001, TC002, TC008, TC009, TC010, TC012 were adapted to work for pdf. Template testcase_description_v2_template.rst was adapted to work for pdf. Change-Id: Ia11e27e5d508f1a784e2a412b50739e32b13797f Signed-off-by: Ana C <ana.cunha@ericsson.com> (cherry picked from commit 00296cd85133d4f38a510e7ad3ecb0ff3fe4d56c)
2015-12-21Add test case description and task file for TC010Kristian Hunt1-0/+65
Add test case description for Memory Latency (TC010) and test case .yaml task file. JIRA: YARDSTICK-94 Change-Id: If7fb120868c9901fe097f310aa249e1fbc8a94ee Signed-off-by: Kristian Hunt <kristian.hunt@gmail.com>
2015-12-18Adds new Yardstick test case TC009, Network Performance, Packet LossPer Holmgren1-0/+70
Similar to Yardstick TC001. Main difference is that each packet size is run 10 times before next packet size. JIRA: YARDSTICK-87 Change-Id: If0f59590dff9c8e5b86760667f01a373afe8aff0
2015-12-18Adds Yardstick test case TC008, Network Performance Extended TestsPer Holmgren1-0/+71
New test case using pktgen tool. Based on TC001, but with additional packet sizes and more repetitions of each test combination, respectively. Test case takes approx.3 hours to complete. Change-Id: Iba2de5efa33d6e2c960772fa5345595f6d7ab4e6 JIRA: YARDSTICK-80
2015-12-16Adapt documentation to latest guidelinesAna C11-228/+98
Adapt Yardstick documentation according to the latest guidelines from the Releng project. The only change in test case description TC001 and TC002 is to remove logo. The same for the test case description v2 template. The previous version of test case description is deleted from repo. The Yardstick_task_template is edited to keep line lenght 80 char. This commit also adds index for docs/yardstick and for docs/user_guides/framework. The overview for the vTC .rst file has been fixed to enable the .pdf generation. Change-Id: Ib6480c3c29ce0f0ee22c9ad717439f6a293ab842 Signed-off-by: Ana C <ana.cunha@ericsson.com>
2015-12-15Add test case description and task file for TC012Kristian Hunt1-0/+68
Add test case description for Memory Bandwidth (TC012) and test case .yaml task file. JIRA: YARDSTICK-113 Change-Id: I6f2b0bb8c920f3ece3a41bac744cc1ec1fd35cbc Signed-off-by: Kristian Hunt <kristian.hunt@gmail.com>
2015-12-09Adds new test case descriptionsPer Holmgren2-0/+142
Adds test case descriptions for JIRA issues number 6 (Network Performance) and number 8 (Network Latency) in accordance to version 2 of the test case description template. Jira:YARDSTICK-6 Jira:YARDSTICK-8 Signed-off-by: Per Holmgren <per.q.holmgren@ericsson.com> Change-Id: Ib6f4d08a1f7c6ba10f3f220d2bb3998311ecf203
2015-12-03Remove etc and source folder from yardstick documentationFatih Degirmenci9-40/+0
conf.py and logo will come from releng which is common for all projects. The directory structure in docs folder has not been decided yet so this change does not require you to change your current way of working. Once this directory structure is decided by opnfvdocs and releng, the changes need to be reflected back to all projects, including yardstick. Change-Id: If0558474a819f4a44e34f790d26c5486751b8266 Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
2015-11-18Add initial installation documentationKristian Hunt2-0/+222
This .rst file describes how to install Yardstick on Ubuntu14.04 or by using a Docker image. JIRA: YARDSTICK-68 Change-Id: I9c5b3b2883c1e2bbbd3325ec40711fd9fec97cdb Signed-off-by: Kristian Hunt <kristian.hunt@gmail.com>
2015-11-04Second commit of the vTCAkis Kourtis2-0/+102
JIRA: Yardstick-37 JIRA: Yardstick-137 The git clone process from the bitbucket repository is done using OAuth2 authentication now. Various build bugs have been fixed. Documentation has been updated, an architecture graph has been for better understanding. README.rst has been moved to docs/source/vTC along with an abbreviations.rst Change-Id: I864a90026df81779f7935f33acfa26ac9fb7c50c Signed-off-by: Akis Kourtis <akis.kourtis@iit.demokritos.gr>
2015-10-23Add updated version for templateAna C2-8/+65
This patch adds a second version for the template for test case description, in table format. Minor updates in the original version, opnfv logo added. Jira:YARDSTICK-2 Change-Id: Ia9b2ba9c237d0ce8493e512663f95b73df210175 Signed-off-by: Ana C <ana.cunha@ericsson.com>
2015-10-15Reorganize documentation in new structureAna C5-33/+58
Remove the to-be-reorganized folder and reorganize documentation in properly named subfolders. Modified conf.py to reflect yardstick project name. Modified index.rst with introduction about yardstick. Templates were moved to new subfolder, no changes in the content. Jira:YARDSTICK-133 Change-Id: Iea5948733c57ff57eb946f44739b69d0e7291356 Signed-off-by: Ana C <ana.cunha@ericsson.com>
2015-09-16Move documentation to new sphinx buildAric Gardner5-0/+65
TODO: Reorganize documentation into properly named subfolders TODO: Add logos to documentation (see index.rst for example) Note you can see the results of this change via a link in the gerrit comments below NOTE: The merge job for your project has not been enabled, this code will not go to the artifacts page upon a merge. you can merge it and work on it in your own time, please contact me to enable the merge (the merge job will make this documentation avaliable to the public on artifacts.opnfv.org) JIRA:RELENG-15 Change-Id: I8fd519393416e2ac2b3ada6fe0670aa4d038fc87 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2015-09-01add support for Jinja2 in task filekubi1-0/+141
Add support in task file for the template syntax based on Jinja2. JIRA:YARDSTICK-101 Change-Id: I24be133ba590510612d97a1fce6c024e6edb57e4 Signed-off-by: kubi <jean.gaoliang@huawei.com>
2015-07-15Add test case description templateAna C1-0/+88
Template states mandatory information for each test case to be delivered by Yardstick Project. JIRA: YARDSTICK-2 Change-Id: I16b98acc6689e24f8e6a85c356ee1b8991bd5276 Signed-off-by: Ana C <ana.cunha@ericsson.com>