summaryrefslogtreecommitdiffstats
path: root/docs/source/index.rst
blob: 0a77ac03d0b8c1c70d47bec9a74bc121b8b975f4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
.. OPNFV Yardstick documentation master file.
   Add chapters and user guides using the
   root `toctree` directive.

.. image:: ../etc/opnfv-logo.png
  :height: 40
  :width: 200
  :alt: OPNFV
  :align: left

=================
Yardstick Project
=================

Welcome to Yardstick's documentation !

.. _Yardstick: https://wiki.opnfv.org/yardstick

Yardstick_ is an OPNFV testing project.

The project goal is to verify infrastructure compliance, from the perspective
of a VNF.

The project scope is the development of a test framework, test cases and test
stimuli.

This document introduces the methodology applied in Yardstick_ project, which
decomposes typical VNF work-load performance metrics into a number of
characteristics/performance vectors, each of them can be represented by
distinct test-cases.

The user guides and test cases delivered for the release are included.

Contents:

Yardstick Project Description
=============================

.. toctree::
   :numbered:
   :maxdepth: 2

User Guides
===========

.. toctree::
    :maxdepth: 1

    user_guides/framework/03-installation

Indices
=======

* :ref:`search`

Revision: _sha1_

Build date: |today|