aboutsummaryrefslogtreecommitdiffstats
path: root/INFO.yaml
diff options
context:
space:
mode:
authorJack Chan <chenjiankun1@huawei.com>2018-03-07 01:54:20 +0000
committerGerrit Code Review <gerrit@opnfv.org>2018-03-07 01:54:20 +0000
commitc5fe46b232edb3474dab8d99797dcbd8b982b447 (patch)
tree5994862f056ad4cadfe158a1609827ea71b03241 /INFO.yaml
parent67d98882489f87dfb215e5c41810cd9b5a4e8bf2 (diff)
parent9735f6b387c5fa414b2558b2a962fd6db4fb337d (diff)
Merge "Add test case sample to enable mixed network"
Diffstat (limited to 'INFO.yaml')
0 files changed, 0 insertions, 0 deletions
-weight: bold } /* Keyword.Declaration */ .highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */ .highlight .kp { color: #008800 } /* Keyword.Pseudo */ .highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */ .highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */ .highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */ .highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */ .highlight .na { color: #336699 } /* Name.Attribute */ .highlight .nb { color: #003388 } /* Name.Builtin */ .highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */ .highlight .no { color: #003366; font-weight: bold } /* Name.Constant */ .highlight .nd { color: #555555 } /* Name.Decorator */ .highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */ .highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */ .highlight .nl { color: #336699; font-style: italic } /* Name.Label */ .highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */ .highlight .py { color: #336699; font-weight: bold } /* Name.Property */ .highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #336699 } /* Name.Variable */ .highlight .ow { color: #008800 } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */ .highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */ .highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */ .highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */ .highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */ .highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */ .highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */ .highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */ .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
.. 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.

*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:`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.

* Chapter :doc:`03-architecture` provides information on the software
  architecture of *Yardstick*.

* Chapter :doc:`04-installation` provides instructions to install *Yardstick*.

* Chapter :doc:`05-operation` provides information on how to use *Yardstick*
  to run and create testcases.

* Chapter :doc:`06-yardstick-plugin` provides information on how to integrate
  other OPNFV testing projects into *Yardstick*.

* 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-grafana` provides inforamtion on *Yardstick* grafana
  dashboard and how to add a dashboard into *Yardstick* grafana dashboard.

* Chapter :doc:`09-api` provides inforamtion on *Yardstick* ReST API and how to
  use *Yardstick* API.

* 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-vtc-overview` provides information on the :term:`VTC`.

* 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:`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: mailto:opnfv-users@lists.opnfv.org&subject="[yardstick]"