Skip to content

Commit

Permalink
doc: language fixes
Browse files Browse the repository at this point in the history
Co-authored-by: Robert Krátký <[email protected]>
  • Loading branch information
slyon and rkratky authored Nov 28, 2023
1 parent f9037e1 commit f511c3f
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions doc/netplan-everywhere.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,22 @@ and the graphical interfaces to configure their devices, Ubuntu has its
own way of describing and storing network configuration via Netplan.

On Ubuntu 23.10 "Mantic Minotaur" and later, NetworkManager uses Netplan APIs
to save the configuration created through any of its graphical or programmatic
to save the configuration created using any of its graphical or programmatic
interfaces. This leads to having a centralized location to store network
configuration. In the Desktop it's convenient to use graphical tools for
configuration when they are available, so nothing will change from the user
perspective, only the way the configuration is handled under the hood.
configuration. On the Desktop, it's convenient to use graphical tools for
configuration when they are available, so nothing changes from the user
perspective; only the way the system handles the configuration in the background.

For more information on Netplan, check [https://netplan.io](https://netplan.io)
For more information on Netplan, see [https://netplan.io](https://netplan.io).

For more information on NetworkManager, check [https://networkmanager.dev](https://networkmanager.dev)
For more information on NetworkManager, see [https://networkmanager.dev](https://networkmanager.dev).

## How it works

Every time a non-temporary connection is created in NetworkManager, instead
of persisting the original `.nmconnection` file, it will create a Netplan YAML
in `/etc/netplan/` called `90-NM-<connection UUID>.yaml`. After creating the
file, NetworkManager will call the Netplan generator to emit the configuration
of persisting the original `.nmconnection` file, it creates a Netplan YAML
file in `/etc/netplan/` called `90-NM-<connection UUID>.yaml`. After creating the
file, NetworkManager calls the Netplan generator to provide the configuration
for that connection. Connections that are temporary, like the ones created
for virtual network interfaces when you connect to a VPN for example, are not
persisted as Netplan files. The reason for that is that these interfaces are
Expand All @@ -45,22 +45,22 @@ $ sudo apt install network-manager

### User interface

From this point on, Netplan will be aware of all your network configuration and
From this point on, Netplan is aware of all your network configuration and
you can query it using its CLI tools, such as `sudo netplan get` or `sudo
netplan status`. All while keeping untouched the traditional way of modifying
them through NetworkManager (graphical UI, GNOME Quick Settings, `nmcli`,
it using NetworkManager (graphical UI, GNOME Quick Settings, `nmcli`,
`nmtui`, D-Bus APIs, ...).

### Management of connection profiles

The NetworkManager-Netplan integration will import connection profiles from
The NetworkManager-Netplan integration imports connection profiles from
`/etc/NetworkManager/system-connections/` to Netplan during the installation
process. It automatically creates a copy of all your connection profiles during
package installation of the new network-manager package in
`/root/NetworkManager.bak/system-connections/`. The same migration will happen
the installation of the new network-manager package in
`/root/NetworkManager.bak/system-connections/`. The same migration happens
in the background whenever you add or modify any connection profile.

You can observe this migration on the `apt-get`` command line, watching out for
You can observe this migration on the `apt-get`` command line. Watch for
logs like the following:
```
Setting up network-manager (1.44.2-1ubuntu1.2) ...
Expand All @@ -71,9 +71,9 @@ Migrating DebConf (f862be9c-fb06-4c0f-862f-c8e210ca4941) to /etc/netplan

For example, if you have a Wifi connection, you will not find the connection
profile file at `/etc/NetworkManager/system-connections/` anymore. Instead,
that file will be removed and a Netplan YAML called `90-NM-<connection UUID>.yaml`
will be created in `/etc/netplan/` and a new ephemeral profile will be generated
and stored in `/run/NetworkManager/system-connections/`.
the system removes the profile file, and Netplan creates a new YAML file called `90-NM-<connection UUID>.yaml`
in `/etc/netplan/` and generates a new ephemeral profile
in `/run/NetworkManager/system-connections/`.

## Limitation

Expand Down Expand Up @@ -107,10 +107,10 @@ network:
proxy._: ""
```
All the configuration under the `passthrough` mapping will be added to
All the configuration under the `passthrough` mapping is added to
the `.nmconnection` file as they are.

In cases where the connection type is not supported by Netplan the
In cases where the connection type is not supported by Netplan, the
`nm-devices` network type will be used. The example below is an OpenVPN
client connection, which is not supported by Netplan at the moment.

Expand Down

0 comments on commit f511c3f

Please sign in to comment.