Merge "Yardstick Preliminary Documentation"

1 files changed, 79 insertions, 0 deletions

diff --git a/docs/testing/user/userguide/01-introduction.rst b/docs/testing/user/userguide/01-introduction.rst
new file mode 100755
index 000000000..0e0eea002
--- /dev/null
+++ b/docs/testing/user/userguide/01-introduction.rst
@@ -0,0 +1,79 @@
+.. 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/download/attachments/2925202/opnfv_summit_-_yardstick_project.pdf?version=1&modificationDate=1458848320000&api=v2
+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:`03-architecture` provides information on the software architecture
+  of yardstick.
+
+* Chapter :doc:`04-vtc-overview` provides information on the :term:`VTC`.
+
+* Chapter :doc:`05-apexlake_installation` provides instructions to install the
+  experimental framework *ApexLake*
+
+* Chapter :doc:`06-apexlake_api` explains how this framework is integrated in
+  *Yardstick*.
+
+* Chapter :doc:`07-nsb-overview` describes the methodology implemented by the
+  yardstick - Network service benchmarking to test real world usecase for a
+  given VNF
+
+* Chapter :doc:`08-nsb_installation` provides instructions to install
+  *Yardstick - Network service benchmarking testing*.
+
+* Chapter :doc:`09-installation` provides instructions to install *Yardstick*.
+
+* Chapter :doc:`10-yardstick_plugin` provides information on how to integrate
+  other OPNFV testing projects into *Yardstick*.
+
+* Chapter :doc:`11-result-store-InfluxDB` provides inforamtion on how to run
+  plug-in test cases and store test results into community's InfluxDB.
+
+* Chapter :doc:`12-list-of-tcs` includes a list of available Yardstick test
+  cases.
+
+
+Contact Yardstick
+=================
+
+Feedback? `Contact us`_
+
+.. _Contact us: opnfv-users@lists.opnfv.org
+