Chapter 10. SR-IOV Operator

Procedure

1. Create the openshift-sriov-network-operator namespace by entering the following command:

   $ cat << EOF| oc create -f -
   apiVersion: v1
   kind: Namespace
   metadata:
     name: openshift-sriov-network-operator
     annotations:
       workload.openshift.io/allowed: management
   EOF

   Copy to Clipboard Toggle word wrap

2. Create an OperatorGroup custom resource (CR) by entering the following command:

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

   Copy to Clipboard Toggle word wrap

3. Create a Subscription CR for the SR-IOV Network Operator by entering the following command:

   $ cat << EOF| oc create -f -
   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: sriov-network-operator-subscription
     namespace: openshift-sriov-network-operator
   spec:
     channel: stable
     name: sriov-network-operator
     source: redhat-operators
     sourceNamespace: openshift-marketplace
   EOF

   Copy to Clipboard Toggle word wrap

4. Create an SriovoperatorConfig resource by entering the following command:

   $ cat <<EOF | oc create -f -
   apiVersion: sriovnetwork.openshift.io/v1
   kind: SriovOperatorConfig
   metadata:
     name: default
     namespace: openshift-sriov-network-operator
   spec:
     enableInjector: true
     enableOperatorWebhook: true
     logLevel: 2
     disableDrain: false
   EOF

   Copy to Clipboard Toggle word wrap

Procedure

1. Install the SR-IOV Network Operator:

   1. In the OpenShift Container Platform web console, click Operators OperatorHub.
   2. Select SR-IOV Network Operator from the list of available Operators, and then click Install.
   3. On the Install Operator page, under Installed Namespace, select Operator recommended Namespace.
   4. Click Install.

2. Verify that the SR-IOV Network Operator is installed successfully:

   1. Navigate to the Operators Installed Operators page.

   2. Ensure that SR-IOV Network Operator is listed in the openshift-sriov-network-operator project with a Status of InstallSucceeded.

      Note

      During installation an Operator might display a Failed status. If the installation later succeeds with an InstallSucceeded message, you can ignore the Failed message.

      If the Operator does not appear as installed, to troubleshoot further:

      • Inspect the Operator Subscriptions and Install Plans tabs for any failure or errors under Status.
      • Navigate to the Workloads Pods page and check the logs for pods in the openshift-sriov-network-operator project.

      • Check the namespace of the YAML file. If the annotation is missing, you can add the annotation workload.openshift.io/allowed=management to the Operator namespace with the following command:

        $ oc annotate ns/openshift-sriov-network-operator workload.openshift.io/allowed=management

        Copy to Clipboard Toggle word wrap
        Note

        For single-node OpenShift clusters, the annotation workload.openshift.io/allowed=management is required for the namespace.

Procedure

1. Create a namespace and an Operator group:

   apiVersion: v1
   kind: Namespace
   metadata:
     name: openshift-sriov-network-operator
   ---
   apiVersion: operators.coreos.com/v1
   kind: OperatorGroup
   metadata:
     name: sriov-network-operators
     namespace: openshift-sriov-network-operator
   spec:
     targetNamespaces:
     - openshift-sriov-network-operator

   Copy to Clipboard Toggle word wrap

2. Create a subscription to the SR-IOV Operator:

   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: sriov-network-operator-subsription
     namespace: openshift-sriov-network-operator
   spec:
     channel: stable
     name: sriov-network-operator
     config:
       nodeSelector:
         node-role.kubernetes.io/worker: ""
     source: redhat-operators
     sourceNamespace: openshift-marketplace

   Copy to Clipboard Toggle word wrap

Verification

1. To verify that the SR-IOV Operator is ready, run the following command and view the resulting output:

   $ oc get csv -n openshift-sriov-network-operator

   Copy to Clipboard Toggle word wrap

   Example output

   NAME                                         DISPLAY                   VERSION               REPLACES                                     PHASE
   sriov-network-operator.4.18.0-202211021237   SR-IOV Network Operator   4.18.0-202211021237   sriov-network-operator.4.18.0-202210290517   Succeeded

   Copy to Clipboard Toggle word wrap

2. To verify that the SR-IOV pods are deployed, run the following command:

   $ oc get pods -n openshift-sriov-network-operator

   Copy to Clipboard Toggle word wrap

Procedure

1. Enable cluster monitoring by running the following command:

   $ oc label ns/openshift-sriov-network-operator openshift.io/cluster-monitoring=true

   Copy to Clipboard Toggle word wrap

   To enable cluster monitoring, you must add the openshift.io/cluster-monitoring=true label in the namespace where you have installed the SR-IOV Network Operator.

2. Set the spec.featureGates.metricsExporter field to true by running the following command:

   $ oc patch -n openshift-sriov-network-operator sriovoperatorconfig/default \
       --type='merge' -p='{"spec": {"featureGates": {"metricsExporter": true}}}'

   Copy to Clipboard Toggle word wrap

Verification

1. Check that the SR-IOV network metrics exporter is enabled by running the following command:

   $ oc get pods -n openshift-sriov-network-operator

   Copy to Clipboard Toggle word wrap

   Example output

   NAME                                     READY   STATUS    RESTARTS   AGE
   operator-webhook-hzfg4                   1/1     Running   0          5d22h
   sriov-network-config-daemon-tr54m        1/1     Running   0          5d22h
   sriov-network-metrics-exporter-z5d7t     1/1     Running   0          10s
   sriov-network-operator-cc6fd88bc-9bsmt   1/1     Running   0          5d22h

   Copy to Clipboard Toggle word wrap

   The sriov-network-metrics-exporter pod must be in the READY state.

2. Optional: Examine the SR-IOV virtual function (VF) metrics by using the OpenShift Container Platform web console. For more information, see "Querying metrics".