Streaming

rpk cluster info

Request broker metadata information.

The Kafka protocol’s metadata contains information about brokers, topics, and the cluster as a whole.

This command only runs if specific sections of metadata are requested. There are currently three sections: the cluster, the list of brokers, and the topics. If no section is specified, this defaults to printing all sections.

If the topic section is requested, all topics are requested by default unless some are manually specified as arguments. Expanded per-partition information can be printed with the -d flag, and internal topics can be printed with the -i flag.

In the broker section, the controller node is suffixed with *.

Using this command with --format json/yaml implies that all sections are included.

Usage

rpk cluster info [flags]

Aliases

rpk cluster status
rpk cluster metadata

Flags

Value Type Description

--format

string

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

-b, --print-brokers

bool

Print brokers section.

-c, --print-cluster

bool

Print cluster section.

-d, --print-detailed-topics

bool

Print per-partition information for topics (implies -t).

-i, --print-internal-topics

bool

Print internal topics (if all topics requested, implies -t).

-t, --print-topics

bool

Print topics section (implied if any topics are specified).

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.