Streaming

rpk cluster config edit

Edit cluster-wide configuration properties.

This command opens a text editor to modify the cluster’s configuration.

Cluster properties are Redpanda settings which apply to all nodes in the cluster. These are separate to node properties, which are set with rpk redpanda config.

Modified values are written back when the file is saved and the editor is closed. Properties which are deleted are reset to their default values.

By default, low level tunables are excluded: use the --all flag to edit all properties including these tunables.

Usage

rpk cluster config edit [flags]

Flags

Value Type Description

--all

bool

Include all properties, including tunables.

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.