From 55ed899b1542f465935bc55957786b450e69f458 Mon Sep 17 00:00:00 2001 From: Kirby Chin Date: Wed, 20 Jul 2022 16:20:23 -0400 Subject: [PATCH 1/2] Update user-guide-v1beta2.adoc --- doc/user-guide-v1beta2.adoc | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/user-guide-v1beta2.adoc b/doc/user-guide-v1beta2.adoc index c4e9f4d81..1c3deb4a4 100644 --- a/doc/user-guide-v1beta2.adoc +++ b/doc/user-guide-v1beta2.adoc @@ -445,7 +445,11 @@ Once a `RuntimeComponent` application is exposed as a Provisioned Service, a ser Runtime Component Operator can create a `ServiceMonitor` resource to integrate with `Prometheus Operator`. -_This feature does not support integration with Knative Service. Prometheus Operator is required to use ServiceMonitor._ +**For users on Red Hat OpenShift Container Platform v4.6+**. Before using the feature, you must install `Prometheus Operator` by following our link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/openshift-monitoring.adoc#application-monitoring-on-rhocp-46++[Application Monitoring on RHOCP 4.6+] guide. Configure the `RuntimeComponent` CR instance with the basic or advanced monitoring specification below, then view Prometheus Metrics through the OpenShift UI as "Administrator" under the `Observe` > `Metrics` tab. + +_The community version of Prometheus Operator is not supported for users on Red Hat OpenShift Container Platform._ + +_This feature does not support integration with Knative Service._ ==== Basic monitoring specification @@ -466,7 +470,7 @@ spec: ==== Advanced monitoring specification -For advanced scenarios, it is possible to set many `ServicerMonitor` settings such as authentication secret using link:++https://github.com/coreos/prometheus-operator/blob/main/Documentation/api.md#endpoint++[Prometheus Endpoint] +For advanced scenarios, it is possible to set many `ServiceMonitor` settings such as authentication secret using link:++https://github.com/coreos/prometheus-operator/blob/main/Documentation/api.md#endpoint++[Prometheus Endpoint]. Ensure that the `basicAuth` secrets (i.e. `metrics-secret`) are created and visible to Runtime Component Operator. [source,yaml] ---- From f4ad6d3cdb0e01e9679ebf2a654087c79f28bf1a Mon Sep 17 00:00:00 2001 From: Kirby Chin Date: Wed, 3 Aug 2022 12:27:52 -0400 Subject: [PATCH 2/2] Update user-guide-v1beta2.adoc --- doc/user-guide-v1beta2.adoc | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/doc/user-guide-v1beta2.adoc b/doc/user-guide-v1beta2.adoc index 1c3deb4a4..b97d16bc5 100644 --- a/doc/user-guide-v1beta2.adoc +++ b/doc/user-guide-v1beta2.adoc @@ -445,7 +445,12 @@ Once a `RuntimeComponent` application is exposed as a Provisioned Service, a ser Runtime Component Operator can create a `ServiceMonitor` resource to integrate with `Prometheus Operator`. -**For users on Red Hat OpenShift Container Platform v4.6+**. Before using the feature, you must install `Prometheus Operator` by following our link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/openshift-monitoring.adoc#application-monitoring-on-rhocp-46++[Application Monitoring on RHOCP 4.6+] guide. Configure the `RuntimeComponent` CR instance with the basic or advanced monitoring specification below, then view Prometheus Metrics through the OpenShift UI as "Administrator" under the `Observe` > `Metrics` tab. +**For users on Red Hat OpenShift Container Platform v4.6+:** + +1. Follow the OpenShift guide on link:++https://docs.openshift.com/container-platform/4.10/monitoring/configuring-the-monitoring-stack.html++[Configuring the monitoring stack] which creates two `ConfigMap` resources, `cluster-monitoring-config` and `user-workload-monitoring-config`. +1. Follow the OpenShift guide on link:++https://docs.openshift.com/container-platform/4.10/monitoring/enabling-monitoring-for-user-defined-projects.html++[Enabling monitoring for user-defined projects] to enable user workloads. +1. Create a `RuntimeComponent` CR instance with the link:++#basic-monitoring-specification++[basic] or link:++#advanced-monitoring-specification++[advanced] monitoring specification below. +1. View metrics through the OpenShift UI as "Administrator" under the `Observe` > `Metrics` tab. _The community version of Prometheus Operator is not supported for users on Red Hat OpenShift Container Platform._