From 94aeedb64a9750aa8c40fa3d17f5267aa5368ccc Mon Sep 17 00:00:00 2001 From: Wen Liang Date: Tue, 20 Feb 2024 14:25:46 -0500 Subject: [PATCH] docs: Update the description about the variable `network_allow_restart` Signed-off-by: Wen Liang --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b849e5f..a480573 100644 --- a/README.md +++ b/README.md @@ -92,11 +92,14 @@ the name prefix. List of variables: - `network_connections` - The connection profiles are configured as `network_connections`, which is a list of dictionaries that include specific options. -- `network_allow_restart` - Certain configurations require the role to restart - network services. For example, if a wireless connection is configured and - NetworkManager-wifi is not installed, NetworkManager must be restarted prior - to the connection being configured. Setting this to `false` will prevent the - role from restarting network service. +- `network_allow_restart` - It defaults to `false`. To load NetworkManager plugins + after installation, NetworkManager requires to be restarted. For example, if a + wireless connection is configured and NetworkManager-wifi is not installed, + NetworkManager must be restarted prior to the connection being configured. The + restart can result in connectivity loss and therefore the role does not allow it + without explicit consent. The user can consent to it by setting + `network_allow_restart` to `true`. Setting `network_allow_restart` to `false` will + prevent the role from restarting NetworkManager. - `network_state` - The network state settings can be configured in the managed host, and the format and the syntax of the configuration should be consistent with the [nmstate state examples](https://nmstate.io/examples.html) (YAML).