Cloud

rpk topic alter-config

Set, delete, add, and remove key/value configs for a topic.

This command allows you to incrementally alter the configuration for multiple topics at a time.

Incremental altering supports four operations:

  1. Setting a key=value pair

  2. Deleting a key’s value

  3. Appending a new value to a list-of-values key

  4. Subtracting (removing) an existing value from a list-of-values key.

The --regex flag (-r) opts into parsing the input topics as regular expressions and altering any non-internal topic that matches any of the expressions. The topic list command accepts the same input regex format, which lets you preview which topics will be altered.

The --dry option will validate whether the requested configuration change is valid, but does not apply it. Use the flag --no-confirm to avoid the confirmation prompt.

Usage

rpk topic alter-config <topics...> --set key=value --delete key2,key3 [flags]

Flags

Value Type Description

--append

stringArray

key=value; Value to append to a list-of-values key (repeatable).

-d, --delete

stringArray

Key to delete (repeatable).

--dry

bool

Dry run: validate the alter request, but do not apply.

--format

string

Output format (json,yaml,text,wide,help). (New in v26.2.1)

--no-confirm

bool

Disable confirmation prompt.

-r, --regex

bool

Parse topics as regex; alter any topic that matches any input topic expression. (New in v26.2.2)

-s, --set

stringArray

key=value; Pair to set (repeatable).

--subtract

stringArray

key=value; Value to remove from list-of-values key (repeatable).

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.