Structure test case descriptions
[yardstick.git] / docs / yardstick / 01-introduction.rst
1 ============
2 Introduction
3 ============
4
5 **Welcome to Yardstick's documentation !**
6
7 .. _Yardstick: https://wiki.opnfv.org/yardstick
8
9 Yardstick_ is an OPNFV Project.
10
11 The project's goal is to verify infrastructure compliance, from the perspective
12 of a :term:`VNF`.
13
14 The Project's scope is the development of a test framework, *Yardstick*, test
15 cases and test stimuli to enable :term:`NFVI` verification.
16 The Project also includes a sample :term:`VNF`, the :term:`VTC`  and its
17 experimental framework, *ApexLake* !
18
19 The chapter :doc:`02-methodology` describes the methodology implemented by the
20 Yardstick Project for :term:`NFVI` verification. The chapter
21 :doc:`03-list-of-tcs` includes a list of available Yardstick test cases.
22
23 Yardstick is used for verifying the OPNFV infrastructure and some of the OPNFV
24 features, listed in :doc:`03-list-of-tcs`.
25
26 The *Yardstick* framework is deployed in several  OPNFV community labs. It is
27 installer, infrastructure and application independent.
28
29 .. _Pharos: https://wiki.opnfv.org/pharos
30
31 .. seealso:: Pharos_ for information on OPNFV community labs.
32
33 Contact Yardstick
34 =================
35
36 Feedback? `Contact us`_
37
38 .. _Contact us: opnfv-users@lists.opnfv.org