From 3482aada056c797c2d7bbff6930a2525cef715c9 Mon Sep 17 00:00:00 2001 From: dfitzmau Date: Fri, 30 Jan 2026 15:16:48 +0000 Subject: [PATCH] OSDOCS-16845-1: CQA for NOP-4 SR-IOV Operator (Installation and Config) --- modules/nw-sriov-installing-operator-cli.adoc | 95 +++++++++++ ...sriov-installing-operator-web-console.adoc | 55 +++++++ modules/nw-sriov-installing-operator.adoc | 152 ------------------ modules/nw-sriov-operator-uninstall.adoc | 3 +- .../installing-sriov-operator.adoc | 17 +- .../uninstalling-sriov-operator.adoc | 4 +- 6 files changed, 167 insertions(+), 159 deletions(-) create mode 100644 modules/nw-sriov-installing-operator-cli.adoc create mode 100644 modules/nw-sriov-installing-operator-web-console.adoc delete mode 100644 modules/nw-sriov-installing-operator.adoc diff --git a/modules/nw-sriov-installing-operator-cli.adoc b/modules/nw-sriov-installing-operator-cli.adoc new file mode 100644 index 0000000000..43687c01b6 --- /dev/null +++ b/modules/nw-sriov-installing-operator-cli.adoc @@ -0,0 +1,95 @@ +// Module included in the following assemblies: +// +// * networking/hardware_networks/installing-sriov-operator.adoc +// * virt/post_installation_configuration/virt-post-install-network-config.adoc + +:_mod-docs-content-type: PROCEDURE +[id="install-operator-cli_{context}"] += Using the CLI to install the SR-IOV Network Operator + +[role="_abstract"] +You can use the CLI to install the SR-IOV Network Operator. By using the CLI, you can deploy the Operator directly from your terminal to manage SR-IOV network devices and attachments without navigating the web console. + +.Prerequisites + +* You installed the {oc-first}. +* You have an account with `cluster-admin` privileges. +* You installed a cluster on bare-metal hardware, and you ensured that cluster nodes have hardware that supports SR-IOV. + +.Procedure + +. Create the `openshift-sriov-network-operator` namespace by entering the following command: ++ +[source,terminal] +---- +$ cat << EOF| oc create -f - +apiVersion: v1 +kind: Namespace +metadata: + name: openshift-sriov-network-operator + annotations: + workload.openshift.io/allowed: management +EOF +---- + +. Create an `OperatorGroup` custom resource (CR) by entering the following command: ++ +[source,terminal] +---- +$ 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 +---- + +. Create a `Subscription` CR for the SR-IOV Network Operator by entering the following command: ++ +[source,terminal] +---- +$ 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 +---- + +. Create an `SriovoperatorConfig` resource by entering the following command: ++ +[source,terminal] +---- +$ cat < *Software Catalog*. ++ +.. Select *SR-IOV Network Operator* from the list of available Operators, and then click *Install*. ++ +.. On the *Install Operator* page, under *Installed Namespace*, select *Operator recommended Namespace*. ++ +.. Click *Install*. + +.Verification + +. Navigate to the *Ecosystem* -> *Installed Operators* page. + +. 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 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: ++ +[source,terminal] +---- +$ oc annotate ns/openshift-sriov-network-operator workload.openshift.io/allowed=management +---- ++ +[NOTE] +==== +For {sno} clusters, the annotation `workload.openshift.io/allowed=management` is required for the namespace. +==== diff --git a/modules/nw-sriov-installing-operator.adoc b/modules/nw-sriov-installing-operator.adoc deleted file mode 100644 index 33691c82d8..0000000000 --- a/modules/nw-sriov-installing-operator.adoc +++ /dev/null @@ -1,152 +0,0 @@ -// Module included in the following assemblies: -// -// * networking/hardware_networks/installing-sriov-operator.adoc -// * virt/post_installation_configuration/virt-post-install-network-config.adoc - -:_mod-docs-content-type: PROCEDURE -[id="installing-sr-iov-operator_{context}"] -= Installing the SR-IOV Network Operator - -As a cluster administrator, you can install the Single Root I/O Virtualization (SR-IOV) Network Operator by using the {product-title} CLI or the web console. - -[id="install-operator-cli_{context}"] -== 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 - -. Create the `openshift-sriov-network-operator` namespace by entering the following command: -+ -[source,terminal] ----- -$ cat << EOF| oc create -f - -apiVersion: v1 -kind: Namespace -metadata: - name: openshift-sriov-network-operator - annotations: - workload.openshift.io/allowed: management -EOF ----- - -. Create an `OperatorGroup` custom resource (CR) by entering the following command: -+ -[source,terminal] ----- -$ 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 ----- - -. Create a `Subscription` CR for the SR-IOV Network Operator by entering the following command: -+ -[source,terminal] ----- -$ 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 ----- -. Create an `SriovoperatorConfig` resource by entering the following command: -+ -[source,terminal] ----- -$ cat < *Software Catalog*. - -.. Select *SR-IOV Network Operator* from the list of available Operators, and then click *Install*. - -.. On the *Install Operator* page, under *Installed Namespace*, select *Operator recommended Namespace*. - -.. Click *Install*. - -. Verify that the SR-IOV Network Operator is installed successfully: - -.. Navigate to the *Ecosystem* -> *Installed Operators* page. - -.. 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: -+ -[source,terminal] ----- -$ oc annotate ns/openshift-sriov-network-operator workload.openshift.io/allowed=management ----- -+ -[NOTE] -==== -For {sno} clusters, the annotation `workload.openshift.io/allowed=management` is required for the namespace. -==== diff --git a/modules/nw-sriov-operator-uninstall.adoc b/modules/nw-sriov-operator-uninstall.adoc index 2f73fcfe0d..d53bb798ae 100644 --- a/modules/nw-sriov-operator-uninstall.adoc +++ b/modules/nw-sriov-operator-uninstall.adoc @@ -6,7 +6,8 @@ [id="nw-sriov-operator-uninstall_{context}"] = Uninstalling the SR-IOV Network Operator -As a cluster administrator, you can uninstall the SR-IOV Network Operator. +[role="_abstract"] +You can remove the SR-IOV Network Operator from your cluster by uninstalling the Operator. This ensures that the Operator and its associated resources are deleted when you no longer need to manage SR-IOV network devices. .Prerequisites diff --git a/networking/networking_operators/sr-iov-operator/installing-sriov-operator.adoc b/networking/networking_operators/sr-iov-operator/installing-sriov-operator.adoc index 8d6df36b80..c2b4b3d61f 100644 --- a/networking/networking_operators/sr-iov-operator/installing-sriov-operator.adoc +++ b/networking/networking_operators/sr-iov-operator/installing-sriov-operator.adoc @@ -6,12 +6,19 @@ include::_attributes/common-attributes.adoc[] toc::[] -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. +[role="_abstract"] +To manage SR-IOV network devices and network attachments on your cluster, install the Single Root I/O Virtualization (SR-IOV) Network Operator. By using this Operator, you can centralize the configuration and lifecycle management of your SR-IOV resources. -// Installing the SR-IOV Network Operator -include::modules/nw-sriov-installing-operator.adoc[leveloffset=+1] +As a cluster administrator, you can install the Single Root I/O Virtualization (SR-IOV) Network Operator by using the {product-title} CLI or the web console. -[id="installing-sriov-operator-next-steps"] -== Next steps +// Using the CLI to install the SR-IOV Network Operator +include::modules/nw-sriov-installing-operator-cli.adoc[leveloffset=+1] + +// +include::modules/nw-sriov-installing-operator-web-console.adoc[leveloffset=+1] + +[role="_additional-resources_installing-sriov-operator.adoc"] +[id="additional-resources_{context}"] +== Additional resources * xref:../../../networking/networking_operators/sr-iov-operator/configuring-sriov-operator.adoc#configuring-sriov-operator[Configuring the SR-IOV Network Operator] diff --git a/networking/networking_operators/sr-iov-operator/uninstalling-sriov-operator.adoc b/networking/networking_operators/sr-iov-operator/uninstalling-sriov-operator.adoc index c7b4d5957a..26217cb761 100644 --- a/networking/networking_operators/sr-iov-operator/uninstalling-sriov-operator.adoc +++ b/networking/networking_operators/sr-iov-operator/uninstalling-sriov-operator.adoc @@ -6,11 +6,13 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] To uninstall the SR-IOV Network Operator, you must delete any running SR-IOV workloads, uninstall the Operator, and delete the webhooks that the Operator used. include::modules/nw-sriov-operator-uninstall.adoc[leveloffset=+1] [role="_additional-resources"] -.Additional resources +[id="additional-resources_{context}"] +== Additional resources * xref:../../../operators/admin/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[Deleting Operators from a cluster]