kata-containers/tests/metrics/network/README.md
Gabriela Cervantes 9166d0aabb docs: Update iperf3 network documentation
This PR updates the iperf3 network documentation to include
the parallel bandwidth.

Fixes #8523

Signed-off-by: Gabriela Cervantes <gabriela.cervantes.tellez@intel.com>
2023-11-28 15:59:38 +00:00

25 lines
1010 B
Markdown

# Kata Containers network metrics
Kata Containers provides a series of network performance tests. Running these provides a basic reference for measuring network essentials like
bandwidth, jitter, latency and parallel bandwidth.
## Performance tools
- `iperf3` measures bandwidth, jitter, CPU usage, parallel bandwidth and the quality of a network link.
## Networking tests
- `k8s-network-metrics-iperf3.sh` measures bandwidth which is the speed of the data transfer.
- `latency-network.sh` measures network latency.
- `nginx-network.sh` is a benchmark of the lightweight Nginx HTTPS web-server and measures the HTTP requests over a fixed period of time with a configurable number of concurrent clients/connections.
- `k8s-network-metrics-iperf3-udp.sh` measures `UDP` bandwidth and parallel bandwidth which is the speed of the data transfer.
## Running the tests
Individual tests can be run by hand, for example:
```
$ cd metrics
$ bash network/iperf3_kubernetes/k8s-network-metrics-iperf3.sh -b
```