summaryrefslogtreecommitdiffstats
path: root/docs/userguide
diff options
context:
space:
mode:
authorAna C <ana.cunha@ericsson.com>2016-02-12 03:25:27 +0100
committerAna Cunha <ana.cunha@ericsson.com>2016-02-19 07:55:53 +0000
commit3bcd8816da2d38f5c0d3c4358a47aac2ac19f873 (patch)
treec5680abfc8250cce6edd624b30571b2907d91589 /docs/userguide
parentc3949144ecd32e7152ba89a45795d7ca401d5d50 (diff)
Yardstick input for Release central doc
This change adds a file, userguide.rst, that will be used by the release central document as a summary of the Yardstick Project. This file shall not be included in the index of the userguide. The file has been renamed to testusage.rst, as per request. Change-Id: Id8099349a7e626be3d800499bf98171d23239ded Signed-off-by: Ana C <ana.cunha@ericsson.com>
Diffstat (limited to 'docs/userguide')
-rw-r--r--docs/userguide/testusage.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/userguide/testusage.rst b/docs/userguide/testusage.rst
new file mode 100644
index 000000000..ee68226ad
--- /dev/null
+++ b/docs/userguide/testusage.rst
@@ -0,0 +1,37 @@
+.. 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.
+
+=========
+Yardstick
+=========
+
+.. _Yardstick: https://wiki.opnfv.org/yardstick
+.. _Presentation: https://wiki.opnfv.org/_media/opnfv_summit_-_yardstick_project.pdf
+.. _NFV-TST001: https://docbox.etsi.org/ISG/NFV/Open/Drafts/TST001_-_Pre-deployment_Validation/
+.. _Yardsticktst: https://wiki.opnfv.org/_media/opnfv_summit_-_bridging_opnfv_and_etsi.pdf
+
+The project's goal is to verify infrastructure compliance, from the perspective
+of a Virtual Network Function (VNF).
+
+The Project's scope is the development of a test framework, *Yardstick*, test
+cases and test stimuli to enable Network Function Virtualization Infrastructure
+(NFVI) verification.
+
+In OPNFV Brahmaputra release, generic test cases covering aspects of the
+metrics in the document ETSI GS NFV-TST001_, "Pre-deployment Testing; Report on
+Validation of NFV Environments and Services" are available; further OPNFV
+releases will provide extended testing of these metrics.
+
+The Project also includes a sample VNF, the Virtual Traffic Classifier (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:: This Presentation_ for an overview of *Yardstick* and
+ Yardsticktst_ for material on alignment ETSI TST001 and Yardstick.