Skip to content

docs/port.md: update #574

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
AkihiroSuda merged 1 commit into from
Apr 7, 2026
+7 −6
Merged

docs/port.md: update #574

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
13 changes: 7 additions & 6 deletions docs/port.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,19 @@ The default value is `none` (do not expose ports).
| `--port-driver` | Throughput | Source IP | Notes
|----------------------|-------------|----------|-------
| `slirp4netns` | 9.78 Gbps | Propagated |
| `builtin` | 35.6 Gbps | Always 127.0.0.1 |
| `gvisor-tap-vsock` (Experimental) | 3.99 Gbps | Propagated | Throughput is currently limited; see issue link below for improvement ideas.
| `builtin` | 35.6 Gbps | Propagated (since v3.0) | In the case of Rootless Docker, userland-proxy has to be disabled for propagating the source IP.
| `gvisor-tap-vsock` (Experimental) | 3.99 Gbps | Not propagated | Throughput is currently limited; see issue link below for improvement ideas.

Benchmark: iperf3 from the parent to the child is measured on GitHub Actions

The `builtin` driver is fast, but be aware that the source IP is not propagated and always set to 127.0.0.1.
The `builtin` driver is fast and should be the best choice for most use cases.

For [`pasta`](./network.md) networks, the `implicit` port driver is the best choice.

For [`gVisor TAP/vsock`](https://github.com/containers/gvisor-tap-vsock) based networks, use the `gvisor-tap-vsock` port driver.

> Note: The `gvisor-tap-vsock` port driver is experimental. Current throughput is known to be slower than other drivers. We are tracking ideas for improving throughput here: https://github.com/rootless-containers/rootlesskit/issues/529
> [!NOTE]
> The `gvisor-tap-vsock` port driver is experimental.
> - Source IP is not propagated: https://github.com/rootless-containers/rootlesskit/issues/573
> - Current throughput is known to be slower than other drivers. We are tracking ideas for improving throughput here: https://github.com/rootless-containers/rootlesskit/issues/529

* To be documented: [`bypass4netns`](https://github.com/rootless-containers/bypass4netns) for native performance.

Expand Down