Skip to content

Commit bc14811

Browse files
committed
OBSDOCS-2226: fix issues identified by the CQA
1 parent dd239ac commit bc14811

File tree

5 files changed

+21
-24
lines changed

5 files changed

+21
-24
lines changed

modules/monitoring-common-terms.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Metrics Server::
5858
The Metrics Server monitoring component collects resource metrics and exposes them in the `metrics.k8s.io` Metrics API service for use by other tools and APIs, which frees the core platform Prometheus stack from handling this functionality.
5959

6060
node::
61-
A worker machine in the {product-title} cluster. A node is either a virtual machine (VM) or a physical machine.
61+
A compute machine in the {product-title} cluster. A node is either a virtual machine (VM) or a physical machine.
6262

6363
Operator::
6464
The preferred method of packaging, deploying, and managing a Kubernetes application in an {product-title} cluster. An Operator takes human operational knowledge and encodes it into software that is packaged and shared with customers.
@@ -79,7 +79,7 @@ Prometheus::
7979
Prometheus is the monitoring system on which the {product-title} monitoring stack is based. Prometheus is a time-series database and a rule evaluation engine for metrics. Prometheus sends alerts to Alertmanager for processing.
8080

8181
Prometheus Operator::
82-
The Prometheus Operator (PO) in the `openshift-monitoring` project creates, configures, and manages platform Prometheus and Alertmanager instances. It also automatically generates monitoring target configurations based on Kubernetes label queries.
82+
The Prometheus Operator in the `openshift-monitoring` project creates, configures, and manages platform Prometheus and Alertmanager instances. It also automatically generates monitoring target configurations based on Kubernetes label queries.
8383

8484
Silences::
8585
A silence can be applied to an alert to prevent notifications from being sent when the conditions for an alert are true. You can mute an alert after the initial notification, while you work on resolving the underlying issue.

modules/monitoring-components-for-monitoring-user-defined-projects.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
ifndef::openshift-dedicated,openshift-rosa[]
1111
{product-version}
1212
endif::openshift-dedicated,openshift-rosa[]
13-
includes an optional enhancement to the monitoring stack that enables you to monitor services and pods in user-defined projects. This feature includes the following components:
13+
includes an optional enhancement to the monitoring stack that helps you monitor services and pods in user-defined projects. This feature includes the following components:
1414

1515
.Components for monitoring user-defined projects
1616
[options="header"]
@@ -19,10 +19,10 @@ includes an optional enhancement to the monitoring stack that enables you to mon
1919
|Component|Description
2020

2121
|Prometheus Operator
22-
|The Prometheus Operator (PO) in the `openshift-user-workload-monitoring` project creates, configures, and manages Prometheus and Thanos Ruler instances in the same project.
22+
|The Prometheus Operator in the `openshift-user-workload-monitoring` project creates, configures, and manages Prometheus and Thanos Ruler instances in the same project.
2323

2424
|Prometheus
25-
|Prometheus is the monitoring system through which monitoring is provided for user-defined projects. Prometheus sends alerts to Alertmanager for processing.
25+
|Prometheus is the monitoring system that provides monitoring for user-defined projects. Prometheus sends alerts to Alertmanager for processing.
2626

2727
|Thanos Ruler
2828
|The Thanos Ruler is a rule evaluation engine for Prometheus that is deployed as a separate process. In {product-title}
@@ -39,8 +39,8 @@ endif::openshift-dedicated,openshift-rosa[]
3939
ifndef::openshift-dedicated,openshift-rosa[]
4040
[NOTE]
4141
====
42-
The components in the preceding table are deployed after monitoring is enabled for user-defined projects.
42+
The components in the preceding table are deployed after you enable monitoring for user-defined projects.
4343
====
4444
endif::openshift-dedicated,openshift-rosa[]
4545

46-
All of these components are monitored by the stack and are automatically updated when {product-title} is updated.
46+
The monitoring stack monitors all components for user-defined projects. The components are automatically updated when {product-title} is updated.

modules/monitoring-default-monitoring-components.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="default-monitoring-components_{context}"]
77
= Default monitoring components
88

9-
By default, the {product-title} {product-version} monitoring stack includes these components:
9+
By default, the {product-title} {product-version} monitoring stack includes the following components:
1010

1111
.Default monitoring stack components
1212
[options="header"]
@@ -18,10 +18,10 @@ By default, the {product-title} {product-version} monitoring stack includes thes
1818
|The {cmo-first} is a central component of the monitoring stack. It deploys, manages, and automatically updates Prometheus and Alertmanager instances, Thanos Querier, Telemeter Client, and metrics targets. The {cmo-short} is deployed by the Cluster Version Operator (CVO).
1919

2020
|Prometheus Operator
21-
|The Prometheus Operator (PO) in the `openshift-monitoring` project creates, configures, and manages platform Prometheus instances and Alertmanager instances. It also automatically generates monitoring target configurations based on Kubernetes label queries.
21+
|The Prometheus Operator in the `openshift-monitoring` project creates, configures, and manages platform Prometheus instances and Alertmanager instances. It also automatically generates monitoring target configurations based on Kubernetes label queries.
2222

