Skip to content

Commit 4c366ae

Browse files
Add documentation for command line variables used during rebuild
Signed-off-by: Matt Richerson <[email protected]>
1 parent cb9cf4c commit 4c366ae

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/guides/storage-profiles/readme.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -302,12 +302,17 @@ In general, `scale` gives a simple way for users to get a filesystem that has pe
302302
- `$VG_NAME` - expands to a volume group name that is controlled by Rabbit software.
303303
- `$DEVICE_LIST` - expands to a list of space-separated `/dev/<path>` devices. This list will contain the devices that were iterated over for the pvcreate step.
304304
- `$DEVICE_NUM` - expands to the count of devices in `$DEVICE_LIST`
305+
- `$DEVICE_NUM-1` - expands to the count of devices in `$DEVICE_LIST` minus 1
306+
- `$DEVICE_NUM-2` - expands to the count of devices in `$DEVICE_LIST` minus 2
307+
- `$DEVICE` - expands to the name of a new device. This is used by `vgextend` when repairing a RAID device
305308

306309
### LVM LV Commands
307310

308311
- `$VG_NAME` - see vgcreate above.
309312
- `$LV_NAME` - expands to a logical volume name that is controlled by Rabbit software.
310313
- `$DEVICE_NUM` - expands to a number indicating the number of devices allocated for the volume group.
314+
- `$DEVICE_NUM-1` - expands to a number indicating the number of devices allocated for the volume group minus 1.
315+
- `$DEVICE_NUM-2` - expands to a number indicating the number of devices allocated for the volume group minus 2.
311316
- `$DEVICE1, $DEVICE2, ..., $DEVICEn` - each expands to one of the devices from the `$DEVICE_LIST` above.
312317
- `$PERCENT_VG` - expands to the size that each LV should be based on a percentage of the total VG size
313318
- `$LV_SIZE` - expands to the size of the LV in kB in the format expected by `lvcreate`
@@ -330,6 +335,16 @@ In general, `scale` gives a simple way for users to get a filesystem that has pe
330335
- `$DEVICE_NUM` - expands to a number indicating the number of devices allocated for this storage request.
331336
- `$DEVICE1, $DEVICE2, ..., $DEVICEn` - each expands to one of the devices from the `$DEVICE_LIST` above.
332337

338+
### zpool replace
339+
340+
- `$DEVICE_NUM` - expands to a number indicating the number of devices allocated for this storage request.
341+
- `$DEVICE_NUM-1` - expands to a number indicating the number of devices allocated for this storage request minus 1.
342+
- `$DEVICE_NUM-2` - expands to a number indicating the number of devices allocated for this storage request minus 2.
343+
- `$DEVICE_LIST` - expands to a list of space-separated `/dev/<path>` devices. This list will contain the devices that were allocated for this storage request.
344+
- `$POOL_NAME` - expands to a pool name that is controlled by Rabbit software.
345+
- `$OLD_DEVICE` - expands to the name of a device that is degraded
346+
- `$NEW_DEVICE` - expands to the name of a new device that can replace the degraded device
347+
333348
### lustre mkfs
334349

335350
- `$FS_NAME` - expands to the filesystem name that was passed to Rabbit software from the workflow's #DW line.

0 commit comments

Comments
 (0)