mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
83 lines
2.7 KiB
Plaintext
83 lines
2.7 KiB
Plaintext
// Module included in the following assemblies:
|
|
//
|
|
// * observability/monitoring/configuring-the-monitoring-stack.adoc
|
|
|
|
:_mod-docs-content-type: REFERENCE
|
|
[id="configurable-monitoring-components_{context}"]
|
|
= Configurable monitoring components
|
|
|
|
// Set attributes to distinguish between cluster monitoring example (core platform monitoring - CPM) and user workload monitoring (UWM) examples.
|
|
// tag::CPM[]
|
|
:configmap-name: cluster-monitoring-config
|
|
:alertmanager: alertmanagerMain
|
|
:prometheus: prometheusK8s
|
|
:thanosname: Thanos Querier
|
|
:thanos: thanosQuerier
|
|
// end::CPM[]
|
|
// tag::UWM[]
|
|
:configmap-name: user-workload-monitoring-config
|
|
:alertmanager: alertmanager
|
|
:prometheus: prometheus
|
|
:thanosname: Thanos Ruler
|
|
:thanos: thanosRuler
|
|
// end::UWM[]
|
|
|
|
This table shows the monitoring components you can configure and the keys used to specify the components in the `{configmap-name}` config map.
|
|
|
|
// tag::UWM[]
|
|
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
[WARNING]
|
|
====
|
|
Do not modify the monitoring components in the `cluster-monitoring-config` `ConfigMap` object. Red{nbsp}Hat Site Reliability Engineers (SRE) use these components to monitor the core cluster components and Kubernetes services.
|
|
====
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
// end::UWM[]
|
|
|
|
// tag::CPM[]
|
|
.Configurable core platform monitoring components
|
|
// end::CPM[]
|
|
// tag::UWM[]
|
|
.Configurable monitoring components for user-defined projects
|
|
// end::UWM[]
|
|
[options="header"]
|
|
|====
|
|
|Component |{configmap-name} config map key
|
|
|Prometheus Operator |`prometheusOperator`
|
|
|Prometheus |`{prometheus}`
|
|
|Alertmanager |`{alertmanager}`
|
|
|{thanosname} | `{thanos}`
|
|
// tag::CPM[]
|
|
|kube-state-metrics |`kubeStateMetrics`
|
|
|monitoring-plugin | `monitoringPlugin`
|
|
|openshift-state-metrics |`openshiftStateMetrics`
|
|
|Telemeter Client |`telemeterClient`
|
|
|Metrics Server |`metricsServer`
|
|
// end::CPM[]
|
|
|====
|
|
|
|
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
[WARNING]
|
|
====
|
|
Different configuration changes to the `ConfigMap` object result in different outcomes:
|
|
|
|
* The pods are not redeployed. Therefore, there is no service outage.
|
|
|
|
* The affected pods are redeployed:
|
|
|
|
** For single-node clusters, this results in temporary service outage.
|
|
|
|
** For multi-node clusters, because of high-availability, the affected pods are gradually rolled out and the monitoring stack remains available.
|
|
|
|
** Configuring and resizing a persistent volume always results in a service outage, regardless of high availability.
|
|
|
|
Each procedure that requires a change in the config map includes its expected outcome.
|
|
====
|
|
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
|
|
|
|
// Unset the source code block attributes just to be safe.
|
|
:!configmap-name:
|
|
:!alertmanager:
|
|
:!prometheus:
|
|
:!thanosname:
|
|
:!thanos:
|