Skip to content

Commit 7feaf5b

Browse files
committed
docs/source/markdown: Remove slirp
Signed-off-by: Lokesh Mandvekar <[email protected]>
1 parent 04e588e commit 7feaf5b

12 files changed

+18
-72
lines changed

docs/source/markdown/options/network.image.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,6 @@ considered insecure.
1515
- **ns:**_path_: path to a network namespace to join.
1616
- **private**: create a new namespace for the container (default)
1717
- **\<network name|ID\>**: Join the network with the given name or ID, e.g. use `--network mynet` to join the network with the name mynet. Only supported for rootful users.
18-
- **slirp4netns[:OPTIONS,...]**: use **slirp4netns**(1) to create a user network stack. It is possible to specify these additional options, they can also be set with `network_cmd_options` in containers.conf:
19-
- **allow_host_loopback=true|false**: Allow slirp4netns to reach the host loopback IP (default is 10.0.2.2 or the second IP from slirp4netns cidr subnet when changed, see the cidr option below). The default is false.
20-
- **mtu=MTU**: Specify the MTU to use for this network. (Default is `65520`).
21-
- **cidr=CIDR**: Specify ip range to use for this network. (Default is `10.0.2.0/24`).
22-
- **enable_ipv6=true|false**: Enable IPv6. Default is true. (Required for `outbound_addr6`).
23-
- **outbound_addr=INTERFACE**: Specify the outbound interface slirp binds to (ipv4 traffic only).
24-
- **outbound_addr=IPv4**: Specify the outbound ipv4 address slirp binds to.
25-
- **outbound_addr6=INTERFACE**: Specify the outbound interface slirp binds to (ipv6 traffic only).
26-
- **outbound_addr6=IPv6**: Specify the outbound ipv6 address slirp binds to.
2718
- **pasta[:OPTIONS,...]**: use **pasta**(1) to create a user-mode networking
2819
stack. \
2920
This is the default for rootless containers and only supported in rootless mode. \
@@ -49,13 +40,11 @@ considered insecure.
4940
- **pasta:--mtu,1500**: Specify a 1500 bytes MTU for the _tap_ interface in
5041
the container.
5142
- **pasta:--ipv4-only,-a,10.0.2.0,-n,24,-g,10.0.2.2,--dns-forward,10.0.2.3,-m,1500,--no-ndp,--no-dhcpv6,--no-dhcp**,
52-
equivalent to default slirp4netns(1) options: disable IPv6, assign
53-
`10.0.2.0/24` to the `tap0` interface in the container, with gateway
43+
disable IPv6, assign `10.0.2.0/24` to the `tap0` interface in the container, with gateway
5444
`10.0.2.3`, enable DNS forwarder reachable at `10.0.2.3`, set MTU to 1500
5545
bytes, disable NDP, DHCPv6 and DHCP support.
5646
- **pasta:-I,tap0,--ipv4-only,-a,10.0.2.0,-n,24,-g,10.0.2.2,--dns-forward,10.0.2.3,--no-ndp,--no-dhcpv6,--no-dhcp**,
57-
equivalent to default slirp4netns(1) options with Podman overrides: same as
58-
above, but leave the MTU to 65520 bytes
47+
same as above, but leave the MTU to 65520 bytes
5948
- **pasta:-t,auto,-u,auto,-T,auto,-U,auto**: enable automatic port forwarding
6049
based on observed bound ports from both host and container sides
6150
- **pasta:-T,5201**: enable forwarding of TCP port 5201 from container to

docs/source/markdown/options/network.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -31,21 +31,7 @@ Valid _mode_ values are:
3131

3232
- **ns:**_path_: Path to a network namespace to join.
3333

