Merge ~alfonsosanchezbeato/snappy-hwe-snaps/+git/network-manager:update-docs into ~snappy-hwe-team/snappy-hwe-snaps/+git/network-manager:master
- Git
- lp:~alfonsosanchezbeato/snappy-hwe-snaps/+git/network-manager
- update-docs
- Merge into master
Status: | Merged |
---|---|
Approved by: | Alfonso Sanchez-Beato |
Approved revision: | 3c8c77260a86470d37bec5f2cf9730e3719c4a45 |
Merged at revision: | 60c38868f4747bf88a684a45009d9516353fcf1f |
Proposed branch: | ~alfonsosanchezbeato/snappy-hwe-snaps/+git/network-manager:update-docs |
Merge into: | ~snappy-hwe-team/snappy-hwe-snaps/+git/network-manager:master |
Diff against target: |
789 lines (+306/-140) 20 files modified
dev/null (+0/-47) docs/configure-a-shared-connection.md (+27/-0) docs/configure-cellular-connections.md (+23/-13) docs/configure-wifi-access-points.md (+24/-0) docs/configure-wifi-connections.md (+2/-2) docs/edit-connections.md (+4/-4) docs/faq.md (+4/-3) docs/index.md (+13/-12) docs/installation.md (+54/-24) docs/logging-messages.md (+4/-4) docs/metadata.yaml (+10/-4) docs/networkmanager-and-netplan.md (+31/-0) docs/reference/available-commands.md (+12/-0) docs/reference/dbus-api.md (+1/-1) docs/reference/snap-configuration/connectivity-check.md (+28/-0) docs/reference/snap-configuration/debug.md (+2/-2) docs/reference/snap-configuration/default_renderer.md (+18/-0) docs/reference/snap-configuration/wifi-powersave.md (+1/-1) docs/reference/snap-configuration/wowlan.md (+3/-3) docs/release-notes.md (+45/-20) |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Alfonso Sanchez-Beato | continuous-integration | Approve | |
System Enablement Bot | continuous-integration | Needs Fixing | |
Review via email: mp+387195@code.launchpad.net |
Commit message
* core/pppd-plugin: wait to recover port settings before notifying death
See code branch MP:
https:/
* docs: update to reflect current state
Description of the change
* core/pppd-plugin: wait to recover port settings before notifying death
See code branch MP:
https:/
* docs: update to reflect current state
System Enablement Bot (system-enablement-ci-bot) wrote : | # |
System Enablement Bot (system-enablement-ci-bot) wrote : | # |
FAILED: Continuous integration, rev:3c8c77260a8
https:/
Executed test runs:
FAILURE: https:/
SUCCESS: https:/
SUCCESS: https:/
SUCCESS: https:/
SUCCESS: https:/
SUCCESS: https:/
None: https:/
Click here to trigger a rebuild:
https:/
Alfonso Sanchez-Beato (alfonsosanchezbeato) : | # |
Preview Diff
1 | diff --git a/docs/configure-a-shared-connection.md b/docs/configure-a-shared-connection.md |
2 | new file mode 100644 |
3 | index 0000000..61cbe87 |
4 | --- /dev/null |
5 | +++ b/docs/configure-a-shared-connection.md |
6 | @@ -0,0 +1,27 @@ |
7 | +--- |
8 | +title: "Configure shared connections" |
9 | +table_of_contents: True |
10 | +--- |
11 | + |
12 | +# Configure shared connections |
13 | + |
14 | +NetworkManager makes very easy to share connectivity, using the device |
15 | +as a gateway to which other devices can connect. That requires running |
16 | +commands similar to |
17 | + |
18 | +``` |
19 | +$ nmcli c add con-name <name> type ethernet ifname <iface> ipv4.method shared ipv6.method ignore |
20 | +$ nmcli c up <name> |
21 | +``` |
22 | + |
23 | +where `<name>` is an arbitrary name we give to the connection and |
24 | +`<iface>` is the name of the interface where external devices will |
25 | +connect to. In this case we are using an ethernet interface |
26 | +(`type ethernet`) and we provide IPv4 addresses, but this extends to other |
27 | +interfaces and to IPv6. |
28 | + |
29 | +When the connection is up, NM starts a DHCP server listening on |
30 | +`<iface>` and changes the networking configuration so we can forward |
31 | +packages and masquerading is enabled for the interface. Of course, for |
32 | +this to work we need an interface different from `<iface>` that has |
33 | +to have external connectivity. |
34 | diff --git a/docs/configure-cellular-connections.md b/docs/configure-cellular-connections.md |
35 | index 215f2dc..b2ad22b 100644 |
36 | --- a/docs/configure-cellular-connections.md |
37 | +++ b/docs/configure-cellular-connections.md |
38 | @@ -5,6 +5,11 @@ table_of_contents: False |
39 | |
40 | # Configure Cellular Connections |
41 | |
42 | +For cellular connections, first install the modem-manager snap with: |
43 | +``` |
44 | +$ snap install modem-manager |
45 | +``` |
46 | + |
47 | Check whether a modem was properly detected via: |
48 | |
49 | ``` |
50 | @@ -15,7 +20,7 @@ Found 1 modems: |
51 | |
52 | In this case we have just one modem, with index 0 (the number at the end of the DBus object path). |
53 | |
54 | -Show detailed information about the modem: |
55 | +Show detailed information about the modem using that index: |
56 | |
57 | ``` |
58 | $ sudo modem-manager.mmcli -m 0 |
59 | @@ -86,15 +91,20 @@ $ nmcli c add type gsm ifname <interface> con-name <name> apn <operator_apn> |
60 | $ nmcli r wwan on |
61 | ``` |
62 | |
63 | -where <interface> is the string listed as “primary port” in the output from 'sudo mmcli -m <N>' |
64 | -(as previously described), |
65 | -<name> is an arbitrary name used to identify the connection, and <operator_apn> is |
66 | -the APN name for your cellular data plan. Note that <interface> is usually a serial |
67 | -port with pattern /dev/tty*, not a networking interface. The reason for ModemManager |
68 | -to use that instead of the networking interface is that this last one can appear/disappear |
69 | -dynamically while the ports do not if the hardware configuration remains unchanged. |
70 | -For instance, the networking interface can be ppp0, ppp1, etc., and it might be |
71 | -different each time it is possible to have other ppp connections with, say, VPNs. |
72 | +where <interface> is the string listed as “primary port” in the |
73 | +output from `sudo mmcli -m <N>` (as previously described), |
74 | +<name> is an arbitrary name used to identify the connection, and |
75 | +<operator_apn> is the APN name for your cellular data plan. |
76 | +Note that <interface> is usually a serial port with pattern |
77 | +tty\* or a cdc-wdm\* device, not a networking interface. As these |
78 | +interface names might change depending on the devices present in the |
79 | +system, a better alternative is to use the sysfs path shown by mmcli |
80 | +(device: ...) or use `'*'`, which will use any modem device detected |
81 | +by MM: |
82 | + |
83 | +``` |
84 | +sudo nmcli c add type gsm ifname '*' con-name <name> apn <operator_apn> |
85 | +``` |
86 | |
87 | After executing these commands, NetworkManager will automatically try to bring up |
88 | the cellular connection whenever ModemManager reports that the modem has |
89 | @@ -115,9 +125,9 @@ $ nmcli c modify <name> connection.autoconnect [yes|no] |
90 | $ nmcli c down <name> |
91 | ``` |
92 | |
93 | -Finally, note that we can provide the PIN (so it is entered automatically) or more |
94 | -needed APN provisioning information when creating/modifying the WWAN connection. |
95 | -For instance: |
96 | +Finally, note that we can provide the PIN (so it is entered |
97 | +automatically) or additional APN provisioning information when |
98 | +creating/modifying the WWAN connection. For instance: |
99 | |
100 | ``` |
101 | $ nmcli c add type gsm ifname <interface> con-name <name> apn <operator_apn> username <user> password <password> pin <PIN> |
102 | diff --git a/docs/configure-wifi-access-points.md b/docs/configure-wifi-access-points.md |
103 | new file mode 100644 |
104 | index 0000000..a87c517 |
105 | --- /dev/null |
106 | +++ b/docs/configure-wifi-access-points.md |
107 | @@ -0,0 +1,24 @@ |
108 | +--- |
109 | +title: "Configure WiFi Access Points" |
110 | +table_of_contents: True |
111 | +--- |
112 | + |
113 | +# Configure WiFi Access Points |
114 | + |
115 | +It is possible to create WiFi Access Points with the network-manager snap. |
116 | +This can be done by running |
117 | + |
118 | +``` |
119 | +$ nmcli d wifi hotspot ifname <wifi_iface> ssid <ssid> password <password> |
120 | +``` |
121 | + |
122 | +where `<wifi_iface>` is the wifi network interface, `<ssid>` is the |
123 | +SSID for the AP that we are creating and that will be visible to |
124 | +devices connecting to it, and `<password>` is the access password |
125 | +(that needs to have between 8-63 characters or 64 hexadecimal |
126 | +characters). NM will create a connection called '`Hotspot <N>`' if |
127 | +the command is successful. |
128 | + |
129 | +The created AP offers by default a shared connection, so devices |
130 | +connected to it should be able to access the Internet if the device |
131 | +providing the AP has access too. |
132 | diff --git a/docs/configure-wifi-connections.md b/docs/configure-wifi-connections.md |
133 | index 4602dfd..aab3f9f 100644 |
134 | --- a/docs/configure-wifi-connections.md |
135 | +++ b/docs/configure-wifi-connections.md |
136 | @@ -6,11 +6,11 @@ table_of_contents: True |
137 | # Configure WiFi Connections |
138 | |
139 | This section explains how to establish a WiFi connection. It covers creating and |
140 | -modyfying connections as well as directly connecting. |
141 | +modifying connections as well as directly connecting. |
142 | |
143 | ## Establish a Wireless Connection |
144 | |
145 | -This section will show how to establish a wifi connection to the wireles |
146 | +This section will show how to establish a wifi connection to the wireless |
147 | network. Note that directly connecting will implicitly create a connection (that |
148 | can be seen with "nmcli c"). The naming of such will follow "SSID N" pattern, |
149 | where N is a number. |
150 | diff --git a/docs/edit-connections.md b/docs/edit-connections.md |
151 | index 0c9d087..15eadec 100644 |
152 | --- a/docs/edit-connections.md |
153 | +++ b/docs/edit-connections.md |
154 | @@ -5,9 +5,9 @@ table_of_contents: True |
155 | |
156 | # Edit Connections |
157 | |
158 | -This part will show you how to use a network-manager built-in editor to modify |
159 | -the connections as well as provide a reference for setting some of the |
160 | -settings. |
161 | +This section shows how to use the network-manager built-in editor to |
162 | +modify connections as well as provide a reference for changing some of |
163 | +the settings. |
164 | |
165 | ## Using nmcli Console |
166 | |
167 | @@ -88,7 +88,7 @@ IPv4 and IPv6 settings. |
168 | |
169 | It is important to understand that every option can be modified using either the |
170 | command-line or the editor. The advantage of the editor is that it shows which |
171 | -options are availabe for modification in contrast to the command-line which does |
172 | +options are available for modification in contrast to the command-line which does |
173 | not. |
174 | |
175 | It is possible however to learn about the available settings from the |
176 | diff --git a/docs/enable-ethernet-support.md b/docs/enable-ethernet-support.md |
177 | deleted file mode 100644 |
178 | index 1aebf45..0000000 |
179 | --- a/docs/enable-ethernet-support.md |
180 | +++ /dev/null |
181 | @@ -1,38 +0,0 @@ |
182 | ---- |
183 | -title: "Enable Ethernet Support" |
184 | -table_of_contents: False |
185 | ---- |
186 | - |
187 | -# Enable Ethernet Support |
188 | - |
189 | -The default netplan configuration files in Ubuntu Core leave management of |
190 | -Ethernet devices to networkd. Therefore, to avoid conflicts, the |
191 | -network-manager snap does not manage Ethernet devices by default. The user has |
192 | -to take care to enable it after installation if desired. |
193 | - |
194 | -## Configure System for Ethernet Support |
195 | - |
196 | -Before following the instructions below, backup the contents of /etc/netplan to |
197 | -be able to restore it at a later point. |
198 | - |
199 | -Also, note that this change might lead to a system without properly configured |
200 | -network connections, which would lead to problems accessing the device, so be |
201 | -careful when doing this. |
202 | - |
203 | -To enable ethernet support, you have to set the `ethernet.enable` property to |
204 | -`true`. See how to do this [here](reference/configuration/ethernet_support.md). |
205 | -When this is done, configuration files for netplan are created so |
206 | -network-manager is the default netplan renderer. When set to `false` (the |
207 | -default), the NM snap explicitly disables the management of ethernet devices to |
208 | -avoid conflicts with networkd. |
209 | - |
210 | -Rebooting the system will be needed for the changes to take effect. |
211 | - |
212 | -After the reboot, NetworkManager should automatically set up attached Ethernet |
213 | -ports or use existing netplan configuration files to setup connections. |
214 | - |
215 | -Once logged into the system you may check the current connection status by |
216 | - |
217 | -``` |
218 | -$ nmcli c show |
219 | -``` |
220 | diff --git a/docs/faq.md b/docs/faq.md |
221 | index ede5b21..e84de9d 100644 |
222 | --- a/docs/faq.md |
223 | +++ b/docs/faq.md |
224 | @@ -12,7 +12,8 @@ to provide solutions for them. |
225 | |
226 | ### Possible cause: Ethernet support is disabled for NetworkManager |
227 | |
228 | -By default the network-manager snap disables Ethernet support to avoid conflicts |
229 | -with networkd/netplan which are used by default on Ubuntu Core 16. See |
230 | -*[Enable Ethernet Support](enable-ethernet-support.md)* for details on how to |
231 | +The core16 based network-manager snap (1.2.2 version) disables by default |
232 | +ethernet support to avoid conflicts |
233 | +with networkd/netplan. See |
234 | +*[NetworkManager and netplan](networkmanager-and-netplan.md)* for details on how to |
235 | enable it. |
236 | diff --git a/docs/index.md b/docs/index.md |
237 | index 81dcc30..6909fc2 100644 |
238 | --- a/docs/index.md |
239 | +++ b/docs/index.md |
240 | @@ -6,31 +6,32 @@ table_of_contents: False |
241 | # About NetworkManager |
242 | |
243 | NetworkManager is a system network service that manages your network |
244 | -devices and connections, attempts to keep network connectivity active |
245 | +devices and connections and attempts to keep network connectivity active |
246 | when available. It manages Ethernet, WiFi, mobile broadband (WWAN) and |
247 | PPPoE devices while also providing VPN integration with a variety of |
248 | -different VPN serivces. |
249 | +different VPN services. |
250 | |
251 | -By default network management on [Ubuntu Core](https://www.ubuntu.com/core) is |
252 | -handled by systemd's |
253 | +By default network management on [Ubuntu |
254 | +Core](https://www.ubuntu.com/core) is handled by systemd's |
255 | [networkd](https://www.freedesktop.org/software/systemd/man/systemd-networkd.service.html) |
256 | -and [netplan](https://launchpad.net/netplan). While NetworkManager has some |
257 | -support to handle netplan configuration files, Ethernet support is disabled by |
258 | -default and has to be turned on explicitly to avoid conflicts with existing |
259 | -network configuration. |
260 | +and [netplan](https://launchpad.net/netplan). However, when |
261 | +NetworkManager is installed, it will take control of all networking |
262 | +devices in the system by creating a netplan configuration file in which |
263 | +it sets itself as the default network renderer. |
264 | |
265 | ## What NetworkManager Offers |
266 | |
267 | -The upstream NetworkManager project offers a wide range of features which are |
268 | -partially available in the snap version. However, |
269 | -as the snap should be always delivered in high quality we don't have yet all |
270 | -upstream features enabled. |
271 | +The upstream NetworkManager project offers a wide range of features and |
272 | +most, but not all of them, are available in the snap package at the |
273 | +moment. |
274 | |
275 | Currently we provide support for the following high level features: |
276 | |
277 | * WiFi connectivity |
278 | * WWAN connectivity (together with ModemManager) |
279 | * Ethernet connectivity |
280 | + * WiFi access point creation |
281 | + * Shared connections |
282 | |
283 | Currently we do not support the following features: |
284 | |
285 | diff --git a/docs/installation.md b/docs/installation.md |
286 | index b031d79..c2d2a6a 100644 |
287 | --- a/docs/installation.md |
288 | +++ b/docs/installation.md |
289 | @@ -5,7 +5,7 @@ table_of_contents: True |
290 | |
291 | # Install NetworkManager |
292 | |
293 | -The NetworkManager snap is currently available from the Ubuntu Store. It can |
294 | +The NetworkManager snap is currently available from the Snap Store. It can |
295 | be installed on any system that supports snaps but is only recommended on |
296 | [Ubuntu Core](https://www.ubuntu.com/core) at the moment. |
297 | |
298 | @@ -13,49 +13,79 @@ You can install the snap with the following command: |
299 | |
300 | ``` |
301 | $ snap install network-manager |
302 | - network-manager 1.2.2-10 from 'canonical' installed |
303 | -``` |
304 | + network-manager (1.10/stable) 1.10.6-7 from Canonical✓ installed |
305 | |
306 | -Although the network-manager snap is available from other channels (candidate, beta, edge), |
307 | -only the stable version should be used for production devices. Their meaning is internal |
308 | -to the development team of the network-manager snap. |
309 | +``` |
310 | |
311 | All necessary plugs and slots will be automatically connected within the |
312 | installation process. You can verify this with: |
313 | |
314 | ``` |
315 | -$ snap interfaces network-manager |
316 | -Slot Plug |
317 | -:network-setup-observe network-manager |
318 | -:ppp network-manager |
319 | -network-manager:service network-manager:nmcli |
320 | -- network-manager:modem-manager |
321 | +$ snap connections network-manager |
322 | +Interface Plug Slot Notes |
323 | +dbus network-manager:wpa - - |
324 | +firewall-control network-manager:firewall-control :firewall-control - |
325 | +hardware-observe network-manager:hardware-observe :hardware-observe - |
326 | +login-session-observe network-manager:login-session-observe :login-session-observe - |
327 | +modem-manager network-manager:modem-manager modem-manager:service - |
328 | +network network-manager:network :network - |
329 | +network-manager network-manager:nmcli network-manager:service - |
330 | +network-observe network-manager:network-observe :network-observe - |
331 | +network-setup-control network-manager:network-setup-control :network-setup-control - |
332 | +network-setup-observe network-manager:network-setup-observe :network-setup-observe - |
333 | +ppp network-manager:ppp :ppp - |
334 | + |
335 | ``` |
336 | |
337 | -**NOTE:** The _network-manager:modem-manager_ plug only gets connected when the |
338 | -_modem-manager_ snap is installed too. Otherwise it stays disconnected. |
339 | +**NOTE:** The _network-manager:modem-manager_ plug only gets connected |
340 | +when the _modem-manager_ snap is installed too. Otherwise it stays |
341 | +disconnected. Similarly, there is a _network-manager:wpa_ plug in case |
342 | +we would want to use a custom wpa supplicant snap instead of the one |
343 | +supplied by the core snap (this is not generally recommended). |
344 | |
345 | -Once the installation has successfully finished the |
346 | -NetworkManager service is running in the background. You can check its current |
347 | -status with |
348 | +Once the installation has successfully finished the NetworkManager |
349 | +service is running in the background. You can check its current status |
350 | +with |
351 | |
352 | ``` |
353 | - $ systemctl status snap.networkmanager |
354 | - ● snap.networkmanager.service - Service for snap application networkmanager |
355 | - Loaded: loaded (/etc/systemd/system/snap.networkmanager.service; enabled; vendor preset: enabled) |
356 | - Active: active (running) since Thu 2017-02-16 09:59:39 UTC; 16s ago |
357 | - Main PID: 1389 (networkmanager) |
358 | - [...] |
359 | + $ systemctl status snap.network-manager.networkmanager.service |
360 | + ● snap.network-manager.networkmanager.service - Service for snap application network-manager.networkmanager |
361 | + Loaded: loaded (/etc/systemd/system/snap.network-manager.networkmanager.service; enabled; vendor preset: enabled) |
362 | + Active: active (running) since Thu 2020-07-09 10:19:01 UTC; 6min ago |
363 | + Main PID: 2850 (NetworkManager) |
364 | + Tasks: 3 (limit: 569) |
365 | + CGroup: /system.slice/snap.network-manager.networkmanager.service |
366 | + └─2850 /snap/network-manager/564/usr/sbin/NetworkManager --config-dir=/var/snap/network-manager/564/conf.d/ --config=/snap/network-manager/564/etc/NetworkManager/NetworkManager.conf --log-level=INFO --no-daemon |
367 | ``` |
368 | |
369 | Now you have NetworkManager successfully installed. |
370 | |
371 | +## network-manager tracks and channels |
372 | + |
373 | +The network-manager snap has currently three tracks: |
374 | + |
375 | + * **20**: Contains upstream 1.22.10 and has a core20 base. The track name refers |
376 | + to the base snap and it is the convention being used at the moment. |
377 | + * **1.10**: Contains upstream 1.10.6 and has a core18 base. Nowadays, this is the one |
378 | + installed by default if the channel is not specified when running `snap install`. |
379 | + The track name refers to the upstream version. More modern releases have changed |
380 | + the convention so the track now refers to the base snap. |
381 | + * **latest**: Contains upstream 1.2.2 and has a core16 base. Despite the unfortunate |
382 | + name (there are historical reasons for that) it is the oldest version. |
383 | + |
384 | +All these tracks are available with the usual risks: stable, |
385 | +candidate, beta, and edge, but only the stable version should be used |
386 | +for production devices. The meaning of the other risk levels is |
387 | +internal to the development team of the network-manager snap. |
388 | + |
389 | ## Next Steps |
390 | |
391 | - * [Enable Ethernet Support](enable-ethernet-support.md) |
392 | + * [NetworkManager and netplan](networkmanager-and-netplan.md) |
393 | * [Explore Network Status](explore-network-status.md) |
394 | * [Configure WiFi Connections](configure-wifi-connections.md) |
395 | + * [Configure WiFi Access Points](configure-wifi-access-points.md) |
396 | * [Configure Cellular Connections](configure-cellular-connections.md) |
397 | + * [Configure shared connections](configure-a-shared-connection.md) |
398 | * [Edit Network Connections](edit-connections.md) |
399 | * [Routing Tables](routing-tables.md) |
400 | * [Logging Messages](logging-messages.md) |
401 | diff --git a/docs/logging-messages.md b/docs/logging-messages.md |
402 | index d242808..5dd4679 100644 |
403 | --- a/docs/logging-messages.md |
404 | +++ b/docs/logging-messages.md |
405 | @@ -5,10 +5,10 @@ table_of_contents: False |
406 | |
407 | # Logging Messages |
408 | |
409 | -This section will show how to modify the logging levels by NetworkManager. |
410 | +This section shows how to modify the logging levels by NetworkManager. |
411 | |
412 | NetworkManager supports on the fly changing of the logging levels and allows for |
413 | -a fine control over what is logged. |
414 | +a fine grained control over what is logged. |
415 | |
416 | First check what is the current logging setup, type: |
417 | |
418 | @@ -34,10 +34,10 @@ $ nmcli general logging [level <level> [domain <domain>]] |
419 | The <level> is the desired log level. You can choose from the following: |
420 | |
421 | * **ERR:** will log only critical errors |
422 | -* **WARN:** will log warnin messages |
423 | +* **WARN:** will log warning messages |
424 | * **INFO:** will log various informational messages |
425 | * **DEBUG:** enables verbose logging for debugging purposes |
426 | |
427 | <domain> is the category of messages that shall be logged with given |
428 | severity. **WIFI** will include only WiFi related messages, **IP4** will include |
429 | -only IPv4 related messages and so on.. |
430 | +only IPv4 related messages, and so on. |
431 | diff --git a/docs/metadata.yaml b/docs/metadata.yaml |
432 | index 82bf35f..12c634a 100644 |
433 | --- a/docs/metadata.yaml |
434 | +++ b/docs/metadata.yaml |
435 | @@ -13,10 +13,14 @@ navigation: |
436 | location: explore-network-status.md |
437 | - title: Configure WiFi Connections |
438 | location: configure-wifi-connections.md |
439 | + - title: Configure WiFi Access Points |
440 | + location: configure-wifi-access-points.md |
441 | - title: Configure Cellular Connections |
442 | location: configure-cellular-connections.md |
443 | - - title: Enable Ethernet Support |
444 | - location: enable-ethernet-support.md |
445 | + - title: Configure shared connections |
446 | + location: configure-a-shared-connection.md |
447 | + - title: NetworkManager and netplan |
448 | + location: networkmanager-and-netplan.md |
449 | - title: Edit Connections |
450 | location: edit-connections.md |
451 | - title: Routing Tables |
452 | @@ -27,10 +31,12 @@ navigation: |
453 | children: |
454 | - title: Snap Configuration |
455 | children: |
456 | - - title: Ethernet Support |
457 | - location: reference/configuration/ethernet_support.md |
458 | + - title: Default renderer |
459 | + location: reference/snap-configuration/default_renderer.md |
460 | - title: Debug |
461 | location: reference/snap-configuration/debug.md |
462 | + - title: Connectivity check |
463 | + location: reference/snap-configuration/connectivity-check.md |
464 | - title: Wake on WLAN |
465 | location: reference/snap-configuration/wowlan.md |
466 | - title: WiFi Powersave |
467 | diff --git a/docs/networkmanager-and-netplan.md b/docs/networkmanager-and-netplan.md |
468 | new file mode 100644 |
469 | index 0000000..9f34e88 |
470 | --- /dev/null |
471 | +++ b/docs/networkmanager-and-netplan.md |
472 | @@ -0,0 +1,31 @@ |
473 | +--- |
474 | +title: "NetworkManager and netplan" |
475 | +table_of_contents: False |
476 | +--- |
477 | + |
478 | +# NetworkManager and netplan |
479 | + |
480 | +The default netplan configuration files in Ubuntu Core leave |
481 | +management of networking devices to networkd. But, when |
482 | +network-manager is installed, it creates new netplan configuration |
483 | +files, setting itself as the default network renderer and taking |
484 | +control of all devices. |
485 | + |
486 | +It is possible to control this behavior with the `defaultrenderer` |
487 | +snap option. It is set by default to `true`, but if we set it to |
488 | +`false`, network-manager reverts the netplan configuration and |
489 | +networkd takes control of the devices again. Note however that |
490 | +networkd will take control only of devices explicitly configured by |
491 | +netplan configuration files, which is usually only ethernet or wifi |
492 | +devices. To do that: |
493 | + |
494 | +``` |
495 | +snap set network-manager defaultrenderer=false |
496 | +``` |
497 | + |
498 | +In the core16 snap (legacy), the behavior was different: networkd was |
499 | +left as default renderer and the default netplan configuration was |
500 | +unchanged when network-manager was installed. There was instead a |
501 | +setting called `ethernet.enable` that was `false` by default. When set |
502 | +to `true`, NetworkManager was set as the default network renderer |
503 | +similarly as described above. |
504 | diff --git a/docs/reference/available-commands.md b/docs/reference/available-commands.md |
505 | index 18b3cec..b774403 100644 |
506 | --- a/docs/reference/available-commands.md |
507 | +++ b/docs/reference/available-commands.md |
508 | @@ -17,3 +17,15 @@ NetworkManager service. |
509 | |
510 | An explanatory description of the command and available options are available |
511 | [here](https://developer.gnome.org/NetworkManager/1.2/nmcli.html) |
512 | + |
513 | +## network-manager.nmtui |
514 | + |
515 | +nmtui is the Network Manager Text User Interface. It is a curses-based application |
516 | +that allows easy configuration of connections and networking settings. Besides |
517 | +network-manager.nmtui, these other three commands are available: |
518 | + |
519 | +* network-manager.nmtui-edit |
520 | +* network-manager.nmtui-connect |
521 | +* network-manager.nmtui-hostname |
522 | + |
523 | +More details can be found in the [manual page](https://developer.gnome.org/NetworkManager/stable/nmtui.html). |
524 | diff --git a/docs/reference/configuration/ethernet_support.md b/docs/reference/configuration/ethernet_support.md |
525 | deleted file mode 100644 |
526 | index fbc5929..0000000 |
527 | --- a/docs/reference/configuration/ethernet_support.md |
528 | +++ /dev/null |
529 | @@ -1,47 +0,0 @@ |
530 | ---- |
531 | -title: Ethernet Support |
532 | -table_of_contents: true |
533 | ---- |
534 | - |
535 | -# Ethernet Support |
536 | - |
537 | -*Available since:* 1.2.2-12 |
538 | - |
539 | -The NetworkManager snap provides a configuration option to adjust |
540 | -if it should manage ethernet network connections. |
541 | - |
542 | -By default the NetworkManager snap **does not** manage ethernet network |
543 | -devices as it would conflict with the default network management in |
544 | -Ubuntu Core which is handled by [netplan](https://launchpad.net/netplan) and |
545 | -[networkd](https://www.freedesktop.org/software/systemd/man/systemd-networkd.service.html). |
546 | - |
547 | -## Enable Ethernet Support |
548 | - |
549 | -To enable management of ethernet network devices the snap provides the |
550 | -*ethernet.enable* configuration option. |
551 | - |
552 | -This configuration option accepts the following values |
553 | - |
554 | - * **false (default):** Ethernet support is disabled. All network |
555 | - devices matching the expression 'en*' or 'eth*' will be ignored. |
556 | - * **true:** All ethernet devices available on the system will be |
557 | - managed by NetworkManager. networkd will not manage any of these |
558 | - anymore. |
559 | - |
560 | -Changing the *ethernet* configuration option needs a reboot of the |
561 | -device it's running on. |
562 | - |
563 | -After the device has rebooted ethernet support is enabled NetworkManager will |
564 | -take over management of all available ethernet network devices on the device. |
565 | - |
566 | -NetworkManager will reuse existing configurations files from */etc/netplan* |
567 | -when ethernet support is enabled. Those will marked as immutable inside |
568 | -NetworkManager and any changes need to be written manually into the relevant |
569 | -files in */etc/netplan*. |
570 | - |
571 | -Example: |
572 | - |
573 | -``` |
574 | - $ snap set network-manager ethernet.enable=true |
575 | - $ sudo reboot |
576 | -``` |
577 | diff --git a/docs/reference/dbus-api.md b/docs/reference/dbus-api.md |
578 | index 7cece10..cc7b7f0 100644 |
579 | --- a/docs/reference/dbus-api.md |
580 | +++ b/docs/reference/dbus-api.md |
581 | @@ -6,4 +6,4 @@ table_of_contents: False |
582 | # DBUS API |
583 | |
584 | Documentation of the DBus API is provided by the NetworkManager upstream project |
585 | -[here](https://developer.gnome.org/NetworkManager/1.2/spec.html). |
586 | +[here](https://developer.gnome.org/NetworkManager/stable/spec.html). |
587 | diff --git a/docs/reference/snap-configuration/connectivity-check.md b/docs/reference/snap-configuration/connectivity-check.md |
588 | new file mode 100644 |
589 | index 0000000..c68cbe4 |
590 | --- /dev/null |
591 | +++ b/docs/reference/snap-configuration/connectivity-check.md |
592 | @@ -0,0 +1,28 @@ |
593 | +--- |
594 | +title: Connectivity check |
595 | +table_of_contents: true |
596 | +--- |
597 | + |
598 | +# Connectivity check |
599 | + |
600 | +Connectivity checking is a NetworkManager functionality that allows |
601 | +periodically testing whether the system can actually access the |
602 | +internet or not. The network-manager snap allows configuring this |
603 | +feature by using the following snap settings: |
604 | + |
605 | +* **connectivity.interval**: it specifies the number of seconds between checks. |
606 | + If set to 0, it disables connectivity check. Set to 300 by default. |
607 | +* **connectivity.response**: This is the expected HTTP body response from the server |
608 | + specified by connectivity.uri. |
609 | +* **connectivity.uri**: The URI where NM is going to periodically access to check connectivity. |
610 | + |
611 | +More details on how these options work can be found in the connectivity section of |
612 | +the [NetworkManager.conf configuration file documentation](https://developer.gnome.org/NetworkManager/stable/NetworkManager.conf.html). |
613 | + |
614 | +Some example commands on how to set a check every three minutes using the |
615 | +Ubuntu connectivity check server are |
616 | + |
617 | +``` |
618 | +$ snap set network-manager connectivity.uri=http://connectivity-check.ubuntu.com/ |
619 | +$ snap set network-manager connectivity.interval=180 |
620 | +``` |
621 | diff --git a/docs/reference/snap-configuration/debug.md b/docs/reference/snap-configuration/debug.md |
622 | index e16d17c..1e54976 100644 |
623 | --- a/docs/reference/snap-configuration/debug.md |
624 | +++ b/docs/reference/snap-configuration/debug.md |
625 | @@ -9,7 +9,7 @@ Debug is a feature that controls the amount of logs produced by the network-mana |
626 | snap. It is useful for collecting information required to either report a bug or |
627 | investigate a network-manager failure (if happens). |
628 | |
629 | -It is disabled by default and has to be explicitely turned on for usage. |
630 | +It is disabled by default and has to be explicitly turned on for usage. |
631 | |
632 | Note that the debug logs may contain sensitive information. |
633 | |
634 | @@ -47,5 +47,5 @@ The debug information, when enabled, will be available in the journal and can |
635 | be viewed with: |
636 | |
637 | ``` |
638 | -$ journalctl --no-pager -u snap.network-manager.networkmanager.service |
639 | +$ journalctl --no-pager -l -u snap.network-manager.networkmanager.service |
640 | ``` |
641 | diff --git a/docs/reference/snap-configuration/default_renderer.md b/docs/reference/snap-configuration/default_renderer.md |
642 | new file mode 100644 |
643 | index 0000000..a50ca48 |
644 | --- /dev/null |
645 | +++ b/docs/reference/snap-configuration/default_renderer.md |
646 | @@ -0,0 +1,18 @@ |
647 | +--- |
648 | +title: Default renderer |
649 | +table_of_contents: true |
650 | +--- |
651 | + |
652 | +# Default renderer |
653 | + |
654 | +The NetworkManager snap provides a configuration option, |
655 | +`defaultrenderer`, to adjust if it should be the default network |
656 | +renderer or not. By default, it is set to `true`. To change it: |
657 | + |
658 | +``` |
659 | +snap set network-manager defaultrenderer=false |
660 | +``` |
661 | + |
662 | +For the core16 snap, there is an option called `ethernet.enable` that |
663 | +does basically the same. See the [NetworkManager and netplan](../../networkmanager-and-netplan.md) |
664 | +section for more details. |
665 | diff --git a/docs/reference/snap-configuration/wifi-powersave.md b/docs/reference/snap-configuration/wifi-powersave.md |
666 | index 8b9e68f..1958697 100644 |
667 | --- a/docs/reference/snap-configuration/wifi-powersave.md |
668 | +++ b/docs/reference/snap-configuration/wifi-powersave.md |
669 | @@ -7,7 +7,7 @@ table_of_contents: True |
670 | |
671 | WiFi Powersave is a feature that allows a device to suspend its radio activity |
672 | after a fixed period of inactivity. The device remains idle for a fixed time, |
673 | -usualy about 100ms, and once it is reached it wakes up to check if the |
674 | +usually about 100ms, and once it is reached it wakes up to check if the |
675 | infrastructure has any packets queued up for it. |
676 | |
677 | The NetworkManager snap allows to configure this option by either enabling or |
678 | diff --git a/docs/reference/snap-configuration/wowlan.md b/docs/reference/snap-configuration/wowlan.md |
679 | index 2ae0791..c4145af 100644 |
680 | --- a/docs/reference/snap-configuration/wowlan.md |
681 | +++ b/docs/reference/snap-configuration/wowlan.md |
682 | @@ -8,7 +8,7 @@ table_of_contents: True |
683 | *Available since:* 1.2.2-11 |
684 | |
685 | Wake on WLAN (called WoWLAN in the following) is a feature which allows a device |
686 | -to be woken up from standby power states to faciliate device management. It is based |
687 | +to be woken up from standby power states to facilitate device management. It is based |
688 | on the well well-established standard for Wake on LAN. The functionality is not entirely |
689 | equivalent to Wake on LAN and there are some limitations. |
690 | |
691 | @@ -53,7 +53,7 @@ This configuration option accepts the following values: |
692 | The content of the magic packet can be extended with the |
693 | wifi.wake-on-wlan-password option to require the client to send a |
694 | specific byte sequence functioning as a password so that not anyone |
695 | - unpriviledged can wake up the system. |
696 | + unprivileged can wake up the system. |
697 | * **gtk-rekey-failure:** A failure of a GTK rekey operation will cause the device to wake up. |
698 | * **4way-handshake:** Reiteration of the 4way handshake will cause the device to wake up. |
699 | * **rfkill-release:** Release of a rfkill will cause the device to wake up. |
700 | @@ -69,7 +69,7 @@ Example: |
701 | |
702 | This configuration option accepts a textual value. If specified, the value will |
703 | be used in addition to the wireless device MAC address to function as a password |
704 | -that disallows unpriviledged actors to wake up the device. |
705 | +that disallows unprivileged actors to wake up the device. |
706 | |
707 | Example: |
708 | |
709 | diff --git a/docs/release-notes.md b/docs/release-notes.md |
710 | index 8a96cee..93de8d7 100644 |
711 | --- a/docs/release-notes.md |
712 | +++ b/docs/release-notes.md |
713 | @@ -5,31 +5,56 @@ table_of_contents: False |
714 | |
715 | # Release Notes |
716 | |
717 | -The version numbers mentioned on this page correspond to those released in the |
718 | -Ubuntu snap store. |
719 | - |
720 | -You can check with the following command which version you have currently |
721 | -installed: |
722 | +You can check with the following command which version you have |
723 | +currently installed: |
724 | |
725 | ``` |
726 | $ snap info network-manager |
727 | name: network-manager |
728 | -summary: "Network management based on NeworkManager" |
729 | -publisher: canonical |
730 | +summary: Network Manager |
731 | +publisher: Canonical✓ |
732 | +store-url: https://snapcraft.io/network-manager |
733 | +contact: https://help.ubuntu.com/community/NetworkManager |
734 | +license: unset |
735 | description: | |
736 | - Network management of wired Ethernet, WiFi and mobile data connection based on |
737 | - NetworkManager and ModemManager |
738 | + NetworkManager is a system network service that manages your network |
739 | + devices and connections, attempting to keep active network connectivity |
740 | + when available. It manages ethernet, WiFi, mobile broadband (WWAN) and |
741 | + PPPoE devices, provides VPN integration with a variety of different |
742 | + VPN serivces. |
743 | + Please find the source code for this track at: |
744 | + https://code.launchpad.net/~snappy-hwe-team/snappy-hwe-snaps/+git/network-manager/+ref/snap-1.10 |
745 | commands: |
746 | - - nmcli |
747 | -tracking: stable |
748 | -installed: 1.2.2-10 (73) 5MB - |
749 | -[...] |
750 | + - network-manager.nmcli |
751 | + - network-manager.nmtui |
752 | + - network-manager.nmtui-connect |
753 | + - network-manager.nmtui-edit |
754 | + - network-manager.nmtui-hostname |
755 | +services: |
756 | + network-manager.networkmanager: simple, enabled, active |
757 | +snap-id: RmBXKl6HO6YOC2DE4G2q1JzWImC04EUy |
758 | +tracking: 1.10/stable |
759 | +refresh-date: today at 10:18 UTC |
760 | +channels: |
761 | + 1.10/stable: 1.10.6-7 2020-06-29 (564) 4MB - |
762 | + 1.10/candidate: 1.10.6-7 2020-06-29 (564) 4MB - |
763 | + 1.10/beta: 1.10.6-7 2020-06-25 (564) 4MB - |
764 | + 1.10/edge: 1.10.6-5-dev 2020-04-06 (542) 4MB - |
765 | + latest/stable: 1.2.2-25 2020-06-22 (554) 4MB - |
766 | + latest/candidate: 1.2.2-25 2020-06-19 (554) 4MB - |
767 | + latest/beta: 1.2.2-26 2020-07-07 (573) 4MB - |
768 | + latest/edge: 1.2.2-26-dev 2020-07-07 (569) 4MB - |
769 | + 20/stable: – |
770 | + 20/candidate: – |
771 | + 20/beta: 1.22.10-1 2020-06-25 (561) 5MB - |
772 | + 20/edge: 1.22.10-2-dev 2020-07-08 (580) 5MB - |
773 | +installed: 1.10.6-7 (564) 4MB - |
774 | + |
775 | ``` |
776 | -</br> |
777 | -## 1.2.2-11 |
778 | |
779 | - * Wake-on-WLAN can be configured via snap/nmcli |
780 | - * Automatic reconfiguration of network devices when device comes back from a |
781 | - low power state |
782 | - * Snap alias available for nmcli |
783 | - * WiFi powersave is configurable via snap configuration |
784 | +The detailed changelog for each revision can be consulted in the sources |
785 | +for each track: |
786 | + |
787 | +* For track 20, [here](https://git.launchpad.net/~snappy-hwe-team/snappy-hwe-snaps/+git/network-manager/tree/ChangeLog?h=snap-20) |
788 | +* For track 1.10, [here](https://git.launchpad.net/~snappy-hwe-team/snappy-hwe-snaps/+git/network-manager/tree/ChangeLog?h=snap-1.10) |
789 | +* For track latest (note again this is not actually the more modern NM), [here](https://git.launchpad.net/~snappy-hwe-team/snappy-hwe-snaps/+git/network-manager/tree/ChangeLog) |
PASSED: Successfully build documentation, rev: 3c8c77260a86470 d37bec5f2cf9730 e3719c4a45
Generated documentation is available at https:/ /jenkins. canonical. com/system- enablement/ job/snappy- hwe-snaps- snap-docs/ 1337/