aboutsummaryrefslogtreecommitdiffstats
path: root/docs/userguide/01-introduction.rst
blob: 3c6100ae772f74d98f1fb700b5d896ed0837bb46 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
.. This work is licensed under a Creative Commons Attribution 4.0 International
.. License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, Ericsson AB and others.

============
Introduction
============

**Welcome to Yardstick's documentation !**

.. _Pharos: https://wiki.opnfv.org/pharos
.. _Yardstick: https://wiki.opnfv.org/yardstick
.. _Presentation: https://wiki.opnfv.org/_media/opnfv_summit_-_yardstick_project.pdf

Yardstick_ is an OPNFV Project.

The project's goal is to verify infrastructure compliance, from the perspective
of a Virtual Network Function (:term:`VNF`).

The Project's scope is the development of a test framework, *Yardstick*, test
cases and test stimuli to enable Network Function Virtualization Infrastructure
(:term:`NFVI`) verification.
The Project also includes a sample :term:`VNF`, the Virtual Traffic Classifier
(:term:`VTC`)  and its experimental framework, *ApexLake* !

*Yardstick* is used in OPNFV for verifying the OPNFV infrastructure and some of
the OPNFV features. The *Yardstick* framework is deployed in several OPNFV
community labs. It is *installer*, *infrastructure* and *application*
independent.

.. seealso:: Pharos_ for information on OPNFV community labs and this
   Presentation_ for an overview of *Yardstick*


About This Document
===================

This document consists of the following chapters:

* Chapter :doc:`02-methodology` describes the methodology implemented by the
  Yardstick Project for :term:`NFVI` verification.

* Chapter :doc:`architecture` provides information on the software architecture
  of yardstick.
* Chapter :doc:`04-vtc-overview` provides information on the :term:`VTC`.

* Chapter :doc:`apexlake_installation` provides instructions to install the
  experimental framework *ApexLake* and chapter :doc:`apexlake_api` explains
  how this framework is integrated in *Yardstick*.

* Chapter :doc:`03-installation` provides instructions to install *Yardstick*.

* Chapter :doc:`03-list-of-tcs` includes a list of available Yardstick
  test cases.


Contact Yardstick
=================

Feedback? `Contact us`_

.. _Contact us: opnfv-users@lists.opnfv.org