Skip to content

Commit bb05c96

Browse files
committed
Edits of Cluster Monitoring Operator docs
1 parent 437c36d commit bb05c96

File tree

3 files changed

+101
-9
lines changed

3 files changed

+101
-9
lines changed
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * scalability_and_performance/scaling-cluster-monitoring-operator.adoc
4+
5+
[id="configuring-cluster-monitoring-{context}"]
6+
= Configuring cluster monitoring
7+
8+
.Procedure
9+
10+
To increase the storage capacity for Prometheus:
11+
12+
. Create a YAML configuration file, `cluster-monitoring-config.yml. For example:
13+
+
14+
----
15+
apiVersion: v1
16+
kind: ConfigMap
17+
data:
18+
config.yaml: |
19+
prometheusOperator:
20+
baseImage: quay.io/coreos/prometheus-operator
21+
prometheusConfigReloaderBaseImage: quay.io/coreos/prometheus-config-reloader
22+
configReloaderBaseImage: quay.io/coreos/configmap-reload
23+
nodeSelector:
24+
node-role.kubernetes.io/infra: ""
25+
prometheusK8s:
26+
retention: {{PROMETHEUS_RETENTION_PERIOD}} <1>
27+
baseImage: openshift/prometheus
28+
nodeSelector:
29+
node-role.kubernetes.io/infra: ""
30+
volumeClaimTemplate:
31+
spec:
32+
storageClassName: gp2
33+
resources:
34+
requests:
35+
storage: {{PROMETHEUS_STORAGE_SIZE}} <2>
36+
alertmanagerMain:
37+
baseImage: openshift/prometheus-alertmanager
38+
nodeSelector:
39+
node-role.kubernetes.io/infra: ""
40+
volumeClaimTemplate:
41+
spec:
42+
storageClassName: gp2
43+
resources:
44+
requests:
45+
storage: {{ALERTMANAGER_STORAGE_SIZE}} <3>
46+
nodeExporter:
47+
baseImage: openshift/prometheus-node-exporter
48+
kubeRbacProxy:
49+
baseImage: quay.io/coreos/kube-rbac-proxy
50+
kubeStateMetrics:
51+
baseImage: quay.io/coreos/kube-state-metrics
52+
nodeSelector:
53+
node-role.kubernetes.io/infra: ""
54+
grafana:
55+
baseImage: grafana/grafana
56+
nodeSelector:
57+
node-role.kubernetes.io/infra: ""
58+
auth:
59+
baseImage: openshift/oauth-proxy
60+
k8sPrometheusAdapter:
61+
nodeSelector:
62+
node-role.kubernetes.io/infra: ""
63+
metadata:
64+
name: cluster-monitoring-config
65+
namespace: openshift-monitoring
66+
----
67+
<1> A typical value is `PROMETHEUS_RETENTION_PERIOD=15d`. Units are measured in
68+
time using one of these suffixes: s, m, h, d.
69+
<2> A typical value is `PROMETHEUS_STORAGE_SIZE=2000Gi`. Storage values can be a
70+
plain integer or as a fixed-point integer using one of these suffixes: E, P, T,
71+
G, M, K. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki.
72+
<3> A typical value is `ALERTMANAGER_STORAGE_SIZE=20Gi`. Storage values can be a
73+
plain integer or as a fixed-point integer using one of these suffixes: E, P, T,
74+
G, M, K. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki.
75+
76+
. Set the values like the retention period and storage sizes.
77+
78+
. Apply the changes by running:
79+
+
80+
----
81+
$ oc create -f cluster-monitoring-config.yml
82+
----

modules/prometheus-database-storage-requirements.adoc

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,8 @@ Red Hat performed various tests for different scale sizes.
4545
Approximately 20 percent of the expected size was added as overhead to ensure
4646
that the storage requirements do not exceed the calculated value.
4747

48-
The above calculation is for the default {product-title}
49-
*cluster-monitoring-operator*. For higher scale, edit the
50-
`openshift_cluster_monitoring_operator_prometheus_storage_capacity` variable in
51-
the Ansible inventory file, which defaults to `50Gi`.
48+
The above calculation is for the default {product-title} Cluster Monitoring
49+
Operator.
5250

5351
[NOTE]
5452
====
@@ -76,5 +74,15 @@ Currently, OpenStack environments are not supported for {product-title} 4.0.
7674

7775
[IMPORTANT]
7876
====
79-
Currently, CNS is not supported in {product-title} 4.0.
77+
OpenShift Container Storage (OCS) is currently a Technology Preview feature.
78+
ifdef::openshift-enterprise[]
79+
Technology Preview features are not supported with Red Hat production service
80+
level agreements (SLAs), might not be functionally complete, and Red Hat does
81+
not recommend to use them for production. These features provide early access to
82+
upcoming product features, enabling customers to test functionality and provide
83+
feedback during the development process.
84+
85+
See the link:https://access.redhat.com/support/offerings/techpreview/[Red Hat
86+
Technology Preview features support scope] for more information.
87+
endif::[]
8088
====

scalability_and_performance/scaling-cluster-monitoring-operator.adoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,13 @@ include::modules/common-attributes.adoc[]
55

66
toc::[]
77

8-
{product-title} exposes metrics that the *cluster-monitoring-operator* collects
9-
and stores in back-ends. As an {product-title} administrator, you can view
10-
system resources, containers and components metrics in one dashboard interface,
11-
Grafana.
8+
{product-title} exposes metrics that the Cluster Monitoring Operator collects
9+
and stores in the Prometheus-based monitoring stack. As an {product-title}
10+
administrator, you can view system resources, containers and components metrics
11+
in one dashboard interface, Grafana.
1212

1313
include::modules/prometheus-database-storage-requirements.adoc[leveloffset=+1]
1414

15+
include::modules/configuring-cluster-monitoring.adoc[leveloffset=+1]
16+
1517
include::modules/scaling-prometheus-components.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)