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.

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: ~/.config/rpk/rpk.yaml, $PWD, 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