Skip to content

docs: add vzNAT and lima:shared to benchmark results #4166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 9, 2025
+27 −4
Merged

docs: add vzNAT and lima:shared to benchmark results #4166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions website/content/en/docs/config/network/vmnet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
29 changes: 25 additions & 4 deletions website/content/en/docs/config/port.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

<!-- When updating the benchmark result, make sure to update the benchmarking environment too -->

| 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

Expand All @@ -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.

<details>
<summary>Benchmarking environment</summary>
<p>
Expand Down