From 07694ef3ae8ec202e77a6010bbc4472fb5f9aa5d Mon Sep 17 00:00:00 2001 From: Gabriela Cervantes Date: Tue, 1 Aug 2023 16:49:09 +0000 Subject: [PATCH] metrics: Add Kata Containers network metrics README This PR adds the Kata Containers network metrics README. Signed-off-by: Gabriela Cervantes --- tests/metrics/network/README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 tests/metrics/network/README.md diff --git a/tests/metrics/network/README.md b/tests/metrics/network/README.md new file mode 100644 index 0000000000..c109a68411 --- /dev/null +++ b/tests/metrics/network/README.md @@ -0,0 +1,21 @@ +# 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 and the quality of a network link. + +## Networking tests + +- `k8s-network-metrics-iperf3.sh` measures 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 +```