Commit d9494de

authored

Merge pull request #4163 from AkihiroSuda/docs-port-benchmark

docs: update port benchmark results

2 parents 5839d36 + 3ceb02c commit d9494deCopy full SHA for d9494de

File tree

1 file changed

+29

-8

lines changed

website/content/en/docs/config
- port.md

1 file changed

+29

-8

lines changed

`‎website/content/en/docs/config/port.md‎`

Lines changed: 29 additions & 8 deletions

Original file line number	Diff line number	Diff line change
`@@ -23,14 +23,18 @@ The default was further reverted to GRPC in Lima v1.1, as the stability issues w`
`23`	`23`
`24`	`24`	`### Using SSH`
`25`	`25`
`26`		`-SSH based port forwarding is the legacy mode that was previously default.`
	`26`	`+SSH based port forwarding was previously the default mode.`
`27`	`27`
`28`	`28`	`To explicitly use SSH forwarding use the below command`
`29`	`29`
`30`	`30`	```bash
`31`	`31`	`LIMA_SSH_PORT_FORWARDER=true limactl start`
`32`	`32`	```
`33`	`33`
	`34`	`+#### Advantages`
	`35`	`+`
	`36`	`+- Outperforms GRPC when VSOCK is available`
	`37`	`+`
`34`	`38`	`#### Caveats`
`35`	`39`
`36`	`40`	`- Doesn't support UDP based port forwarding`
`@@ -67,15 +71,17 @@ LIMA_SSH_PORT_FORWARDER=false limactl start`
`67`	`71`	`#### Advantages`
`68`	`72`
`69`	`73`	`- 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`
`71`	`75`	`- No additional child process for port forwarding`
`72`	`76`
`73`	`77`	`### Benchmarks`
`74`	`78`
`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 \|`
`79`	`85`
`80`	`86`	`The benchmarks detail above are obtained using the following commands`
`81`	`87`
`@@ -84,7 +90,22 @@ Host -> limactl start vz`
`84`	`90`
`85`	`91`	`VZ Guest -> iperf3 -s`
`86`	`92`
`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)`
`89`	`95`	```
`90`	`96`
	`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

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit d9494de

File tree

1 file changed

1 file changed

`‎website/content/en/docs/config/port.md‎`

0 commit comments