Skip to content

Commit 8ebebb6

Browse files
committed
Create the 4.18 monitoring branch and move the existing content
1 parent 0604958 commit 8ebebb6

File tree

50 files changed

+354
-274
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+354
-274
lines changed

about-ocp-monitoring/about-ocp-monitoring.adoc

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
9+
ifndef::openshift-dedicated,openshift-rosa[]
1010
{product-title} includes a preconfigured, preinstalled, and self-updating monitoring stack that provides monitoring for core platform components. You also have the option to xref:../configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[enable monitoring for user-defined projects].
1111

1212
A cluster administrator can xref:../configuring-core-platform-monitoring/preparing-to-configure-the-monitoring-stack.adoc#preparing-to-configure-the-monitoring-stack[configure the monitoring stack] with the supported configurations. {product-title} delivers monitoring best practices out of the box.
@@ -15,14 +15,12 @@ A set of alerts are included by default that immediately notify administrators a
1515

1616
After installing {product-title}, cluster administrators can optionally enable monitoring for user-defined projects. By using this feature, cluster administrators, developers, and other users can specify how services and pods are monitored in their own projects.
1717
As a cluster administrator, you can find answers to common problems such as user metrics unavailability and high consumption of disk space by Prometheus in xref:../troubleshooting/troubleshooting-monitoring-issues.adoc#troubleshooting-monitoring-issues[Troubleshooting monitoring issues].
18-
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
18+
endif::openshift-dedicated,openshift-rosa[]
1919

20-
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
20+
ifdef::openshift-dedicated,openshift-rosa[]
2121
In {product-title}, you can monitor your own projects in isolation from Red{nbsp}Hat Site Reliability Engineering (SRE) platform metrics. You can monitor your own projects without the need for an additional monitoring solution.
22+
endif::openshift-dedicated,openshift-rosa[]
23+
24+
25+
2226

23-
The {product-title}
24-
ifdef::openshift-rosa,openshift-rosa-hcp[]
25-
(ROSA)
26-
endif::openshift-rosa,openshift-rosa-hcp[]
27-
monitoring stack is based on the link:https://prometheus.io/[Prometheus] open source project and its wider ecosystem.
28-
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]

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

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,22 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
10-
The {product-title} monitoring stack is based on the link:https://prometheus.io/[Prometheus] open source project and its wider ecosystem.
11-
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
12-
The monitoring stack includes default monitoring components and components for monitoring user-defined projects.
9+
The {product-title}
10+
ifdef::openshift-rosa[]
11+
(ROSA)
12+
endif::openshift-rosa[]
13+
monitoring stack is based on the link:https://prometheus.io/[Prometheus] open source project and its wider ecosystem. The monitoring stack includes default monitoring components and components for monitoring user-defined projects.
1314

1415
// Understanding the monitoring stack
1516
include::modules/monitoring-understanding-the-monitoring-stack.adoc[leveloffset=+1]
16-
17-
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
17+
ifndef::openshift-dedicated,openshift-rosa[]
1818
//Default monitoring components
1919
include::modules/monitoring-default-monitoring-components.adoc[leveloffset=+1]
20-
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
21-
2220
include::modules/monitoring-default-monitoring-targets.adoc[leveloffset=+2]
23-
2421
[role="_additional-resources"]
2522
.Additional resources
2623
* xref:../accessing-metrics/accessing-metrics-as-an-administrator.adoc#getting-detailed-information-about-a-target_accessing-metrics-as-an-administrator[Getting detailed information about a metrics target]
24+
endif::openshift-dedicated,openshift-rosa[]
2725
2826
//Components for monitoring user-defined projects
2927
include::modules/monitoring-components-for-monitoring-user-defined-projects.adoc[leveloffset=+1]
@@ -35,25 +33,24 @@ include::modules/monitoring-monitoring-stack-in-ha-clusters.adoc[leveloffset=+1]
3533
3634
[role="_additional-resources"]
3735
.Additional resources
38-
39-
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
36+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html-single/operators/index#osdk-ha-sno[High-availability or single-node cluster detection and support]
4037
* xref:../configuring-core-platform-monitoring/storing-and-recording-data.adoc#configuring-persistent-storage_storing-and-recording-data[Configuring persistent storage]
4138
* xref:../configuring-core-platform-monitoring/configuring-performance-and-scalability.adoc#configuring-performance-and-scalability[Configuring performance and scalability]
42-
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
43-
44-
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
45-
* xref:../configuring-user-workload-monitoring/storing-and-recording-data-uwm.adoc#configuring-persistent-storage_storing-and-recording-data-uwm[Configuring persistent storage]
46-
* xref:../configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc#configuring-performance-and-scalability-uwm[Configuring performance and scalability]
47-
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4839
4940
//Glossary of common terms for OCP monitoring
5041
include::modules/monitoring-common-terms.adoc[leveloffset=+1]
5142
52-
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
43+
ifndef::openshift-dedicated,openshift-rosa[]
5344
[role="_additional-resources"]
5445
[id="additional-resources_{context}"]
5546
== Additional resources
5647
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/support/index#about-remote-health-monitoring[About remote health monitoring]
5748
* xref:../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]
5849
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/security_and_compliance/index#tls-security-profiles[Configuring TLS security profiles]
59-
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
50+
endif::openshift-dedicated,openshift-rosa[]
51+
52+
53+
54+
55+
56+

