Skip to content

fix(mpg): clarify restore command help text - #5043

Merged
tripledoublev merged 2 commits into
masterfrom
vincent/mpg-restore-help
Aug 5, 2026
Merged

fix(mpg): clarify restore command help text#5043
tripledoublev merged 2 commits into
masterfrom
vincent/mpg-restore-help

Conversation

@tripledoublev

Copy link
Copy Markdown
Contributor

Change Summary

What and Why:

fly mpg restore provisions 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-id values 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 list for backup IDs. Help text only — no behavior change, --backup-id description left as-is.

Verified by:

  • go build, gofmt, go vet, go test ./internal/command/mpg/... — all clean;
  • inspecting the rendered fly mpg restore --help from a built binary;
  • confirming each claim against both the v1 and v2 code paths, since mpg restore dispatches 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: --name to set the restored cluster's name, and --pitr-time for point-in-time restore.


Documentation

  • Fresh Produce
  • In superfly/docs, or asked for help from docs team
  • n/a

`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.

@miguel-fly miguel-fly left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The long description looks a bit verbose, since all the lines are concatenated without line breaks:

Image

--
Consider reducing the description a bit. For example:

Image

Copy link
Copy Markdown
Contributor Author

Trimmed the help text in e163911a0 to match the suggested wording; verified the rendered output, and go test ./internal/command/mpg/... passes.

@tripledoublev
tripledoublev merged commit e6225f6 into master Aug 5, 2026
22 of 24 checks passed
@tripledoublev
tripledoublev deleted the vincent/mpg-restore-help branch August 5, 2026 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants