diff options
Diffstat (limited to 'docs/testing/user/userguide')
| -rw-r--r-- | docs/testing/user/userguide/Yardstick_user_interface.rst | 29 | ||||
| -rw-r--r-- | docs/testing/user/userguide/opnfv_yardstick_tc076.rst | 63 |
2 files changed, 82 insertions, 10 deletions
diff --git a/docs/testing/user/userguide/Yardstick_user_interface.rst b/docs/testing/user/userguide/Yardstick_user_interface.rst new file mode 100644 index 000000000..9058dd46d --- /dev/null +++ b/docs/testing/user/userguide/Yardstick_user_interface.rst @@ -0,0 +1,29 @@ +Yardstick User Interface +======================== + +This interface provides a user to view the test result +in table format and also values pinned on to a graph. + + +Command +------- +:: + + yardstick report generate <task-ID> <testcase-filename> + + +Description +----------- + +1. When the command is triggered using the task-id and the testcase +name provided the respective values are retrieved from the +database (influxdb in this particular case). + +2. The values are then formatted and then provided to the html +template framed with complete html body using Django Framework. + +3. Then the whole template is written into a html file. + +The graph is framed with Timestamp on x-axis and output values +(differ from testcase to testcase) on y-axis with the help of +"Highcharts". diff --git a/docs/testing/user/userguide/opnfv_yardstick_tc076.rst b/docs/testing/user/userguide/opnfv_yardstick_tc076.rst index ac7bde794..1e7647fa6 100644 --- a/docs/testing/user/userguide/opnfv_yardstick_tc076.rst +++ b/docs/testing/user/userguide/opnfv_yardstick_tc076.rst @@ -19,14 +19,20 @@ Yardstick Test Case Description TC076 | | TCP segment error rate and UDP datagram error rate | | | | +--------------+--------------------------------------------------------------+ -|test purpose | Monitor network metrics provided by the kernel in a host and | -| | calculate IP datagram error rate, ICMP message error rate, | -| | TCP segment error rate and UDP datagram error rate. | +|test purpose | The purpose of TC076 is to evaluate the IaaS network | +| | reliability with regards to IP datagram error rate, ICMP | +| | message error rate, TCP segment error rate and UDP datagram | +| | error rate. | | | | -+--------------+--------------------------------------------------------------+ -|configuration | file: opnfv_yardstick_tc076.yaml | +| | TC076 monitors network metrics provided by the Linux kernel | +| | in a host and calculates IP datagram error rate, ICMP | +| | message error rate, TCP segment error rate and UDP datagram | +| | error rate. | | | | -| | There is no additional configuration to be set for this TC. | +| | The purpose is also to be able to spot the trends. | +| | Test results, graphs and similar shall be stored for | +| | comparison reasons and product evolution understanding | +| | between different OPNFV versions and/or configurations. | | | | +--------------+--------------------------------------------------------------+ |test tool | nstat | @@ -34,6 +40,25 @@ Yardstick Test Case Description TC076 | | nstat is a simple tool to monitor kernel snmp counters and | | | network interface statistics. | | | | +| | (nstat is not always part of a Linux distribution, hence it | +| | needs to be installed. nstat is provided by the iproute2 | +| | collection, which is usually also the name of the package in | +| | many Linux distributions.As an example see the | +| | /yardstick/tools/ directory for how to generate a Linux | +| | image with iproute2 included.) | +| | | ++--------------+--------------------------------------------------------------+ +|test | Ping packets (ICMP protocol's mandatory ECHO_REQUEST | +|description | datagram) are sent from host VM to target VM(s) to elicit | +| | ICMP ECHO_RESPONSE. | +| | | +| | nstat is invoked on the target vm to monitors network | +| | metrics provided by the Linux kernel. | ++--------------+--------------------------------------------------------------+ +|configuration | file: opnfv_yardstick_tc076.yaml | +| | | +| | There is no additional configuration to be set for this TC. | +| | | +--------------+--------------------------------------------------------------+ |references | nstat man page | | | | @@ -43,19 +68,37 @@ Yardstick Test Case Description TC076 |applicability | This test case is mainly for monitoring network metrics. | | | | +--------------+--------------------------------------------------------------+ -|pre_test | | -|conditions | | +|pre_test | The test case image needs to be installed into Glance | +|conditions | with fio included in it. | +| | | +| | No POD specific requirements have been identified. | | | | +--------------+--------------------------------------------------------------+ |test sequence | description and expected result | | | | +--------------+--------------------------------------------------------------+ -|step 1 | The pod is available. | -| | Nstat is invoked and logs are produced and stored. | +|step 1 | Two host VMs are booted, as server and client. | +| | | ++--------------+--------------------------------------------------------------+ +|step 2 | Yardstick is connected with the server VM by using ssh. | +| | 'ping_benchmark' bash script is copyied from Jump Host to | +| | the server VM via the ssh tunnel. | +| | | ++--------------+--------------------------------------------------------------+ +|step 3 | Ping is invoked. Ping packets are sent from server VM to | +| | client VM. RTT results are calculated and checked against | +| | the SLA. nstat is invoked on the client vm to monitors | +| | network metrics provided by the Linux kernel. IP datagram | +| | error rate, ICMP message error rate, TCP segment error rate | +| | and UDP datagram error rate are calculated. | +| | Logs are produced and stored. | | | | | | Result: Logs are stored. | | | | +--------------+--------------------------------------------------------------+ +|step 4 | Two host VMs are deleted. | +| | | ++--------------+--------------------------------------------------------------+ |test verdict | None. | | | | +--------------+--------------------------------------------------------------+ |