Skip to content

Commit

Permalink
doc: Explanation about 00-network-manager-all.yaml
Browse files Browse the repository at this point in the history
Replaces: #373
  • Loading branch information
slyon committed Jul 11, 2023
1 parent 3bc43d9 commit 74d292e
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
5 changes: 5 additions & 0 deletions doc/explanation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
structure-id
```

## NetworkManager
```{toctree}
nm-all
```

## Design
Network configuration abstraction via systemd-generator
```{toctree}
Expand Down
26 changes: 26 additions & 0 deletions doc/nm-all.md
Original file line number Diff line number Diff line change
@@ -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`.

0 comments on commit 74d292e

Please sign in to comment.