Refactor KMT Readme

[mbertrone]

What does this PR do?

This PR provides a comprehensive rewrite of the README for the Kernel Matrix Testing (KMT). The primary goal is to improve the documentation's clarity, structure, and overall user-friendliness for both new and existing users.

Key changes include:
A new Structure:

• A Table of Contents for quick navigation.
• Separate Quick Start guides for local, remote, and mixed (local + remote) VM setups.
• A Core Concepts section to explain fundamental ideas like stacks and vmsets.
• Command Reference with dedicated sections for each kmt task.

Motivation

Provide to developers a better User Experience when using this documentation.

Describe how you validated your changes

Documentation changes only

Possible Drawbacks / Trade-offs

Additional Notes

[cit-pr-commenter]

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 1c487fd8-7b9a-4687-bc6b-d57f60ad6a9d

Baseline: 403e498
Comparison: 496c57a
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf	experiment	goal	Δ mean %	Δ mean % CI	trials	links
➖	quality_gate_logs	% cpu utilization	+3.07	[+0.28, +5.87]	1	Logs bounds checks dashboard
➖	ddot_metrics	memory utilization	+0.55	[+0.44, +0.67]	1	Logs
➖	uds_dogstatsd_20mb_12k_contexts_20_senders	memory utilization	+0.26	[+0.22, +0.31]	1	Logs
➖	otlp_ingest_metrics	memory utilization	+0.14	[-0.03, +0.31]	1	Logs
➖	file_to_blackhole_0ms_latency_http1	egress throughput	+0.12	[-0.45, +0.69]	1	Logs
➖	uds_dogstatsd_to_api_cpu	% cpu utilization	+0.11	[-0.78, +1.00]	1	Logs
➖	docker_containers_memory	memory utilization	+0.05	[-0.03, +0.14]	1	Logs
➖	file_to_blackhole_100ms_latency	egress throughput	+0.05	[-0.55, +0.65]	1	Logs
➖	file_to_blackhole_0ms_latency	egress throughput	+0.03	[-0.54, +0.60]	1	Logs
➖	file_to_blackhole_1000ms_latency_linear_load	egress throughput	+0.02	[-0.22, +0.25]	1	Logs
➖	uds_dogstatsd_to_api	ingress throughput	+0.00	[-0.27, +0.27]	1	Logs
➖	tcp_dd_logs_filter_exclude	ingress throughput	-0.00	[-0.02, +0.02]	1	Logs
➖	file_to_blackhole_1000ms_latency	egress throughput	-0.01	[-0.61, +0.59]	1	Logs
➖	file_to_blackhole_0ms_latency_http2	egress throughput	-0.02	[-0.58, +0.53]	1	Logs
➖	file_to_blackhole_300ms_latency	egress throughput	-0.03	[-0.61, +0.55]	1	Logs
➖	quality_gate_idle	memory utilization	-0.04	[-0.10, +0.02]	1	Logs bounds checks dashboard
➖	file_to_blackhole_500ms_latency	egress throughput	-0.05	[-0.66, +0.55]	1	Logs
➖	file_tree	memory utilization	-0.05	[-0.19, +0.08]	1	Logs
➖	otlp_ingest_logs	memory utilization	-0.19	[-0.31, -0.06]	1	Logs
➖	ddot_logs	memory utilization	-0.25	[-0.34, -0.16]	1	Logs
➖	quality_gate_idle_all_features	memory utilization	-0.25	[-0.32, -0.18]	1	Logs bounds checks dashboard
➖	tcp_syslog_to_blackhole	ingress throughput	-0.45	[-0.51, -0.40]	1	Logs
➖	docker_containers_cpu	% cpu utilization	-0.67	[-3.68, +2.33]	1	Logs

Bounds Checks: ✅ Passed

perf	experiment	bounds_check_name	replicates_passed	links
✅	docker_containers_cpu	simple_check_run	10/10
✅	docker_containers_memory	memory_usage	10/10
✅	docker_containers_memory	simple_check_run	10/10
✅	file_to_blackhole_0ms_latency	lost_bytes	10/10
✅	file_to_blackhole_0ms_latency	memory_usage	10/10
✅	file_to_blackhole_0ms_latency_http1	lost_bytes	10/10
✅	file_to_blackhole_0ms_latency_http1	memory_usage	10/10
✅	file_to_blackhole_0ms_latency_http2	lost_bytes	10/10
✅	file_to_blackhole_0ms_latency_http2	memory_usage	10/10
✅	file_to_blackhole_1000ms_latency	memory_usage	10/10
✅	file_to_blackhole_1000ms_latency_linear_load	memory_usage	10/10
✅	file_to_blackhole_100ms_latency	lost_bytes	10/10
✅	file_to_blackhole_100ms_latency	memory_usage	10/10
✅	file_to_blackhole_300ms_latency	lost_bytes	10/10
✅	file_to_blackhole_300ms_latency	memory_usage	10/10
✅	file_to_blackhole_500ms_latency	lost_bytes	10/10
✅	file_to_blackhole_500ms_latency	memory_usage	10/10
✅	quality_gate_idle	intake_connections	10/10	bounds checks dashboard
✅	quality_gate_idle	memory_usage	10/10	bounds checks dashboard
✅	quality_gate_idle_all_features	intake_connections	10/10	bounds checks dashboard
✅	quality_gate_idle_all_features	memory_usage	10/10	bounds checks dashboard
✅	quality_gate_logs	intake_connections	10/10	bounds checks dashboard
✅	quality_gate_logs	lost_bytes	10/10	bounds checks dashboard
✅	quality_gate_logs	memory_usage	10/10	bounds checks dashboard

