Update documentation for Storage Profiles#299
Merged
Conversation
The storage profiles documentation was stale, and many fields weren't documented. This commit adds documentation for existing fields as well as the new UserCommands and AllocationPadding fields. Signed-off-by: Matt Richerson <matthew.richerson@hpe.com>
ajfloeder
reviewed
Dec 8, 2025
ajfloeder
left a comment
ajfloeder
left a comment
Contributor
There was a problem hiding this comment.
Do you have markdown lint installed? I'm seeing about 10 lint errors right now.
ajfloeder
reviewed
Dec 8, 2025
ajfloeder
left a comment
ajfloeder
left a comment
Contributor
There was a problem hiding this comment.
We should have an overview somewhere other than in user-containers about the various workflow states and what happens in each to make these storage profile callouts make more sense.
That's a job for another day, however.
ajfloeder
reviewed
Dec 8, 2025
behlendorf
reviewed
Dec 8, 2025
| - `$MOUNT_PATH` - expands to the path to mount on | ||
| #### Lustre Client | ||
|
|
||
| ### PostMount/PreUnmount and PostActivate/PreDeactivate |
Collaborator
There was a problem hiding this comment.
Can we also document which environment variables are available for use in the User Commands.
…nd execution Signed-off-by: Matt Richerson <matthew.richerson@hpe.com>
Signed-off-by: Matt Richerson <matthew.richerson@hpe.com>
ajfloeder
approved these changes
Dec 9, 2025
behlendorf
approved these changes
Dec 9, 2025
github-project-automation
Bot
moved this from 👀 In review
to ✅ Closed
in Issues Dashboard
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The storage profiles documentation was stale, and many fields weren't documented. This commit adds documentation for existing fields as well as the new UserCommands and AllocationPadding fields.