Installing the SR-IOV Network Operator

You can install the Single Root I/O Virtualization (SR-IOV) Network Operator on your cluster to manage SR-IOV network devices and network attachments.

Installing SR-IOV Network Operator

As a cluster administrator, you can install the SR-IOV Network Operator by using the OKD CLI or the web console.

CLI: Installing the SR-IOV Network Operator

As a cluster administrator, you can install the Operator using the CLI.

Prerequisites

• A cluster installed on bare-metal hardware with nodes that have hardware that supports SR-IOV.

• Install the OpenShift CLI (oc).

• An account with cluster-admin privileges.

Procedure

1. To create the openshift-sriov-network-operator namespace, enter the following command:

   $ cat << EOF| oc create -f -
   apiVersion: v1
   kind: Namespace
   metadata:
     name: openshift-sriov-network-operator
   EOF

2. To create an OperatorGroup CR, enter 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

3. Subscribe to the SR-IOV Network Operator.

   1. Run the following command to get the OKD major and minor version. It is required for the channel value in the next step.

      $ OC_VERSION=$(oc version -o yaml | grep openshiftVersion | \
          grep -o '[0-9]*[.][0-9]*' | head -1)

   2. To create a Subscription CR for the SR-IOV Network Operator, enter 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: "${OC_VERSION}"
        name: sriov-network-operator
        source: redhat-operators
        sourceNamespace: openshift-marketplace
      EOF

4. To verify that the Operator is installed, enter the following command:

   $ oc get csv -n openshift-sriov-network-operator \
     -o custom-columns=Name:.metadata.name,Phase:.status.phase

   Example output

   Name                                        Phase
   sriov-network-operator.4.4.0-202006160135   Succeeded

Web console: Installing the SR-IOV Network Operator

As a cluster administrator, you can install the Operator using the web console.

Prerequisites

• A cluster installed on bare-metal hardware with nodes that have hardware that supports SR-IOV.

• Install the OpenShift CLI (oc).

• An account with cluster-admin privileges.

Procedure

1. Create a namespace for the SR-IOV Network Operator:

   1. In the OKD web console, click Administration → Namespaces.

   2. Click Create Namespace.

   3. In the Name field, enter openshift-sriov-network-operator, and then click Create.

2. Install the SR-IOV Network Operator:

   1. In the OKD 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 A specific namespace on the cluster, select openshift-sriov-network-operator.

   4. Click Install.

3. 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.

      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.

Next steps

• Optional: Configuring the SR-IOV Network Operator