TELCODOCS-607: Bare-metal events monitoring using PolicyGenTemplate

Author: amolnar-rh

modules/ztp-configuring-hwevents-using-pgt.adoc

@@ -0,0 +1,74 @@
+// Module included in the following assemblies:
+//
+// * scalability_and_performance/ztp-deploying-disconnected.adoc
+
+:_content-type: PROCEDURE
+[id="ztp-creating-hwevents_{context}"]
+= Configuring bare-metal event monitoring using PolicyGenTemplate CRs
+
+You can configure bare-metal hardware events for vRAN clusters that are deployed using the GitOps Zero Touch Provisioning (ZTP) pipeline.
+
+.Prerequisites
+
+* Install the OpenShift CLI (`oc`).
+* Log in as a user with `cluster-admin` privileges.
+* Create a Git repository where you manage your custom site configuration data.
+
+[NOTE]
+====
+Multiple `HardwareEvent` resources are not permitted.
+====
+
+.Procedure
+
+. To configure the AMQ Interconnect Operator and the {redfish-operator} Operator, add the following YAML to `spec.sourceFiles` in the `common-ranGen.yaml` file:
++
+[source,yaml]
+----
+# AMQ interconnect operator for fast events
+- fileName: AmqSubscriptionNS.yaml
+  policyName: "subscriptions-policy"
+- fileName: AmqSubscriptionOperGroup.yaml
+  policyName: "subscriptions-policy"
+- fileName: AmqSubscription.yaml
+  policyName: "subscriptions-policy"
+# Bare Metal Event Rely operator
+- fileName: BareMetalEventRelaySubscriptionNS.yaml
+  policyName: "subscriptions-policy"
+- fileName: BareMetalEventRelaySubscriptionOperGroup.yaml
+  policyName: "subscriptions-policy"
+- fileName: BareMetalEventRelaySubscription.yaml
+  policyName: "subscriptions-policy"
+----
+
+. Add the `Interconnect` CR to `.spec.sourceFiles` in the site configuration file, for example, the `example-sno-site.yaml` file:
++
+[source,yaml]
+----
+- fileName: AmqInstance.yaml
+  policyName: "config-policy"
+----
+
+. Add the `HardwareEvent` CR to `spec.sourceFiles` in your specific group configuration file, for example, in the `group-du-sno-ranGen.yaml` file:
++
+[source,yaml]
+----
+- fileName: HardwareEvent.yaml
+  policyName: "config-policy"
+  spec:
+    nodeSelector: {}
+    transportHost: "amqp://<amq_interconnect_name>.<amq_interconnect_namespace>.svc.cluster.local" <1>
+    logLevel: "info"
+----
+<1>  The `transportHost` URL is composed of the existing AMQ Interconnect CR `name` and `namespace`. For example, in `transportHost: "amqp://amq-router.amq-router.svc.cluster.local"`, the AMQ Interconnect `name` and `namespace` are both set to `amq-router`.
+
+. Commit the `PolicyGenTemplate` change in Git, and then push the changes to your site configuration repository to deploy bare-metal events monitoring to new sites using GitOps ZTP.
+
+. Create the Redfish Secret by running the following command:
++
+[source,terminal]
+----
+$ oc -n openshift-bare-metal-events create secret generic redfish-basic-auth \
+--from-literal=username=<bmc_username> --from-literal=password=<bmc_password> \
+--from-literal=hostaddr="<bmc_host_ip_addr>"
+----

scalability_and_performance/ztp-deploying-disconnected.adoc

@@ -82,6 +82,17 @@ include::modules/ztp-configuring-ptp-fast-events.adoc[leveloffset=+2]
 
 include::modules/ztp-configuring-uefi-secure-boot.adoc[leveloffset=+2]
 
+include::modules/ztp-configuring-hwevents-using-pgt.adoc[leveloffset=+2]
+
+[role="_additional-resources"]
+.Additional resources
+
+* For more information about how to install the {redfish-operator}, see xref:../monitoring/using-rfhe.adoc#nw-rfhe-installing-operator-cli_using-rfhe[Installing the {redfish-operator} using the CLI].
+
+* For more information about how to install the AMQ Interconnect Operator, see xref:../monitoring/using-rfhe.html#hw-installing-amq-interconnect-messaging-bus_using-rfhe[Installing the AMQ messaging bus].
+
+* For more information about how to create the username, password, and the host IP address for the secret, see xref:../monitoring/using-rfhe.html#nw-rfhe-creating-hardware-event_using-rfhe[Creating the bare-metal event and Secret CRs].
+
 include::modules/ztp-installing-the-gitops-ztp-pipeline.adoc[leveloffset=+1]
 
 include::modules/ztp-preparing-the-ztp-git-repository.adoc[leveloffset=+2]