2323
|Prometheus
24-
|Prometheus is the monitoring system on which the {product-title} monitoring stack is based. Prometheus is a time-series database and a rule evaluation engine for metrics. Prometheus sends alerts to Alertmanager for processing.
24+
|The {product-title} monitoring stack is based on the Prometheus monitoring system. Prometheus is a time-series database and a rule evaluation engine for metrics. Prometheus sends alerts to Alertmanager for processing.
2525

2626
|Metrics Server
2727
|The Metrics Server component (MS in the preceding diagram) collects resource metrics and exposes them in the `metrics.k8s.io` Metrics API service for use by other tools and APIs, which frees the core platform Prometheus stack from handling this functionality. Note that with the {product-title} 4.16 release, Metrics Server replaces Prometheus Adapter.
@@ -46,11 +46,11 @@ You can use {cmo-full} config map settings to manage monitoring-plugin resources
4646
|Thanos Querier aggregates and optionally deduplicates core {product-title} metrics and metrics for user-defined projects under a single, multi-tenant interface.
4747

4848
|Telemeter Client
49-
|Telemeter Client sends a subsection of the data from platform Prometheus instances to Red Hat to facilitate Remote Health Monitoring for clusters.
49+
|Telemeter Client sends a subsection of the data from platform Prometheus instances to Red{nbsp}Hat to enable remote health monitoring for clusters.
5050

5151
|===
5252

53-
All of the components in the monitoring stack are monitored by the stack and are automatically updated when {product-title} is updated.
53+
The monitoring stack monitors all components within the stack. The components are automatically updated when {product-title} is updated.
5454

5555
[NOTE]
5656
====

modules/monitoring-understanding-the-monitoring-stack.adoc

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,30 @@
33
// * virt/support/virt-openshift-cluster-monitoring.adoc
44
// * observability/monitoring/monitoring-overview.adoc
55

6-
// This module uses a conditionalized title so that the module
7-
// can be re-used in associated products but the title is not
8-
// included in the existing OpenShift assembly.
9-
106
:_mod-docs-content-type: CONCEPT
117
[id="understanding-the-monitoring-stack_{context}"]
128
= Understanding the monitoring stack
139

1410
The monitoring stack includes the following components:
1511

16-
* *Default platform monitoring components*.
12+
Default platform monitoring components::
1713
ifndef::openshift-dedicated,openshift-rosa[]
18-
A set of platform monitoring components are installed in the `openshift-monitoring` project by default during an OpenShift Container Platform installation. This provides monitoring for core cluster components including Kubernetes services. The default monitoring stack also enables remote health monitoring for clusters.
14+
A set of platform monitoring components are installed in the `openshift-monitoring` project by default during an {product-title} installation. This provides monitoring for core cluster components including Kubernetes services. The default monitoring stack also enables remote health monitoring for clusters.
1915
endif::openshift-dedicated,openshift-rosa[]
2016
ifdef::openshift-dedicated,openshift-rosa[]
21-
A set of platform monitoring components are installed in the `openshift-monitoring` project by default during a {product-title} installation. Red Hat Site Reliability Engineers (SRE) use these components to monitor core cluster components including Kubernetes services. This includes critical metrics, such as CPU and memory, collected from all of the workloads in every namespace.
17+
A set of platform monitoring components are installed in the `openshift-monitoring` project by default during a {product-title} installation. Red{nbsp}Hat Site Reliability Engineers (SRE) use these components to monitor core cluster components including Kubernetes services. This includes critical metrics, such as CPU and memory, collected from all of the workloads in every namespace.
2218
endif::openshift-dedicated,openshift-rosa[]
2319
+
24-
These components are illustrated in the *Installed by default* section in the following diagram.
20+
You can see these components in the *Installed by default* section in the following diagram.
2521

26-
* *Components for monitoring user-defined projects*.
22+
Components for monitoring user-defined projects::
2723
ifndef::openshift-dedicated,openshift-rosa[]
28-
After optionally enabling monitoring for user-defined projects, additional monitoring components are installed in the `openshift-user-workload-monitoring` project. This provides monitoring for user-defined projects.
24+
If you enable monitoring for user-defined projects, additional monitoring components are installed in the `openshift-user-workload-monitoring` project. This provides optional monitoring for user-defined projects.
2925
endif::openshift-dedicated,openshift-rosa[]
3026
ifdef::openshift-dedicated,openshift-rosa[]
3127
A set of user-defined project monitoring components are installed in the `openshift-user-workload-monitoring` project by default during a {product-title} installation. You can use these components to monitor services and pods in user-defined projects.
3228
endif::openshift-dedicated,openshift-rosa[]
33-
These components are illustrated in the *User* section in the following diagram.
29+
+
30+
You can see these components in the *User* section in the following diagram.
3431

3532
image:monitoring-architecture.png[{product-title} monitoring architecture]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ toc::[]
99
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1010
The {product-title} monitoring stack is based on the link:https://prometheus.io/[Prometheus] open source project and its wider ecosystem.
1111
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
12-
The monitoring stack includes default monitoring components and components for monitoring user-defined projects.
12+
You can learn about the monitoring stack architecture, which includes default monitoring components and components for monitoring user-defined projects.
1313

1414
// Understanding the monitoring stack
1515
include::modules/monitoring-understanding-the-monitoring-stack.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)