Skip to content

Commit 64cc98d

Browse files
authored
Merge pull request #52810 from xenolinux/monitoring-common-terms
OSDOCS#4562: Add common terms in monitoring book
2 parents 245e6b9 + 19b46ea commit 64cc98d

File tree

2 files changed

+96
-2
lines changed

2 files changed

+96
-2
lines changed

modules/monitoring-common-terms.adoc

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * monitoring/monitoring-overview.adoc
4+
5+
:_content-type: REFERENCE
6+
[id="openshift-monitoring-common-terms_{context}"]
7+
= Common terms
8+
9+
This glossary defines common terms that are used in {product-title} architecture.
10+
11+
Alertmanager::
12+
Alertmanager handles alerts received from Prometheus. Alertmanager is also responsible for sending the alerts to external notification systems.
13+
14+
Alerting rules::
15+
Alerting rules contain a set of conditions that outline a particular state within a cluster. Alerts are triggered when those conditions are true. An alerting rule can be assigned a severity that defines how the alerts are routed.
16+
17+
Cluster Monitoring Operator::
18+
The Cluster Monitoring Operator (CMO) is a central component of the monitoring stack. It deploys and manages Prometheus instances such as, the Thanos Querier, the Telemeter Client, and metrics targets to ensure that they are up to date. The CMO is deployed by the Cluster Version Operator (CVO).
19+
20+
Cluster Version Operator::
21+
The Cluster Version Operator (CVO) manages the lifecycle of cluster Operators, many of which are installed in {product-title} by default.
22+
23+
config map::
24+
A config map provides a way to inject configuration data into pods. You can reference the data stored in a config map in a volume of type `ConfigMap`. Applications running in a pod can use this data.
25+
26+
Container::
27+
A container is a lightweight and executable image that includes software and all its dependencies. Containers virtualize the operating system. As a result, you can run containers anywhere from a data center to a public or private cloud as well as a developer’s laptop.
28+
29+
custom resource (CR)::
30+
A CR is an extension of the Kubernetes API. You can create custom resources.
31+
32+
etcd::
33+
etcd is the key-value store for {product-title}, which stores the state of all resource objects.
34+
35+
Fluentd::
36+
Fluentd gathers logs from nodes and feeds them to Elasticsearch.
37+
38+
Kubelets::
39+
Runs on nodes and reads the container manifests. Ensures that the defined containers have started and are running.
40+
41+
Kubernetes API server::
42+
Kubernetes API server validates and configures data for the API objects.
43+
44+
Kubernetes controller manager::
45+
Kubernetes controller manager governs the state of the cluster.
46+
47+
Kubernetes scheduler::
48+
Kubernetes scheduler allocates pods to nodes.
49+
50+
labels::
51+
Labels are key-value pairs that you can use to organize and select subsets of objects such as a pod.
52+
53+
Metering::
54+
Metering is a general purpose data analysis tool that enables you to write reports to process data from different data sources.
55+
56+
node::
57+
A worker machine in the {product-title} cluster. A node is either a virtual machine (VM) or a physical machine.
58+
59+
Operator::
60+
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.
61+
62+
Operator Lifecycle Manager (OLM)::
63+
OLM helps you install, update, and manage the lifecycle of Kubernetes native applications. OLM is an open source toolkit designed to manage Operators in an effective, automated, and scalable way.
64+
65+
Persistent storage::
66+
Stores the data even after the device is shut down. Kubernetes uses persistent volumes to store the application data.
67+
68+
Persistent volume claim (PVC)::
69+
You can use a PVC to mount a PersistentVolume into a Pod. You can access the storage without knowing the details of the cloud environment.
70+
71+
pod::
72+
The pod is the smallest logical unit in Kubernetes. A pod is comprised of one or more containers to run in a worker node.
73+
74+
Prometheus::
75+
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.
76+
77+
Prometheus adapter::
78+
The Prometheus Adapter translates Kubernetes node and pod queries for use in Prometheus. The resource metrics that are translated include CPU and memory utilization. The Prometheus Adapter exposes the cluster resource metrics API for horizontal pod autoscaling.
79+
80+
Prometheus Operator::
81+
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+
83+
Silences::
84+
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.
85+
86+
storage::
87+
{product-title} supports many types of storage, both for on-premise and cloud providers. You can manage container storage for persistent and non-persistent data in an {product-title} cluster.
88+
89+
Thanos Ruler::
90+
The Thanos Ruler is a rule evaluation engine for Prometheus that is deployed as a separate process. In {product-title}, Thanos Ruler provides rule and alerting evaluation for the monitoring of user-defined projects.
91+
92+
web console::
93+
A user interface (UI) to manage {product-title}.

monitoring/monitoring-overview.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ toc::[]
1414

1515
A cluster administrator can xref:../monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[configure the monitoring stack] with the supported configurations. {product-title} delivers monitoring best practices out of the box.
1616

17-
A set of alerts are included by default that immediately notify cluster administrators about issues with a cluster. Default dashboards in the {product-title} web console include visual representations of cluster metrics to help you to quickly understand the state of your cluster. With the {product-title} web console, you can xref:../monitoring/managing-metrics.adoc#managing-metrics[view and manage metrics], xref:../monitoring/managing-alerts.adoc#managing-alerts[alerts], and xref:../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[review monitoring dashboards].
17+
A set of alerts are included by default that immediately notify administrators about issues with a cluster. Default dashboards in the {product-title} web console include visual representations of cluster metrics to help you to quickly understand the state of your cluster. With the {product-title} web console, you can xref:../monitoring/managing-metrics.adoc#managing-metrics[view and manage metrics], xref:../monitoring/managing-alerts.adoc#managing-alerts[alerts], and xref:../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[review monitoring dashboards].
1818

1919
In the *Observe* section of {product-title} web console, you can access and manage monitoring features such as xref:../monitoring/managing-metrics.adoc#managing-metrics[metrics], xref:../monitoring/managing-alerts.adoc#managing-alerts[alerts], xref:../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[monitoring dashboards], and xref:../monitoring/managing-metrics-targets.adoc#managing-metrics-targets[metrics targets].
2020

21-
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.
21+
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.
2222
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:../monitoring/troubleshooting-monitoring-issues.adoc#troubleshooting-monitoring-issues[Troubleshooting monitoring issues].
2323

2424
// Understanding the monitoring stack
@@ -27,6 +27,7 @@ include::modules/monitoring-default-monitoring-components.adoc[leveloffset=+2]
2727
include::modules/monitoring-default-monitoring-targets.adoc[leveloffset=+2]
2828
include::modules/monitoring-components-for-monitoring-user-defined-projects.adoc[leveloffset=+2]
2929
include::modules/monitoring-targets-for-user-defined-projects.adoc[leveloffset=+2]
30+
include::modules/monitoring-common-terms.adoc[leveloffset=+1]
3031

3132
[role="_additional-resources"]
3233
[id="additional-resources_monitoring-overview"]

0 commit comments

Comments
 (0)