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:
- Setting a key=value pair
- Deleting a key's value
- Appending a new value to a list-of-values key
- 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). |
--brokers | strings | Comma-separated list of broker <ip>:<port> pairs (for example,--brokers '192.168.78.34:9092,192.168.78.35:9092,192.179.23.54:9092' ). Alternatively, you may set the REDPANDA_BROKERS environment variable with the comma-separated list of broker addresses. |
--config | string | Redpanda config file, if not set the file will be searched for in the default locations. |
--password | string | SASL password to be used for authentication. |
--sasl-mechanism | string | The authentication mechanism to use. Supported values:SCRAM-SHA-256 , SCRAM-SHA-512 . |
--tls-cert | string | The certificate to be used for TLS authentication with the broker. |
--tls-enabled | - | Enable TLS for the Kafka API (not necessary if specifying custom certs). |
--tls-key | string | The certificate key to be used for TLS authentication with the broker. |
--tls-truststore | string | The truststore to be used for TLS communication with the broker. |
--user | string | SASL user to be used for authentication. |
-v, --verbose | - | Enable verbose logging (default false ). |