[pbs-devel] [PATCH proxmox-backup v5 3/4] docs: add documentation for proxmox-network-interface-pinning

[Stefan Hanreich]

Mostly taken from the Proxmox VE documentation, but removed the
Proxmox VE specific parts and added a short introductory paragraph
that describes the problem of network interface name changes.

Signed-off-by: Stefan Hanreich <s.hanreich at proxmox.com>
---
 docs/network-management.rst | 55 +++++++++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)

diff --git a/docs/network-management.rst b/docs/network-management.rst
index 5ae19e56..492becdf 100644
--- a/docs/network-management.rst
+++ b/docs/network-management.rst
@@ -97,3 +97,58 @@ of **Configuration** or by using the ``dns`` subcommand of
 
 
 .. include:: traffic-control.rst
+
+
+Overriding network device names
+-------------------------------
+
+When upgrading kernels, adding PCIe devices or updating your BIOS, automatically
+generated network interface names can change. To alleviate this issues, Proxmox
+Backup Server provides a tool for automatically generating .link files for
+overriding the name of network devices. It also automatically replaces the
+occurences of the old interface name in `/etc/network/interfaces`.
+
+The generated link files are stored in `/usr/local/lib/systemd/network`. For the
+interfaces file a new file will be generated in the same place with a `.new`
+suffix. This way you can inspect the changes made to the configuration by
+using diff (or another diff viewer of your choice):
+
+----
+diff -y /etc/network/interfaces /etc/network/interfaces.new
+----
+
+If you see any problematic changes or want to revert the changes made by the
+pinning tool **before rebooting**, simply delete all `.new` files and the
+respective link files from `/usr/local/lib/systemd/network`.
+
+The following command will generate a .link file for all physical network
+interfaces that do not yet have a .link file and update selected Proxmox VE
+configuration files (see above). The generated names will use the default prefix
+`nic`, so the resulting interface names will be `nic1`, `nic2`, ...
+
+----
+proxmox-network-interface-pinning generate
+----
+
+You can override the default prefix with the `--prefix` flag:
+
+----
+proxmox-network-interface-pinning generate --prefix myprefix
+----
+
+It is also possible to pin only a specific interface:
+
+----
+proxmox-network-interface-pinning generate --interface enp1s0
+----
+
+When pinning a specific interface, you can specify the exact name that the
+interface should be pinned to:
+
+----
+proxmox-network-interface-pinning generate --interface enp1s0 --target-name if42
+----
+
+In order to apply the changes made by `proxmox-network-interface-pinning` to the
+network configuration, the host needs to be rebooted.
+
-- 
2.47.2