docs/userguide/01-introduction.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International
   2 .. License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4 .. (c) OPNFV, Ericsson AB and others.
   5
   6 ============
   7 Introduction
   8 ============
   9
  10 **Welcome to Yardstick's documentation !**
  11
  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
  15 Yardstick_ is an OPNFV Project.
  16
  17 The project's goal is to verify infrastructure compliance, from the perspective
  18 of a Virtual Network Function (:term:`VNF`).
  19
  20 The Project's scope is the development of a test framework, *Yardstick*, test
  21 cases and test stimuli to enable Network Function Virtualization Infrastructure
  22 (:term:`NFVI`) verification.
  23 The Project also includes a sample :term:`VNF`, the Virtual Traffic Classifier
  24 (:term:`VTC`)  and its experimental framework, *ApexLake* !
  25
  26 *Yardstick* is used in OPNFV for verifying the OPNFV infrastructure and some of
  27 the OPNFV features. The *Yardstick* framework is deployed in several OPNFV
  28 community labs. It is *installer*, *infrastructure* and *application*
  29 independent.
  30
  31 .. seealso:: Pharos_ for information on OPNFV community labs and this
  32    Presentation_ for an overview of *Yardstick*
  33
  34
  35 About This Document
  36 ===================
  37
  38 This document consists of the following chapters:
  39
  40 * Chapter :doc:`02-methodology` describes the methodology implemented by the
  41   Yardstick Project for :term:`NFVI` verification.
  42
  43 * Chapter :doc:`03-architecture` provides information on the software architecture
  44   of yardstick.
  45
  46 * Chapter :doc:`04-vtc-overview` provides information on the :term:`VTC`.
  47
  48 * Chapter :doc:`05-apexlake_installation` provides instructions to install the
  49   experimental framework *ApexLake* and chapter :doc:`06-apexlake_api` explains
  50   how this framework is integrated in *Yardstick*.
  51
  52 * Chapter :doc:`07-installation` provides instructions to install *Yardstick*.
  53
  54 * Chapter :doc:`08-yardstick_plugin` provides information on how to integrate
  55   other OPNFV testing projects into *Yardstick*.
  56
  57 * Chapter :doc:`09-result-store-InfluxDB` provides inforamtion on how to run
  58   plug-in test cases and store test results into community's InfluxDB.
  59
  60 * Chapter :doc:`10-list-of-tcs` includes a list of available Yardstick test
  61   cases.
  62
  63
  64 Contact Yardstick
  65 =================
  66
  67 Feedback? `Contact us`_
  68
  69 .. _Contact us: opnfv-users@lists.opnfv.org
  70