Merge "Add grafana config for TC055_ComputeCapacity"
[yardstick.git] / docs / userguide / opnfv_yardstick_tc061.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 TC061
8 *************************************
9
10 .. _man-pages: http://linux.die.net/man/1/sar
11
12 +-----------------------------------------------------------------------------+
13 |Network Utilization                                                          |
14 |                                                                             |
15 +--------------+--------------------------------------------------------------+
16 |test case id  | OPNFV_YARDSTICK_TC061_Network Utilization                    |
17 |              |                                                              |
18 +--------------+--------------------------------------------------------------+
19 |metric        | Network utilization                                          |
20 |              |                                                              |
21 +--------------+--------------------------------------------------------------+
22 |test purpose  | To evaluate the IaaS network capability with regards to      |
23 |              | network utilization, including Total number of packets       |
24 |              | received per second, Total number of packets transmitted per |
25 |              | second, Total number of kilobytes received per second, Total |
26 |              | number of kilobytes transmitted per second, Number of        |
27 |              | compressed packets received per second (for cslip etc.),     |
28 |              | Number of compressed packets transmitted per second, Number  |
29 |              | of multicast packets received per second, Utilization        |
30 |              | percentage of the network interface.                         |
31 |              | This test case should be run in parallel to other Yardstick  |
32 |              | test cases and not run as a stand-alone test case.           |
33 |              | Measure the network usage statistics from the network devices|
34 |              | Average, minimum and maximun values are obtained.            |
35 |              | The purpose is also to be able to spot trends.               |
36 |              | Test results, graphs and similar shall be stored for         |
37 |              | comparison reasons and product evolution understanding       |
38 |              | between different OPNFV versions and/or configurations.      |
39 |              |                                                              |
40 +--------------+--------------------------------------------------------------+
41 |configuration | File: netutilization.yaml (in the 'samples' directory)       |
42 |              |                                                              |
43 |              | * interval: 1 - repeat, pausing every 1 seconds in-between.  |
44 |              | * count: 1 - display statistics 1 times, then exit.          |
45 |              |                                                              |
46 +--------------+--------------------------------------------------------------+
47 |test tool     | sar                                                          |
48 |              |                                                              |
49 |              | The sar command writes to standard output the contents of    |
50 |              | selected cumulative activity counters in the operating       |
51 |              | system.                                                      |
52 |              | sar is normally part of a Linux distribution, hence it       |
53 |              | doesn't needs to be installed.                               |
54 |              |                                                              |
55 +--------------+--------------------------------------------------------------+
56 |references    | man-pages_                                                   |
57 |              |                                                              |
58 |              | ETSI-NFV-TST001                                              |
59 |              |                                                              |
60 +--------------+--------------------------------------------------------------+
61 |applicability | Test can be configured with different:                       |
62 |              |                                                              |
63 |              |  * interval;                                                 |
64 |              |  * count;                                                    |
65 |              |  * runner Iteration and intervals.                           |
66 |              |                                                              |
67 |              | There are default values for each above-mentioned option.    |
68 |              | Run in background with other test cases.                     |
69 |              |                                                              |
70 +--------------+--------------------------------------------------------------+
71 |pre-test      | The test case image needs to be installed into Glance        |
72 |conditions    | with sar included in the image.                              |
73 |              |                                                              |
74 |              | No POD specific requirements have been identified.           |
75 |              |                                                              |
76 +--------------+--------------------------------------------------------------+
77 |test sequence | description and expected result.                             |
78 |              |                                                              |
79 +--------------+--------------------------------------------------------------+
80 |step 1        | The host is installed as client. The related TC, or TCs, is  |
81 |              | invoked and sar logs are produced and stored.                |
82 |              |                                                              |
83 |              | Result: logs are stored.                                     |
84 |              |                                                              |
85 +--------------+--------------------------------------------------------------+
86 |test verdict  | None. Network utilization results are fetched and stored.    |
87 |              |                                                              |
88 +--------------+--------------------------------------------------------------+