Merge "Add support for restarting a service"
[yardstick.git] / README.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International
2 .. License.
3 .. http://creativecommons.org/licenses/by/4.0
4 .. (c) OPNFV, Ericsson AB and others.
5
6
7 Yardstick
8 =========
9
10
11 Overview
12 --------
13
14 Yardstick is a framework to test non functional characteristics of an NFV
15 Infrastructure as perceived by an application.
16
17 An application is a set of virtual machines deployed using the orchestrator of
18 the target cloud, for example OpenStack Heat.
19
20 Yardstick measures a certain service performance but can also validate the
21 service performance to be within a certain level of agreement.
22
23 For more information on Yardstick project, please visit:
24
25     https://wiki.opnfv.org/display/yardstick/Yardstick
26     http://artifacts.opnfv.org/yardstick/docs/userguide/index.html#document-01-introduction
27
28
29 Architecture
30 ------------
31
32 Yardstick is a command line tool written in python inspired by Rally. Yardstick
33 is intended to run on a computer with access and credentials to a cloud. The
34 test case is described in a configuration file given as an argument.
35
36 How it works: the benchmark task configuration file is parsed and converted into
37 an internal model. The context part of the model is converted into a Heat
38 template and deployed into a stack. Each scenario is run using a runner, either
39 serially or in parallel. Each runner runs in its own subprocess executing
40 commands in a VM using SSH. The output of each command is written as json
41 records to a file.
42
43 For more information on Yardstick architecture, please read:
44
45     http://artifacts.opnfv.org/yardstick/docs/userguide/index.html#document-03-architecture
46
47
48 Installation
49 ------------
50
51 Yardstick supports installation on Ubuntu 14.04, OpenSUSE Leap 42.2, 42.3 and
52 Tumbleweed or via a Docker image.
53
54 To learn how to install Yardstick, consult the documentation available online
55 at:
56
57     http://artifacts.opnfv.org/yardstick/docs/userguide/index.html#document-09-installation
58
59
60 Developers
61 ----------
62 For information on how to contribute to Yardstick, please visit:
63
64     https://wiki.opnfv.org/display/yardstick/Get+started+as+a+Yardstick+developer