Skip to content

Commit d0957a7

Browse files
authored
Merge pull request #100816 from eromanova97/OBSDOCS-2495
OBSDOCS-2495 - CMO TLS/configMap updates cause Prometheus restarts
2 parents 2671a23 + facaece commit d0957a7

File tree

3 files changed

+47
-7
lines changed

3 files changed

+47
-7
lines changed

modules/monitoring-default-monitoring-components.adoc

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,3 @@ You can use {cmo-full} config map settings to manage monitoring-plugin resources
5151
|===
5252

5353
The monitoring stack monitors all components within the stack. The components are automatically updated when {product-title} is updated.
54-
55-
[NOTE]
56-
====
57-
All components of the monitoring stack use the TLS security profile settings that are centrally configured by a cluster administrator.
58-
If you configure a monitoring stack component that uses TLS security settings, the component uses the TLS security profile settings that already exist in the `tlsSecurityProfile` field in the global {product-title} `apiservers.config.openshift.io/cluster` resource.
59-
====
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
// Module included in the following assembly:
2+
//
3+
// * observability/monitoring/monitoring-stack-architecture.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="tls-security-and-rotation_{context}"]
7+
= TLS security and rotation in the monitoring stack
8+
9+
[role="_abstract"]
10+
Learn how TLS profiles and certificate rotation work in the {product-title} monitoring stack to keep communication secure.
11+
12+
TLS security profiles for monitoring components::
13+
All components of the monitoring stack use the TLS security profile settings that are centrally configured by a cluster administrator.
14+
The monitoring stack component uses the TLS security profile settings that already exist in the `tlsSecurityProfile` field in the global {product-title} `apiservers.config.openshift.io/cluster` resource.
15+
16+
TLS certificate rotation and automatic restarts::
17+
The {cmo-full} manages the internal TLS certificate lifecycle for the monitoring components. These certificates secure the internal communication between the monitoring components.
18+
+
19+
During certificate rotation, the {cmo-short} updates secrets and config maps, which triggers automatic restarts of affected pods. This is an expected behavior, and the pods recover automatically.
20+
+
21+
The following example shows events that occur during certificate rotation:
22+
+
23+
[source,terminal]
24+
----
25+
$ oc get events -n openshift-monitoring
26+
27+
LAST SEEN TYPE REASON OBJECT MESSAGE
28+
2h39m Normal SecretUpdated deployment/cluster-monitoring-operator Updated Secret/grpc-tls -n openshift-monitoring because it changed
29+
2h39m Normal SecretCreated deployment/cluster-monitoring-operator Created Secret/prometheus-user-workload-grpc-tls -n openshift-user-workload-monitoring because it was missing
30+
2h39m Normal SecretCreated deployment/cluster-monitoring-operator Created Secret/thanos-querier-grpc-tls -n openshift-monitoring because it was missing
31+
2h39m Normal SecretCreated deployment/cluster-monitoring-operator Created Secret/thanos-ruler-grpc-tls -n openshift-user-workload-monitoring because it was missing
32+
2h39m Normal SecretCreated deployment/cluster-monitoring-operator Created Secret/prometheus-k8s-grpc-tls -n openshift-monitoring because it was missing
33+
2h38m Warning FailedMount pod/prometheus-k8s-0 MountVolume.SetUp failed for volume "secret-grpc-tls" : secret "prometheus-k8s-grpc-tls" not found
34+
2h39m Normal Created pod/prometheus-k8s-0 Created container kube-rbac-proxy-thanos
35+
2h39m Normal Started pod/prometheus-k8s-0 Started container kube-rbac-proxy-thanos
36+
2h39m Normal SuccessfulDelete statefulset/prometheus-k8s delete Pod prometheus-k8s-0 in StatefulSet prometheus-k8s successful
37+
2h39m Normal SuccessfulCreate statefulset/prometheus-k8s create Pod prometheus-k8s-0 in StatefulSet prometheus-k8s successful
38+
----

observability/monitoring/about-ocp-monitoring/monitoring-stack-architecture.adoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,15 @@ ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4646
* xref:../../../observability/monitoring/configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc#configuring-performance-and-scalability-uwm[Configuring performance and scalability]
4747
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4848

49+
//TLS security and rotation in the monitoring stack
50+
include::modules/monitoring-tls-security-and-rotation.adoc[leveloffset=+1]
51+
52+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
53+
[role="_additional-resources"]
54+
.Additional resources
55+
* xref:../../../security/tls-security-profiles.adoc#tls-security-profiles[Configuring TLS security profiles]
56+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
57+
4958
//Glossary of common terms for OCP monitoring
5059
include::modules/monitoring-common-terms.adoc[leveloffset=+1]
5160
@@ -55,5 +64,4 @@ ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
5564
== Additional resources
5665
* xref:../../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring]
5766
* xref:../../../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#granting-users-permission-to-monitor-user-defined-projects_preparing-to-configure-the-monitoring-stack-uwm[Granting users permissions for monitoring for user-defined projects]
58-
* xref:../../../security/tls-security-profiles.adoc#tls-security-profiles[Configuring TLS security profiles]
5967
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]

0 commit comments

Comments
 (0)