accessing-metrics/accessing-metrics-as-a-developer.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,8 @@ You can access metrics to monitor the performance of your cluster workloads.
1313

1414
* xref:../key-concepts/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics]
1515
16-
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1716
//Viewing a list of available metrics
1817
include::modules/monitoring-viewing-a-list-of-available-metrics.adoc[leveloffset=+1]
19-
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2018

2119
//Querying metrics for user-defined projects with the OCP web console
2220
include::modules/monitoring-querying-metrics-for-user-defined-projects-with-mon-dashboard.adoc[leveloffset=+1]
@@ -33,4 +31,4 @@ include::modules/monitoring-reviewing-monitoring-dashboards-developer.adoc[level
3331
.Additional resources
3432

3533
* xref:../key-concepts/key-concepts.adoc#about-monitoring-dashboards_key-concepts[About monitoring dashboards]
36-
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/building_applications/index#monitoring-project-and-application-metrics-using-developer-perspective[Monitoring project and application metrics using the Developer perspective]
34+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html-single/building_applications/index#odc-monitoring-project-and-application-metrics-using-developer-perspective[Monitoring project and application metrics using the Developer perspective]

accessing-metrics/accessing-metrics-as-an-administrator.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,8 @@ You can access metrics to monitor the performance of cluster components and your
1313

1414
* xref:../key-concepts/key-concepts.adoc#understanding-metrics_key-concepts[Understanding metrics]
1515
16-
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1716
//Viewing a list of available metrics
1817
include::modules/monitoring-viewing-a-list-of-available-metrics.adoc[leveloffset=+1]
19-
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2018

2119
//Querying metrics for all projects with the OCP web console
2220
include::modules/monitoring-querying-metrics-for-all-projects-with-mon-dashboard.adoc[leveloffset=+1]
@@ -36,3 +34,4 @@ include::modules/monitoring-reviewing-monitoring-dashboards-admin.adoc[leveloffs
3634
.Additional resources
3735

3836
* xref:../key-concepts/key-concepts.adoc#about-monitoring-dashboards_key-concepts[About monitoring dashboards]
37+

accessing-metrics/accessing-monitoring-apis-by-using-the-cli.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,8 @@ include::modules/monitoring-resources-reference-for-the-cluster-monitoring-opera
4343
[id="additional-resources_{context}"]
4444
== Additional resources
4545

46-
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4746
* xref:../configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[Enabling monitoring for user-defined projects]
4847
* xref:../configuring-core-platform-monitoring/configuring-metrics.adoc#configuring-remote-write-storage_configuring-metrics[Configuring remote write storage for core platform monitoring]
49-
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
5048
* xref:../configuring-user-workload-monitoring/configuring-metrics-uwm.adoc#configuring-remote-write-storage_configuring-metrics-uwm[Configuring remote write storage for monitoring of user-defined projects]
5149
* xref:../accessing-metrics/accessing-metrics-as-an-administrator.adoc#accessing-metrics-as-an-administrator[Accessing metrics as an administrator]
5250
* xref:../accessing-metrics/accessing-metrics-as-a-developer.adoc#accessing-metrics-as-a-developer[Accessing metrics as a developer]

config-map-reference/config-map-reference-for-the-cluster-monitoring-operator.adoc

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,13 @@ The configuration file is always defined under the `config.yaml` key in the conf
3232
====
3333
* Not all configuration parameters for the monitoring stack are exposed.
3434
Only the parameters and fields listed in this reference are supported for configuration.
35-
For more information about supported configurations, see xref:../support-for-monitoring/maintenance-and-support-for-monitoring.adoc#maintenance-and-support-for-monitoring[Maintenance and support for monitoring].
35+
For more information about supported configurations, see
36+
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
37+
* xref:../support-for-monitoring/maintenance-and-support-for-monitoring.adoc#maintenance-and-support-for-monitoring[Maintenance and support for monitoring]
38+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
39+
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
40+
xref:../../observability/monitoring/configuring-the-monitoring-stack.adoc#maintenance-and-support_configuring-the-monitoring-stack[Maintenance and support for monitoring].
41+
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
3642
3743
* Configuring cluster monitoring is optional.
3844
* If a configuration does not exist or is empty, default values are used.
@@ -55,7 +61,7 @@ link:#thanosrulerconfig[ThanosRulerConfig]
5561
[options="header"]
5662
|===
5763
| Property | Type | Description
58-
|apiVersion|string|Defines the API version of Alertmanager. `v1` is no longer supported, `v2` is set as the default value.
64+
|apiVersion|string|Defines the API version of Alertmanager. Possible values are `v1` or `v2`. The default is `v2`.
5965

6066
|bearerToken|*v1.SecretKeySelector|Defines the secret key reference containing the bearer token to use when authenticating to Alertmanager.
6167

@@ -718,7 +724,7 @@ Appears in: link:#userworkloadconfiguration[UserWorkloadConfiguration]
718724
[options="header"]
719725
|===
720726
| Property | Type | Description
721-
|additionalAlertmanagerConfigs|[]link:#additionalalertmanagerconfig[AdditionalAlertmanagerConfig]|Configures how the Thanos Ruler component communicates with additional Alertmanager instances. The Cluster Monitoring Operator reads the cluster-wide proxy settings and configures the appropriate proxy URL for the Alertmanager endpoints. All Alertmanager endpoints in this group are expected to use the same proxy URL. Endpoints that bypass the cluster proxy should be placed in a separate group. The default value is `nil`.
727+
|additionalAlertmanagerConfigs|[]link:#additionalalertmanagerconfig[AdditionalAlertmanagerConfig]|Configures how the Thanos Ruler component communicates with additional Alertmanager instances. The default value is `nil`.
722728

723729
|evaluationInterval|string|Configures the default interval between Prometheus rule evaluations in case the `PrometheusRule` resource does not specify any value. The interval must be set between 5 seconds and 5 minutes. The value can be expressed in: seconds (for example `30s`), minutes (for example `1m`) or a mix of minutes and seconds (for example `1m30s`). It applies to `PrometheusRule` resources without the `openshift.io/prometheus-rule-evaluation-scope=\"leaf-prometheus\"` label. The default value is `15s`.
724730

configuring-core-platform-monitoring/configuring-alerts-and-notifications.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Alertmanager does not send notifications by default. It is strongly recommended
4949
* xref:../key-concepts/key-concepts.adoc#sending-notifications-to-external-systems_key-concepts[Sending notifications to external systems]
5050
* link:https://www.pagerduty.com/[PagerDuty website]
5151
* link:https://www.pagerduty.com/docs/guides/prometheus-integration-guide/[Prometheus Integration Guide (PagerDuty documentation)]
52-
* xref:../support-for-monitoring/maintenance-and-support-for-monitoring.adoc#support-version-matrix-for-monitoring-components_maintenance-and-support-for-monitoring[Support version matrix for monitoring components]
52+
* xref:../release-notes/monitoring-release-notes.adoc#support-version-matrix-for-monitoring-components_monitoring-release-notes[Support version matrix for monitoring components]
5353
* xref:../configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-alert-routing-for-user-defined-projects_preparing-to-configure-the-monitoring-stack-uwm[Enabling alert routing for user-defined projects]
5454

5555
include::modules/monitoring-configuring-alert-routing-default-platform-alerts.adoc[leveloffset=+2]

configuring-user-workload-monitoring/configuring-alerts-and-notifications-uwm.adoc

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,26 +19,18 @@ include::modules/monitoring-adding-a-secret-to-the-alertmanager-configuration.ad
1919
//Attaching additional labels to your time series and alerts
2020
include::modules/monitoring-attaching-additional-labels-to-your-time-series-and-alerts.adoc[leveloffset=+1,tags=**;!CPM;UWM]
2121

22-
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2322
[role="_additional-resources"]
2423
.Additional resources
2524

2625
* xref:../configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[Enabling monitoring for user-defined projects]
27-
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2826
2927
[id="configuring-alert-notifications_{context}"]
3028
== Configuring alert notifications
3129

32-
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
3330
In {product-title}, an administrator can enable alert routing for user-defined projects with one of the following methods:
3431

3532
* Use the default platform Alertmanager instance.
3633
* Use a separate Alertmanager instance only for user-defined projects.
37-
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
38-
39-
ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
40-
In {product-title}, the `dedicated-admin` user can enable alert routing for user-defined projects by using a separate Alertmanager instance for user-defined projects.
41-
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
4234

4335
Developers and other users with the `alert-routing-edit` cluster role can configure custom alert notifications for their user-defined projects by configuring alert receivers.
4436

@@ -58,7 +50,7 @@ Review the following limitations of alert routing for user-defined projects:
5850
* xref:../key-concepts/key-concepts.adoc#sending-notifications-to-external-systems_key-concepts[Sending notifications to external systems]
5951
* link:https://www.pagerduty.com/[PagerDuty website]
6052
* link:https://www.pagerduty.com/docs/guides/prometheus-integration-guide/[Prometheus Integration Guide (PagerDuty documentation)]
61-
* xref:../support-for-monitoring/maintenance-and-support-for-monitoring.adoc#support-version-matrix-for-monitoring-components_maintenance-and-support-for-monitoring[Support version matrix for monitoring components]
53+
* xref:../release-notes/monitoring-release-notes.adoc#support-version-matrix-for-monitoring-components_monitoring-release-notes[Support version matrix for monitoring components]
6254
* xref:../configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-alert-routing-for-user-defined-projects_preparing-to-configure-the-monitoring-stack-uwm[Enabling alert routing for user-defined projects]
6355

6456
include::modules/monitoring-configuring-alert-routing-for-user-defined-projects.adoc[leveloffset=+2]

configuring-user-workload-monitoring/configuring-metrics-uwm.adoc

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,8 @@ include::modules/monitoring-configuring-remote-write-storage.adoc[leveloffset=+1
2020

2121
[role="_additional-resources"]
2222
.Additional resources
23-
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
23+
2424
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/monitoring_apis/index#spec-remotewrite-writerelabelconfigs[`writeRelabelConfigs`]
25-
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
2625
* link:https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config[`relabel_config` (Prometheus documentation)]
2726
2827
include::modules/monitoring-supported-remote-write-authentication-settings.adoc[leveloffset=+2]
@@ -33,9 +32,8 @@ include::modules/monitoring-example-remote-write-queue-configuration.adoc[levelo
3332

3433
[role="_additional-resources"]
3534
.Additional resources
36-
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
35+
3736
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/monitoring_apis/index#spec-remotewrite-2[Prometheus REST API reference for remote write]
38-
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
3937
* link:https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage[Remote write compatible endpoints (Prometheus documentation)]
4038
* link:https://prometheus.io/docs/practices/remote_write/#remote-write-tuning[Remote write tuning (Prometheus documentation)]
4139
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/nodes/index#nodes-pods-secrets-about_nodes-pods-secrets[Understanding secrets]
@@ -64,9 +62,7 @@ include::modules/monitoring-example-service-endpoint-authentication-settings.ado
6462
[role="_additional-resources"]
6563
.Additional resources
6664

67-
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
6865
* xref:../configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[Enabling monitoring for user-defined projects]
66+
* link:https://access.redhat.com/articles/6675491[Scrape Prometheus metrics using TLS in ServiceMonitor configuration] (Red{nbsp}Hat Customer Portal article)
6967
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/monitoring_apis/index#podmonitor-monitoring-coreos-com-v1[PodMonitor API]
7068
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html-single/monitoring_apis/index#servicemonitor-monitoring-coreos-com-v1[ServiceMonitor API]
71-
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
72-
* link:https://access.redhat.com/articles/6675491[Scrape Prometheus metrics using TLS in ServiceMonitor configuration (Red{nbsp}Hat Customer Portal)]

0 commit comments

Comments
 (0)