Streaming

rpk cluster config set

Set a cluster configuration property. You can set a single property or multiple properties at once, for example:

rpk cluster config set audit_enabled true
rpk cluster config set iceberg_enabled=true iceberg_catalog_type=rest

You must use <key>=<value> notation to set multiple properties.

If you set the cluster property value to an empty string, the property is reset to its default.

This command is provided for use in scripts. For interactive editing, or bulk changes, use the edit and import commands respectively.

For a list of available properties, see Cluster Configuration Properties.

Usage

rpk cluster config set <key> <value> [flags]

Flags

Value Type Description

-h, --help

-

Help for set.

--all

-

Include all properties, including tunables.

--config

string

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

-X, --config-opt

stringArray

Override rpk configuration settings. See rpk -X or execute rpk -X help for inline detail or rpk -X list for terser detail.

--profile

string

Profile to use. See rpk profile for more details.

-v, --verbose

-

Enable verbose logging.

Setting properties to non-number values (such as setting string values with -) can be problematic for some terminals due to how POSIX flags are parsed. For example, the following command may not work from some terminals:

rpk cluster config set delete_retention_ms -1

Workaround: Use -- to disable parsing for all subsequent characters. For example:

rpk cluster config set -- delete_retention_ms -1