Streaming

rpk topic describe

Print detailed information about topics. There are three potential views: a summary of the topic, the topic configurations, and a detailed partitions section. By default, the summary and configs sections are printed.

Using the --format flag with either JSON or YAML prints all the topic information.

The --regex flag (-r) parses arguments as regular expressions and describes topics that match any of the expressions.

Usage

rpk topic describe <topics> [flags]

Aliases

rpk topic info

Flags

Value Type Description

--format

string

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

-a, --print-all

bool

Print all topic configuration properties, including defaults and read-only values.

-c, --print-configs

bool

Print the config section.

-p, --print-partitions

bool

Print the detailed partitions section.

-s, --print-summary

bool

Print the summary section.

-r, --regex

bool

Parse arguments as regex; describe any topic that matches any input topic expression.

--stable

bool

Include the stable offsets column in the partitions section. Stable offsets reflect only committed transactional records and are only useful if you produce to this topic transactionally.

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.