Cloud

rpk cluster config

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

Cluster properties are Redpanda settings that apply to all brokers in the cluster.

Usage

rpk cluster config [flags]

Subcommands

Command Description

rpk cluster config get

Get a cluster configuration property.

rpk cluster config list

List cluster configuration properties. This command lists all available cluster configuration properties.

rpk cluster config set

Set a single cluster configuration property. This command is provided for use in scripts.

rpk cluster config status

Get the configuration status of Redpanda brokers. For each broker, the command output shows: - Whether you need to restart the broker to apply the new settings - Any settings that the broker has flagged as invalid or unknown The command also returns the version of cluster configuration that each broker has applied.

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.