From 74d292e2e9993da0762ac70a921918d454f9d388 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lukas=20M=C3=A4rdian?= Date: Mon, 10 Jul 2023 15:53:21 +0200 Subject: [PATCH] doc: Explanation about 00-network-manager-all.yaml Replaces: https://github.com/canonical/netplan/pull/373 --- doc/explanation.md | 5 +++++ doc/nm-all.md | 26 ++++++++++++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 doc/nm-all.md diff --git a/doc/explanation.md b/doc/explanation.md index b64a00a7c..b65c73446 100644 --- a/doc/explanation.md +++ b/doc/explanation.md @@ -5,6 +5,11 @@ structure-id ``` +## NetworkManager +```{toctree} +nm-all +``` + ## Design Network configuration abstraction via systemd-generator ```{toctree} diff --git a/doc/nm-all.md b/doc/nm-all.md new file mode 100644 index 000000000..f8371b599 --- /dev/null +++ b/doc/nm-all.md @@ -0,0 +1,26 @@ +## NetworkManager default configuration + +Without configuration, Netplan will not do anything. Therefore, on Desktop +systems, a useful configuration snippet to just bring up networking via DHCP is +as follows: + +```yaml +network: + version: 2 + renderer: NetworkManager +``` + +This will make NetworkManager manage all devices and by default. Any ethernet +device will come up with DHCP, once carrier is detected. This is basically +Netplan passing control over to NetworkManager at boot time. + +You can still define any more specific IDs in you Netplan configuration, to +configure interfaces individually, according to Netplan's [YAML reference](/netplan-yaml/). + +When NetworkManager's [Netplan desktop integration}(/netplan-everywhere/) is +activated, NetworkManager will automatically create specific Netplan IDs for +each of its connection profiles. + +This configuration snippet is shipped by default on Ubuntu Desktop systems +through the [ubuntu-settings](https://launchpad.net/ubuntu/+source/ubuntu-settings) +package as `/usr/lib/netplan/00-network-manager-all.yaml`. \ No newline at end of file