34-
- **private**: Create a new namespace for the container. This uses the **bridge** mode for rootful containers and **slirp4netns** for rootless ones.
35-
36-
- **slirp4netns[:OPTIONS,...]**: use **slirp4netns**(1) to create a user network stack. It is possible to specify these additional options, they can also be set with `network_cmd_options` in containers.conf:
37-
38-
- **allow_host_loopback=true|false**: Allow slirp4netns to reach the host loopback IP (default is 10.0.2.2 or the second IP from slirp4netns cidr subnet when changed, see the cidr option below). The default is false.
39-
- **mtu=**_MTU_: Specify the MTU to use for this network. (Default is `65520`).
40-
- **cidr=**_CIDR_: Specify ip range to use for this network. (Default is `10.0.2.0/24`).
41-
- **enable_ipv6=true|false**: Enable IPv6. Default is true. (Required for `outbound_addr6`).
42-
- **outbound_addr=**_INTERFACE_: Specify the outbound interface slirp binds to (ipv4 traffic only).
43-
- **outbound_addr=**_IPv4_: Specify the outbound ipv4 address slirp binds to.
44-
- **outbound_addr6=**_INTERFACE_: Specify the outbound interface slirp binds to (ipv6 traffic only).
45-
- **outbound_addr6=**_IPv6_: Specify the outbound ipv6 address slirp binds to.
46-
- **port_handler=rootlesskit**: Use rootlesskit for port forwarding. Default. \
47-
Note: Rootlesskit changes the source IP address of incoming packets to an IP address in the container network namespace, usually `10.0.2.100`. If the application requires the real source IP address, e.g. web server logs, use the slirp4netns port handler. The rootlesskit port handler is also used for rootless containers when connected to user-defined networks.
48-
- **port_handler=slirp4netns**: Use the slirp4netns port forwarding, it is slower than rootlesskit but preserves the correct source IP address. This port handler cannot be used for user-defined networks.
34+
- **private**: Create a new namespace for the container. This uses the **bridge** mode for rootful containers.
4935

5036
- **pasta[:OPTIONS,...]**: use **pasta**(1) to create a user-mode networking
5137
stack. \
@@ -80,13 +66,11 @@ Valid _mode_ values are:
8066
- **pasta:--mtu,1500**: Specify a 1500 bytes MTU for the _tap_ interface in
8167
the container.
8268
- **pasta:--ipv4-only,-a,10.0.2.0,-n,24,-g,10.0.2.2,--dns-forward,10.0.2.3,-m,1500,--no-ndp,--no-dhcpv6,--no-dhcp**,
83-
equivalent to default slirp4netns(1) options: disable IPv6, assign
84-
`10.0.2.0/24` to the `tap0` interface in the container, with gateway
69+
disable IPv6, assign `10.0.2.0/24` to the `tap0` interface in the container, with gateway
8570
`10.0.2.3`, enable DNS forwarder reachable at `10.0.2.3`, set MTU to 1500
8671
bytes, disable NDP, DHCPv6 and DHCP support.
8772
- **pasta:-I,tap0,--ipv4-only,-a,10.0.2.0,-n,24,-g,10.0.2.2,--dns-forward,10.0.2.3,--no-ndp,--no-dhcpv6,--no-dhcp**,
88-
equivalent to default slirp4netns(1) options with Podman overrides: same as
89-
above, but leave the MTU to 65520 bytes
73+
same as above, but leave the MTU to 65520 bytes
9074
- **pasta:-t,auto,-u,auto,-T,auto,-U,auto**: enable automatic port forwarding
9175
based on observed bound ports from both host and container sides
9276
- **pasta:-T,5201**: enable forwarding of TCP port 5201 from container to

docs/source/markdown/options/publish.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ If it is not, the container port is randomly assigned a port on the host.
2323
Use **podman port** to see the actual mapping: `podman port $CONTAINER $CONTAINERPORT`.
2424

2525
Port publishing is only supported for containers utilizing their own network namespace
26-
through `bridge` networks, or the `pasta` and `slirp4netns` network modes.
26+
through `bridge` networks, or the `pasta` network mode.

