Chapter 28. Kubernetes NMState

Procedure

1. Select Operators OperatorHub.
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

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

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

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

   Example output

   Name                                                           Phase
   kubernetes-nmstate-operator.4.14.0-202210210157   Succeeded

5. Create an instance of the

   nmstate

   Operator:

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

6. Verify that all pods for the NMState Operator are in a

   Running

   state:

   $ oc get pod -n openshift-nmstate

   Example output

   Name                                      Ready   Status   Restarts  Age
   pod/nmstate-handler-wn55p                 1/1     Running  0         77s
   pod/nmstate-operator-f6bb869b6-v5m92      1/1     Running  0         4m51s
   ...

Procedure

1. Navigate to Networking NodeNetworkConfigurationPolicy.

2. In the NodeNetworkConfigurationPolicy page, click Create, and select From Form option.

   In case there are no existing policies, you can alternatively click Create NodeNetworkConfigurationPolicy to createa policy using form.

   Note

   To create policy using YAML, click Create, and select With YAML option. The following steps are applicable to create a policy only by using form.

3. Optional: Check the Apply this NodeNetworkConfigurationPolicy only to specific subsets of nodes using the node selector checkbox to specify the nodes where the policy must be applied.
4. Enter the policy name in the Policy name field.
5. Optional: Enter the description of the policy in the Description field.

6. Optional: In the Policy Interface(s) section, a bridge interface is added by default with preset values in editable fields. Edit the values by executing the following steps:

   1. Enter the name of the interface in Interface name field.
   2. Select the network state from Network state dropdown. The default selected value is Up.

   3. Select the type of interface from Type dropdown. The available values are Bridge, Bonding, and Ethernet. The default selected value is Bridge.

      Note

      Addition of a VLAN interface by using the form is not supported. To add a VLAN interface, you must use YAML to create the policy. Once added, you cannot edit the policy by using form.

   4. Optional: In the IP configuration section, check IPv4 checkbox to assign an IPv4 address to the interface, and configure the IP address assignment details:

      1. Click IP address to configure the interface with a static IP address, or DHCP to auto-assign an IP address.

      2. If you have selected IP address option, enter the IPv4 address in IPV4 address field, and enter the prefix length in Prefix length field.

         If you have selected DHCP option, uncheck the options that you want to disable. The available options are Auto-DNS, Auto-routes, and Auto-gateway. All the options are selected by default.

   5. Optional: Enter the port number in Port field.
   6. Optional: Check the checkbox Enable STP to enable STP.
   7. Optional: To add an interface to the policy, click Add another interface to the policy.
   8. Optional: To remove an interface from the policy, click icon next to the interface.
   Note

   Alternatively, you can click Edit YAML on the top of the page to continue editing the form using YAML.

7. Click Create to complete policy creation.

Procedure

1. Navigate to Networking NodeNetworkConfigurationPolicy.
2. In the NodeNetworkConfigurationPolicy page, click the icon placed next to the policy you want to delete, and click Delete.
3. In the pop-up window, enter the policy name to confirm deletion, and click Delete.

Procedure

1. Create the

   NodeNetworkConfigurationPolicy

   manifest. The following example configures a Linux bridge on all worker nodes and configures the DNS resolver:

   apiVersion: nmstate.io/v1
   kind: NodeNetworkConfigurationPolicy
   metadata:
     name: br1-eth1-policy 

   1

   
   spec:
     nodeSelector: 

   2

   
       node-role.kubernetes.io/worker: "" 

   3

   
     maxUnavailable: 3 

   4

   
     desiredState:
       interfaces:
         - name: br1
           description: Linux bridge with eth1 as a port 

   5

   
           type: linux-bridge
           state: up
           ipv4:
             dhcp: true
             enabled: true
             auto-dns: false
           bridge:
             options:
               stp:
                 enabled: false
             port:
               - name: eth1
       dns-resolver: 

   6

   
         config:
           search:
           - example.com
           - example.org
           server:
           - 8.8.8.8

   1

   Name of the policy.

   2

   Optional: If you do not include the nodeSelector parameter, the policy applies to all nodes in the cluster.

   3

   This example uses the node-role.kubernetes.io/worker: "" node selector to select all worker nodes in the cluster.

   4

   Optional: Specifies the maximum number of nmstate-enabled nodes that the policy configuration can be applied to concurrently. This parameter can be set to either a percentage value (string), for example, "10%", or an absolute value (number), such as 3.

   5

   Optional: Human-readable description for the interface.

   6

   Optional: Specifies the search and server settings for the DNS server.

2. Create the node network policy:

   $ oc apply -f br1-eth1-policy.yaml 

   1

   1

   File name of the node network configuration policy manifest.

Procedure

1. Add the

   root-servers.net

   zone at the end of the

   /etc/named.conf

   configuration file by running the following command:

   $ cat >> /etc/named.conf <<EOF
   zone "root-servers.net" IN {
       	type master;
       	file "named.localhost";
   };
   EOF

2. Restart the

   named

   service by running the following command:

   $ systemctl restart named

3. Confirm that the

   root-servers.net

   zone is present by running the following command:

   $ journalctl -u named|grep root-servers.net

   Example output

   Jul 03 15:16:26 rhel-8-10 bash[xxxx]: zone root-servers.net/IN: loaded serial 0
   Jul 03 15:16:26 rhel-8-10 named[xxxx]: zone root-servers.net/IN: loaded serial 0

4. Verify that the DNS server can resolve the NS record for the

   root-servers.net

   domain by running the following command:

   $ host -t NS root-servers.net. 127.0.0.1

   Example output

   Using domain server:
   Name: 127.0.0.1
   Address: 127.0.0.53
   Aliases:
   root-servers.net name server root-servers.net.

1. Create a configuration file that delegates the domain

   root-servers.net

   to another DNS server by running the following command:

   $ echo 'server=/root-servers.net/<DNS_server_IP>'> /etc/dnsmasq.d/delegate-root-servers.net.conf

2. Restart the

   dnsmasq

   service by running the following command:

   $ systemctl restart dnsmasq

3. Confirm that the

   root-servers.net

   domain is delegated to another DNS server by running the following command:

   $ journalctl -u dnsmasq|grep root-servers.net

   Example output

   Jul 03 15:31:25 rhel-8-10 dnsmasq[1342]: using nameserver 192.168.1.1#53 for domain root-servers.net

4. Verify that the DNS server can resolve the NS record for the

   root-servers.net

   domain by running the following command:

   $ host -t NS root-servers.net. 127.0.0.1

   Example output

   Using domain server:
   Name: 127.0.0.1
   Address: 127.0.0.1#53
   Aliases:
   root-servers.net name server root-servers.net.