Streaming

rpk shadow failover

Failover a Redpanda Shadow Link.

This command performs a failover operation for a 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

This section provides examples of how to use rpk shadow failover.

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

bool

Failover all shadow topics associated with the Shadow Link.

--no-confirm

bool

Disable confirmation prompt.

--topic

string

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

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.