From d82028696742969508dd0c277829f16eec4c61bf Mon Sep 17 00:00:00 2001 From: Akihiro Suda Date: Wed, 8 Oct 2025 16:53:37 +0900 Subject: [PATCH] docs: add vzNAT and lima:shared to benchmark results Signed-off-by: Akihiro Suda --- .../content/en/docs/config/network/vmnet.md | 2 ++ website/content/en/docs/config/port.md | 29 ++++++++++++++++--- 2 files changed, 27 insertions(+), 4 deletions(-) diff --git a/website/content/en/docs/config/network/vmnet.md b/website/content/en/docs/config/network/vmnet.md index 3ec2b90b905..6228bd78558 100644 --- a/website/content/en/docs/config/network/vmnet.md +++ b/website/content/en/docs/config/network/vmnet.md @@ -37,6 +37,8 @@ The range of the IP address is not specifiable. The "vzNAT" network does not need the `socket_vmnet` binary and the `sudoers` file. +The "vzNAT" network also has a significant advantage in the throughput. See the [benchmark result](../port.md#benchmarks). + ## socket_vmnet ### Managed (192.168.105.0/24) diff --git a/website/content/en/docs/config/port.md b/website/content/en/docs/config/port.md index d5b5677d144..41dff68bd89 100644 --- a/website/content/en/docs/config/port.md +++ b/website/content/en/docs/config/port.md @@ -74,14 +74,33 @@ LIMA_SSH_PORT_FORWARDER=false limactl start - Performs faster compared to SSH based forwarding, when VSOCK is not available - No additional child process for port forwarding + +## Accessing ports by IP address + +To access a guest's ports by its IP address, connect the guest to the `vzNAT` or the `lima:shared` network. + +The `vzNAT` network is extremely faster and easier to use, however, `vzNAT` is only available for [VZ](./vmtype/vz.md) guests. + +```bash +limactl start --network vzNAT +lima ip addr show lima0 +``` + +See [Config » Network » VMNet networks](./network/vmnet.md) for the further information. + ### Benchmarks -| Use case | GRPC | **SSH (w/ VSOCK)** | SSH (w/o VSOCK) | -|-------------|----------------|--------------------|-----------------| -| TCP | 5.37 Gbits/sec | 6.32 Gbits/sec | 4.06 Gbits/sec | -| TCP Reverse | 7.11 Gbits/sec | 7.47 Gbits/sec | 3.84 Gbits/sec | +| By localhost | SSH (w/o VSOCK) | GRPC | SSH (w/ VSOCK) | +|--------------|-----------------|----------------|-----------------| +| TCP | 4.06 Gbits/sec | 5.37 Gbits/sec | 6.32 Gbits/sec | +| TCP Reverse | 3.84 Gbits/sec | 7.11 Gbits/sec | 7.47 Gbits/sec | + +| By IP address | lima:shared | vzNAT | +|---------------|----------------|----------------| +| TCP | 3.46 Gbits/sec | 59.2 Gbits/sec | +| TCP Reverse | 2.35 Gbits/sec | 130 Gbits/sec | The benchmarks detail above are obtained using the following commands @@ -94,6 +113,8 @@ Host -> iperf3 -c 127.0.0.1 //Benchmark for TCP (average of "sender" and "receiv Host -> iperf3 -c 127.0.0.1 -R //Benchmark for TCP Reverse (same as above) ``` +The benchmark result, especially the throughput of vzNAT, highly depends on the performance of the hardware. +
Benchmarking environment