docs/source/markdown/podman-container-inspect.1.md.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ $ podman container inspect foobar
239239
"Tag": "",
240240
"Size": "0B"
241241
},
242-
"NetworkMode": "slirp4netns",
242+
"NetworkMode": "pasta",
243243
"PortBindings": {},
244244
"RestartPolicy": {
245245
"Name": "",

docs/source/markdown/podman-create.1.md.in

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -488,12 +488,12 @@ be installed. The shadow-utils package must include the newuidmap and newgidmap
488488

489489
In order for users to run rootless, there must be an entry for their username in /etc/subuid and /etc/subgid which lists the UIDs for their user namespace.
490490

491-
Rootless Podman works better if the fuse-overlayfs and slirp4netns packages are installed.
491+
Rootless Podman works better if the fuse-overlayfs package is installed.
492492
The fuse-overlayfs package provides a userspace overlay storage driver, otherwise users need to use
493493
the vfs storage driver, which can be disk space expensive and less performant
494494
than other drivers.
495495

496-
To enable VPN on the container, slirp4netns or pasta needs to be specified;
496+
To enable VPN on the container, pasta needs to be specified;
497497
without either, containers need to be run with the --network=host flag.
498498

499499
## ENVIRONMENT
@@ -543,7 +543,7 @@ page.
543543
NOTE: Use the environment variable `TMPDIR` to change the temporary storage location of downloaded container images. Podman defaults to use `/var/tmp`.
544544

545545
## SEE ALSO
546-
**[podman(1)](podman.1.md)**, **[podman-save(1)](podman-save.1.md)**, **[podman-ps(1)](podman-ps.1.md)**, **[podman-attach(1)](podman-attach.1.md)**, **[podman-pod-create(1)](podman-pod-create.1.md)**, **[podman-port(1)](podman-port.1.md)**, **[podman-start(1)](podman-start.1.md)**, **[podman-kill(1)](podman-kill.1.md)**, **[podman-stop(1)](podman-stop.1.md)**, **[podman-generate-systemd(1)](podman-generate-systemd.1.md)**, **[podman-rm(1)](podman-rm.1.md)**, **[subgid(5)](https://www.unix.com/man-page/linux/5/subgid)**, **[subuid(5)](https://www.unix.com/man-page/linux/5/subuid)**, **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)**, **[podman-systemd.unit(5)](podman-systemd.unit.5.md)**, **[setsebool(8)](https://man7.org/linux/man-pages/man8/setsebool.8.html)**, **[slirp4netns(1)](https://github.com/rootless-containers/slirp4netns/blob/master/slirp4netns.1.md)**, **[pasta(1)](https://passt.top/builds/latest/web/passt.1.html)**, **[fuse-overlayfs(1)](https://github.com/containers/fuse-overlayfs/blob/main/fuse-overlayfs.1.md)**, **proc(5)**, **[conmon(8)](https://github.com/containers/conmon/blob/main/docs/conmon.8.md)**, **personality(2)**
546+
**[podman(1)](podman.1.md)**, **[podman-save(1)](podman-save.1.md)**, **[podman-ps(1)](podman-ps.1.md)**, **[podman-attach(1)](podman-attach.1.md)**, **[podman-pod-create(1)](podman-pod-create.1.md)**, **[podman-port(1)](podman-port.1.md)**, **[podman-start(1)](podman-start.1.md)**, **[podman-kill(1)](podman-kill.1.md)**, **[podman-stop(1)](podman-stop.1.md)**, **[podman-generate-systemd(1)](podman-generate-systemd.1.md)**, **[podman-rm(1)](podman-rm.1.md)**, **[subgid(5)](https://www.unix.com/man-page/linux/5/subgid)**, **[subuid(5)](https://www.unix.com/man-page/linux/5/subuid)**, **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)**, **[podman-systemd.unit(5)](podman-systemd.unit.5.md)**, **[setsebool(8)](https://man7.org/linux/man-pages/man8/setsebool.8.html)**, **[pasta(1)](https://passt.top/builds/latest/web/passt.1.html)**, **[fuse-overlayfs(1)](https://github.com/containers/fuse-overlayfs/blob/main/fuse-overlayfs.1.md)**, **proc(5)**, **[conmon(8)](https://github.com/containers/conmon/blob/main/docs/conmon.8.md)**, **personality(2)**
547547

548548
### Troubleshooting
549549

docs/source/markdown/podman-generate-spec.1.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ $ podman generate spec container1
8686
"nsmode": "default"
8787
},
8888
"netns": {
89-
"nsmode": "slirp4netns"
89+
"nsmode": "pasta"
9090
},
9191
"Networks": null,
9292
"use_image_hosts": false,
@@ -161,7 +161,7 @@ $ cat output.json
161161
"nsmode": "default"
162162
},
163163
"netns": {
164-
"nsmode": "slirp4netns"
164+
"nsmode": "pasta"
165165
},
166166
"Networks": null,
167167
"use_image_hosts": false,

docs/source/markdown/podman-info.1.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -119,15 +119,6 @@ host:
119119
seccompProfilePath: /usr/share/containers/seccomp.json
120120
selinuxEnabled: true
121121
serviceIsRemote: false
122-
slirp4netns:
123-
executable: /bin/slirp4netns
124-
package: slirp4netns-1.1.12-2.fc34.x86_64
125-
version: |-
126-
slirp4netns version 1.1.12
127-
commit: 7a104a101aa3278a2152351a082a6df71f57c9a3
128-
libslirp: 4.4.0
129-
SLIRP_CONFIG_VERSION_MAX: 3
130-
libseccomp: 2.5.0
131122
swapFree: 15687475200
132123
swapTotal: 16886259712
133124
uptime: 47h 15m 9.91s (Approximately 1.96 days)
@@ -262,11 +253,6 @@ $ podman info --format json
262253
"seccompProfilePath": "/usr/share/containers/seccomp.json",
263254
"selinuxEnabled": true
264255
},
265-
"slirp4netns": {
266-
"executable": "/bin/slirp4netns",
267-
"package": "slirp4netns-1.1.12-2.fc34.x86_64",
268-
"version": "slirp4netns version 1.1.12\ncommit: 7a104a101aa3278a2152351a082a6df71f57c9a3\nlibslirp: 4.4.0\nSLIRP_CONFIG_VERSION_MAX: 3\nlibseccomp: 2.5.0"
269-
},
270256
"pasta": {
271257
"executable": "/usr/bin/passt",
272258
"package": "passt-0^20221116.gace074c-1.fc34.x86_64",

docs/source/markdown/podman-network.1.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,7 @@ The default bridge network (called `podman`) uses 10.88.0.0/16 as a subnet. When
4444
### Pasta
4545
Pasta by default performs no Network Address Translation (NAT) and copies the IPs from your main interface into the container namespace. If pasta cannot find an interface with the default route, it will select an interface if there is only one interface with a valid route. If you do not have a default route and several interfaces have defined routes, pasta will be unable to figure out the correct interface and it will fail to start. To specify the interface, use `-i` option to pasta. A default set of pasta options can be set in **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)** under the `[network]` section with the `pasta_options` key.
4646

