Skip to content

Add documentation for command line variables used during rebuild #283

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
matthew-richerson merged 1 commit into from
Aug 26, 2025
Merged

Add documentation for command line variables used during rebuild #283

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
15 changes: 15 additions & 0 deletions docs/guides/storage-profiles/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -302,12 +302,17 @@ In general, `scale` gives a simple way for users to get a filesystem that has pe
- `$VG_NAME` - expands to a volume group name that is controlled by Rabbit software.
- `$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.
- `$DEVICE_NUM` - expands to the count of devices in `$DEVICE_LIST`
- `$DEVICE_NUM-1` - expands to the count of devices in `$DEVICE_LIST` minus 1
- `$DEVICE_NUM-2` - expands to the count of devices in `$DEVICE_LIST` minus 2
- `$DEVICE` - expands to the name of a new device. This is used by `vgextend` when repairing a RAID device

### LVM LV Commands

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

### zpool replace

- `$DEVICE_NUM` - expands to a number indicating the number of devices allocated for this storage request.
- `$DEVICE_NUM-1` - expands to a number indicating the number of devices allocated for this storage request minus 1.
- `$DEVICE_NUM-2` - expands to a number indicating the number of devices allocated for this storage request minus 2.
- `$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.
- `$POOL_NAME` - expands to a pool name that is controlled by Rabbit software.
- `$OLD_DEVICE` - expands to the name of a device that is degraded
- `$NEW_DEVICE` - expands to the name of a new device that can replace the degraded device

### lustre mkfs

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