summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
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>