docs/testing/user/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
  16 Yardstick_ is an OPNFV Project.
  17
  18 The project's goal is to verify infrastructure compliance, from the perspective
  19 of a Virtual Network Function (:term:`VNF`).
  20
  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.
  24 The Project also includes a sample :term:`VNF`, the Virtual Traffic Classifier
  25 (:term:`VTC`)  and its experimental framework, *ApexLake* !
  26
  27 *Yardstick* is used in OPNFV for verifying the OPNFV infrastructure and some of
  28 the OPNFV features. The *Yardstick* framework is deployed in several OPNFV
  29 community labs. It is *installer*, *infrastructure* and *application*
  30 independent.
  31
  32 .. seealso:: Pharos_ for information on OPNFV community labs and this
  33    Presentation_ for an overview of *Yardstick*
  34
  35
  36 About This Document
  37 ===================
  38
  39 This document consists of the following chapters:
  40
  41 * Chapter :doc:`01-introduction` provides a brief introduction to *Yardstick*
  42   project's background and describes the structure of this document.
  43
  44 * Chapter :doc:`02-methodology` describes the methodology implemented by the
  45   *Yardstick* Project for :term:`NFVI` verification.
  46
  47 * Chapter :doc:`03-architecture` provides information on the software architecture
  48   of *Yardstick*.
  49
  50 * Chapter :doc:`04-installation` provides instructions to install *Yardstick*.
  51
  52 * Chapter :doc:`05-yardstick_plugin` provides information on how to integrate
  53   other OPNFV testing projects into *Yardstick*.
  54
  55 * Chapter :doc:`06-result-store-InfluxDB` provides inforamtion on how to run
  56   plug-in test cases and store test results into community's InfluxDB.
  57
  58 * Chapter :doc:`07-grafana` provides inforamtion on *Yardstick* grafana dashboard
  59   and how to add a dashboard into *Yardstick* grafana dashboard.
  60
  61 * Chapter :doc:`08-api` provides inforamtion on *Yardstick* ReST API and how to
  62   use *Yardstick* API.
  63
  64 * Chapter :doc:`09-vtc-overview` provides information on the :term:`VTC`.
  65
  66 * Chapter :doc:`10-apexlake_installation` provides instructions to install the
  67   experimental framework *ApexLake*
  68
  69 * Chapter :doc:`11-apexlake_api` explains how this framework is integrated in
  70   *Yardstick*.
  71
  72 * Chapter :doc:`12-nsb-overview` describes the methodology implemented by the
  73   Yardstick - Network service benchmarking to test real world usecase for a
  74   given VNF.
  75
  76 * Chapter :doc:`13-nsb_installation` provides instructions to install
  77   *Yardstick - Network service benchmarking testing*.
  78
  79 * Chapter :doc:`14-list-of-tcs` includes a list of available *Yardstick* test
  80   cases.
  81
  82
  83 Contact Yardstick
  84 =================
  85
  86 Feedback? `Contact us`_
  87
  88 .. _Contact us: opnfv-users@lists.opnfv.org