Chapter 2. Troubleshooting node network configuration

Procedure

1. Create a policy on your cluster. The following example creates a simple bridge, br1 that has ens01 as its member:

   apiVersion: nmstate.io/v1
   kind: NodeNetworkConfigurationPolicy
   metadata:
     name: ens01-bridge-testfail
   spec:
     desiredState:
       interfaces:
         - name: br1
           description: Linux bridge with the wrong port
           type: linux-bridge
           state: up
           ipv4:
             dhcp: true
             enabled: true
           bridge:
             options:
               stp:
                 enabled: false
             port:
               - name: ens01
   # ...

   Copy to Clipboard Toggle word wrap

2. Apply the policy to your network interface:

   $ oc apply -f ens01-bridge-testfail.yaml

   Copy to Clipboard Toggle word wrap

   Example output

   nodenetworkconfigurationpolicy.nmstate.io/ens01-bridge-testfail created

   Copy to Clipboard Toggle word wrap

3. Verify the status of the policy by running the following command:

   $ oc get nncp

   Copy to Clipboard Toggle word wrap

   The output shows that the policy failed:

   Example output

   NAME                    STATUS
   ens01-bridge-testfail   FailedToConfigure

   Copy to Clipboard Toggle word wrap

   The policy status alone does not indicate if it failed on all nodes or a subset of nodes.

4. List the node network configuration enactments to see if the policy was successful on any of the nodes. If the policy failed for only a subset of nodes, the output suggests that the problem is with a specific node configuration. If the policy failed on all nodes, the output suggests that the problem is with the policy.

   $ oc get nnce

   Copy to Clipboard Toggle word wrap

   The output shows that the policy failed on all nodes:

   Example output

   NAME                                         STATUS
   control-plane-1.ens01-bridge-testfail        FailedToConfigure
   control-plane-2.ens01-bridge-testfail        FailedToConfigure
   control-plane-3.ens01-bridge-testfail        FailedToConfigure
   compute-1.ens01-bridge-testfail              FailedToConfigure
   compute-2.ens01-bridge-testfail              FailedToConfigure
   compute-3.ens01-bridge-testfail              FailedToConfigure

   Copy to Clipboard Toggle word wrap

5. View one of the failed enactments. The following command uses the output tool jsonpath to filter the output:

   $ oc get nnce compute-1.ens01-bridge-testfail -o jsonpath='{.status.conditions[?(@.type=="Failing")].message}'

   Copy to Clipboard Toggle word wrap

   Example output

   [2024-10-10T08:40:46Z INFO  nmstatectl] Nmstate version: 2.2.37
   NmstateError: InvalidArgument: Controller interface br1 is holding unknown port ens01

   Copy to Clipboard Toggle word wrap

   The previous example shows the output from an InvalidArgument error that indicates that the ens01 is an unknown port. For this example, you might need to change the port configuration in the policy configuration file.

6. To ensure that the policy is configured properly, view the network configuration for one or all of the nodes by requesting the NodeNetworkState object. The following command returns the network configuration for the control-plane-1 node:

   $ oc get nns control-plane-1 -o yaml

   Copy to Clipboard Toggle word wrap

   The output shows that the interface name on the nodes is ens1 but the failed policy incorrectly uses ens01:

   Example output

      - ipv4:
   # ...
         name: ens1
         state: up
         type: ethernet

   Copy to Clipboard Toggle word wrap

7. Correct the error by editing the existing policy:

   $ oc edit nncp ens01-bridge-testfail

   Copy to Clipboard Toggle word wrap

   # ...
             port:
               - name: ens1

   Copy to Clipboard Toggle word wrap

   Save the policy to apply the correction.

8. Check the status of the policy to ensure it updated successfully:

   $ oc get nncp

   Copy to Clipboard Toggle word wrap

   Example output

   NAME                    STATUS
   ens01-bridge-testfail   SuccessfullyConfigured

   Copy to Clipboard Toggle word wrap

   The updated policy is successfully configured on all nodes in the cluster.