summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-network.1.md
diff options
context:
space:
mode:
authorPaul Holzinger <pholzing@redhat.com>2022-02-15 16:46:23 +0100
committerPaul Holzinger <pholzing@redhat.com>2022-02-15 16:46:23 +0100
commit4a166c8b63f102de13a282fb26cd818b66a7a336 (patch)
treef8fb05f3ab3cc496e041a00907901b49cac37e62 /docs/source/markdown/podman-network.1.md
parent5977fd509582d6dc8727ce8f8a78011888a1dc17 (diff)
downloadpodman-4a166c8b63f102de13a282fb26cd818b66a7a336.tar.gz
podman-4a166c8b63f102de13a282fb26cd818b66a7a336.tar.bz2
podman-4a166c8b63f102de13a282fb26cd818b66a7a336.zip
podman network: add documentation for netavark
Add some docs about the different network backends. Also remove the CNI word from network since we refer to either a netavark or CNI config. Signed-off-by: Paul Holzinger <pholzing@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-network.1.md')
-rw-r--r--docs/source/markdown/podman-network.1.md38
1 files changed, 24 insertions, 14 deletions
diff --git a/docs/source/markdown/podman-network.1.md b/docs/source/markdown/podman-network.1.md
index 29ee70139..bc75cce3b 100644
--- a/docs/source/markdown/podman-network.1.md
+++ b/docs/source/markdown/podman-network.1.md
@@ -1,27 +1,37 @@
% podman-network(1)
## NAME
-podman\-network - Manage Podman CNI networks
+podman\-network - Manage Podman networks
## SYNOPSIS
**podman network** *subcommand*
## DESCRIPTION
-The network command manages CNI networks for Podman.
+The network command manages networks for Podman.
+
+Podman supports two network backends [Netavark](https://github.com/containers/netavark)
+and [CNI](https://www.cni.dev/). Support for netavark was added in Podman v4.0. To configure
+the network backend use the `network_backend`key under the `[Network]` in
+**[containers.conf(5)](https://github.com/containers/common/blob/master/docs/containers.conf.5.md)**.
+New systems should use netavark by default, to check what backed 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.
## COMMANDS
-| Command | Man Page | Description |
-| ---------- | -------------------------------------------------------------- | ------------------------------------------------------------------- |
-| connect | [podman-network-connect(1)](podman-network-connect.1.md) | Connect a container to a network |
-| create | [podman-network-create(1)](podman-network-create.1.md) | Create a Podman CNI network |
-| disconnect | [podman-network-disconnect(1)](podman-network-disconnect.1.md) | Disconnect a container from a network |
-| exists | [podman-network-exists(1)](podman-network-exists.1.md) | Check if the given network exists |
-| inspect | [podman-network-inspect(1)](podman-network-inspect.1.md) | Displays the raw CNI network configuration for one or more networks |
-| ls | [podman-network-ls(1)](podman-network-ls.1.md) | Display a summary of CNI networks |
-| prune | [podman-network-prune(1)](podman-network-prune.1.md) | Remove all unused networks |
-| reload | [podman-network-reload(1)](podman-network-reload.1.md) | Reload network configuration for containers |
-| rm | [podman-network-rm(1)](podman-network-rm.1.md) | Remove one or more CNI networks |
+| Command | Man Page | Description |
+| ---------- | -------------------------------------------------------------- | --------------------------------------------------------------- |
+| connect | [podman-network-connect(1)](podman-network-connect.1.md) | Connect a container to a network |
+| create | [podman-network-create(1)](podman-network-create.1.md) | Create a Podman network |
+| disconnect | [podman-network-disconnect(1)](podman-network-disconnect.1.md) | Disconnect a container from a network |
+| exists | [podman-network-exists(1)](podman-network-exists.1.md) | Check if the given network exists |
+| inspect | [podman-network-inspect(1)](podman-network-inspect.1.md) | Displays the raw network configuration for one or more networks |
+| ls | [podman-network-ls(1)](podman-network-ls.1.md) | Display a summary of networks |
+| prune | [podman-network-prune(1)](podman-network-prune.1.md) | Remove all unused networks |
+| reload | [podman-network-reload(1)](podman-network-reload.1.md) | Reload network configuration for containers |
+| rm | [podman-network-rm(1)](podman-network-rm.1.md) | Remove one or more networks |
## SEE ALSO
-**[podman(1)](podman.1.md)**
+**[podman(1)](podman.1.md)**, **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)**