Merge "Add Storperf in CI [work in progress]"
[yardstick.git] / docs / userguide / opnfv_yardstick_tc044.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 TC044
8 *************************************
9
10 .. _man-pages: http://manpages.ubuntu.com/manpages/trusty/en/man1/free.1.html
11
12 +-----------------------------------------------------------------------------+
13 |Memory Utilization                                                           |
14 |                                                                             |
15 +--------------+--------------------------------------------------------------+
16 |test case id  | OPNFV_YARDSTICK_TC044_Memory Utilization                     |
17 |              |                                                              |
18 +--------------+--------------------------------------------------------------+
19 |metric        | Memory utilization                                           |
20 |              |                                                              |
21 +--------------+--------------------------------------------------------------+
22 |test purpose  | To evaluate the IaaS compute capability with regards to      |
23 |              | memory utilization.This test case should be run in parallel  |
24 |              | to other Yardstick test cases and not run as a stand-alone   |
25 |              | test case.                                                   |
26 |              | Measure the memory usage statistics including used memory,   |
27 |              | free memory, buffer, cache and shared memory.                |
28 |              | Both average and maximun values are obtained.                |
29 |              | The purpose is also to be able to spot trends.               |
30 |              | Test results, graphs and similar shall be stored for         |
31 |              | comparison reasons and product evolution understanding       |
32 |              | between different OPNFV versions and/or configurations.      |
33 |              |                                                              |
34 +--------------+--------------------------------------------------------------+
35 |configuration | File: memload.yaml (in the 'samples' directory)              |
36 |              |                                                              |
37 |              | * interval: 1 - repeat, pausing every 1 seconds in-between.  |
38 |              | * count: 10 - display statistics 10 times, then exit.        |
39 |              |                                                              |
40 +--------------+--------------------------------------------------------------+
41 |test tool     | free                                                         |
42 |              |                                                              |
43 |              | free provides information about unused and used memory and   |
44 |              | swap space on any computer running Linux or another Unix-like|
45 |              | operating system.                                            |
46 |              | free is normally part of a Linux distribution, hence it      |
47 |              | doesn't needs to be installed.                               |
48 |              |                                                              |
49 +--------------+--------------------------------------------------------------+
50 |references    | man-pages_                                                   |
51 |              |                                                              |
52 |              | ETSI-NFV-TST001                                              |
53 |              |                                                              |
54 +--------------+--------------------------------------------------------------+
55 |applicability | Test can be configured with different:                       |
56 |              |                                                              |
57 |              |  * interval;                                                 |
58 |              |  * count;                                                    |
59 |              |  * runner Iteration and intervals.                           |
60 |              |                                                              |
61 |              | There are default values for each above-mentioned option.    |
62 |              | Run in background with other test cases.                     |
63 |              |                                                              |
64 +--------------+--------------------------------------------------------------+
65 |pre-test      | The test case image needs to be installed into Glance        |
66 |conditions    | with free included in the image.                             |
67 |              |                                                              |
68 |              | No POD specific requirements have been identified.           |
69 |              |                                                              |
70 +--------------+--------------------------------------------------------------+
71 |test sequence | description and expected result                              |
72 |              |                                                              |
73 +--------------+--------------------------------------------------------------+
74 |step 1        | The host is installed as client. The related TC, or TCs, is  |
75 |              | invoked and free logs are produced and stored.               |
76 |              |                                                              |
77 |              | Result: logs are stored.                                     |
78 |              |                                                              |
79 +--------------+--------------------------------------------------------------+
80 |test verdict  | None. Memory utilization results are fetched and stored.     |
81 |              |                                                              |
82 +--------------+--------------------------------------------------------------+