rpk cluster health
Queries health overview.
Health overview is created based on the health reports collected periodically from all nodes in the cluster. A cluster is considered healthy when the following conditions are met:
-
all cluster nodes are responding
-
all partitions have leaders
-
the cluster controller is present
Flags
Value | Type | Description |
---|---|---|
--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. |
--api-urls |
string |
Comma-separated list of admin API addresses (<ip>:<port> |
-e, --exit-when-healthy |
- |
When used with watch, exits after cluster is back in healthy state. |
-h, --help |
- |
Help for health |
-w, --watch |
- |
Blocks and writes out all cluster health changes. |
--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 |