Skip to content
Merged
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
50 changes: 50 additions & 0 deletions modules/lvms-about-volume-metrics-alerts.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
// Module included in the following assemblies:
//
// storage/persistent_storage/persistent_storage_local/persistent-storage-using-lvms.adoc
:_mod-docs-content-type: CONCEPT
[id="lvms-about-volume-metrics-alerts_{context}"]
= Metrics and alerts overview

[role="_abstract"]
You can monitor thin pool and volume group usage through {lvms} metrics, and receive alerts at 75% (near full) and 85% (critical) capacity thresholds to take corrective action before storage operations fail.

[id="lvms-monitoring-using-lvms-metrics_{context}"]
== Metrics
You can monitor {lvms} by viewing the metrics.

The following table describes the `topolvm` metrics:

.`topolvm` metrics
[%autowidth,options="header"]
|===
|Alert | Description
|`topolvm_thinpool_data_percent` | Indicates the percentage of data space used in the LVM thinpool.
|`topolvm_thinpool_metadata_percent` | Indicates the percentage of metadata space used in the LVM thinpool.
|`topolvm_thinpool_size_bytes` | Indicates the size of the LVM thin pool in bytes.
|`topolvm_volumegroup_available_bytes` | Indicates the available space in the LVM volume group in bytes.
|`topolvm_volumegroup_size_bytes` | Indicates the size of the LVM volume group in bytes.
|`topolvm_thinpool_overprovisioned_available` | Indicates the available over-provisioned size of the LVM thin pool in bytes.
|===

[NOTE]
====
Metrics are updated every 10 minutes or when there is a change, such as a new logical volume creation, in the thin pool.
====

[id="lvms-monitoring-using-lvms-alerts_{context}"]
== Alerts
When the thin pool and volume group reach maximum storage capacity, further operations fail. This can lead to data loss.

{lvms} sends the following alerts when the usage of the thin pool and volume group exceeds a certain value:

.{lvms} alerts
[%autowidth, options="header"]
|===
|Alert| Description
|`VolumeGroupUsageAtThresholdNearFull`|This alert is triggered when both the volume group and thin pool usage exceeds 75% on nodes. Data deletion or volume group expansion is required.
|`VolumeGroupUsageAtThresholdCritical`|This alert is triggered when both the volume group and thin pool usage exceeds 85% on nodes. In this case, the volume group is critically full. Data deletion or volume group expansion is required.
|`ThinPoolDataUsageAtThresholdNearFull`|This alert is triggered when the thin pool data uusage in the volume group exceeds 75% on nodes. Data deletion or thin pool expansion is required.
|`ThinPoolDataUsageAtThresholdCritical`|This alert is triggered when the thin pool data usage in the volume group exceeds 85% on nodes. Data deletion or thin pool expansion is required.
|`ThinPoolMetaDataUsageAtThresholdNearFull`|This alert is triggered when the thin pool metadata usage in the volume group exceeds 75% on nodes. Data deletion or thin pool expansion is required.
|`ThinPoolMetaDataUsageAtThresholdCritical`|This alert is triggered when the thin pool metadata usage in the volume group exceeds 85% on nodes. Data deletion or thin pool expansion is required.
|===
3 changes: 2 additions & 1 deletion modules/lvms-download-log-files-and-diagnostics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
[id="lvms-dowloading-log-files-and-diagnostics_{context}"]
= Downloading log files and diagnostic information using must-gather

When {lvms} is unable to automatically resolve a problem, use the must-gather tool to collect the log files and diagnostic information so that you or the Red Hat Support can review the problem and determine a solution.
[role="_abstract"]
Use the must-gather tool to collect log files and diagnostic information when {lvms} cannot automatically resolve a problem. You or Red Hat Support can then review the collected data to troubleshoot the issue.

.Procedure
* Run the `must-gather` command from the client connected to the {lvms} cluster:
Expand Down
58 changes: 11 additions & 47 deletions modules/lvms-monitoring-logical-volume-manager-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,56 +6,20 @@
[id="lvms-monitoring_{context}"]
= Monitoring {lvms}

To enable cluster monitoring, you must add the following label in the namespace where you have installed {lvms}:
[source,text]
----
openshift.io/cluster-monitoring=true
----

[IMPORTANT]
====
For information about enabling cluster monitoring in {rh-rhacm}, see link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/{rh-rhacm-version}/html-single/observability/index[Observability] and link:https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/{rh-rhacm-version}/html-single/observability/index#adding-custom-metrics[Adding custom metrics].
====

