Skip to content

[enterprise-4.13] OBSDOCS-547: Remove explicit mention of local persistent storage volu… #77777

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 20, 2024
Merged

[enterprise-4.13] OBSDOCS-547: Remove explicit mention of local persistent storage volu… #77777

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
103 changes: 19 additions & 84 deletions ...ring-a-local-persistent-volume-claim.adoc → ...onfiguring-a-persistent-volume-claim.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,11 @@
// * observability/monitoring/configuring-the-monitoring-stack.adoc

:_mod-docs-content-type: PROCEDURE
[id="configuring-a-local-persistent-volume-claim_{context}"]
ifndef::openshift-dedicated,openshift-rosa[]
= Configuring a local persistent volume claim
endif::openshift-dedicated,openshift-rosa[]
ifdef::openshift-dedicated,openshift-rosa[]
[id="configuring-a-persistent-volume-claim_{context}"]

= Configuring a persistent volume claim
endif::openshift-dedicated,openshift-rosa[]

For monitoring components to use a persistent volume (PV), you must configure a persistent volume claim (PVC).
To use a persistent volume (PV) for monitoring components, you must configure a persistent volume claim (PVC).

.Prerequisites

Expand Down Expand Up @@ -52,18 +48,21 @@ metadata:
namespace: openshift-monitoring
data:
config.yaml: |
<component>:
<component>: #<1>
volumeClaimTemplate:
spec:
storageClassName: <storage_class>
storageClassName: <storage_class> #<2>
resources:
requests:
storage: <amount_of_storage>
storage: <amount_of_storage> #<3>
----
<1> Specify the core monitoring component for which you want to configure the PVC.
<2> Specify an existing storage class. If a storage class is not specified, the default storage class is used.
<3> Specify the amount of required storage.
+
See the link:https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims[Kubernetes documentation on PersistentVolumeClaims] for information on how to specify `volumeClaimTemplate`.
+
The following example configures a PVC that claims local persistent storage for the Prometheus instance that monitors core {product-title} components:
The following example configures a PVC that claims persistent storage for the Prometheus instance that monitors core {product-title} components:
+
[source,yaml]
----
Expand All @@ -77,33 +76,11 @@ data:
prometheusK8s:
volumeClaimTemplate:
spec:
storageClassName: local-storage
storageClassName: my-storage-class
resources:
requests:
storage: 40Gi
----
+
In the above example, the storage class created by the Local Storage Operator is called `local-storage`.
+
The following example configures a PVC that claims local persistent storage for Alertmanager:
+
[source,yaml]
----
apiVersion: v1
kind: ConfigMap
metadata:
name: cluster-monitoring-config
namespace: openshift-monitoring
data:
config.yaml: |
alertmanagerMain:
volumeClaimTemplate:
spec:
storageClassName: local-storage
resources:
requests:
storage: 10Gi
----

