mark nmstate as experimental
@@ -137,13 +137,34 @@ spec:
rangeEnd: "FD:FF:FF:FF:FF:FF"
```
-## Nmstate
+## NMState
-The operator allows the administrator to deploy the [NmState State Controller](https://github.com/nmstate/nmstate) as a daemonset across all of one's nodes.
-This project manages host networking settings in a declarative manner. The networking state is described by a pre-defined schema. Reporting of current state and changes to it (desired state) both conform to the schema.
-Nmstate is aimed to satisfy enterprise needs to manage host networking through a northbound declarative API and multi provider support on the southbound. NetworkManager acts as the main (and currently the only) provider supported.
+**Note:** This feature is **experimental**. NMState is unstable and its API
+may change.
-It communicate with a NetworkManager instance running on the node using D-Bus. Make sure that NetworkManager is installed and running on each node.
+The operator allows the administrator to deploy the [NMState State
+Controller](https://github.com/nmstate/nmstate) as a daemonset across all of
+one's nodes. This project manages host networking settings in a declarative
+manner. The networking state is described by a pre-defined schema. Reporting of
+current state and changes to it (desired state) both conform to the schema.
+NMState is aimed to satisfy enterprise needs to manage host networking through a
+northbound declarative API and multi provider support on the southbound.
+NetworkManager acts as the main (and currently the only) provider supported.
+
+This component can be enabled by adding `nmstate` section to the
+`NetworkAddonsConfig`.
+
+```yaml
+apiVersion: networkaddonsoperator.network.kubevirt.io/v1alpha1
+kind: NetworkAddonsConfig
+metadata:
+ name: cluster
+spec:
+ nmstate: {}
+```
+
+It communicate with a NetworkManager instance running on the node using D-Bus.
+Make sure that NetworkManager is installed and running on each node.
```shell
yum install NetworkManager
