Skip to main content
Version: 22.3

rpk cluster config

Interact with cluster configuration properties.

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.

Use the edit subcommand to interactively modify the cluster configuration, or export and import to write configuration to a file that can be edited and read back later.

These commands take an optional --all flag to include all properties including low level tunables such as internal buffer sizes, that do not usually need to be changed during normal operations. These properties generally require some expertize to set safely, so if in doubt, avoid using --all.

Modified properties are propagated immediately to all nodes. The status subcommand can be used to verify that all nodes are up to date, and identify any settings which were rejected by a node, for example if a node is running a different redpanda version that does not recognize certain properties.

Usage

rpk cluster config [command]

Flags

Value Type Description
--admin-api-tls-certstringThe 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-keystringThe certificate key to be used for TLS authentication with the Admin API.
--admin-api-tls-truststorestringThe truststore to be used for TLS communication with the Admin API.
--all- Include all properties, including tunables.
--api-urlsstring Comma-separated list of admin API addresses (<ip>:<port>).
-h, --help- Help for config.
--brokersstringsComma-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 REDPANDA_BROKERSenvironment variable with the comma-separated list of broker addresses.
--configstringRedpanda config file, if not set the file will be searched for in the default. locations
--passwordstring SASL password to be used for authentication.
--sasl-mechanismstringThe authentication mechanism to use. Supported values: SCRAM-SHA-256, SCRAM-SHA-512.
--tls-certstringThe 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-keystringThe certificate key to be used for TLS authentication with the broker.
--tls-truststorestring The truststore to be used for TLS communication with the broker.
--userstring SASL user to be used for authentication.
-v, --verbose-Enable verbose logging (default false).