1 .. This work is licensed under a Creative Commons Attribution 4.0 International
3 .. http://creativecommons.org/licenses/by/4.0
4 .. (c) OPNFV, Ericsson AB and others.
10 **Welcome to Yardstick's documentation !**
12 .. _Pharos: https://wiki.opnfv.org/pharos
13 .. _Yardstick: https://wiki.opnfv.org/yardstick
14 .. _Presentation: https://wiki.opnfv.org/download/attachments/2925202/opnfv_summit_-_yardstick_project.pdf?version=1&modificationDate=1458848320000&api=v2
15 Yardstick_ is an OPNFV Project.
17 The project's goal is to verify infrastructure compliance, from the perspective
18 of a Virtual Network Function (:term:`VNF`).
20 The Project's scope is the development of a test framework, *Yardstick*, test
21 cases and test stimuli to enable Network Function Virtualization Infrastructure
22 (:term:`NFVI`) verification.
23 The Project also includes a sample :term:`VNF`, the Virtual Traffic Classifier
24 (:term:`VTC`) and its experimental framework, *ApexLake* !
26 *Yardstick* is used in OPNFV for verifying the OPNFV infrastructure and some of
27 the OPNFV features. The *Yardstick* framework is deployed in several OPNFV
28 community labs. It is *installer*, *infrastructure* and *application*
31 .. seealso:: Pharos_ for information on OPNFV community labs and this
32 Presentation_ for an overview of *Yardstick*
38 This document consists of the following chapters:
40 * Chapter :doc:`02-methodology` describes the methodology implemented by the
41 Yardstick Project for :term:`NFVI` verification.
43 * Chapter :doc:`03-architecture` provides information on the software architecture
46 * Chapter :doc:`04-vtc-overview` provides information on the :term:`VTC`.
48 * Chapter :doc:`05-apexlake_installation` provides instructions to install the
49 experimental framework *ApexLake*
51 * Chapter :doc:`06-apexlake_api` explains how this framework is integrated in
54 * Chapter :doc:`07-nsb-overview` describes the methodology implemented by the
55 yardstick - Network service benchmarking to test real world usecase for a
58 * Chapter :doc:`08-nsb_installation` provides instructions to install
59 *Yardstick - Network service benchmarking testing*.
61 * Chapter :doc:`09-installation` provides instructions to install *Yardstick*.
63 * Chapter :doc:`10-yardstick_plugin` provides information on how to integrate
64 other OPNFV testing projects into *Yardstick*.
66 * Chapter :doc:`11-result-store-InfluxDB` provides inforamtion on how to run
67 plug-in test cases and store test results into community's InfluxDB.
69 * Chapter :doc:`12-list-of-tcs` includes a list of available Yardstick test
76 Feedback? `Contact us`_
78 .. _Contact us: opnfv-users@lists.opnfv.org