rpk redpanda config set

This command is not supported on macOS, Windows.

Set configuration values, such as the redpanda node ID or the list of seed servers

This command modifies the redpanda.yaml you have locally on disk.

Examples

The first argument is the key within the yaml representing a property / field that you would like to set. Nested fields can be accessed through a dot:

rpk redpanda config set redpanda.developer_mode true

All values are parsed as yaml and, since yaml is a superset of json, you can also format your input as json. Individual specific fields or full structs can be set:

rpk redpanda config set rpk.tune_disk_irq true

or

rpk redpanda config set redpanda.rpc_server '{address: 3.250.158.1, port: 9092}'

You can set an entire array by wrapping all items with braces, or by using one struct:

rpk redpanda config set redpanda.advertised_kafka_api '[{address: 10.0.0.1, port: 9092}]'

or

rpk redpanda config set redpanda.advertised_kafka_api '{address: 10.0.0.1, port: 9092}'

Indexing can be used to set specific items in an array. You can index one past the end of an array to extend it:

rpk redpanda config set redpanda.advertised_kafka_api[1] '{address: 10.0.0.1, port: 9092}'

The json format can be used to set values as json:

rpk redpanda config set redpanda.rpc_server '{"address":"0.0.0.0","port":33145}' --format json

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

rpk redpanda config set redpanda.kafka_api[0].port=9092

Usage

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

Flags

Value Type Description

-h, --help

-

Help for set.

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