Skip to main content
Version: 22.3

rpk topic describe

Describe a topic.

This command prints detailed information about a topic. There are three potential sections: a summary of the topic, the topic configs, and a detailed partitions section. By default, the summary and configs sections are printed.

Usage

rpk topic describe [TOPIC] [flags]

Aliases

describe, info

Flags

Value Type Description
-h, --help- Help for describe.
-a, --print-all- Print all sections.
-c, --print-configs- Print the config section.
-p, --print-partitions- Print the detailed partitions section.
-s, --print-summary- Print the summary section.
--brokersstringsComma-separated list of broker <ip>:<port> pairs (for example,--brokers '192.168.78.34:9092,192.168.78.35:9092,192.179.23.54:9092'). Alternatively, you may set the REDPANDA_BROKERSenvironment variable with the comma-separated list of broker addresses.
--configstringRedpanda config file, if not set the file will be searched for in the default locations.
--passwordstring SASL password to be used for authentication.
--sasl-mechanismstringThe authentication mechanism to use. Supported values:SCRAM-SHA-256, SCRAM-SHA-512.
--tls-certstringThe certificate to be used for TLS authentication with the broker.
--tls-enabled-Enable TLS for the Kafka API (not necessary if specifying custom certs).
--tls-keystringThe certificate key to be used for TLS authentication with the broker.
--tls-truststorestring The truststore to be used for TLS communication with the broker.
--userstring SASL user to be used for authentication.
-v, --verbose-Enable verbose logging (default false).