Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Name: Support for monitoring
Dir: support-for-monitoring
Distros: openshift-monitoring
Topics:
- Name: Maintenance and support for monitoring
File: maintenance-and-support-for-monitoring
- Name: Support for monitoring
File: support-for-monitoring
---
Name: Monitoring key concepts
Dir: key-concepts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,7 @@ The configuration file is always defined under the `config.yaml` key in the conf
====
* Not all configuration parameters for the monitoring stack are exposed.
Only the parameters and fields listed in this reference are supported for configuration.
For more information about supported configurations, see
ifndef::openshift-dedicated,openshift-rosa[]
* xref:../support-for-monitoring/maintenance-and-support-for-monitoring.adoc#maintenance-and-support-for-monitoring[Maintenance and support for monitoring]
endif::openshift-dedicated,openshift-rosa[]
ifdef::openshift-dedicated,openshift-rosa[]
xref:../../observability/monitoring/configuring-the-monitoring-stack.adoc#maintenance-and-support_configuring-the-monitoring-stack[Maintenance and support for monitoring].
endif::openshift-dedicated,openshift-rosa[]
For more information about supported configurations, see xref:../support-for-monitoring/support-for-monitoring.adoc#support-for-monitoring[Support for monitoring].

* Configuring cluster monitoring is optional.
* If a configuration does not exist or is empty, default values are used.
Expand Down
2 changes: 2 additions & 0 deletions modules/monitoring-support-considerations.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
= Support considerations for monitoring

[role="_abstract"]
Learn about supported configurations for {ocp} monitoring to ensure stability and backward compatibility.

[NOTE]
====
Backward compatibility for metrics, recording rules, or alerting rules is not guaranteed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
[role="_abstract"]
Monitoring Operators ensure that {ocp} monitoring resources function as designed and tested. If Cluster Version Operator (CVO) control of an Operator is overridden, the Operator does not respond to configuration changes, reconcile the intended state of cluster objects, or receive updates.

While overriding CVO control for an Operator can be helpful during debugging, this is unsupported and the cluster administrator assumes full control of the individual component configurations and upgrades.
While overriding CVO control for an Operator can be helpful during debugging, this is unsupported. The cluster administrator assumes full control of the individual component configurations and upgrades.

[id="overriding-the-cluster-version-operator_{context}"]
== Overriding the Cluster Version Operator
Expand Down
Original file line number Diff line number Diff line change
@@ -1,22 +1,29 @@
:_mod-docs-content-type: ASSEMBLY
[id="maintenance-and-support-for-monitoring"]
= Maintenance and support for monitoring
[id="support-for-monitoring"]
= Support for monitoring

include::_attributes/common-attributes.adoc[]

:context: maintenance-and-support-for-monitoring
:context: support-for-monitoring

toc::[]

[role="_abstract"]
Not all configuration options for the monitoring stack are exposed. The only supported way of configuring {ocp} monitoring is by configuring the {cmo-first} using the options described in the xref:../config-map-reference/config-map-reference-for-the-cluster-monitoring-operator.adoc#cluster-monitoring-operator-configuration-reference[Config map reference for the {cmo-full}]. *Do not use other configurations, as they are unsupported.*
Ensure reliable {ocp} monitoring by using only supported {cmo-first} configurations. Learn about the limitations and avoid losing unsupported changes due to automatic resets.

Not all configuration options for the monitoring stack are exposed. The only supported way to configure {ocp} monitoring is through the {cmo-full} by using the options in the xref:../config-map-reference/config-map-reference-for-the-cluster-monitoring-operator.adoc#cluster-monitoring-operator-configuration-reference[Config map reference for the {cmo-full}].

[WARNING]
====
Use of other configurations, which are not listed in the xref:../config-map-reference/config-map-reference-for-the-cluster-monitoring-operator.adoc#cluster-monitoring-operator-configuration-reference[Config map reference for the {cmo-full}], is not supported.
====

Configuration paradigms might change across Prometheus releases, and such cases can only be handled gracefully if all configuration possibilities are controlled. If you use configurations other than those described in the xref:../config-map-reference/config-map-reference-for-the-cluster-monitoring-operator.adoc#cluster-monitoring-operator-configuration-reference[Config map reference for the {cmo-full}], your changes will disappear because the {cmo-short} automatically reconciles any differences and resets any unsupported changes back to the originally defined state by default and by design.

ifdef::openshift-dedicated,openshift-rosa[]
[IMPORTANT]
====
Installing another Prometheus instance is not supported by the Red Hat Site Reliability Engineers (SRE).
Installing another Prometheus instance is not supported by the Red{nbsp}Hat Site Reliability Engineers (SRE).
====
endif::openshift-dedicated,openshift-rosa[]

Expand Down