aboutsummaryrefslogtreecommitdiffstats
path: root/docs/testing/user/userguide/01-introduction.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/testing/user/userguide/01-introduction.rst')
-rwxr-xr-xdocs/testing/user/userguide/01-introduction.rst51
1 files changed, 32 insertions, 19 deletions
diff --git a/docs/testing/user/userguide/01-introduction.rst b/docs/testing/user/userguide/01-introduction.rst
index 0e0eea002..63d0d9883 100755
--- a/docs/testing/user/userguide/01-introduction.rst
+++ b/docs/testing/user/userguide/01-introduction.rst
@@ -12,6 +12,7 @@ Introduction
.. _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
@@ -37,36 +38,49 @@ About This Document
This document consists of the following chapters:
+* Chapter :doc:`01-introduction` provides a brief introduction to *Yardstick*
+ project's background and describes the structure of this document.
+
* Chapter :doc:`02-methodology` describes the methodology implemented by the
- Yardstick Project for :term:`NFVI` verification.
+ *Yardstick* Project for :term:`NFVI` verification.
* Chapter :doc:`03-architecture` provides information on the software architecture
- of yardstick.
+ of *Yardstick*.
-* Chapter :doc:`04-vtc-overview` provides information on the :term:`VTC`.
+* Chapter :doc:`04-installation` provides instructions to install *Yardstick*.
-* Chapter :doc:`05-apexlake_installation` provides instructions to install the
- experimental framework *ApexLake*
+* Chapter :doc:`05-yardstick_plugin` provides information on how to integrate
+ other OPNFV testing projects into *Yardstick*.
-* Chapter :doc:`06-apexlake_api` explains how this framework is integrated in
- *Yardstick*.
+* Chapter :doc:`06-result-store-InfluxDB` provides inforamtion on how to run
+ plug-in test cases and store test results into community's InfluxDB.
-* 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:`07-grafana` provides inforamtion on *Yardstick* grafana dashboard
+ and how to add a dashboard into *Yardstick* grafana dashboard.
-* Chapter :doc:`08-nsb_installation` provides instructions to install
- *Yardstick - Network service benchmarking testing*.
+* Chapter :doc:`08-api` provides inforamtion on *Yardstick* ReST API and how to
+ use *Yardstick* API.
-* Chapter :doc:`09-installation` provides instructions to install *Yardstick*.
+* Chapter :doc:`09-yardstick_user_interface` provides inforamtion on how to use
+ yardstick report CLI to view the test result in table format and also values
+ pinned on to a graph
-* Chapter :doc:`10-yardstick_plugin` provides information on how to integrate
- other OPNFV testing projects into *Yardstick*.
+* Chapter :doc:`10-vtc-overview` provides information on the :term:`VTC`.
-* 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:`11-apexlake_installation` provides instructions to install the
+ experimental framework *ApexLake*
+
+* Chapter :doc:`12-apexlake_api` explains how this framework is integrated in
+ *Yardstick*.
-* Chapter :doc:`12-list-of-tcs` includes a list of available Yardstick test
+* Chapter :doc:`13-nsb-overview` describes the methodology implemented by the
+ Yardstick - Network service benchmarking to test real world usecase for a
+ given VNF.
+
+* Chapter :doc:`14-nsb_installation` provides instructions to install
+ *Yardstick - Network service benchmarking testing*.
+
+* Chapter :doc:`15-list-of-tcs` includes a list of available *Yardstick* test
cases.
@@ -76,4 +90,3 @@ Contact Yardstick
Feedback? `Contact us`_
.. _Contact us: opnfv-users@lists.opnfv.org
-