From 108d2bc430eb77fb77a94f623925c34960d286f9 Mon Sep 17 00:00:00 2001 From: Paul Holzinger Date: Fri, 3 Nov 2023 11:43:19 +0100 Subject: [PATCH] docs: make CNI removal explicit The docs were rather vague about the deprecation of CNI, make it clear that we are going to remove it with 5.0 as we decided to do that in our planning. Also while looking at the podman network create docs I noticed --ipam-driver dhcp was still documented as not supported with netavark so I fixed that as well. Signed-off-by: Paul Holzinger --- cni/README.md | 4 ++-- docs/source/markdown/podman-network-create.1.md | 10 +++++++--- docs/source/markdown/podman-network.1.md | 6 +++--- docs/source/markdown/podman.1.md | 3 ++- 4 files changed, 14 insertions(+), 9 deletions(-) diff --git a/cni/README.md b/cni/README.md index c818c8522b..7b8ea09a3a 100644 --- a/cni/README.md +++ b/cni/README.md @@ -1,7 +1,7 @@ ## `cni` ## -**Note**: CNI is being deprecated from Podman and support will be dropped at a future date. Use of netavark is now -advised and is the default network backend for Podman. +**Note**: The CNI backend is deprecated and will be removed in the next major Podman version 5.0, in preference +of Netavark, see **[podman-network(1)](../docs/source/markdown/podman-network.1.md)** on how to change the backend. There are a wide variety of different [CNI](https://github.com/containernetworking/cni) network configurations. This directory just contains an example configuration that can be used as the diff --git a/docs/source/markdown/podman-network-create.1.md b/docs/source/markdown/podman-network-create.1.md index ce1da280fe..0243b183a6 100644 --- a/docs/source/markdown/podman-network-create.1.md +++ b/docs/source/markdown/podman-network-create.1.md @@ -15,8 +15,10 @@ If no options are provided, Podman assigns a free subnet and name for the networ Upon completion of creating the network, Podman displays the name of the newly added network. -NOTE: The support for the network name "pasta" is deprecated and will be removed in the next major -release because it is used as a special network mode in **podman run/create --network**. +NOTE: The support for "pasta" as network *name* value is deprecated and will not be accepted in the next major +Podman version 5.0, because it is used as a special network mode in **podman run/create --network**. +The CNI backend is also deprecated and will also be removed in the next major Podman version 5.0, in preference +of Netavark, see **[podman-network(1)](podman-network.1.md)** on how to change the backend. ## OPTIONS #### **--disable-dns** @@ -87,7 +89,9 @@ ipam driver automatically based on the network driver. Valid values are: - - `dhcp`: IP addresses are assigned from a dhcp server on the network. This driver is not yet supported with netavark. For CNI the *dhcp* plugin needs to be activated before. + - `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. - `host-local`: IP addresses are assigned locally. - `none`: No ip addresses are assigned to the interfaces. diff --git a/docs/source/markdown/podman-network.1.md b/docs/source/markdown/podman-network.1.md index 4843da4bc7..03314fe0c7 100644 --- a/docs/source/markdown/podman-network.1.md +++ b/docs/source/markdown/podman-network.1.md @@ -10,9 +10,9 @@ podman\-network - Manage Podman networks 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 v4.0. CNI will be deprecated in the future in preference of -Netavark. To configure -the network backend use the `network_backend` key under the `[Network]` in +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}}`. diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md index f1a65a2d38..151a7410d5 100644 --- a/docs/source/markdown/podman.1.md +++ b/docs/source/markdown/podman.1.md @@ -106,7 +106,8 @@ Path to the directory where network configuration files are located. For the netavark backend "/etc/containers/networks" is used 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 from Podman in the future, use netavark. +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.