Streaming

rpk shadow

Manage Redpanda Shadow Links.

Shadowing is Redpanda’s enterprise-grade disaster recovery solution that establishes asynchronous, offset-preserving replication between two distinct Redpanda clusters. A cluster is able to create a dedicated client that continuously replicates source cluster data, including offsets, timestamps, and cluster metadata.

Usage

rpk shadow [flags]

Subcommands

Command Description

rpk shadow config

Generate a Redpanda Shadow Link configuration file.

rpk shadow create

Create a Redpanda Shadow Link. This command creates a Shadow Link using a configuration file that defines the connection details and synchronization settings.

rpk shadow delete

Delete a Redpanda Shadow Link. This command deletes a Shadow Link by name.

rpk shadow describe

Describe one or more shadow links. For Redpanda Cloud, rpk uses the Redpanda ID of the cluster you are currently logged in to.

rpk shadow failover

Failover a Redpanda Shadow Link. This command performs a failover operation for a Shadow Link.

rpk shadow list

List Redpanda Shadow Links. This command lists all Shadow Links on the shadow cluster, showing their names, unique identifiers, and current states.

rpk shadow status

Display the status of a shadow link. When using --format json or --format yaml, the command outputs all sections by default.

rpk shadow update

Update a Shadow Link. This command opens your default editor with the current Shadow Link configuration.

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.