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.
Flags
| Value | Type | Description |
|---|---|---|
-h, --help |
- |
Help for edit |
--admin-api-tls-cert |
string |
The certificate to be used for TLS authentication with the Admin API. |
--admin-api-tls-enabled |
- |
Enable TLS for the Admin API (not necessary if specifying custom certs). |
--admin-api-tls-key |
string |
The certificate key to be used for TLS authentication with the Admin API. |
--admin-api-tls-truststore |
string |
The truststore to be used for TLS communication with the Admin API. |
--all |
- |
Include all properties, including tunables. |
--api-urls |
string |
Comma-separated list of admin API addresses (<ip>:<port>). |
--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 |
--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 |