@@ -23,14 +23,18 @@ The default was further reverted to GRPC in Lima v1.1, as the stability issues w
2323
2424### Using SSH
2525
26- SSH based port forwarding is the legacy mode that was previously default.
26+ SSH based port forwarding was previously the default mode .
2727
2828To explicitly use SSH forwarding use the below command
2929
3030``` bash
3131LIMA_SSH_PORT_FORWARDER=true limactl start
3232```
3333
34+ #### Advantages
35+
36+ - Outperforms GRPC when VSOCK is available
37+
3438#### Caveats
3539
3640- Doesn't support UDP based port forwarding
@@ -67,15 +71,17 @@ LIMA_SSH_PORT_FORWARDER=false limactl start
6771#### Advantages
6872
6973- Supports both TCP and UDP based port forwarding
70- - Performs faster compared to SSH based forwarding
74+ - Performs faster compared to SSH based forwarding, when VSOCK is not available
7175- No additional child process for port forwarding
7276
7377### Benchmarks
7478
75- | Use case | GRPC | SSH |
76- | -------------| ----------------| ----------------|
77- | TCP | 3.80 Gbits/sec | 3.38 Gbits/sec |
78- | TCP Reverse | 4.77 Gbits/sec | 3.08 Gbits/sec |
79+ <!-- When updating the benchmark result, make sure to update the benchmarking environment too -->
80+
81+ | Use case | GRPC | ** SSH (w/ VSOCK)** | SSH (w/o VSOCK) |
82+ | -------------| ----------------| --------------------| -----------------|
83+ | TCP | 5.37 Gbits/sec | 6.32 Gbits/sec | 4.06 Gbits/sec |
84+ | TCP Reverse | 7.11 Gbits/sec | 7.47 Gbits/sec | 3.84 Gbits/sec |
7985
8086The benchmarks detail above are obtained using the following commands
8187
@@ -84,7 +90,22 @@ Host -> limactl start vz
8490
8591VZ Guest -> iperf3 -s
8692
87- Host -> iperf3 -c 127.0.0.1 //Benchmark for TCP
88- Host -> iperf3 -c 127.0.0.1 -R //Benchmark for TCP Reverse
93+ Host -> iperf3 -c 127.0.0.1 //Benchmark for TCP (average of "sender" and "receiver")
94+ Host -> iperf3 -c 127.0.0.1 -R //Benchmark for TCP Reverse (same as above)
8995```
9096
97+ <details >
98+ <summary >Benchmarking environment</summary >
99+ <p >
100+
101+ - Lima version: 2.0.0-alpha.2
102+ - Guest: Ubuntu 25.04
103+ - OpenSSH 9.9p1
104+ - iperf 3.18
105+ - Host: macOS 26.0.1
106+ - OpenSSH 10.0p2
107+ - iperf 3.19.1 (Homebrew)
108+ - Hardware: MacBook Pro 2024 (M4 Max, 128 GiB)
109+
110+ </p >
111+ </details >
0 commit comments