From fcdfb010900321080be3ec139641b4daa7c08cd6 Mon Sep 17 00:00:00 2001 From: GroceryBoyJr Date: Fri, 13 Dec 2024 16:22:42 -0500 Subject: [PATCH] OCPBUGS-15851: 2 NFD exceptions are not covered in product docs --- .../psap-node-feature-discovery-operator.adoc | 6 ++++++ modules/creating-nfd-cr-cli-disconnected.adoc | 3 ++- modules/creating-nfd-cr-cli.adoc | 3 ++- modules/creating-nfd-cr-web-console.adoc | 5 +++++ 4 files changed, 15 insertions(+), 2 deletions(-) diff --git a/hardware_enablement/psap-node-feature-discovery-operator.adoc b/hardware_enablement/psap-node-feature-discovery-operator.adoc index 793f4d8be6..3523f9eaae 100644 --- a/hardware_enablement/psap-node-feature-discovery-operator.adoc +++ b/hardware_enablement/psap-node-feature-discovery-operator.adoc @@ -19,6 +19,12 @@ The Node Feature Discovery (NFD) Operator orchestrates all resources needed to r As a cluster administrator, you can create a `NodeFeatureDiscovery` CR by using the {oc-first} or the web console. + +[NOTE] +==== +Starting with version 4.12, the `operand.image` field in the `NodeFeatureDiscovery` CR is mandatory. If the NFD Operator is deployed by using {olm-first}, OLM automatically sets the `operand.image` field. If you create the `NodeFeatureDiscovery` CR by using the {product-title} CLI or the {product-title} web console, you must set the `operand.image` field explicitly. +==== + include::modules/creating-nfd-cr-cli.adoc[leveloffset=+2] include::modules/creating-nfd-cr-cli-disconnected.adoc[leveloffset=+2] include::modules/creating-nfd-cr-web-console.adoc[leveloffset=+2] diff --git a/modules/creating-nfd-cr-cli-disconnected.adoc b/modules/creating-nfd-cr-cli-disconnected.adoc index 96a256f50d..490ce0301c 100644 --- a/modules/creating-nfd-cr-cli-disconnected.adoc +++ b/modules/creating-nfd-cr-cli-disconnected.adoc @@ -70,7 +70,7 @@ metadata: name: nfd-instance spec: operand: - image: /openshift4/ose-node-feature-discovery@ + image: /openshift4/ose-node-feature-discovery@ <1> imagePullPolicy: Always workerConfig: configData: | @@ -142,6 +142,7 @@ spec: matchOn: - loadedKMod: ["example_kmod3"] ---- +<1> The `operand.image` field is mandatory. . Create the `NodeFeatureDiscovery` CR by running the following command: + diff --git a/modules/creating-nfd-cr-cli.adoc b/modules/creating-nfd-cr-cli.adoc index 37e6df473e..9f57a8a6fb 100644 --- a/modules/creating-nfd-cr-cli.adoc +++ b/modules/creating-nfd-cr-cli.adoc @@ -38,7 +38,7 @@ spec: instance: "" # instance is empty by default topologyupdater: false # False by default operand: - image: registry.redhat.io/openshift4/ose-node-feature-discovery-rhel9:v{product-version} + image: registry.redhat.io/openshift4/ose-node-feature-discovery-rhel9:v{product-version} <1> imagePullPolicy: Always workerConfig: configData: | @@ -110,6 +110,7 @@ spec: matchOn: - loadedKMod: ["example_kmod3"] ---- +<1> The `operand.image` field is mandatory. . Create the `NodeFeatureDiscovery` CR by running the following command: + diff --git a/modules/creating-nfd-cr-web-console.adoc b/modules/creating-nfd-cr-web-console.adoc index b69b83f402..6352d186ed 100644 --- a/modules/creating-nfd-cr-web-console.adoc +++ b/modules/creating-nfd-cr-web-console.adoc @@ -20,3 +20,8 @@ As a cluster administrator, you can create a `NodeFeatureDiscovery` CR by using . In the *Node Feature Discovery* section, under *Provided APIs*, click *Create instance*. . Edit the values of the `NodeFeatureDiscovery` CR. . Click *Create*. + +[NOTE] +==== +Starting with version 4.12, the `operand.image` field in the `NodeFeatureDiscovery` CR is mandatory. If the NFD Operator is deployed by using {olm-first}, OLM automatically sets the `operand.image` field. If you create the `NodeFeatureDiscovery` CR by using the {product-title} CLI or the {product-title} web console, you must set the `operand.image` field explicitly. +====