rpk topic describe

This command prints 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]
bash

Aliases

describe, info
bash

Flags

Value Type Description

-h, --help

-

Help for describe.

-a, --print-all

-

Print all sections.

-c, --print-configs

-

Print the config section.

--format

string

Output format. Possible values: json, yaml, text, wide, help. Default: text.

-p, --print-partitions

-

Print the detailed partitions section.

-s, --print-summary

-

Print the summary section.

-r, --regex

-

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

--stable

-

Include the stable offsets column in the partitions section; only relevant if you produce to this topic transactionally.

--config

string

Redpanda or rpk config file; default search paths are /var/lib/redpanda/.config/rpk/rpk.yaml, $PWD/redpanda.yaml, and /etc/redpanda/redpanda.yaml.

-X, --config-opt

stringArray

Override rpk configuration settings. See rpk -X or execute rpk -X help for inline detail or rpk -X list for terser detail.

--profile

string

Profile to use. See rpk profile for more details.

-v, --verbose

-

Enable verbose logging.