Explanation

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

Performance changes are noted in the perf column of each table:

• ✅ = significantly better comparison variant performance
• ❌ = significantly worse comparison variant performance
• ➖ = no significant change in performance

A regression test is an A/B test of target performance in a repeatable rig, where "performance" is measured as "comparison variant minus baseline variant" for an optimization goal (e.g., ingress throughput). Due to intrinsic variability in measuring that goal, we can only estimate its mean value for each experiment; we report uncertainty in that value as a 90.00% confidence interval denoted "Δ mean % CI".

For each experiment, we decide whether a change in performance is a "regression" -- a change worth investigating further -- if all of the following criteria are true:

1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

2. Its 90.00% confidence interval "Δ mean % CI" does not contain zero, indicating that if our statistical model is accurate, there is at least a 90.00% chance there is a difference in performance between baseline and comparison variants.

3. Its configuration does not mark it "erratic".

CI Pass/Fail Decision

✅ Passed. All Quality Gates passed.

• quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
• quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
• quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
• quality_gate_idle_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.
• quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
• quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.
• quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.

[agent-platform-auto-pr]

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor 403e498

Successful checks

Info

	Quality gate	Delta	On disk size (MiB)	Delta	On wire size (MiB)
✅	agent_deb_amd64	$${+0}$$	$${697.03}$$ < $${697.37}$$	$${-0.01}$$	$${176.11}$$ < $${177.03}$$
✅	agent_deb_amd64_fips	$${+0}$$	$${695.32}$$ < $${695.59}$$	$${+0.01}$$	$${175.55}$$ < $${176.51}$$
✅	agent_heroku_amd64	$${0}$$	$${358.68}$$ < $${359.67}$$	$${+0}$$	$${96.53}$$ < $${97.47}$$
✅	agent_msi	$${0}$$	$${958.85}$$ < $${959.86}$$	$${+0}$$	$${146.29}$$ < $${147.27}$$
✅	agent_rpm_amd64	$${+0}$$	$${697.02}$$ < $${697.36}$$	$${+0.01}$$	$${177.7}$$ < $${178.56}$$
✅	agent_rpm_amd64_fips	$${+0}$$	$${695.31}$$ < $${695.58}$$	$${-0.03}$$	$${177.53}$$ < $${178.43}$$
✅	agent_rpm_arm64	$${-0}$$	$${687.04}$$ < $${687.37}$$	$${-0.05}$$	$${161.07}$$ < $${161.99}$$
✅	agent_rpm_arm64_fips	$${-0}$$	$${685.44}$$ < $${685.72}$$	$${+0.07}$$	$${160.34}$$ < $${161.11}$$
✅	agent_suse_amd64	$${+0}$$	$${697.02}$$ < $${697.36}$$	$${+0.01}$$	$${177.7}$$ < $${178.56}$$
✅	agent_suse_amd64_fips	$${+0}$$	$${695.31}$$ < $${695.58}$$	$${-0.03}$$	$${177.53}$$ < $${178.43}$$
✅	agent_suse_arm64	$${-0}$$	$${687.04}$$ < $${687.37}$$	$${-0.05}$$	$${161.07}$$ < $${161.99}$$
✅	agent_suse_arm64_fips	$${-0}$$	$${685.44}$$ < $${685.72}$$	$${+0.07}$$	$${160.34}$$ < $${161.11}$$
✅	docker_agent_amd64	$${+0.01}$$	$${780.83}$$ < $${781.16}$$	$${-0}$$	$${268.8}$$ < $${269.63}$$
✅	docker_agent_arm64	$${+0.01}$$	$${794.3}$$ < $${794.62}$$	$${+0}$$	$${256.16}$$ < $${257.0}$$
✅	docker_agent_jmx_amd64	$${+0.01}$$	$${972.02}$$ < $${972.35}$$	$${-0}$$	$${337.76}$$ < $${338.6}$$
✅	docker_agent_jmx_arm64	$${+0.01}$$	$${974.09}$$ < $${974.41}$$	$${-0}$$	$${321.1}$$ < $${321.97}$$
✅	docker_agent_windows1809	$${+0}$$	$${1486.99}$$ < $${1488.0}$$	$${-0.05}$$	$${488.06}$$ < $${488.95}$$
✅	docker_agent_windows1809_core	$${-0}$$	$${6216.95}$$ < $${6218.0}$$	$${0}$$	$${2048.0}$$ < $${2049.0}$$
✅	docker_agent_windows1809_core_jmx	$${+0.2}$$	$${6338.72}$$ < $${6361.0}$$	$${0}$$	$${2048.0}$$ < $${2049.0}$$
✅	docker_agent_windows1809_jmx	$${+0}$$	$${1608.62}$$ < $${1609.5}$$	$${-0.06}$$	$${530.26}$$ < $${531.32}$$
✅	docker_agent_windows2022	$${-0.08}$$	$${1506.14}$$ < $${1507.0}$$	$${-0.05}$$	$${500.74}$$ < $${501.7}$$
✅	docker_agent_windows2022_core	$${-0.21}$$	$${6190.01}$$ < $${6311.0}$$	$${0}$$	$${2048.0}$$ < $${2049.0}$$
✅	docker_agent_windows2022_core_jmx	$${-0.27}$$	$${6311.42}$$ < $${6313.0}$$	$${0}$$	$${2048.0}$$ < $${2049.0}$$
✅	docker_agent_windows2022_jmx	$${-0.13}$$	$${1627.87}$$ < $${1628.16}$$	$${-0}$$	$${543.06}$$ < $${543.98}$$
✅	docker_cluster_agent_amd64	$${+0.01}$$	$${212.85}$$ < $${213.79}$$	$${+0.01}$$	$${72.39}$$ < $${73.33}$$
✅	docker_cluster_agent_arm64	$${+0.01}$$	$${228.69}$$ < $${229.64}$$	$${+0.01}$$	$${68.65}$$ < $${69.6}$$
✅	docker_cws_instrumentation_amd64	$${0}$$	$${7.08}$$ < $${7.12}$$	$${-0}$$	$${2.95}$$ < $${3.29}$$
✅	docker_cws_instrumentation_arm64	$${0}$$	$${6.69}$$ < $${6.92}$$	$${-0}$$	$${2.7}$$ < $${3.07}$$
✅	docker_dogstatsd_amd64	$${-0}$$	$${39.22}$$ < $${39.57}$$	$${+0}$$	$${15.12}$$ < $${15.76}$$
✅	docker_dogstatsd_arm64	$${+0}$$	$${37.88}$$ < $${38.2}$$	$${+0}$$	$${14.53}$$ < $${14.83}$$
✅	dogstatsd_deb_amd64	$${0}$$	$${30.45}$$ < $${31.4}$$	$${+0}$$	$${8.0}$$ < $${8.95}$$
✅	dogstatsd_deb_arm64	$${0}$$	$${29.02}$$ < $${29.97}$$	$${+0}$$	$${6.94}$$ < $${7.89}$$
✅	dogstatsd_rpm_amd64	$${0}$$	$${30.45}$$ < $${31.4}$$	$${-0}$$	$${8.01}$$ < $${8.96}$$
✅	dogstatsd_suse_amd64	$${0}$$	$${30.45}$$ < $${31.4}$$	$${-0}$$	$${8.01}$$ < $${8.96}$$
✅	iot_agent_deb_amd64	$${0}$$	$${50.44}$$ < $${51.38}$$	$${-0}$$	$${12.84}$$ < $${13.79}$$
✅	iot_agent_deb_arm64	$${0}$$	$${47.91}$$ < $${48.85}$$	$${-0}$$	$${11.14}$$ < $${12.09}$$
✅	iot_agent_deb_armhf	$${0}$$	$${47.48}$$ < $${48.42}$$	$${+0.01}$$	$${11.21}$$ < $${12.16}$$
✅	iot_agent_rpm_amd64	$${0}$$	$${50.44}$$ < $${51.38}$$	$${+0}$$	$${12.86}$$ < $${13.81}$$
✅	iot_agent_rpm_arm64	$${0}$$	$${47.91}$$ < $${48.85}$$	$${+0}$$	$${11.16}$$ < $${12.11}$$
✅	iot_agent_suse_amd64	$${0}$$	$${50.44}$$ < $${51.38}$$	$${+0}$$	$${12.86}$$ < $${13.81}$$

[usamasaqib]

Looks good! Provided a few more suggestions.

[mbertrone]

/merge

[dd-devflow]

View all feedbacks in Devflow UI.

2025-06-19 12:58:19 UTC ℹ️ Start processing command /merge

---

2025-06-19 12:58:25 UTC ℹ️ MergeQueue: pull request added to the queue

The expected merge time in main is approximately 1h (p90).

---

2025-06-19 13:40:21 UTC ℹ️ MergeQueue: This merge request was merged