X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Ftesting%2Fuser%2Fuserguide%2F01-introduction.rst;h=5fc2e8d0f6e04c37520babd44c714a390dcd1328;hb=0e995cf2eb30dc64cd0f24c7efc45a8fd44375f5;hp=0e0eea0028990f7f2f2d3c3d6585bcf25e3dc9a9;hpb=6f541e757283b528d8736e314b2490f28d3c2563;p=yardstick.git diff --git a/docs/testing/user/userguide/01-introduction.rst b/docs/testing/user/userguide/01-introduction.rst index 0e0eea002..5fc2e8d0f 100755 --- a/docs/testing/user/userguide/01-introduction.rst +++ b/docs/testing/user/userguide/01-introduction.rst @@ -9,9 +9,10 @@ Introduction **Welcome to Yardstick's documentation !** -.. _Pharos: https://wiki.opnfv.org/pharos -.. _Yardstick: https://wiki.opnfv.org/yardstick +.. _Pharos: https://wiki.opnfv.org/display/pharos +.. _Yardstick: https://wiki.opnfv.org/display/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 @@ -20,8 +21,6 @@ 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 @@ -37,43 +36,51 @@ 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. +* 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:`04-installation` provides instructions to install *Yardstick*. -* Chapter :doc:`05-apexlake_installation` provides instructions to install the - experimental framework *ApexLake* +* Chapter :doc:`05-operation` provides information on how to use *Yardstick* + to run and create testcases. -* Chapter :doc:`06-apexlake_api` explains how this framework is integrated in - *Yardstick*. +* Chapter :doc:`06-yardstick-plugin` provides information on how to integrate + other OPNFV testing projects into *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:`07-result-store-InfluxDB` provides inforamtion on how to run + plug-in test cases and store test results into community's InfluxDB. -* Chapter :doc:`08-nsb_installation` provides instructions to install - *Yardstick - Network service benchmarking testing*. +* Chapter :doc:`08-grafana` provides inforamtion on *Yardstick* grafana + dashboard and how to add a dashboard into *Yardstick* grafana dashboard. -* Chapter :doc:`09-installation` provides instructions to install *Yardstick*. +* Chapter :doc:`09-api` provides inforamtion on *Yardstick* ReST API and how to + use *Yardstick* API. -* Chapter :doc:`10-yardstick_plugin` provides information on how to integrate - other OPNFV testing projects into *Yardstick*. +* Chapter :doc:`10-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:`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-nsb-overview` describes the methodology implemented by the + Yardstick - Network service benchmarking to test real world usecase for a + given VNF. -* Chapter :doc:`12-list-of-tcs` includes a list of available Yardstick test - cases. +* Chapter :doc:`13-nsb-installation` provides instructions to install + *Yardstick - Network Service Benchmarking (NSB) testing*. +* Chapter :doc:`14-nsb-operation` provides information on running *NSB* + +* Chapter :doc:`15-list-of-tcs` includes a list of available *Yardstick* test + cases. Contact Yardstick ================= Feedback? `Contact us`_ -.. _Contact us: opnfv-users@lists.opnfv.org - +.. _Contact us: mailto:opnfv-users@lists.opnfv.org&subject="#yardstick"