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. Pausing a task that is already paused has no effect. Tasks are paused one at a time, in the order given; if one is rejected, the tasks before it stay paused.

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 until the task is resumed. That task can be paused only on a link that shadows the source Schema Registry over its API.

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 pause <link_name> --task <tasks...> [flags]

Examples

This section provides examples of how to use rpk shadow task pause.

Stop mirroring consumer group offsets:

rpk shadow task pause my-shadow-link --task consumer-groups

Stop creating shadow topics and mirroring roles:

rpk shadow task pause my-shadow-link --task topics,roles

Flags

Value Type Description

--task

stringSlice

Comma-separated list of tasks to pause. Required.

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.