====== Project: Yardstick - Infrastructure Verification ====== * Project Name: Yardstick \\ * Project Repository: yardstick \\ ^ {{:information.png?120|}} ^ **Quick links** \\ [[https://jira.opnfv.org/secure/RapidBoard.jspa?rapidView=19 |Yardstick Kanban board]] \\ [[https://jira.opnfv.org/secure/Dashboard.jspa?selectPageId=10501|Yardstick Jira Dashboard]] \\ [[https://wiki.opnfv.org/candidates_for_test_cases|Yardstick Test cases]] \\ [[https://wiki.opnfv.org/lab_booking/yardstick|Yardstick Dev Labs Booking ]] \\ [[yardstick#documentation|Yardstick documentation]] \\ [[yardstick#videos|Yardstick videos]] ^ ===== Release-B Deliverables ===== ^ {{:information.png?50|}} ^ **Check !** \\ [[http://testresults.opnfv.org/grafana/login|Yardstick Dashboard]] \\ (opnfv/opnfv) ^ ^ HTML ^ PDF ^ | [[http://artifacts.opnfv.org/yardstick/brahmaputra/docs/userguide/index.html|Yardstick User Guide ]] | [[http://artifacts.opnfv.org/yardstick/brahmaputra/docs/userguide/userguide.pdf|Yardstick User Guide ]] | |[[http://artifacts.opnfv.org/yardstick/brahmaputra/docs/apidocs/index.html|Yardstick Code Documentation ]] | [[http://artifacts.opnfv.org/yardstick/brahmaputra/docs/apidocs/apidocs.pdf|Yardstick Code Documentation]] | |[[http://artifacts.opnfv.org/yardstick/brahmaputra/docs/release/index.html|Yardstick Release Note ]] | [[http://artifacts.opnfv.org/yardstick/brahmaputra/docs/release/release.pdf|Yardstick Release Note ]] | |[[http://artifacts.opnfv.org/yardstick/brahmaputra/docs/results/index.html| Yardstick Test Results Documentation ]] | [[http://artifacts.opnfv.org/yardstick/brahmaputra/docs/results/results.pdf| Yardstick Test Results Documentation ]] | ===== Description ===== The goal of the Yardstick Project is to verify the infrastructure compliance when running VNF applications. \\ NFV Use Cases described in [[http://www.etsi.org/deliver/etsi_gs/NFV/001_099/001/01.01.01_60/gs_NFV001v010101p.pdf|ETSI GS NFV 001]] show a large variety of applications, each defining specific requirements and complex configuration on the underlying infrastructure and test tools.The Yardstick concept decomposes typical VNF work-load performance metrics into a number of characteristics/performance vectors, which each of them can be represented by distinct test-cases. The project's scope is to develop a test framework, test cases and test stimuli. The methodology used by the Project, to verify the infrastructure form the perspective of a VNF, shall be aligned with [[https://docbox.etsi.org/ISG/NFV/Open/Drafts/TST001_-_Pre-deployment_Validation/|ETSI TST001]]. * **Meetings:** * Weekly coordination meeting: Thursdays 14h00 UTC, see [[https://wiki.opnfv.org/meetings/test|Meeting details]] * Work meetings: * IRC only - channel: #opnfv-yardstick * Mondays & Thursdays UTC 8h30 - 9h00 * Mondays UTC 15h00 - 16h00 * Check [[https://wiki.opnfv.org/yardstick_workmeetings| Agenda]] and [[http://ircbot.wl.linuxfoundation.org/meetings/opnfv-yardstick/|Minutes of Meetings]] * Design sessions and Cross-OPNFV Projects cooperation: see [[https://wiki.opnfv.org/design sessions|details]] * **Etherpads:** * Project governance, Mobility Traffic Profile - [[https://etherpad.opnfv.org/p/yardstick]] * Yardstick and HA - [[https://etherpad.opnfv.org/p/yardstick_ha]] * Yardstick folder structure - [[https://etherpad.opnfv.org/p/yardstick_folders]] * Yardstick framework architecture - [[https://etherpad.opnfv.org/p/yardstick_framework]] * Yardstick test results visualization - [[https://etherpad.opnfv.org/p/yardstick_visualization]] * Yardstick release-B planning - [[https://etherpad.opnfv.org/p/yardstick_release_b]] * Yardstick release-B troubleshooting and known issues - [[https://etherpad.opnfv.org/p/yardstick_release_b_troubleshooting]] * Yardstick release-C planning - [[https://etherpad.opnfv.org/p/yardstick_release_c]] * **Gerrit:** [[https://gerrit.opnfv.org/gerrit/#/q/yardstick]] * **Git:** [[https://git.opnfv.org/cgit/]] * **Jira:** [[https://jira.opnfv.org/secure/BrowseProjects.jspa#all]] * **Jenkins:** [[https://build.opnfv.org/ci/view/yardstick/]] * **Dev Lab booking:** [[https://wiki.opnfv.org/lab_booking/yardstick|Yardstick Dev Labs]] * **Project planning:** [[https://jira.opnfv.org/secure/Dashboard.jspa?selectPageId=10501|Yardstick Jira Dashboard]] and [[https://jira.opnfv.org/secure/RapidBoard.jspa?rapidView=19|Yardstick Kanban board]] * **OPNFV Statistics:** [[http://projects.bitergia.com/opnfv/browser/]] * **OPNFV Statistics in Stackalytics:** [[http://stackalytics.com/?release=all&project_type=opnfv-group&metric=commits]] * **Virtual Traffic Classifier:** [[https://wiki.opnfv.org/vtc|virtual Traffic Classifier]] * [[project_proposals/yardstick|Project proposal]] * TSC approval of the project proposal: [[http://meetbot.opnfv.org/meetings/opnfv-meeting/2015/opnfv-meeting.2015-04-28-13.59.html]] ===== Scope ===== The following are in the project scope: * Decompose VNF work-load performance metrics into a number of characteristics/performance vectors, identifying and categorizing the metrics related to characterization of the infrastructure, develop test case examples to realize the metrics; * Enable verification of more complex test cases by developing functionality to run parallel testing, inject fault, test multiple topologies, test scenarios. * Methodology for verifying infrastrucuture from the perspective of a VNF aligned with [[https://docbox.etsi.org/ISG/NFV/Open/Drafts/TST001_-_Pre-deployment_Validation/|ETSI TST 001]]. ===== Deliverables ===== * [[https://jira.opnfv.org/secure/Dashboard.jspa?selectPageId=10501|Yardstick Jira Dashboard]] * [[Candidates for Test Cases|Planned & Proposed Test cases]] ===== Contact Yardstick ===== You can reach us in any of the following ways: post your suggestion is the relevant page, contact us on IRC channel #opnfv-yardstick or send an e-mail to with **[opnfv-tech-discuss][Yardstick] ** on the subject ====== Reference Material ====== ==== OPNFV Summit, Nov 9-12 2015 ==== * Summit Presentations * {{:opnfv_summit_-_yardstick_project.pdf|}} * {{::opnfv_summit_-_test_strategy_for_brahmaputra.pdf|}} * {{::opnfv_summit_-_bridging_opnfv_and_etsi.pdf|}} * Other Design Summit presentations: https://wiki.opnfv.org/events/2015-designsummit-presentations * Slides: http://events.linuxfoundation.org/events/opnfv-summit/program/slides * Testing breakout session Nov 9th: http://ircbot.wl.linuxfoundation.org/meetings/opnfv-yardstick/2015/opnfv-yardstick.2015-11-09-23.19.html * Testing breakout session Nov 10th: http://ircbot.wl.linuxfoundation.org/meetings/opnfv-yardstick/2015/opnfv-yardstick.2015-11-11-00.38.html * HA breakout session Nov 10th: http://ircbot.wl.linuxfoundation.org/meetings/opnfv-yardstick/2015/opnfv-yardstick.2015-11-10-17.18.html * Yardstick breakout session: http://ircbot.wl.linuxfoundation.org/meetings/opnfv-yardstick/2015/opnfv-yardstick.2015-11-10-18.58.html ==== Presentations and Demos ==== * Test & Performance Weekly Meeting, October 1st {{:vnf_framework_demo.pdf|}} * Test & Performance Weekly Meeting, September 3rd {{:yardstick_virtual_traffic_classifier_presentation.pdf|}} * Test & Performance Weekly Meeting, August 27th {{:mobile_traffic_profile_update_150827.pdf}} * Test & Performance Weekly Meeting, August 20th {{:yardstick_demo_150820.pdf|}} \\ {{:yardstick_storagedemo_20150820.pdf}} \\ * Test & Performance Weekly Meeting, June 18th {{:yardstick_demo_150618.pdf|}}\\ {{:yardstick-june-2015.pdf|}} ==== Videos ==== [[https://www.youtube.com/watch?v=4S4izNolmR0 | yardstick installation]] (OPNFV YouTube channel) \\ [[https://www.youtube.com/watch?v=MHghL4QyuSo | virtual Traffic Classifier demo]] (OPNFV YouTube channel) \\ [[https://www.youtube.com/watch?v=5XDIaUDz0PI | ApexLake demo ]] (OPNFV YouTube channel) ==== Documentation ==== ^ {{ :work_i_p.jpg?150 |}} ^ Documentation is automatically generated, written using reSt markup. \\ The documentation for the project's deliverables, including framework \\ and test case user guides is under construction. \\ The pages below will be reorganized in main index and user guides \\ as the chapters are completed. ^ * Yardstick Framework User Guide: * HTML: http://artifacts.opnfv.org/yardstick/docs/user_guides_framework/index.html * PDF: http://artifacts.opnfv.org/yardstick/docs/user_guides_framework/user_guides_framework.pdf * Yardstick Config Guide: * HTML: http://artifacts.opnfv.org/yardstick/docs/yardstick/index.html * PDF: http://artifacts.opnfv.org/yardstick/docs/yardstick/yardstick.pdf * virtual Traffic Classifier: * Overview: http://artifacts.opnfv.org/yardstick/docs/source/vTC/README.html ==== Additional links ==== * [[https://wiki.opnfv.org/testing|OPNFV Main Testing Page]] * [[https://wiki.opnfv.org/brahmaputra_testing_page|Brahmaputra Testing Page]] * [[https://wiki.opnfv.org/releases/brahmaputra|Brahmaputra release page]] * [[https://wiki.opnfv.org/developer/contribution_guidelines|OPNFV Coding Guidelines]] * [[https://ask.opnfv.org/questions/|Ask OPNFV]] * [[https://wiki.opnfv.org/releases/brahmaputra/release_plan|Brahmaputra release plan]] ==== Old Yardstick pages, no longer used ==== * https://wiki.opnfv.org/sprints * https://wiki.opnfv.org/methodology * https://wiki.opnfv.org/questions * https://wiki.opnfv.org/candidates_for_scenarios ---- ====== Key Project Facts ====== {{scrape>https://gerrit.opnfv.org/gerrit/gitweb?p=yardstick.git;a=blob_plain;f=INFO;}} **Contributors**: * Morgan Richomme * Rebecca Steinert * Fatih Degirmenci * Pierre Lynch * Julien Zhang * Mikhael Harswanto Tanutama * Krzysztof Barczynski * Shaoteng Liu * Michael Mcgrath * Akis Kourtis * George Xilouris * Sean Wenström * Kristian Hunt * Per Holmgren * Jose Lausuch * Liang Qi * Hao Pang * Gao Liang * Younes Fettah * Wu Zhihui * Yimin Wang * Vincenzo Riccobene * Daniel Smith * Rex Lee * Dávid Siket * Akos Farago * Oktávián Papp * András Babós * Tamás Tallódi * Gundarapu Reddy * Ricardo Noriega De Soto * Brady Allen Johnson * P Ritesh * Ulf Markström