summaryrefslogtreecommitdiffstats
path: root/docs/userguide/01-introduction.rst
diff options
context:
space:
mode:
authorAna C <ana.cunha@ericsson.com>2016-02-10 19:07:13 +0100
committerAna Cunha <ana.cunha@ericsson.com>2016-02-11 15:05:18 +0000
commit95cdd0ea41e3892422de92f13fac39871585706e (patch)
treed8703d6411af6614b299a1005495c389327793ad /docs/userguide/01-introduction.rst
parent5f2938cc116f5c8769317e043440d79a0fb2045f (diff)
Add license info and update structure
This change adds license to all .rst files under userguide. It also combines all configguide files into user guide. New reference.rst with list of links. Updated glossary, removed separate directories for apexlake and yardstick framework. Change-Id: I6532ed073905b0fa85a17e759ea7dc3c24acb91f Signed-off-by: Ana C <ana.cunha@ericsson.com> (cherry picked from commit 702eebbf78b29fb9046436dd71575b4f210f4731)
Diffstat (limited to 'docs/userguide/01-introduction.rst')
-rw-r--r--docs/userguide/01-introduction.rst61
1 files changed, 61 insertions, 0 deletions
diff --git a/docs/userguide/01-introduction.rst b/docs/userguide/01-introduction.rst
new file mode 100644
index 000000000..90c112a47
--- /dev/null
+++ b/docs/userguide/01-introduction.rst
@@ -0,0 +1,61 @@
+.. 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:`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