** *To configure a PVC for a component that monitors user-defined projects*:
endif::openshift-dedicated,openshift-rosa[]
Expand All @@ -125,58 +102,21 @@ metadata:
namespace: openshift-user-workload-monitoring
data:
config.yaml: |
<component>:
<component>: #<1>
volumeClaimTemplate:
spec:
storageClassName: <storage_class>
storageClassName: <storage_class> #<2>
resources:
requests:
storage: <amount_of_storage>
storage: <amount_of_storage> #<3>
----
<1> Specify the component for user-defined monitoring for which you want to configure the PVC.
<2> Specify an existing storage class. If a storage class is not specified, the default storage class is used.
<3> Specify the amount of required storage.
+
See the link:https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims[Kubernetes documentation on PersistentVolumeClaims] for information on how to specify `volumeClaimTemplate`.
+
The following example configures a PVC that claims
ifndef::openshift-dedicated,openshift-rosa[]
local
endif::openshift-dedicated,openshift-rosa[]
persistent storage for the Prometheus instance that monitors user-defined projects:
+
[source,yaml]
----
apiVersion: v1
kind: ConfigMap
metadata:
name: user-workload-monitoring-config
namespace: openshift-user-workload-monitoring
data:
config.yaml: |
prometheus:
volumeClaimTemplate:
spec:
ifndef::openshift-dedicated,openshift-rosa[]
storageClassName: local-storage
endif::openshift-dedicated,openshift-rosa[]
ifdef::openshift-dedicated,openshift-rosa[]
storageClassName: gp3
endif::openshift-dedicated,openshift-rosa[]
resources:
requests:
storage: 40Gi
----
+
ifndef::openshift-dedicated,openshift-rosa[]
In the above example, the storage class created by the Local Storage Operator is called `local-storage`.
endif::openshift-dedicated,openshift-rosa[]
ifdef::openshift-dedicated,openshift-rosa[]
The above example uses the `gp3` storage class.
endif::openshift-dedicated,openshift-rosa[]
+
The following example configures a PVC that claims
ifndef::openshift-dedicated,openshift-rosa[]
local
endif::openshift-dedicated,openshift-rosa[]
persistent storage for Thanos Ruler:
The following example configures a PVC that claims persistent storage for Thanos Ruler:
+
[source,yaml]
----
Expand All @@ -190,12 +130,7 @@ data:
thanosRuler:
volumeClaimTemplate:
spec:
ifndef::openshift-dedicated,openshift-rosa[]
storageClassName: local-storage
endif::openshift-dedicated,openshift-rosa[]
ifdef::openshift-dedicated,openshift-rosa[]
storageClassName: gp3
endif::openshift-dedicated,openshift-rosa[]
storageClassName: my-storage-class
resources:
requests:
storage: 10Gi
Expand Down
19 changes: 7 additions & 12 deletions modules/monitoring-configuring-persistent-storage.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,31 +11,26 @@ Run cluster monitoring with persistent storage to gain the following benefits:
* Protect your metrics and alerting data from data loss by storing them in a persistent volume (PV). As a result, they can survive pods being restarted or recreated.
* Avoid getting duplicate notifications and losing silences for alerts when the Alertmanager pods are restarted.

For production environments, it is highly recommended to configure persistent storage. Because of the high IO demands, it is advantageous to use local storage.
For production environments, it is highly recommended to configure persistent storage.

[id="persistent-storage-prerequisites"]
[id="persistent-storage-prerequisites_{context}"]
== Persistent storage prerequisites

ifdef::openshift-dedicated,openshift-rosa[]
* Use the block type of storage.
endif::openshift-dedicated,openshift-rosa[]

ifndef::openshift-dedicated,openshift-rosa[]
* Dedicate sufficient local persistent storage to ensure that the disk does not become full. How much storage you need depends on the number of pods.

* Verify that you have a persistent volume (PV) ready to be claimed by the persistent volume claim (PVC), one PV for each replica. Because Prometheus and Alertmanager both have two replicas, you need four PVs to support the entire monitoring stack. The PVs are available from the Local Storage Operator, but not if you have enabled dynamically provisioned storage.
* Dedicate sufficient persistent storage to ensure that the disk does not become full.

* Use `Filesystem` as the storage type value for the `volumeMode` parameter when you configure the persistent volume.
+
[NOTE]
====
If you use a local volume for persistent storage, do not use a raw block volume, which is described with `volumeMode: Block` in the `LocalVolume` object. Prometheus cannot use raw block volumes.
====
+
[IMPORTANT]
====
Prometheus does not support file systems that are not POSIX compliant.
* Do not use a raw block volume, which is described with `volumeMode: Block` in the `PersistentVolume` resource. Prometheus cannot use raw block volumes.

* Prometheus does not support file systems that are not POSIX compliant.
For example, some NFS file system implementations are not POSIX compliant.
If you want to use an NFS file system for storage, verify with the vendor that their NFS implementation is fully POSIX compliant.
====
endif::openshift-dedicated,openshift-rosa[]
endif::openshift-dedicated,openshift-rosa[]
Loading