[id="lvms-monitoring-using-lvms-metrics_{context}"]
== Metrics
[role="_abstract"]
You can monitor {lvms} by enabling cluster monitoring with a namespace label, then viewing metrics to track storage usage and receiving alerts when thin pool and volume group capacity reaches critical thresholds to prevent data loss.

You can monitor {lvms} by viewing the metrics.
To enable cluster monitoring, you must add a label in the namespace where you have installed {lvms}.

The following table describes the `topolvm` metrics:

.`topolvm` metrics
[%autowidth,options="header"]
|===
|Alert | Description
|`topolvm_thinpool_data_percent` | Indicates the percentage of data space used in the LVM thinpool.
|`topolvm_thinpool_metadata_percent` | Indicates the percentage of metadata space used in the LVM thinpool.
|`topolvm_thinpool_size_bytes` | Indicates the size of the LVM thin pool in bytes.
|`topolvm_volumegroup_available_bytes` | Indicates the available space in the LVM volume group in bytes.
|`topolvm_volumegroup_size_bytes` | Indicates the size of the LVM volume group in bytes.
|`topolvm_thinpool_overprovisioned_available` | Indicates the available over-provisioned size of the LVM thin pool in bytes.
|===

[NOTE]
[IMPORTANT]
====
Metrics are updated every 10 minutes or when there is a change, such as a new logical volume creation, in the thin pool.
For information about enabling cluster monitoring in {rh-rhacm}, see "Observability" and "Adding custom metrics".
====

[id="lvms-monitoring-using-lvms-alerts_{context}"]
== Alerts

When the thin pool and volume group reach maximum storage capacity, further operations fail. This can lead to data loss.

{lvms} sends the following alerts when the usage of the thin pool and volume group exceeds a certain value:
.Procedure
* To enable cluster monitoring, add the following label in the namespace where you have installed {lvms}:
[source,text]
----
openshift.io/cluster-monitoring=true
----

.LVM Storage alerts
[%autowidth, options="header"]
|===
|Alert| Description
|`VolumeGroupUsageAtThresholdNearFull`|This alert is triggered when both the volume group and thin pool usage exceeds 75% on nodes. Data deletion or volume group expansion is required.
|`VolumeGroupUsageAtThresholdCritical`|This alert is triggered when both the volume group and thin pool usage exceeds 85% on nodes. In this case, the volume group is critically full. Data deletion or volume group expansion is required.
|`ThinPoolDataUsageAtThresholdNearFull`|This alert is triggered when the thin pool data uusage in the volume group exceeds 75% on nodes. Data deletion or thin pool expansion is required.
|`ThinPoolDataUsageAtThresholdCritical`|This alert is triggered when the thin pool data usage in the volume group exceeds 85% on nodes. Data deletion or thin pool expansion is required.
|`ThinPoolMetaDataUsageAtThresholdNearFull`|This alert is triggered when the thin pool metadata usage in the volume group exceeds 75% on nodes. Data deletion or thin pool expansion is required.
|`ThinPoolMetaDataUsageAtThresholdCritical`|This alert is triggered when the thin pool metadata usage in the volume group exceeds 85% on nodes. Data deletion or thin pool expansion is required.
|===
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,15 @@
[id="lvms-unstalling-lvms-using-cli_{context}"]
= Uninstalling {lvms} by using the CLI

You can uninstall {lvms} by using the {oc-first}.
[role="_abstract"]
Uninstall {lvms} when it is no longer needed or before upgrading to a different storage solution by using the OpenShift CLI (`oc`) after removing all provisioned storage resources.

.Prerequisites

* You have logged in to `oc` as a user with `cluster-admin` permissions.
* You deleted the persistent volume claims (PVCs), volume snapshots, and volume clones provisioned by {lvms}. You have also deleted the applications that are using these resources.
* You deleted the `LVMCluster` custom resource (CR).

.Procedure

. Get the `currentCSV` value for the {lvms} Operator by running the following command:
+
[source,terminal]
Expand Down Expand Up @@ -46,9 +45,10 @@ subscription.operators.coreos.com "lvms-operator" deleted
+
[source,terminal]
----
$ oc delete clusterserviceversion <currentCSV> -n <namespace> <1>
$ oc delete clusterserviceversion <currentCSV> -n <namespace>
----
<1> Replace `<currentCSV>` with the `currentCSV` value for the {lvms} Operator.
+
Replace `<currentCSV>` with the `currentCSV` value for the {lvms} Operator.
+
.Example output
[source,terminal]
Expand All @@ -57,7 +57,6 @@ clusterserviceversion.operators.coreos.com "lvms-operator.v4.15.3" deleted
----

