fix(mpg): clarify restore command help text - #5043
Merged
Merged
Conversation
`fly mpg restore` provisions a new, separately-billed cluster and leaves the source untouched, but the help text didn't say so, and gave no pointer to where backup IDs come from. State both explicitly.
3 tasks
miguel-fly
approved these changes
Aug 5, 2026
Contributor
Author
|
Trimmed the help text in |
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
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.


Change Summary
What and Why:
fly mpg restoreprovisions a new, separately-billed cluster from the backup and leaves the source cluster untouched. The help text didn't say that, and gave no pointer to where--backup-idvalues come from. A customer reported the command as confusing.How:
Update the command's short/long help text to state that restore creates a new cluster (billed separately, same organization, provisioned asynchronously) rather than restoring in place, and to point at
fly mpg backup listfor backup IDs. Help text only — no behavior change,--backup-iddescription left as-is.Verified by:
go build,gofmt,go vet,go test ./internal/command/mpg/...— all clean;fly mpg restore --helpfrom a built binary;mpg restoredispatches on cluster version — the wording is deliberately version-agnostic because the two differ (e.g. generated-name format is<source> restored <timestamp>on v1 vs<source> restored <backup_id>on v2).Open question for reviewers: this is now on the long side for flyctl help text (~70 words vs a ~10-word median). Happy to trim if it reads as too much — the facts were added in response to the reported confusion, but which of them earn their place is a fair thing to push back on.
Related to:
Follow-ups tracked in that issue and intentionally out of scope here:
--nameto set the restored cluster's name, and--pitr-timefor point-in-time restore.Documentation