Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions modules/configuring-cluster-monitoring.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@ You can increase the storage capacity for the Prometheus component in the cluste

.Procedure

To increase the storage capacity for Prometheus:

. Create a YAML configuration file, `cluster-monitoring-config.yaml`. For example:
. To increase the storage capacity for Prometheus, create a YAML configuration file, `cluster-monitoring-config.yaml`, as in the following example:
+
[source,yaml]
----
Expand All @@ -22,32 +20,35 @@ kind: ConfigMap
data:
config.yaml: |
prometheusK8s:
retention: {{PROMETHEUS_RETENTION_PERIOD}} <1>
retention: <prometheus_retention_period>
nodeSelector:
node-role.kubernetes.io/infra: ""
volumeClaimTemplate:
spec:
storageClassName: {{STORAGE_CLASS}} <2>
storageClassName: <storage_class>
resources:
requests:
storage: {{PROMETHEUS_STORAGE_SIZE}} <3>
storage: <prometheus_storage_size>
alertmanagerMain:
nodeSelector:
node-role.kubernetes.io/infra: ""
volumeClaimTemplate:
spec:
storageClassName: {{STORAGE_CLASS}} <2>
storageClassName: <storage_class>
resources:
requests:
storage: {{ALERTMANAGER_STORAGE_SIZE}} <4>
storage: <alertmanager_storage_size>
metadata:
name: cluster-monitoring-config
namespace: openshift-monitoring
----
<1> The default value of Prometheus retention is `PROMETHEUS_RETENTION_PERIOD=15d`. Units are measured in time using one of these suffixes: s, m, h, d.
<2> The storage class for your cluster.
<3> A typical value is `PROMETHEUS_STORAGE_SIZE=2000Gi`. Storage values can be a plain integer or a fixed-point integer using one of these suffixes: E, P, T, G, M, K. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki.
<4> A typical value is `ALERTMANAGER_STORAGE_SIZE=20Gi`. Storage values can be a plain integer or a fixed-point integer using one of these suffixes: E, P, T, G, M, K. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki.
+
--
* `<prometheus_retention_period>` specifies the Prometheus retention period. The default value is `15d`. Units are measured in time using one of these suffixes: s, m, h, d.
* `<storage_class>` specifies the storage class for your cluster.
* `<prometheus_storage_size>` specifies the Prometheus storage size. A typical value is `2000Gi`. Storage values can be a plain integer or a fixed-point integer using one of these suffixes: E, P, T, G, M, K. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki.
* `<alertmanager_storage_size>` specifies the Alertmanager storage size. A typical value is `20Gi`. Storage values can be a plain integer or a fixed-point integer using one of these suffixes: E, P, T, G, M, K. You can also use the power-of-two equivalents: Ei, Pi, Ti, Gi, Mi, Ki.
--

. Add values for the retention period, storage class, and storage sizes.

Expand Down
1 change: 1 addition & 0 deletions modules/infrastructure-node-sizing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="infrastructure-node-sizing_{context}"]
= Infrastructure node sizing

[role="_abstract"]
_Infrastructure nodes_ are nodes that are labeled to run pieces of the {product-title} environment. The infrastructure node resource requirements depend on the cluster age, nodes, and objects in the cluster, as these factors can lead to an increase in the number of metrics or time series in Prometheus. The following infrastructure node size recommendations are based on the results observed in cluster-density testing detailed in the *Control plane node sizing* section, where the monitoring stack and the default ingress-controller were moved to these nodes.

[options="header",cols="4*"]
Expand Down
1 change: 1 addition & 0 deletions modules/prometheus-database-storage-requirements.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
[id="prometheus-database-storage-requirements_{context}"]
= Prometheus database storage requirements

[role="_abstract"]
Red{nbsp}Hat performed various tests for different scale sizes.

[NOTE]
Expand Down
10 changes: 10 additions & 0 deletions modules/scaling-cluster-monitoring-operator.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// Module included in the following assemblies:
//
// * scalability_and_performance/recommended-performance-scale-practices/recommended-infrastructure-practices.adoc

:_mod-docs-content-type: CONCEPT
[id="scaling-cluster-monitoring-operator_{context}"]
= Scaling the {cmo-full}

[role="_abstract"]
{product-title} exposes metrics that the {cmo-first} collects and stores in the Prometheus-based monitoring stack. As an administrator, you can view dashboards for system resources, containers, and components metrics in the {product-title} web console by navigating to *Observe* -> *Dashboards*.
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,16 @@ include::_attributes/common-attributes.adoc[]

toc::[]

[role="_abstract"]
This topic provides recommended performance and scalability practices for infrastructure in {product-title}.

include::modules/infrastructure-node-sizing.adoc[leveloffset=+1]

[id="scaling-cluster-monitoring-operator_{context}"]
== Scaling the {cmo-full}
include::modules/scaling-cluster-monitoring-operator.adoc[leveloffset=+1]

{product-title} exposes metrics that the {cmo-first} collects and stores in the Prometheus-based monitoring stack. As an administrator, you can view dashboards for system resources, containers, and components metrics in the {product-title} web console by navigating to *Observe* -> *Dashboards*.
include::modules/prometheus-database-storage-requirements.adoc[leveloffset=+2]

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

include::modules/configuring-cluster-monitoring.adoc[leveloffset=+1]
include::modules/configuring-cluster-monitoring.adoc[leveloffset=+2]

[role="_additional-resources"]
== Additional resources
Expand Down