rpk cluster

View and modify cluster-wide configuration properties. Changes take effect across all brokers.

Manage and monitor cluster connections.

Query cluster health and display the overall health status of the cluster. Redpanda collects health reports periodically from all nodes and aggregates them into a health overview.

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

Manage cluster license.

Describe log directories on Redpanda brokers.

Manage cluster maintenance mode for performing rolling upgrades and other maintenance operations.

Manage cluster partitions.

Manage Redpanda client quotas.

Start, stop and query runs of Redpanda self-test through the Admin API listener.

Manage cluster storage, including mounting and unmounting topics from Tiered Storage.

Information about transactions and transactional producers. Transactions allow producing, or consume-modifying-producing, to Redpanda.

string

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

stringArray

Override rpk configuration settings; -X help for detail or -X list for terser detail.

bool

Ignore rpk.yaml and redpanda.yaml; use default settings.

string

rpk profile to use.

bool

Enable verbose logging.