47-
The default rootless networking tool can be selected in **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)** under the `[network]` section with `default_rootless_network_cmd`, which can be set to `pasta` (default) or `slirp4netns`.
48-
49-
### Slirp4netns
50-
Slirp4netns uses 10.0.2.0/24 for its default network. This can also be changed in **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)** but under the `[engine]` section. Use the `network_cmd_options` key and add `["cidr=X.X.X.X/24"]` as a value. Note that slirp4netns needs a network prefix size between 1 and 25. This option accepts an array, so more options can be added in a comma-separated string as described on the **[podman-network-create(1)](podman-network-create.1.md)** man page. To change the CIDR for just one container, specify it on the cli using the `--network` option like this: `--network slirp4netns:cidr=192.168.1.0/24`.
47+
The default rootless networking tool can be selected in **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)** under the `[network]` section with `default_rootless_network_cmd`, which should be set to `pasta` (default).
5148

5249
### Podman network create
5350
When a new network is created with a `podman network create` command, and no subnet is given with the --subnet option, Podman starts picking a free subnet from 10.89.0.0/24 to 10.255.255.0/24. Use the `default_subnet_pools` option under the `[network]` section in **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)** to change the range and/or size that is assigned by default.

docs/source/markdown/podman-pod-create.1.md.in

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -212,11 +212,6 @@ Create a pod with published ports on the host.
212212
$ podman pod create --publish 8443:443
213213
```
214214

215-
Create a pod with the specified network configuration.
216-
```
217-
$ podman pod create --network slirp4netns:outbound_addr=127.0.0.1,allow_host_loopback=true
218-
```
219-
220215
Create a pod with the specified network.
221216
```
222217
$ podman pod create --network pasta

