24.1 beta 23.3 23.2 23.1

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.

--brokers

strings

Comma-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_BROKERS environment variable with the comma-separated list of broker addresses.

--config

string

Redpanda config file, if not set the file will be searched for in the default locations.

--password

string

SASL password to be used for authentication.

--sasl-mechanism

string

The authentication mechanism to use. Supported values: SCRAM-SHA-256, SCRAM-SHA-512.

--tls-cert

string

The 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-key

string

The certificate key to be used for TLS authentication with the broker.

--tls-truststore

string

The truststore to be used for TLS communication with the broker.

--user

string

SASL user to be used for authentication.

-v, --verbose

-

Enable verbose logging (default false).