Skip to main content
Version: 22.3

rpk cluster maintenance status

Report maintenance status.

This command reports maintenance status for each node in the cluster. The output is presented as a table with each row representing a node in the cluster. The output can be used to monitor the progress of node draining.

NODE-ID DRAINING FINISHED ERRORS PARTITIONS ELIGIBLE TRANSFERRING FAILED
1 false false false 0 0 0 0
FieldDescription
Node-idThe node ID.
Drainingtrue if the node is actively draining leadership.
FinishedLeadership draining has completed.
ErrorsErrors have been encountered while draining.
PartitionsNumber of partitions whose leadership has moved.
EligibleNumber of partitions with leadership eligible to move.
TransferringCurrent active number of leadership transfers.
FailedNumber of failed leadership transfers.

Notes:

  • When errors are present further information will be available in the logs for the corresponding node.

  • Only partitions with more than one replica are eligible for leadership transfer.

Usage

rpk cluster maintenance status [flags]

Flags

Value Type Description
-h, --help- Help for status.
--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-urlsstring Comma-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_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).