Merge "Bugfix: specify pod.yaml files used for TC055 as TC055 is running directly...
[yardstick.git] / docs / userguide / opnfv_yardstick_tc069.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, Huawei Technologies Co.,Ltd and others.
5
6 *************************************
7 Yardstick Test Case Description TC069
8 *************************************
9
10 .. _RAMspeed: http://alasir.com/software/ramspeed/
11
12 +-----------------------------------------------------------------------------+
13 |Memory Bandwidth                                                             |
14 |                                                                             |
15 +--------------+--------------------------------------------------------------+
16 |test case id  | OPNFV_YARDSTICK_TC069_Memory Bandwidth                       |
17 |              |                                                              |
18 +--------------+--------------------------------------------------------------+
19 |metric        | Megabyte per second (MBps)                                   |
20 |              |                                                              |
21 +--------------+--------------------------------------------------------------+
22 |test purpose  | To evaluate the IaaS compute performance with regards to     |
23 |              | memory bandwidth.                                            |
24 |              | Measure the maximum possible cache and memory performance    |
25 |              | while reading and writing certain blocks of data (starting   |
26 |              | from 1Kb and further in power of 2) continuously through ALU |
27 |              | and FPU respectively.                                        |
28 |              | Measure different aspects of memory performance via synthetic|
29 |              | simulations. Each simulation consists of four performances   |
30 |              | (Copy, Scale, Add, Triad).                                   |
31 |              | Test results, graphs and similar shall be stored for         |
32 |              | comparison reasons and product evolution understanding       |
33 |              | between different OPNFV versions and/or configurations.      |
34 |              |                                                              |
35 +--------------+--------------------------------------------------------------+
36 |configuration | File: opnfv_yardstick_tc069.yaml                             |
37 |              |                                                              |
38 |              | * SLA (optional): 7000 (MBps) min_bandwidth: The minimum     |
39 |              |   amount of memory bandwidth that is accepted.               |
40 |              | * type_id: 1 - runs a specified benchmark (by an ID number): |
41 |              |     1 -- INTmark [writing]          4 -- FLOATmark [writing] |
42 |              |     2 -- INTmark [reading]          5 -- FLOATmark [reading] |
43 |              |     3 -- INTmem                     6 -- FLOATmem            |
44 |              | * block_size: 64 Megabytes - the maximum block size per array|
45 |              | * load: 32 Gigabytes - the amount of data load per pass      |
46 |              | * iterations: 5 - test is run 5   times iteratively.         |
47 |              | * interval: 1 - there is 1 second delay between each         |
48 |              |   iteration.                                                 |
49 |              |                                                              |
50 +--------------+--------------------------------------------------------------+
51 |test tool     | RAMspeed                                                     |
52 |              |                                                              |
53 |              | RAMspeed is a free open source command line utility to       |
54 |              | measure cache and memory performance of computer systems.    |
55 |              | RAMspeed is not always part of a Linux distribution, hence it|
56 |              | needs to be installed in the test image.                     |
57 |              |                                                              |
58 +--------------+--------------------------------------------------------------+
59 |references    | RAMspeed_                                                    |
60 |              |                                                              |
61 |              | ETSI-NFV-TST001                                              |
62 |              |                                                              |
63 +--------------+--------------------------------------------------------------+
64 |applicability | Test can be configured with different:                       |
65 |              |                                                              |
66 |              |  * benchmark operations (such as INTmark [writing],          |
67 |              |    INTmark [reading], FLOATmark [writing],                   |
68 |              |    FLOATmark [reading], INTmem, FLOATmem);                   |
69 |              |  * block size per array;                                     |
70 |              |  * load per pass;                                            |
71 |              |  * number of batch run iterations;                           |
72 |              |  * iterations and intervals.                                 |
73 |              |                                                              |
74 |              | There are default values for each above-mentioned option.    |
75 |              |                                                              |
76 +--------------+--------------------------------------------------------------+
77 |pre-test      | The test case image needs to be installed into Glance        |
78 |conditions    | with RAmspeed included in the image.                         |
79 |              |                                                              |
80 |              | No POD specific requirements have been identified.           |
81 |              |                                                              |
82 +--------------+--------------------------------------------------------------+
83 |test sequence | description and expected result                              |
84 |              |                                                              |
85 +--------------+--------------------------------------------------------------+
86 |step 1        | The host is installed as client. RAMspeed is invoked and logs|
87 |              | are produced and stored.                                     |
88 |              |                                                              |
89 |              | Result: logs are stored.                                     |
90 |              |                                                              |
91 +--------------+--------------------------------------------------------------+
92 |test verdict  | Test fails if the measured memory bandwidth is below the SLA |
93 |              | value or if there is a test case execution problem.          |
94 |              |                                                              |
95 +--------------+--------------------------------------------------------------+