Skip to content

Commit

Permalink
rpk: rename storage recovery to restore.
Browse files Browse the repository at this point in the history
We are introducing a new recovery mode and this
can lead to confusion.

(cherry picked from commit b2180d6)
  • Loading branch information
r-vasquez authored and vbotbuildovich committed Nov 29, 2023
1 parent 65e8630 commit f3d10a9
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
11 changes: 6 additions & 5 deletions src/go/rpk/pkg/cli/cluster/storage/recovery/recovery.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,20 @@ import (

func NewCommand(fs afero.Fs, p *config.Params) *cobra.Command {
cmd := &cobra.Command{
Use: "recovery",
Short: "Interact with the topic recovery process",
Long: `Interact with the topic recovery process.
Use: "restore",
Aliases: []string{"recovery"},
Short: "Interact with the topic restoration process",
Long: `Interact with the topic restoration process.
This command is used to restore topics from the archival bucket, which can be
useful for disaster recovery or if a topic was accidentally deleted.
To begin the recovery process, use the "recovery start" command. Note that this
To begin the recovery process, use the "restore start" command. Note that this
process can take a while to complete, so the command will exit after starting
it. If you want the command to wait for the process to finish, use the "--wait"
or "-w" flag.
You can check the status of the recovery process with the "recovery status"
You can check the status of the recovery process with the "restore status"
command after it has been started.
`,
}
Expand Down
6 changes: 3 additions & 3 deletions src/go/rpk/pkg/cli/cluster/storage/recovery/start.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ func newStartCommand(fs afero.Fs, p *config.Params) *cobra.Command {

cmd := &cobra.Command{
Use: "start",
Short: "Start the topic recovery process",
Long: `Start the topic recovery process.
Short: "Start the topic restoration process",
Long: `Start the topic restoration process.
This command starts the process of restoring topics from the archival bucket.
If the wait flag (--wait/-w) is set, the command will poll the status of the
Expand Down Expand Up @@ -66,7 +66,7 @@ recovery process until it's finished.`,
fmt.Println("Successfully started topic recovery")

if !wait {
fmt.Println("To check the recovery status, run 'rpk cluster storage recovery status'")
fmt.Println("To check the recovery status, run 'rpk cluster storage restore status'")
return
}

Expand Down
4 changes: 2 additions & 2 deletions src/go/rpk/pkg/cli/cluster/storage/recovery/status.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ import (
func newStatusCommand(fs afero.Fs, p *config.Params) *cobra.Command {
cmd := &cobra.Command{
Use: "status",
Short: "Fetch the status of the topic recovery process",
Long: `Fetch the status of the topic recovery process.
Short: "Fetch the status of the topic restoration process",
Long: `Fetch the status of the topic restoration process.
This command fetches the status of the process of restoring topics from the
archival bucket.`,
Expand Down

0 comments on commit f3d10a9

Please sign in to comment.