Skip to content

Commit

Permalink
Merge pull request openshift#3 from aireilly/amolnar-rh_consolidated-ZTP
Browse files Browse the repository at this point in the history
TELCODOCS-261: missed a few sagidlow Redfish comments
  • Loading branch information
amolnar-rh authored Apr 6, 2022
2 parents 5df4f6b + b3bf225 commit 5aa7274
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion modules/nw-rfhe-creating-hardware-event.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[id="nw-rfhe-creating-hardware-event_{context}"]
= Creating the Redfish HardwareEvent and Secret CRs

To start using baremetal hardware events, create the a `HardwareEvent` custom resource (CR) for the host where the Redfish hardware is present. Hardware events and faults are reported in the `hw-event-proxy` logs.
To start using bare-metal hardware events, create the a `HardwareEvent` custom resource (CR) for the host where the Redfish hardware is present. Hardware events and faults are reported in the `hw-event-proxy` logs.

.Prerequisites

Expand Down
6 changes: 3 additions & 3 deletions modules/nw-rfhe-creating_bmc_event_sub.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ You can configure the baseboard management controller (BMC) to send Redfish hard

[IMPORTANT]
====
You can only create a `BMCEventSubscription` CR for physical hardware that supports Redfish and has a vendor interface set to `redfish` or `idrac-redfish`.
You can only create a `BMCEventSubscription` custom resource (CR) for physical hardware that supports Redfish and has a vendor interface set to `redfish` or `idrac-redfish`.
====

[NOTE]
====
Use the `BMCEventSubscription` CR to subscribe to predefined Redfish events. The Redfish standard does not provide an option to create specific alerts and thresholds. For example, to receive an alert event when an enclosure's temperature exceeds 40° Celsius, you must manually configure the event according to the vendor's recommendations.
====

Perform the following procedure to subscribe to Redfish hardware events for the node using a `BMCEventSubscription` custom resource (CR).
Perform the following procedure to subscribe to Redfish hardware events for the node using a `BMCEventSubscription` CR.

.Prerequisites
* Install the OpenShift CLI (`oc`).
Expand Down Expand Up @@ -108,7 +108,7 @@ spec:
context: ''
----
<1> Specifies the name or UUID of the worker node where the Redfish events are generated.
<2> Specifies the baremetal hardware event proxy service, for example, `https://hw-event-proxy-cloud-native-events.apps.compute-1.example.com/webhook`.
<2> Specifies the bare-metal hardware event proxy service, for example, `https://hw-event-proxy-cloud-native-events.apps.compute-1.example.com/webhook`.
+

.. Create the `BMCEventSubscription` CR:
Expand Down
2 changes: 1 addition & 1 deletion modules/nw-rfhe-installing-operator-web-console.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ As a cluster administrator, you can install the Baremetal Hardware Event Proxy O

.. Choose *Baremetal Hardware Event Proxy Operator* from the list of available Operators, and then click *Install*.

.. On the *Install Operator* page, select or create a *Namespace* and then select *baremetal-hardware-event-proxy-operator*. Then, click *Install*.
.. On the *Install Operator* page, select or create a *Namespace*, select *baremetal-hardware-event-proxy-operator*, and then click *Install*.

. Optional: Verify that the Baremetal Hardware Event Proxy Operator installed successfully:

Expand Down

0 comments on commit 5aa7274

Please sign in to comment.