Doc for Xreview by other test projects
[yardstick.git] / docs / userguide / opnfv_yardstick_tc073.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 TC073
8 *************************************
9
10 .. _netperf: http://www.netperf.org/netperf/training/Netperf.html
11
12 +-----------------------------------------------------------------------------+
13 |Throughput per NFVI node test                                                |
14 |                                                                             |
15 +--------------+--------------------------------------------------------------+
16 |test case id  | OPNFV_YARDSTICK_TC073_Network latency and throughput between |
17 |              | nodes                                                        |
18 |              |                                                              |
19 +--------------+--------------------------------------------------------------+
20 |metric        | Network latency and throughput                               |
21 |              |                                                              |
22 +--------------+--------------------------------------------------------------+
23 |test purpose  | To evaluate the IaaS network performance with regards to     |
24 |              | flows and throughput, such as if and how different amounts   |
25 |              | of packet sizes and flows matter for the throughput between  |
26 |              | nodes in one pod.                                            |
27 |              |                                                              |
28 +--------------+--------------------------------------------------------------+
29 |configuration | file: opnfv_yardstick_tc073.yaml                             |
30 |              |                                                              |
31 |              | Packet size: default 1024 bytes.                             |
32 |              |                                                              |
33 |              | Test length: default 20 seconds.                             |
34 |              |                                                              |
35 |              | The client and server are distributed on different nodes.    |
36 |              |                                                              |
37 |              | For SLA max_mean_latency is set to 100.                      |
38 |              |                                                              |
39 +--------------+--------------------------------------------------------------+
40 |test tool     | netperf                                                      |
41 |              | Netperf is a software application that provides network      |
42 |              | bandwidth testing between two hosts on a network. It         |
43 |              | supports Unix domain sockets, TCP, SCTP, DLPI and UDP via    |
44 |              | BSD Sockets. Netperf provides a number of predefined tests   |
45 |              | e.g. to measure bulk (unidirectional) data transfer or       |
46 |              | request response performance.                                |
47 |              | (netperf is not always part of a Linux distribution, hence   |
48 |              | it needs to be installed.)                                   |
49 |              |                                                              |
50 +--------------+--------------------------------------------------------------+
51 |references    | netperf Man pages                                            |
52 |              | ETSI-NFV-TST001                                              |
53 |              |                                                              |
54 +--------------+--------------------------------------------------------------+
55 |applicability | Test can be configured with different packet sizes and       |
56 |              | test duration. Default values exist.                         |
57 |              |                                                              |
58 |              | SLA (optional): max_mean_latency                             |
59 |              |                                                              |
60 +--------------+--------------------------------------------------------------+
61 |pre-test      | The POD can be reached by external ip and logged on via ssh  |
62 |conditions    |                                                              |
63 +--------------+--------------------------------------------------------------+
64 |test sequence | description and expected result                              |
65 |              |                                                              |
66 +--------------+--------------------------------------------------------------+
67 |step 1        | Install netperf tool on each specified node, one is as the   |
68 |              | server, and the other as the client.                         |
69 |              |                                                              |
70 +--------------+--------------------------------------------------------------+
71 |step 2        | Log on to the client node and use the netperf command to     |
72 |              | execute the network performance test                         |
73 |              |                                                              |
74 +--------------+--------------------------------------------------------------+
75 |step 3        | The throughput results stored.                               |
76 |              |                                                              |
77 +--------------+--------------------------------------------------------------+
78 |test verdict  | Fails only if SLA is not passed, or if there is a test case  |
79 |              | execution problem.                                           |
80 |              |                                                              |
81 +--------------+--------------------------------------------------------------+