rpk topic storage mode-migration describe

Describe the storage mode migration status of topics.

A storage mode migration moves a topic whose 'redpanda.storage.mode.impl' is local, unset, or tiered_v1 to cloud or tiered_v2. Setting 'redpanda.storage.mode.impl' to cloud or tiered_v2 with rpk topic alter-config starts one. So does setting 'redpanda.storage.mode' to cloud, or to tiered on a local or unset topic when the cluster’s default_redpanda_storage_mode_tiered_impl is tiered_v2.

With no topics, the command describes every topic that is migrating or has migrated.

For each topic, this command prints:

  • STATUS: none (the topic has no migration), migrating, or complete. unspecified means the broker did not report a status. A status that this version of rpk does not know prints as a number.

  • MIGRATED-FROM: the 'redpanda.storage.mode.impl' value the topic migrated from, or '-' if the topic has never migrated.

  • PARTITIONS-COMPLETE: the number of partitions that have finished migrating.

  • PARTITIONS-ADMITTED: the number of partitions allowed to start migrating so far. At most topic_storage_mode_migration_max_concurrent_partitions partitions migrate at once across the cluster, and more are admitted as earlier ones finish.

  • PARTITIONS-TO-MIGRATE: the number of partitions that existed when the migration started. Partitions added later are created in the new storage mode and are not counted.

  • BACKED-OFF-PARTITIONS: the IDs of admitted partitions whose migration gave up after making no progress for topic_storage_mode_migration_error_backoff_timeout, or '-' if there are none. Each stays in its previous storage mode until its migration is retried, and no more of the topic’s partitions are admitted until then. A partition whose leader does not respond is not listed.

The controller records partition progress about every 10 seconds, so the reported progress can trail the actual migration by about that much.

This command was introduced in version v26.3.1.

Usage

rpk topic storage mode-migration describe <topics...> [flags]

Examples

This section provides examples of how to use rpk topic storage mode-migration describe.

Describe the storage mode migration status of a topic:

rpk topic storage mode-migration describe foo

Describe the storage mode migration status of several topics in JSON:

rpk topic storage mode-migration describe foo bar --format json

Describe every topic that is migrating or has migrated:

rpk topic storage mode-migration describe

Flags

Value Type Description

--format

string

Output format (json,yaml,text,wide,help). Default: text.

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.