Skip to main content
Version: 23.1

rpk cluster self-test

Start, stop and query Redpanda's self-test. Self-test runs benchmarks to characterize disk and network performance of Redpanda machines. It runs through the Admin API listener.

Usage

rpk cluster self-test [command]

Available commands:

start       Starts a new self test run
status Queries status of current self test run or returns last results
stop Stops the currently executing self test

Flags

Value Type Description
-h, --help- Help for self-test.
--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.
--api-urlsstringsComma-separated list of admin API addresses (<IP>:<port>).
--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_BROKERS environment 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.
--passwordstringSASL 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-truststorestringThe truststore to be used for TLS communication with the broker.
--userstringSASL user for authentication.
-v, --verbose-Enable verbose logging (default: false).

What do you like about this doc?




Optional: Share your email address if we can contact you about your feedback.

Let us know what we do well: