Skip to content

[enterprise-4.6] RHDEVDOCS-4310 - clarify confusing statements about custom Prometheus support #51696

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 14, 2022
Merged

[enterprise-4.6] RHDEVDOCS-4310 - clarify confusing statements about custom Prometheus support #51696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions ...itoring-exposing-custom-application-metrics-for-horizontal-pod-autoscaling.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@ You can use the `prometheus-adapter` resource to expose custom application metri

.Prerequisites

* You have a custom Prometheus instance installed. In this example, it is presumed that Prometheus was installed in a user-defined `custom-prometheus` project.
* You have a custom Prometheus instance installed as a Prometheus pod managed by a deployment or `StatefulSet` object but not by a Prometheus custom resource (CR).
* You have installed the custom Prometheus instance in a user-defined `custom-prometheus` project.
+
[NOTE]
[IMPORTANT]
====
Custom Prometheus instances and the Prometheus Operator installed through Operator Lifecycle Manager (OLM) can cause issues with user-defined workload monitoring if it is enabled. Custom Prometheus instances are not supported in {product-title}.
Custom Prometheus instances and the Prometheus Operator installed through Operator Lifecycle Manager (OLM) are not compatible with user-defined monitoring if it is enabled. Therefore, custom Prometheus instances that are installed as a Prometheus custom resource (CR) managed by the OLM Prometheus Operator are not supported in {product-title}.
====
+
* You have deployed an application and a service in a user-defined project. In this example, it is presumed that the application and its service monitor were installed in a user-defined `custom-prometheus` project.
Expand Down
4 changes: 2 additions & 2 deletions modules/monitoring-support-considerations.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
= Support considerations for monitoring

The following modifications are explicitly not supported:

* *Creating additional `ServiceMonitor`, `PodMonitor`, and `PrometheusRule` objects in the `openshift-*` and `kube-*` projects.*
* *Modifying any resources or objects deployed in the `openshift-monitoring` or `openshift-user-workload-monitoring` projects.* The resources created by the {product-title} monitoring stack are not meant to be used by any other resources, as there are no guarantees about their backward compatibility.
+
Expand All @@ -18,7 +18,7 @@ The Alertmanager configuration is deployed as a secret resource in the `openshif
* *Modifying resources of the stack.* The {product-title} monitoring stack ensures its resources are always in the state it expects them to be. If they are modified, the stack will reset them.
* *Deploying user-defined workloads to `openshift-*`, and `kube-*` projects.* These projects are reserved for Red Hat provided components and they should not be used for user-defined workloads.
* *Modifying the monitoring stack Grafana instance.*
* *Installing custom Prometheus instances on {product-title}.*
* *Installing custom Prometheus instances on {product-title}.* A custom instance is a Prometheus custom resource (CR) managed by the Prometheus Operator.
* *Enabling symptom based monitoring by using the `Probe` custom resource definition (CRD) in Prometheus Operator.*

[NOTE]
Expand Down