24.1 beta 23.3 23.2 23.1

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 --dry option will validate whether the requested configuration change is valid, but does not apply it.

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

-

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

-h, --help

-

Help for alter-config.

-s, --set

stringArray

key=value; Pair to set (repeatable).

--subtract

stringArray

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

--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.