podman icon indicating copy to clipboard operation
podman copied to clipboard

Outdated documentation: slirp4netns vs pasta

Open lahwaacz opened this issue 1 year ago • 6 comments

Issue Description

podman-network.1.md says that slirp4netns is the default network program for rootless containers.

However, containers.conf.5.md has default_rootless_network_cmd="pasta" by default.

Steps to reproduce the issue

Read the latest man pages :smile:

Describe the results you received

Outdated documentation

Describe the results you expected

Documentation should be up to date

podman info output

(irrelevant)

Podman in a container

No

Privileged Or Rootless

Rootless

Upstream Latest Release

Yes

Additional environment details

Additional environment details

Additional information

Additional information like issue happens only occasionally or issue happens with a particular architecture or on a particular setting

lahwaacz avatar Apr 30 '24 08:04 lahwaacz

Contributions welcome

Luap99 avatar Apr 30 '24 12:04 Luap99

@Luap99 Can I work on this?

radar07 avatar May 01 '24 15:05 radar07

@radar07 sure

Luap99 avatar May 02 '24 09:05 Luap99

@Luap99 I wonder if we have to write a brief description about pasta as the default rootless network in place of slirp4netns in the man page. Do you have any suggestions?

radar07 avatar May 03 '24 13:05 radar07

Yes that would be good, pasta works a bit differently so adding it there would be good. Maybe the pasta section here could serve as a string point: https://blog.podman.io/2024/03/podman-5-0-breaking-changes-in-detail/

The default is also wrong in https://github.com/containers/podman/blob/main/docs/source/markdown/options/network.md

Luap99 avatar May 03 '24 14:05 Luap99

@Luap99, Thanks for letting me know. I created a PR with few changes that might get this done. Also, please let me know if you have any other suggestions.

radar07 avatar May 03 '24 17:05 radar07