docs/source/markdown/podman-run.1.md.in

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -937,12 +937,12 @@ be installed. The **shadow-utils** package must include the **newuidmap**(1) and
937937

938938
In order for users to run rootless, there must be an entry for their username in _/etc/subuid_ and _/etc/subgid_ which lists the UIDs for their user namespace.
939939

940-
Rootless Podman works better if the fuse-overlayfs and slirp4netns packages are installed.
940+
Rootless Podman works better if the fuse-overlayfs package is installed.
941941
The **fuse-overlayfs** package provides a userspace overlay storage driver, otherwise users need to use
942942
the **vfs** storage driver, which can be disk space expensive and less
943943
performant than other drivers.
944944

945-
To enable VPN on the container, slirp4netns or pasta needs to be specified;
945+
To enable VPN on the container, pasta needs to be specified;
946946
without either, containers need to be run with the --network=host flag.
947947

948948
## ENVIRONMENT
@@ -990,7 +990,7 @@ page.
990990
NOTE: Use the environment variable `TMPDIR` to change the temporary storage location of downloaded container images. Podman defaults to use `/var/tmp`.
991991

992992
## SEE ALSO
993-
**[podman(1)](podman.1.md)**, **[podman-save(1)](podman-save.1.md)**, **[podman-ps(1)](podman-ps.1.md)**, **[podman-attach(1)](podman-attach.1.md)**, **[podman-pod-create(1)](podman-pod-create.1.md)**, **[podman-port(1)](podman-port.1.md)**, **[podman-start(1)](podman-start.1.md)**, **[podman-kill(1)](podman-kill.1.md)**, **[podman-stop(1)](podman-stop.1.md)**, **[podman-generate-systemd(1)](podman-generate-systemd.1.md)**, **[podman-rm(1)](podman-rm.1.md)**, **[subgid(5)](https://www.unix.com/man-page/linux/5/subgid)**, **[subuid(5)](https://www.unix.com/man-page/linux/5/subuid)**, **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)**, **[podman-systemd.unit(5)](podman-systemd.unit.5.md)**, **[setsebool(8)](https://man7.org/linux/man-pages/man8/setsebool.8.html)**, **[slirp4netns(1)](https://github.com/rootless-containers/slirp4netns/blob/master/slirp4netns.1.md)**, **[pasta(1)](https://passt.top/builds/latest/web/passt.1.html)**, **[fuse-overlayfs(1)](https://github.com/containers/fuse-overlayfs/blob/main/fuse-overlayfs.1.md)**, **proc(5)**, **[conmon(8)](https://github.com/containers/conmon/blob/main/docs/conmon.8.md)**, **personality(2)**
993+
**[podman(1)](podman.1.md)**, **[podman-save(1)](podman-save.1.md)**, **[podman-ps(1)](podman-ps.1.md)**, **[podman-attach(1)](podman-attach.1.md)**, **[podman-pod-create(1)](podman-pod-create.1.md)**, **[podman-port(1)](podman-port.1.md)**, **[podman-start(1)](podman-start.1.md)**, **[podman-kill(1)](podman-kill.1.md)**, **[podman-stop(1)](podman-stop.1.md)**, **[podman-generate-systemd(1)](podman-generate-systemd.1.md)**, **[podman-rm(1)](podman-rm.1.md)**, **[subgid(5)](https://www.unix.com/man-page/linux/5/subgid)**, **[subuid(5)](https://www.unix.com/man-page/linux/5/subuid)**, **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)**, **[podman-systemd.unit(5)](podman-systemd.unit.5.md)**, **[setsebool(8)](https://man7.org/linux/man-pages/man8/setsebool.8.html)**, **[pasta(1)](https://passt.top/builds/latest/web/passt.1.html)**, **[fuse-overlayfs(1)](https://github.com/containers/fuse-overlayfs/blob/main/fuse-overlayfs.1.md)**, **proc(5)**, **[conmon(8)](https://github.com/containers/conmon/blob/main/docs/conmon.8.md)**, **personality(2)**
994994

995995
### Troubleshooting
996996

0 commit comments

Comments
 (0)