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 Ecosystem Software Catalog.
   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.

Verification

1. Navigate to the Ecosystem 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.

3. If the Operator does not show as installed, complete any of the following steps to troubleshoot the issue:

   • 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 SriovOperatorConfig custom resource (CR). The following example creates a file named sriovOperatorConfig.yaml:

   apiVersion: sriovnetwork.openshift.io/v1
   kind: SriovOperatorConfig
   metadata:
     name: default
     namespace: openshift-sriov-network-operator
   spec:
     disableDrain: false
     enableInjector: true
     enableOperatorWebhook: true
     logLevel: 2
     featureGates:
       metricsExporter: false
   # ...

   Copy to Clipboard Toggle word wrap

   where:

   metadata.name

   Specifies the name of the SR-IOV Network Operator instance. The only valid name for the SriovOperatorConfig resource is default and the name must be in the namespace where the Operator is deployed.

   spec.enableInjector

   Specifies if any network-resources-injector pod can run in the namespace. If not specified in the CR or explicitly set to true, defaults to false or <none>, preventing any network-resources-injector pod from running in the namespace. The recommended setting is true.

   spec.enableOperatorWebhook

   Specifies if any operator-webhook pods can run in the namespace. The enableOperatorWebhook field, if not specified in the CR or explicitly set to true, defaults to false or <none>, preventing any operator-webhook pod from running in the namespace. The recommended setting is true.

2. Apply the resource to your cluster by running the following command:

   $ oc apply -f sriovOperatorConfig.yaml

   Copy to Clipboard Toggle word wrap

Procedure

1. Delete all SR-IOV custom resources (CRs):

   $ oc delete sriovnetwork -n openshift-sriov-network-operator --all

   Copy to Clipboard Toggle word wrap

   $ oc delete sriovnetworknodepolicy -n openshift-sriov-network-operator --all

   Copy to Clipboard Toggle word wrap

   $ oc delete sriovibnetwork -n openshift-sriov-network-operator --all

   Copy to Clipboard Toggle word wrap

   $ oc delete sriovoperatorconfigs -n openshift-sriov-network-operator --all

   Copy to Clipboard Toggle word wrap
2. Follow the instructions in the "Deleting Operators from a cluster" section to remove the SR-IOV Network Operator from your cluster.

3. Delete the SR-IOV custom resource definitions that remain in the cluster after the SR-IOV Network Operator is uninstalled:

   $ oc delete crd sriovibnetworks.sriovnetwork.openshift.io

   Copy to Clipboard Toggle word wrap

   $ oc delete crd sriovnetworknodepolicies.sriovnetwork.openshift.io

   Copy to Clipboard Toggle word wrap

   $ oc delete crd sriovnetworknodestates.sriovnetwork.openshift.io

   Copy to Clipboard Toggle word wrap

   $ oc delete crd sriovnetworkpoolconfigs.sriovnetwork.openshift.io

   Copy to Clipboard Toggle word wrap

   $ oc delete crd sriovnetworks.sriovnetwork.openshift.io

   Copy to Clipboard Toggle word wrap

   $ oc delete crd sriovoperatorconfigs.sriovnetwork.openshift.io

   Copy to Clipboard Toggle word wrap

4. Delete the SR-IOV Network Operator namespace:

   $ oc delete namespace openshift-sriov-network-operator

   Copy to Clipboard Toggle word wrap