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.
6 Convention for heading levels in Yardstick documentation:
8 ======= Heading 0 (reserved for the title in a document)
14 Avoid deeper levels because they do not render well.
20 **Welcome to Yardstick's documentation !**
22 .. _Pharos: https://wiki.opnfv.org/display/pharos
23 .. _Yardstick: https://wiki.opnfv.org/display/yardstick
24 .. _Presentation: https://wiki.opnfv.org/download/attachments/2925202/opnfv_summit_-_yardstick_project.pdf?version=1&modificationDate=1458848320000&api=v2
26 Yardstick_ is an OPNFV Project.
28 The project's goal is to verify infrastructure compliance, from the perspective
29 of a Virtual Network Function (:term:`VNF`).
31 The Project's scope is the development of a test framework, *Yardstick*, test
32 cases and test stimuli to enable Network Function Virtualization Infrastructure
33 (:term:`NFVI`) verification.
35 *Yardstick* is used in OPNFV for verifying the OPNFV infrastructure and some of
36 the OPNFV features. The *Yardstick* framework is deployed in several OPNFV
37 community labs. It is *installer*, *infrastructure* and *application*
40 .. seealso:: Pharos_ for information on OPNFV community labs and this
41 Presentation_ for an overview of *Yardstick*
47 This document consists of the following chapters:
49 * Chapter :doc:`01-introduction` provides a brief introduction to *Yardstick*
50 project's background and describes the structure of this document.
52 * Chapter :doc:`02-methodology` describes the methodology implemented by the
53 *Yardstick* Project for :term:`NFVI` verification.
55 * Chapter :doc:`03-architecture` provides information on the software
56 architecture of *Yardstick*.
58 * Chapter :doc:`04-installation` provides instructions to install *Yardstick*.
60 * Chapter :doc:`05-operation` provides information on how to use *Yardstick*
61 to run and create testcases.
63 * Chapter :doc:`06-yardstick-plugin` provides information on how to integrate
64 other OPNFV testing projects into *Yardstick*.
66 * Chapter :doc:`07-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:`08-grafana` provides inforamtion on *Yardstick* grafana
70 dashboard and how to add a dashboard into *Yardstick* grafana dashboard.
72 * Chapter :doc:`09-api` provides inforamtion on *Yardstick* ReST API and how to
75 * Chapter :doc:`10-yardstick-user-interface` provides inforamtion on how to use
76 yardstick report CLI to view the test result in table format and also values
79 * Chapter :doc:`12-nsb-overview` describes the methodology implemented by the
80 Yardstick - Network service benchmarking to test real world usecase for a
83 * Chapter :doc:`13-nsb-installation` provides instructions to install
84 *Yardstick - Network Service Benchmarking (NSB) testing*.
86 * Chapter :doc:`14-nsb-operation` provides information on running *NSB*
88 * Chapter :doc:`15-list-of-tcs` includes a list of available *Yardstick* test
94 Feedback? `Contact us`_
96 .. _Contact us: mailto:opnfv-users@lists.opnfv.org&subject="#yardstick"