rpk shadow task

Pause or resume the sync tasks of a Shadow Link.

A Shadow Link runs one sync task per kind of metadata it mirrors from the source cluster. Pausing a task stops that one kind of sync until the task is resumed; the rest of the link keeps working. This sets the same paused option as rpk shadow update does, and rpk shadow update replaces the whole link configuration, so an update that leaves the option out resumes the task.

Pausing the schema-registry task also lifts the write protection the link holds on the Schema Registry contexts it owns, so clients can write to those contexts again until the task is resumed. That task can be paused or resumed only on a link that shadows the source Schema Registry over its API.

Tasks cannot be paused or resumed after a failover of the link has started.

These commands use the Admin API and are not available on Redpanda Cloud.

Tasks are addressed by one of these names:

Value Description

consumer-groups

Consumer Group Shadowing

roles

Roles Migrator Task

schema-registry

Schema Registry Shadowing

security

Security Migrator Task

topics

Source Topic Sync

This command was introduced in version v26.3.1.

Usage

rpk shadow task [flags]

Subcommands

Command Description

rpk shadow task pause

Pause sync tasks of a Shadow Link. Each task named with --task enters the paused state and stops syncing until it is resumed with rpk shadow task resume.

rpk shadow task resume

Resume paused sync tasks of a Shadow Link. Each task named with --task leaves the paused state and syncing continues.

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.