Skip to content

Commit be7deba

Browse files
committed
OBSDOCS-1492: Update the automatically generated resource file
1 parent 4a6fad9 commit be7deba

File tree

3 files changed

+9
-12
lines changed

3 files changed

+9
-12
lines changed

modules/monitoring-resources-reference-for-the-cluster-monitoring-operator.adoc

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
// make edits or learn more about how this file is generated, read the docgen utility
55
// instructions in the source code for the CMO.
66
:_mod-docs-content-type: REFERENCE
7-
[id="resources-reference-for-the-cluster-monitoring-operator"]
7+
[id="resources-reference-for-the-cluster-monitoring-operator_{context}"]
88
= Resources reference for the Cluster Monitoring Operator
99

1010
This document describes the following resources deployed and managed by the Cluster Monitoring Operator (CMO):
@@ -16,16 +16,13 @@ Use this information when you want to configure API endpoint connections to retr
1616

1717
[IMPORTANT]
1818
====
19-
In certain situations, accessing API endpoints can degrade the performance and scalability of your cluster, especially if you use endpoints to retrieve, send, or query large amounts of metrics data.
19+
In certain situations, accessing endpoints can degrade the performance and scalability of your cluster, especially if you use endpoints to retrieve, send, or query large amounts of metrics data.
2020
2121
To avoid these issues, follow these recommendations:
2222
2323
* Avoid querying endpoints frequently. Limit queries to a maximum of one every 30 seconds.
24-
* Do not try to retrieve all metrics data via the `/federate` endpoint for Prometheus.
25-
Query it only when you want to retrieve a limited, aggregated data set.
26-
For example, retrieving fewer than 1,000 samples for each request helps minimize the risk of performance degradation.
24+
* Do not try to retrieve all metrics data via the `/federate` endpoint. Query it only when you want to retrieve a limited, aggregated data set. For example, retrieving fewer than 1,000 samples for each request helps minimize the risk of performance degradation.
2725
====
28-
2926
[id="cmo-routes-resources"]
3027
== CMO routes resources
3128

@@ -72,7 +69,8 @@ Expose the user-defined Alertmanager web server within the cluster on the follow
7269

7370
Expose the Alertmanager web server within the cluster on the following ports:
7471

75-
* Port 9094 provides access to all the Alertmanager endpoints. Granting access requires binding a user to the `monitoring-alertmanager-view` role (for read-only operations) or the `monitoring-alertmanager-edit` role in the `openshift-monitoring` project.
72+
* Port 9094 provides access to all the Alertmanager endpoints. Granting access requires binding a user to the `monitoring-alertmanager-view` (for read-only operations) or `monitoring-alertmanager-edit` role in the `openshift-monitoring` project.
73+
7674
* Port 9092 provides access to the Alertmanager endpoints restricted to a given project. Granting access requires binding a user to the `monitoring-rules-edit` cluster role or `monitoring-edit` cluster role in the project.
7775
* Port 9097 provides access to the `/metrics` endpoint only. This port is for internal use, and no other usage is guaranteed.
7876

@@ -107,7 +105,6 @@ Expose openshift-state-metrics `/metrics` endpoints within the cluster on the fo
107105
Expose the Prometheus web server within the cluster on the following ports:
108106

109107
* Port 9091 provides access to all the Prometheus endpoints. Granting access requires binding a user to the `cluster-monitoring-view` cluster role.
110-
111108
* Port 9092 provides access to the `/metrics` and `/federate` endpoints only. This port is for internal use, and no other usage is guaranteed.
112109

113110
=== openshift-user-workload-monitoring/prometheus-operator
@@ -137,7 +134,7 @@ Expose the Thanos Querier web server within the cluster on the following ports:
137134

138135
* Port 9091 provides access to all the Thanos Querier endpoints. Granting access requires binding a user to the `cluster-monitoring-view` cluster role.
139136
* Port 9092 provides access to the `/api/v1/query`, `/api/v1/query_range/`, `/api/v1/labels`, `/api/v1/label/*/values`, and `/api/v1/series` endpoints restricted to a given project. Granting access requires binding a user to the `view` cluster role in the project.
140-
* Port 9093 provides access to the `/api/v1/alerts`, and `/api/v1/rules` endpoints restricted to a given project. Granting access requires binding a user to the `monitoring-rules-edit` cluster role, `monitoring-edit` cluster role or `monitoring-rules-view` cluster role in the project.
137+
* Port 9093 provides access to the `/api/v1/alerts`, and `/api/v1/rules` endpoints restricted to a given project. Granting access requires binding a user to the `monitoring-rules-edit`, `monitoring-edit`, or `monitoring-rules-view` cluster role in the project.
141138
* Port 9094 provides access to the `/metrics` endpoint only. This port is for internal use, and no other usage is guaranteed.
142139

143140
=== openshift-user-workload-monitoring/thanos-ruler
@@ -151,5 +148,5 @@ This also exposes the gRPC endpoints on port 10901. This port is for internal us
151148

152149
=== openshift-monitoring/cluster-monitoring-operator
153150

154-
Expose the `/metrics` endpoint on port 8443. This port is for internal use, and no other usage is guaranteed.
151+
Expose the `/metrics` and `/validate-webhook` endpoints on port 8443. This port is for internal use, and no other usage is guaranteed.
155152

observability/monitoring/accessing-third-party-monitoring-apis.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ In certain situations, accessing API endpoints can degrade the performance and s
1616
To avoid these issues, follow these recommendations:
1717
1818
* Avoid querying endpoints frequently. Limit queries to a maximum of one every 30 seconds.
19-
* Do not try to retrieve all metrics data via the `/federate` endpoint for Prometheus. Query it only when you want to retrieve a limited, aggregated data set. For example, retrieving fewer than 1,000 samples for each request helps minimize the risk of performance degradation.
19+
* Do not try to retrieve all metrics data through the `/federate` endpoint for Prometheus. Query it only when you want to retrieve a limited, aggregated data set. For example, retrieving fewer than 1,000 samples for each request helps minimize the risk of performance degradation.
2020
====
2121

2222
// Accessing service APIs for third-party monitoring components

observability/monitoring/configuring-the-monitoring-stack.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ include::modules/monitoring-granting-users-permissions-for-core-platform-monitor
8282
.Additional resources
8383
* xref:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#granting-user-permissions-using-the-web-console_enabling-monitoring-for-user-defined-projects[Granting user permissions by using the web console]
8484
* xref:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#granting-user-permissions-using-the-cli_enabling-monitoring-for-user-defined-projects[Granting user permissions by using the CLI]
85-
* xref:../../observability/monitoring/accessing-third-party-monitoring-apis.adoc#resources-reference-for-the-cluster-monitoring-operator[Resources reference for the {cmo-full}]
85+
* xref:../../observability/monitoring/accessing-third-party-monitoring-apis.adoc#resources-reference-for-the-cluster-monitoring-operator_accessing-monitoring-apis-by-using-the-cli[Resources reference for the {cmo-full}]
8686
* xref:../../observability/monitoring/accessing-third-party-monitoring-apis.adoc#cmo-services-resources[CMO services resources]
8787

8888
endif::openshift-dedicated,openshift-rosa[]

0 commit comments

Comments
 (0)