Skip to content

Commit 567427a

Browse files
committed
Enhanced documentation for removing logical volumes
1 parent 883658c commit 567427a

File tree

2 files changed

+46
-1
lines changed

2 files changed

+46
-1
lines changed

docs/usage/baremetal/removing.md

+42-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,45 @@ title: "Removing a Logical Volume"
33
weight: 30400
44
---
55

6-
<placeholder>
6+
Removing a logical Volume (LV) in simplyblock permanently deletes the volume and its associated data from the cluster.
7+
This operation is performed using the `sbcli` command line interface. Care should be taken to verify that the volume
8+
is no longer in use and that backups are in place if needed.
9+
10+
While deleting a logical volume is a straightforward operation, but it must be executed carefully to avoid accidental
11+
data loss. Always ensure that the volume is no longer needed before removal.
12+
13+
!!! danger
14+
This action is **irreversible**. Once a logical volume is deleted, all data stored on it is permanently lost, except
15+
a snapshot or snapshot chain exists.
16+
17+
## Prerequisites
18+
19+
- A running simplyblock cluster with `sbcli` configured.
20+
- Ensure the Logical Volume is not mounted or in active use.
21+
- Verify that data stored on the volume is no longer required or has been backed up.
22+
23+
## Deleting a Logical Volume
24+
25+
To remove a Logical Volume:
26+
27+
```bash
28+
sbcli lvol delete <VOLUME_UUID> [--force]
29+
```
30+
31+
### Parameters
32+
33+
- `--force`: Optional parameter to force the deletion of the logical volume
34+
35+
## Verification
36+
37+
To confirm that the volume has been successfully deleted:
38+
39+
```bash
40+
sbcli volume list
41+
```
42+
43+
Verify that the volume no longer appears in the list of active logical volumes.
44+
45+
!!! warning
46+
If snapshots or snapshot chains of the logical volume exist, the internal storage is not reclaimed until all of the
47+
snapshots are deleted as well.

docs/usage/simplyblock-csi/removing.md

+4
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,7 @@ Now the PV can be deleted:
3535
```bash title="Delete a PersistentVolume"
3636
kubectl get pv <pv-name>
3737
```
38+
39+
!!! warning
40+
If snapshots or snapshot chains of the logical volume exist, the internal storage is not reclaimed until all of the
41+
snapshots are deleted as well.

0 commit comments

Comments
 (0)