Streaming

rpk cluster config

View and modify Redpanda cluster configuration properties.

Modified properties are propagated immediately to all brokers. Use rpk cluster config status to verify that all brokers are up to date, and to identify any settings that were rejected, for example, if a broker is still restarting.

Cluster properties are Redpanda settings that apply to all brokers in the cluster. These are separate from broker properties, which apply to only that broker and are set with rpk redpanda config.

Use the edit subcommand to interactively modify the cluster configuration, or export and import to write the configuration to a file that can be edited and read back later.

These commands take an optional --all flag to include all properties such as low-level tunables (for example, internal buffer sizes) that do not usually need to be changed during normal operations. These properties generally require some expertise to set safely, so if in doubt, avoid using --all.

Usage

rpk cluster config [flags]

Subcommands

Command Description

rpk cluster config edit

Edit cluster-wide configuration properties. This command opens a text editor to modify the cluster’s configuration.

rpk cluster config export

Export cluster configuration. Writes out a YAML representation of the cluster configuration to a file, suitable for editing and later applying with the corresponding import command.

rpk cluster config force-reset

Forcibly clear a cluster configuration property on this node. This command is not for general changes to cluster configuration: use this only when Redpanda will not start due to a configuration issue.

rpk cluster config get

Get a cluster configuration property.

rpk cluster config import

Import cluster configuration from a file. Import configuration from a YAML file, usually generated with corresponding export command.

rpk cluster config lint

Remove any deprecated content from redpanda.yaml. Deprecated content includes properties which were set via redpanda.yaml in earlier versions of redpanda, but are now managed via Redpanda’s central configuration store (and via rpk cluster config edit).

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.

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.