From 28130d3cefcfceb82b2ba451fcd433a226a6e1fb Mon Sep 17 00:00:00 2001 From: Gabriela Cervantes Date: Mon, 26 Jun 2023 16:19:28 +0000 Subject: [PATCH 1/2] docs: Add boot time metrics documentation This PR adds boot time metrics documentation for kata metrics tests. Fixes #7170 Signed-off-by: Gabriela Cervantes --- tests/metrics/time/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 tests/metrics/time/README.md diff --git a/tests/metrics/time/README.md b/tests/metrics/time/README.md new file mode 100644 index 0000000000..28aa707f74 --- /dev/null +++ b/tests/metrics/time/README.md @@ -0,0 +1,16 @@ +# Kata Containers boot time metrics +The boot time metrics test takes a number of time measurements through +the complete launch/shutdown cycle of a single container. From those +measurements it derives a number of time measures, such as: +- time to payload execution +- time to get to VM kernel +- time in VM kernel boot +- time to quit +- total time (from launch to finished) + +## Running the test +Boot time test can be run by hand, for example: +``` +$ cd metrics +$ bash time/launch_times.sh -i public.ecr.aws/ubuntu/ubuntu:latest -n 1 +``` From e45899ae0ecf55efb8eb4d6efecdec37264e0c87 Mon Sep 17 00:00:00 2001 From: Gabriela Cervantes Date: Mon, 26 Jun 2023 16:23:36 +0000 Subject: [PATCH 2/2] docs: Add time tests documentation reference This PR adds time tests documentation reference in the general README for kata metrics. Signed-off-by: Gabriela Cervantes --- tests/metrics/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tests/metrics/README.md b/tests/metrics/README.md index 4e2d118700..738b9ebb2b 100644 --- a/tests/metrics/README.md +++ b/tests/metrics/README.md @@ -48,6 +48,8 @@ boot into a workload or kill a container. This directory does *not* contain "speed" tests that measure network or storage for instance. +For further details see the [time tests documentation](time). + ### Density Tests that measure the size and overheads of the runtime. Generally this is looking at