Streaming

rpk cluster config list

This command lists all available cluster configuration properties.

Use rpk cluster config get to retrieve specific property values.

Use rpk cluster config edit for interactive editing.

Use the --filter flag with a regular expression to filter configuration keys. This is useful for exploring related configuration properties or finding specific settings.

Usage

rpk cluster config list [flags]

Examples

List all cluster configuration properties:

rpk cluster config list

List configuration properties matching a filter:

rpk cluster config list --filter="kafka.*"

Filter properties containing "log":

rpk cluster config list --filter=".*log.*"

Filter with case-insensitive matching:

rpk cluster config list --filter="(?i)batch.*"

List configuration properties in JSON format:

rpk cluster config list --format=json

List configuration properties in YAML format:

rpk cluster config list --format=yaml

Flags

Value Type Description

--filter

string

Filter configuration keys using regular expression.

--format

string

Output format. Possible values: json, yaml, text, wide, help. Default: text.

-h, --help

-

Help for list.

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