Kubernetes NMState Operator¶

Kubernetes NMState Operator Official Documentation

The Kubernetes NMState Operator manages node network configuration on the cluster. It is required for configuring advanced networking such as bonds, VLANs, and OVS bridges on bare metal nodes.

Install the Operator via WebUI¶

Go to Ecosystem -> Software Catalog -> filter for "nmstate" -> click "Kubernetes NMState Operator" tile
Click Install
Leave all the defaults and click Install
After the operator is installed, go to Ecosystem -> Installed Operators -> and click on "Kubernetes NMState Operator"
Click on the NMState tab at the top and then click "Create NMState" button
Don't change anything. Click "Create" button.
The screen will refresh because of the updated console plugin for NMState.
Check the Networking menu item has been updated with a bunch of new options. Click on "Node network configuration" to view your cluster network setup. If the option is not present, do a browser refresh (F5) for the GUI and the items will be present.

Install the Operator via YAML¶

apiVersion: v1
kind: Namespace
metadata:
  name: openshift-nmstate
---
apiVersion: operators.coreos.com/v1
kind: OperatorGroup
metadata:
  name: openshift-nmstate
  namespace: openshift-nmstate
spec:
  targetNamespaces:
    - openshift-nmstate
---
apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: kubernetes-nmstate-operator
  namespace: openshift-nmstate
spec:
  channel: stable
  installPlanApproval: Automatic
  name: kubernetes-nmstate-operator
  source: redhat-operators
  sourceNamespace: openshift-marketplace

oc apply -f nmstate-operator.yaml

Wait for the operator to install:

oc wait --for=condition=Available deployment/nmstate-operator -n openshift-nmstate --timeout=120s

Create the NMState Instance¶

After the operator is running, create the NMState custom resource to deploy the state controller across all nodes:

apiVersion: nmstate.io/v1
kind: NMState
metadata:
  name: nmstate

oc apply -f nmstate-instance.yaml

Verify¶

oc get nmstate
oc get daemonset -n openshift-nmstate

All nodes should have a running NMState handler pod:

oc get pods -n openshift-nmstate

Warning

If the Networking > Node network configuration option is not present in the left hand menu, do a browser refresh (F5) for the GUI and the items will be present.