rpk cluster storage restore

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 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 restore status command after it has been started.

Usage

rpk cluster storage restore [flags]

Aliases

rpk cluster storage recovery

Subcommands

Command Description

rpk cluster storage restore start

Start the cluster restoration process. This command starts the process of restoring data from a failed cluster with Tiered Storage enabled, including its metadata, onto a new cluster.

rpk cluster storage restore status

Fetch the status of the topic restoration process. This command fetches the status of the process of restoring topics from the archival bucket.

Global flags

Value Type Description

--config

string

Redpanda or rpk config file; default search paths are ~/.config/rpk/rpk.yaml, $PWD/redpanda.yaml, and /etc/redpanda/redpanda.yaml.

-X, --config-opt

stringArray

Override rpk configuration settings; -X help for detail or -X list for terser detail.

--ignore-profile

bool

Ignore rpk.yaml and redpanda.yaml; use default settings.

--profile

string

rpk profile to use.

-v, --verbose

bool

Enable verbose logging.

Suggested reading