rpk cluster

Manage Redpanda cluster brokers.

View and modify Redpanda cluster configuration properties. Modified properties are propagated immediately to all brokers.

Manage and monitor cluster connections.

Queries cluster for health overview. Health overview is created based on the health reports collected periodically from all nodes in the cluster.

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.

List and configure Redpanda broker loggers.

Interact with cluster maintenance mode. Maintenance mode is a state that a node may be placed into in which the node may be shutdown or restarted with minimal disruption to client workloads.

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.

Check and finalize major-version upgrades. When the cluster configuration features_auto_finalization is disabled, an upgrade stays pending after all brokers are on the new version, so you can downgrade while soak-testing.

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.