Cloud

rpk cluster config set

Set a single cluster configuration property.

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

You may also use <key>=<value> notation for setting configuration properties:

rpk cluster config set log_retention_ms=-1

If an empty string is given as the value, the property is reset to its default. Use the flag --no-confirm to avoid the confirmation prompt.

The output returns an operation ID. Use the status command to check the progress of the configuration change.

Usage

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

Examples

This section provides examples of how to use rpk cluster config set.

Set a single property

Enable auditing

rpk cluster config set audit_enabled true

Set multiple properties

Enable Iceberg with REST catalog type (use key=value notation)

rpk cluster config set iceberg_enabled=true iceberg_catalog_type=rest

Flags

Value Type Description

--no-confirm

bool

Disable confirmation prompt.

--timeout

duration

Maximum time to poll for operation completion before displaying operation ID for manual status checking (for example, 300ms, 1.5s, 30s).

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.

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

Suggested reading