Skip to content

Commit d919b74

Browse files
committed
OCPBUGS-15851: 2 NFD exceptions are not covered in product docs
1 parent f6a166d commit d919b74

File tree

4 files changed

+15
-2
lines changed

4 files changed

+15
-2
lines changed

hardware_enablement/psap-node-feature-discovery-operator.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ The Node Feature Discovery (NFD) Operator orchestrates all resources needed to r
1919

2020
As a cluster administrator, you can create a `NodeFeatureDiscovery` CR by using the {oc-first} or the web console.
2121

22+
23+
[NOTE]
24+
====
25+
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.
26+
====
27+
2228
include::modules/creating-nfd-cr-cli.adoc[leveloffset=+2]
2329
include::modules/creating-nfd-cr-cli-disconnected.adoc[leveloffset=+2]
2430
include::modules/creating-nfd-cr-web-console.adoc[leveloffset=+2]

modules/creating-nfd-cr-cli-disconnected.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ metadata:
7070
name: nfd-instance
7171
spec:
7272
operand:
73-
image: <mirror_registry>/openshift4/ose-node-feature-discovery@<image_digest>
73+
image: <mirror_registry>/openshift4/ose-node-feature-discovery@<image_digest> <1>
7474
imagePullPolicy: Always
7575
workerConfig:
7676
configData: |
@@ -142,6 +142,7 @@ spec:
142142
matchOn:
143143
- loadedKMod: ["example_kmod3"]
144144
----
145+
<1> The `operand.image` field is mandatory.
145146

146147
. Create the `NodeFeatureDiscovery` CR by running the following command:
147148
+

modules/creating-nfd-cr-cli.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ spec:
3838
instance: "" # instance is empty by default
3939
topologyupdater: false # False by default
4040
operand:
41-
image: registry.redhat.io/openshift4/ose-node-feature-discovery-rhel9:v{product-version}
41+
image: registry.redhat.io/openshift4/ose-node-feature-discovery-rhel9:v{product-version} <1>
4242
imagePullPolicy: Always
4343
workerConfig:
4444
configData: |
@@ -110,6 +110,7 @@ spec:
110110
matchOn:
111111
- loadedKMod: ["example_kmod3"]
112112
----
113+
<1> The `operand.image` field is mandatory.
113114

114115
. Create the `NodeFeatureDiscovery` CR by running the following command:
115116
+

modules/creating-nfd-cr-web-console.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,8 @@ As a cluster administrator, you can create a `NodeFeatureDiscovery` CR by using
2020
. In the *Node Feature Discovery* section, under *Provided APIs*, click *Create instance*.
2121
. Edit the values of the `NodeFeatureDiscovery` CR.
2222
. Click *Create*.
23+
24+
[NOTE]
25+
====
26+
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.
27+
====

0 commit comments

Comments
 (0)