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/_media/opnfv_summit_-_yardstick_project.pdf
16 Yardstick_ is an OPNFV Project.
18 The project's goal is to verify infrastructure compliance, from the perspective
19 of a Virtual Network Function (:term:`VNF`).
21 The Project's scope is the development of a test framework, *Yardstick*, test
22 cases and test stimuli to enable Network Function Virtualization Infrastructure
23 (:term:`NFVI`) verification.
24 The Project also includes a sample :term:`VNF`, the Virtual Traffic Classifier
25 (:term:`VTC`) and its experimental framework, *ApexLake* !
27 *Yardstick* is used in OPNFV for verifying the OPNFV infrastructure and some of
28 the OPNFV features. The *Yardstick* framework is deployed in several OPNFV
29 community labs. It is *installer*, *infrastructure* and *application*
32 .. seealso:: Pharos_ for information on OPNFV community labs and this
33 Presentation_ for an overview of *Yardstick*
39 This document consists of the following chapters:
41 * Chapter :doc:`02-methodology` describes the methodology implemented by the
42 Yardstick Project for :term:`NFVI` verification.
44 * Chapter :doc:`architecture` provides information on the software architecture
46 * Chapter :doc:`04-vtc-overview` provides information on the :term:`VTC`.
48 * Chapter :doc:`apexlake_installation` provides instructions to install the
49 experimental framework *ApexLake* and chapter :doc:`apexlake_api` explains
50 how this framework is integrated in *Yardstick*.
52 * Chapter :doc:`03-installation` provides instructions to install *Yardstick*.
54 * Chapter :doc:`03-list-of-tcs` includes a list of available Yardstick
61 Feedback? `Contact us`_
63 .. _Contact us: opnfv-users@lists.opnfv.org