mirror of
https://github.com/containers/podman.git
synced 2026-03-13 08:01:19 +08:00
Update man page documentation to remove CNI references
Removed all CNI-specific documentation from man pages: - podman.1.md: Simplified --network-config-dir to only mention netavark directories - podman-network.1.md: Removed dual backend description, now states netavark is the only backend - podman-network-create.1.md: Removed CNI-specific notes about DNS and DHCP socket configuration - podman-network-connect.1.md: Removed CNI limitation note about network aliases - options/network-alias.md: Removed CNI limitation note about network aliases - podman-info.1.md: Updated example output to show netavark backend information instead of CNI All man pages now reflect netavark as the sole network backend. Signed-off-by: Lokesh Mandvekar <lsm5@redhat.com>
This commit is contained in:
@@ -8,5 +8,3 @@ Add a network-scoped alias for the <<container|pod>>, setting the alias for all
|
||||
name only for a specific network, use the alias option as described under the **--network** option.
|
||||
If the network has DNS enabled (`podman network inspect -f {{.DNSEnabled}} <name>`),
|
||||
these aliases can be used for name resolution on the given network. This option can be specified multiple times.
|
||||
NOTE: When using CNI a <<container|pod>> only has access to aliases on the first network that it joins. This limitation does
|
||||
not exist with netavark/aardvark-dns.
|
||||
|
||||
@@ -76,20 +76,16 @@ host:
|
||||
logDriver: journald
|
||||
memFree: 1833385984
|
||||
memTotal: 16401895424
|
||||
networkBackend: cni
|
||||
networkBackend: netavark
|
||||
networkBackendInfo:
|
||||
backend: cni
|
||||
backend: netavark
|
||||
dns:
|
||||
package: podman-plugins-3.4.4-1.fc34.x86_64
|
||||
path: /usr/libexec/cni/dnsname
|
||||
version: |-
|
||||
CNI dnsname plugin
|
||||
version: 1.3.1
|
||||
commit: unknown
|
||||
package: |-
|
||||
containernetworking-plugins-1.0.1-1.fc34.x86_64
|
||||
podman-plugins-3.4.4-1.fc34.x86_64
|
||||
path: /usr/libexec/cni
|
||||
package: aardvark-dns-1.0.1-1.fc34.x86_64
|
||||
path: /usr/libexec/podman/aardvark-dns
|
||||
version: aardvark-dns 1.0.1
|
||||
package: netavark-1.0.1-1.fc34.x86_64
|
||||
path: /usr/libexec/podman/netavark
|
||||
version: netavark 1.0.1
|
||||
ociRuntime:
|
||||
name: crun
|
||||
package: crun-1.0-1.fc34.x86_64
|
||||
@@ -232,15 +228,16 @@ $ podman info --format json
|
||||
"logDriver": "journald",
|
||||
"memFree": 1785753600,
|
||||
"memTotal": 16401895424,
|
||||
"networkBackend": "cni",
|
||||
"networkBackend": "netavark",
|
||||
"networkBackendInfo": {
|
||||
"backend": "cni",
|
||||
"package": "containernetworking-plugins-1.0.1-1.fc34.x86_64\npodman-plugins-3.4.4-1.fc34.x86_64",
|
||||
"path": "/usr/libexec/cni",
|
||||
"backend": "netavark",
|
||||
"package": "netavark-1.0.1-1.fc34.x86_64",
|
||||
"path": "/usr/libexec/podman/netavark",
|
||||
"version": "netavark 1.0.1",
|
||||
"dns": {
|
||||
"version": "CNI dnsname plugin\nversion: 1.3.1\ncommit: unknown",
|
||||
"package": "podman-plugins-3.4.4-1.fc34.x86_64",
|
||||
"path": "/usr/libexec/cni/dnsname"
|
||||
"version": "aardvark-dns 1.0.1",
|
||||
"package": "aardvark-dns-1.0.1-1.fc34.x86_64",
|
||||
"path": "/usr/libexec/podman/aardvark-dns"
|
||||
}
|
||||
},
|
||||
"ociRuntime": {
|
||||
|
||||
@@ -14,8 +14,6 @@ Once connected, the container can communicate with other containers in the same
|
||||
#### **--alias**=*name*
|
||||
Add network-scoped alias for the container. If the network has DNS enabled (`podman network inspect -f {{.DNSEnabled}} <NAME>`),
|
||||
these aliases can be used for name resolution on the given network. Multiple *--alias* options may be specified as input.
|
||||
NOTE: When using CNI, a container only has access to aliases on the first network that it joins. This limitation does
|
||||
not exist with netavark/aardvark-dns.
|
||||
|
||||
#### **--ip**=*address*
|
||||
Set a static ipv4 address for this container on this network.
|
||||
|
||||
@@ -62,8 +62,7 @@ For `macvlan` and `ipvlan`, it is the parent device on the host. It is the same
|
||||
|
||||
#### **--internal**
|
||||
|
||||
Restrict external access of this network when using a `bridge` network. Note when using the CNI backend
|
||||
DNS will be automatically disabled, see **--disable-dns**.
|
||||
Restrict external access of this network when using a `bridge` network.
|
||||
|
||||
When using the `macvlan` or `ipvlan` driver with this option no default route will be added to the container.
|
||||
Because it bypasses the host network stack no additional restrictions can be set by podman and if a
|
||||
@@ -92,9 +91,8 @@ ipam driver automatically based on the network driver.
|
||||
|
||||
Valid values are:
|
||||
|
||||
- `dhcp`: IP addresses are assigned from a dhcp server on the network. When using the netavark backend
|
||||
the `netavark-dhcp-proxy.socket` must be enabled in order to start the dhcp-proxy when a container is
|
||||
started, for CNI use the `cni-dhcp.socket` unit instead.
|
||||
- `dhcp`: IP addresses are assigned from a dhcp server on the network. The `netavark-dhcp-proxy.socket`
|
||||
must be enabled in order to start the dhcp-proxy when a container is started.
|
||||
- `host-local`: IP addresses are assigned locally.
|
||||
- `none`: No ip addresses are assigned to the interfaces.
|
||||
|
||||
|
||||
@@ -9,16 +9,7 @@ podman\-network - Manage Podman networks
|
||||
## DESCRIPTION
|
||||
The network command manages networks for Podman.
|
||||
|
||||
Podman supports two network backends [Netavark](https://github.com/containers/netavark)
|
||||
and [CNI](https://www.cni.dev/). Netavark is the default network backend and was added in Podman version 4.0.
|
||||
CNI is deprecated and will be removed in the next major Podman version 5.0, in preference of Netavark.
|
||||
To configure the network backend use the `network_backend` key under the `[Network]` in
|
||||
**[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)**.
|
||||
New systems use netavark by default, to check what backend is used run
|
||||
`podman info --format {{.Host.NetworkBackend}}`.
|
||||
|
||||
All network commands work for both backends but CNI and Netavark use different config files
|
||||
so networks have to be created again after a backend change.
|
||||
Podman uses [Netavark](https://github.com/containers/netavark) as the network backend.
|
||||
|
||||
## COMMANDS
|
||||
|
||||
|
||||
@@ -107,11 +107,8 @@ Further note that the flag is a root-level flag and must be specified before any
|
||||
#### **--network-config-dir**=*directory*
|
||||
|
||||
Path to the directory where network configuration files are located.
|
||||
For the netavark backend "/etc/containers/networks" is used as root
|
||||
The default is "/etc/containers/networks" as root
|
||||
and "$graphroot/networks" as rootless.
|
||||
For the CNI backend the default is "/etc/cni/net.d" as root
|
||||
and "$HOME/.config/cni/net.d" as rootless.
|
||||
CNI is deprecated and will be removed in the next major Podman version 5.0 in preference of Netavark.
|
||||
|
||||
#### **--out**=*path*
|
||||
Redirect the output of podman to the specified path without affecting the container output or its logs. This parameter can be used to capture the output from any of podman's commands directly into a file and enable suppression of podman's output by specifying /dev/null as the path. To explicitly disable the container logging, the **--log-driver** option should be used.
|
||||
|
||||
Reference in New Issue
Block a user