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
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.
25 *Yardstick* is used in OPNFV for verifying the OPNFV infrastructure and some of
26 the OPNFV features. The *Yardstick* framework is deployed in several OPNFV
27 community labs. It is *installer*, *infrastructure* and *application*
30 .. seealso:: Pharos_ for information on OPNFV community labs and this
31 Presentation_ for an overview of *Yardstick*
37 This document consists of the following chapters:
39 * Chapter :doc:`01-introduction` provides a brief introduction to *Yardstick*
40 project's background and describes the structure of this document.
42 * Chapter :doc:`02-methodology` describes the methodology implemented by the
43 *Yardstick* Project for :term:`NFVI` verification.
45 * Chapter :doc:`03-architecture` provides information on the software
46 architecture of *Yardstick*.
48 * Chapter :doc:`04-installation` provides instructions to install *Yardstick*.
50 * Chapter :doc:`05-operation` provides information on how to use *Yardstick*
51 to run and create testcases.
53 * Chapter :doc:`06-yardstick-plugin` provides information on how to integrate
54 other OPNFV testing projects into *Yardstick*.
56 * Chapter :doc:`07-result-store-InfluxDB` provides inforamtion on how to run
57 plug-in test cases and store test results into community's InfluxDB.
59 * Chapter :doc:`08-grafana` provides inforamtion on *Yardstick* grafana
60 dashboard and how to add a dashboard into *Yardstick* grafana dashboard.
62 * Chapter :doc:`09-api` provides inforamtion on *Yardstick* ReST API and how to
65 * Chapter :doc:`10-yardstick-user-interface` provides inforamtion on how to use
66 yardstick report CLI to view the test result in table format and also values
69 * Chapter :doc:`11-vtc-overview` provides information on the :term:`VTC`.
71 * Chapter :doc:`12-nsb-overview` describes the methodology implemented by the
72 Yardstick - Network service benchmarking to test real world usecase for a
75 * Chapter :doc:`13-nsb_installation` provides instructions to install
76 *Yardstick - Network Service Benchmarking (NSB) testing*.
78 * Chapter :doc:`14-nsb-operation` provides information on running *NSB*
80 * Chapter :doc:`15-list-of-tcs` includes a list of available *Yardstick* test
86 Feedback? `Contact us`_
88 .. _Contact us: mailto:opnfv-users@lists.opnfv.org&subject="[yardstick]"