Skip to content

Commit 0520445

Browse files
committed
Added a set of baremetal usage commands
1 parent 1954def commit 0520445

File tree

4 files changed

+165
-4
lines changed

4 files changed

+165
-4
lines changed

docs/usage/baremetal/cloning.md

+33-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,36 @@ title: "Cloning a Logical Volume"
33
weight: 30200
44
---
55

6-
<placeholder>
6+
Cloning a logical Volume (LV) in simplyblock creates a writable, independent copy-on-write clone of an existing volume.
7+
This is useful for scenarios such as testing, staging, backups, and development environments, all while preserving the
8+
original data. Clones can be created quickly and efficiently using the `sbcli` command line interface.
9+
10+
## Prerequisites
11+
12+
- A running simplyblock cluster with an existing logical volume.
13+
- An existing [snapshot](snapshotting.md) of a logical volume.
14+
- `sbcli` installed and configured with access to the simplyblock management API.
15+
16+
## Cloning a Logical Volume
17+
18+
To create a clone of an existing Logical Volume:
19+
20+
```bash
21+
sbcli snapshot clone \
22+
<SNAPSHOT_UUID> \
23+
<NEW_VOLUME_NAME>
24+
```
25+
26+
## Verification
27+
28+
After cloning, the new Logical Volume can be listed:
29+
30+
```bash
31+
sbcli lvol list
32+
```
33+
34+
Details of the cloned volume can be retrieved using:
35+
36+
```bash
37+
sbcli lvol get <VOLUME_UUID>
38+
```

docs/usage/baremetal/expanding.md

+51-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,54 @@ title: "Expanding a Logical Volume"
33
weight: 30300
44
---
55

6-
<placeholder>
6+
# Resizing (Expanding) a Logical Volume with sbcli
7+
8+
## Overview
9+
10+
Resizing a logical Volume (LV) in simplyblock allows additional capacity to be allocated without downtime, ensuring
11+
workloads have sufficient storage as demand grows. The `sbcli` command line interface is used to expand the size of an
12+
existing Logical Volume in a simple and efficient manner.
13+
14+
## Prerequisites
15+
16+
- A running simplyblock cluster with a valid logical volume.
17+
- `sbcli` installed and configured with access to the simplyblock management API.
18+
19+
## Expanding a Logical Volume
20+
21+
To increase the size of an existing logical volume:
22+
23+
```bash
24+
sbcli volume resize \
25+
<VOLUME_UUID> \
26+
<NEW_SIZE>
27+
```
28+
29+
## Verification
30+
31+
After resizing, confirm the new volume size:
32+
33+
```bash
34+
sbcli volume get <VOLUME_UUID>
35+
```
36+
37+
## Resize the Filesystem (If Required)
38+
39+
Certain filesystems, such as ext4, may require growing the filesystem after the underlying volume has been expanded.
40+
41+
### For `ext4` filesystems:
42+
43+
```bash
44+
resize2fs /dev/nvmeXnY
45+
```
46+
47+
### For `xfs` filesystems:
48+
49+
```bash
50+
xfs_growfs /mount/point
51+
```
52+
53+
## Shrinking a Volume
54+
55+
Theoretically it is possible to shrink a volume. It can, however, create issues with certain filesystems. When a volume
56+
needs to be shrunk, it is recommended to create a snapshot and restore it onto a new volume.

docs/usage/baremetal/provisioning.md

+51-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,54 @@ title: "Provisioning a Logical Volume"
33
weight: 30000
44
---
55

6-
<placeholder>
6+
A logical volume (LV) in simplyblock can be provisioned using the `sbcli` command line interface. This allows
7+
administrators to create virtual NVMe block devices backed by simplyblock’s distributed storage, enabling
8+
high-performance and fault-tolerant storage for workloads.
9+
10+
## Prerequisites
11+
12+
- A running simplyblock cluster with healthy management and storage nodes.
13+
- `sbcli` installed and configured with access to the simplyblock management API.
14+
15+
## Provisioning a New Logical Volume
16+
17+
To create a new logical volume:
18+
19+
```bash
20+
sbcli lvol add \
21+
--max-rw-iops <IOPS> \
22+
--max-r-mbytes <THROUGHPUT> \
23+
--max-w-mbytes <THROUGHPUT> \
24+
<VOLUME_NAME> \
25+
<VOLUME_SIZE> \
26+
<POOL_NAME>
27+
```
28+
29+
### Available Parameters
30+
31+
| Parameter | Description | Default |
32+
|-------------------------------|-----------------------------------------------------|---------|
33+
| --snapshot, -s | Enables snapshot capability on the logical volume. | false |
34+
| --max-size | Maximum size of the logical volume. | 0 |
35+
| --ha-type {single,ha,default} | High availability mode of the logical volume. | ha |
36+
| --encrypt | Enables in inline encryption on the logical volume. | false |
37+
| --crypto-key1 CRYPTO_KEY1 | The hex value of the first encryption key. | |
38+
| --crypto-key2 CRYPTO_KEY2 | The hex value of the second encryption key. | |
39+
| --max-rw-iops MAX_RW_IOPS | Maximum IO operations per second. | 0 |
40+
| --max-rw-mbytes MAX_RW_MBYTES | Maximum read/write throughput. | 0 |
41+
| --max-r-mbytes MAX_R_MBYTES | Maximum read throughout. | 0 |
42+
| --max-w-mbytes MAX_W_MBYTES | Maximum write throughput. | 0 |
43+
44+
## Verification
45+
46+
After creation, the Logical Volume can be listed and verified:
47+
48+
```bash
49+
sbcli volume list
50+
```
51+
52+
Details of the volume can be retrieved using:
53+
54+
```bash
55+
sbcli lvol get <VOLUME_UUID>
56+
```

docs/usage/baremetal/snapshotting.md

+30-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,33 @@ title: "Snapshotting a Logical Volume"
33
weight: 30100
44
---
55

6-
<placeholder>
6+
# Creating a Snapshot of a Logical Volume with sbcli
7+
8+
## Overview
9+
10+
Snapshots in simplyblock provide point-in-time copies of logical Volumes (LVs), allowing for backup, recovery, or
11+
cloning operations without impacting the active workload. Snapshots can be created using the `sbcli` command line
12+
interface to protect critical data or enable development and testing environments based on production data.
13+
14+
## Prerequisites
15+
16+
- A running simplyblock cluster with an existing logical volume.
17+
- `sbcli` installed and configured with access to the simplyblock management API.
18+
19+
## Creating a Snapshot
20+
21+
To create a snapshot of an existing Logical Volume:
22+
23+
```bash
24+
sbcli snapshot add \
25+
<VOLUME_UUID> \
26+
<SNAPSHOT_NAME>
27+
```
28+
29+
## Verification
30+
31+
After creation, the snapshot can be listed:
32+
33+
```bash
34+
sbcli snapshot list
35+
```

0 commit comments

Comments
 (0)