Cloud

rpk shadow failover

Failover a Redpanda shadow link.

Failover converts shadow topics into regular topics on the shadow cluster, allowing producers and consumers to interact with them directly. After failover, the shadow link stops replicating data from the source cluster.

Use the --all flag to failover all shadow topics associated with the shadow link, or use the --topic flag to failover a specific topic. You must specify either --all or --topic.

The command prompts you to confirm the failover operation. Use the --no-confirm flag to skip the confirmation prompt.

Failover is a critical operation. After failover, shadow topics become regular topics and replication stops. Ensure your applications are ready to connect to the shadow cluster before performing a failover.

Usage

rpk shadow failover [LINK_NAME] [flags]

Examples

Failover all topics for a shadow link:

rpk shadow failover my-shadow-link --all

Failover a specific topic:

rpk shadow failover my-shadow-link --topic my-topic

Failover without confirmation:

rpk shadow failover my-shadow-link --all --no-confirm

Flags

Value Type Description

--all

-

Failover all shadow topics associated with the shadow link.

--no-confirm

-

Disable confirmation prompt.

--topic

string

Specific topic to failover. If --all is not set, at least one topic must be provided.

-h, --help

-

Help for failover.

--config

string

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

-X, --config-opt

stringArray

Override rpk configuration settings. See rpk -X or execute rpk -X help for inline detail or rpk -X list for terser detail.

--profile

string

Profile to use. See rpk profile for more details.

-v, --verbose

-

Enable verbose logging.