rpk cluster config
View and modify cluster-wide configuration properties. Changes take effect across all brokers.
Cluster properties are Redpanda settings that apply to all brokers in the cluster.
Subcommands
| Command | Description |
|---|---|
Edit cluster-wide configuration properties. This command opens a text editor to modify the cluster’s configuration. |
|
Export cluster configuration. Writes out a YAML representation of the cluster configuration to a file, suitable for editing and later applying with the corresponding |
|
Forcibly clear a cluster configuration property on this node. This command is not for general changes to cluster configuration: use this only when Redpanda will not start due to a configuration issue. |
|
Get a cluster configuration property. |
|
Import cluster configuration from a file. Import configuration from a YAML file, usually generated with corresponding |
|
Identify any Redpanda configuration properties that are not recognized. These may be properties that were valid in earlier versions of Redpanda but are now managed via the central configuration store. |
|
List cluster configuration properties. This command lists all available cluster configuration properties. |
|
Set a single cluster configuration property. This command is provided for use in scripts. |
|
Get the configuration status of Redpanda brokers. For each broker, the command output shows: - Whether you need to restart the broker to apply the new settings - Any settings that the broker has flagged as invalid or unknown The command also returns the version of cluster configuration that each broker has applied. |
Global flags
| Value | Type | Description |
|---|---|---|
|
string |
Redpanda or |
|
stringArray |
Override |
|
bool |
Ignore |
|
string |
|
|
bool |
Enable verbose logging. |