.Verification

* To verify that the {lvms} Operator is uninstalled, run the following command:
+
[source,terminal]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,15 @@
[id="lvms-unstalling-lvms-with-web-console_{context}"]
= Uninstalling {lvms} by using the web console

You can uninstall {lvms} using the {product-title} web console.
[role="_abstract"]
Uninstall {lvms} when it is no longer needed or before upgrading to a different storage solution by using the {product-title} web console after removing all provisioned storage resources.

.Prerequisites

* You have access to {product-title} as a user with `cluster-admin` permissions.
* You have deleted the persistent volume claims (PVCs), volume snapshots, and volume clones provisioned by {lvms}. You have also deleted the applications that are using these resources.
* You have deleted the `LVMCluster` custom resource (CR).


.Procedure

. Log in to the {product-title} web console.
. Click *Ecosystem* -> *Installed Operators*.
. Click *{lvms}* in the `openshift-lvm-storage` namespace.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,25 @@
[id="lvms-uninstalling-lvms-rhacm_{context}"]
= Uninstalling {lvms} installed using {rh-rhacm}

To uninstall {lvms} that you installed using {rh-rhacm}, you must delete the {rh-rhacm} `Policy` custom resource (CR) that you created for installing and configuring {lvms}.
[role="_abstract"]
To uninstall {lvms} that you installed by using {rh-rhacm} when it is no longer needed or before switching to a different storage solution, delete the {rh-rhacm} `Policy` custom resource (CR) that you created for installation after removing all provisioned storage resources.

.Prerequisites

* You have access to the {rh-rhacm} cluster as a user with `cluster-admin` permissions.
* You have deleted the persistent volume claims (PVCs), volume snapshots, and volume clones provisioned by {lvms}. You have also deleted the applications that are using these resources.
* You have deleted the `LVMCluster` CR that you created using {rh-rhacm}.

.Procedure

. Log in to the OpenShift CLI (`oc`).

. Delete the {rh-rhacm} `Policy` CR that you created for installing and configuring {lvms} by using the following command:
+
[source,terminal]
----
$ oc delete -f <policy> -n <namespace> <1>
$ oc delete -f <policy> -n <namespace>
----
<1> Replace `<policy>` with the name of the `Policy` CR YAML file.
+
Replace `<policy>` with the name of the `Policy` CR YAML file.

. Create a `Policy` CR YAML file with the configuration to uninstall {lvms}:
+
Expand Down
14 changes: 5 additions & 9 deletions modules/lvms-updating-lvms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,34 +6,31 @@
[id="lvms-updating-lvms_{context}"]
= Updating {lvms}

You can update {lvms} to ensure compatibility with the {product-title} version.
[role="_abstract"]
You can update {lvms} to ensure compatibility with the {product-title} version after upgrading your cluster.

[NOTE]
====
The default namespace for the {lvms} Operator is `openshift-lvm-storage`.
====

.Prerequisites

* You have updated your {product-title} cluster.

* You have installed a previous version of {lvms}.

* You have installed the OpenShift CLI (`oc`).

* You have access to the cluster using an account with `cluster-admin` permissions.

.Procedure

. Log in to the OpenShift CLI (`oc`).

. Update the `Subscription` custom resource (CR) that you created while installing {lvms} by running the following command:
+
[source,terminal]
----
$ oc patch subscription lvms-operator -n openshift-lvm-storage --type merge --patch '{"spec":{"channel":"<update_channel>"}}' <1>
$ oc patch subscription lvms-operator -n openshift-lvm-storage --type merge --patch '{"spec":{"channel":"<update_channel>"}}'
----
<1> Replace `<update_channel>` with the version of {lvms} that you want to install. For example, `stable-{product-version}`.
+
Replace `<update_channel>` with the version of {lvms} that you want to install. For example, `stable-{product-version}`.

. View the update events to check that the installation is complete by running the following command:
+
Expand All @@ -56,7 +53,6 @@ $ oc get events -n openshift-lvm-storage
----

.Verification

* Verify the {lvms} version by running the following command:
+
[source,terminal]
Expand Down