Skip to content

Commit 1630646

Browse files
docs: Promote network_state variable as the future for network management
Signed-off-by: Wen Liang <[email protected]>
1 parent f3f5aa6 commit 1630646

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,18 @@ NetworkManager's API version since which the settings are introduced.
3232

3333
The `network` role supports two modules: `network_connections` and `network_state`.
3434

35+
Since the backend of `network_state` is Nmstate, the `network_state` modules represents
36+
the future direction for the network role, aiming to provide a more streamlined and
37+
reliable way of managing network. As a result, the focus is on promoting the use of
38+
`network_state` over the `network_connections` variable to ensure better consistency
39+
and functionality moving forward. Additionally, most of the features currently
40+
supported in NetworkManager are also available with `network_state`. For more
41+
information and examples on how to configure the network using Nmstate schema in
42+
`network_state` variable, please refer to the official documentation at
43+
[nmstate.io](https://nmstate.io). For detailed syntax and explanations of each
44+
parameter, visit
45+
[nmstate's API documentation](https://docs.rs/nmstate/latest/nmstate/index.html).
46+
3547
For each host a list of networking profiles can be configured via the
3648
`network_connections` variable.
3749

0 commit comments

Comments
 (0)