Chapter 1. Kubernetes NMState Operator

Procedure

1. Select Ecosystem Software Catalog.
2. In the search field below All Items, enter nmstate and click Enter to search for the Kubernetes NMState Operator.
3. Click on the Kubernetes NMState Operator search result.
4. Click on Install to open the Install Operator window.
5. Click Install to install the Operator.
6. After the Operator finishes installing, click View Operator.
7. Under Provided APIs, click Create Instance to open the dialog box for creating an instance of kubernetes-nmstate.

8. In the Name field of the dialog box, ensure the name of the instance is nmstate.

   Note

   The name restriction is a known issue. The instance is a singleton for the entire cluster.

9. Accept the default settings and click Create to create the instance.

Procedure

1. Create the nmstate Operator namespace:

   $ cat << EOF | oc apply -f -
   apiVersion: v1
   kind: Namespace
   metadata:
     name: openshift-nmstate
   spec:
     finalizers:
     - kubernetes
   EOF

   Copy to Clipboard Toggle word wrap

2. Create the OperatorGroup:

   $ cat << EOF | oc apply -f -
   apiVersion: operators.coreos.com/v1
   kind: OperatorGroup
   metadata:
     name: openshift-nmstate
     namespace: openshift-nmstate
   spec:
     targetNamespaces:
     - openshift-nmstate
   EOF

   Copy to Clipboard Toggle word wrap

3. Subscribe to the nmstate Operator:

   $ cat << EOF| oc apply -f -
   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
   EOF

   Copy to Clipboard Toggle word wrap

4. Confirm the ClusterServiceVersion (CSV) status for the nmstate Operator deployment equals Succeeded:

   $ oc get clusterserviceversion -n openshift-nmstate \
    -o custom-columns=Name:.metadata.name,Phase:.status.phase

   Copy to Clipboard Toggle word wrap

5. Create an instance of the nmstate Operator:

   $ cat << EOF | oc apply -f -
   apiVersion: nmstate.io/v1
   kind: NMState
   metadata:
     name: nmstate
   EOF

   Copy to Clipboard Toggle word wrap

6. If your cluster has problems with the DNS health check probe because of DNS connectivity issues, you can add the following DNS host name configuration to the NMState CRD to build in health checks that can resolve these issues:

   apiVersion: nmstate.io/v1
   kind: NMState
   metadata:
     name: nmstate
   spec:
     probeConfiguration:
       dns:
         host: redhat.com
   # ...

   Copy to Clipboard Toggle word wrap

   1. Apply the DNS host name configuration to your cluster network by running the following command. Ensure that you replace <filename> with the name of your CRD file.

      $ oc apply -f <filename>.yaml

      Copy to Clipboard Toggle word wrap

   2. Monitor the nmstate CRD until the resource reaches the Available condition by running the following command. Ensure that you set a value for the --timeout option so that if the Available condition is not met within this set maximum waiting time, the command times out and generates an error message.

      $ oc wait --for=condition=Available nmstate/nmstate --timeout=600s

      Copy to Clipboard Toggle word wrap

Verification

1. Verify that all pods for the NMState Operator have the Running status by entering the following command:

   $ oc get pod -n openshift-nmstate

   Copy to Clipboard Toggle word wrap

Procedure

1. If you want to view the metrics from the Developer perspective in the OpenShift Container Platform web console, complete the following tasks:

   1. Click Observe.
   2. To view the metrics of a specific project, select the project in the Project: list. For example, openshift-nmstate.
   3. Click the Metrics tab.

   4. To visualize the metrics on the plot, select a query from the Select query list or create a custom PromQL query based on the selected query by selecting Show PromQL.

      Note

      You can only run one query at a time with the developer role.

2. If you want to view the metrics in the OpenShift Container Platform web console as an administrator, complete the following tasks:

   1. Click Observe Metrics.
   2. Enter kubernetes_nmstate_features_applied in the Expression field.
   3. Click Add query and then Run queries.

3. To explore the visualized metrics, do any of the following tasks:

   1. To zoom into the plot and change the time range, do any of the following tasks:

      • To visually select the time range, click and drag on the plot horizontally.
      • To select the time range, use the menu which is in the upper left of the console.
   2. To reset the time range, select Reset zoom.
   3. To display the output for all the queries at a specific point in time, hold the mouse cursor on the plot at that point. The query output displays in a pop-up box.