23.2 23.1 22.3 22.2 22.1 21.11

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

Field

Description

Node-id

The node ID.

Draining

true if the node is actively draining leadership.

Finished

Leadership draining has completed.

Errors

Errors have been encountered while draining.

Partitions

Number of partitions whose leadership has moved.

Eligible

Number of partitions with leadership eligible to move.

Transferring

Current active number of leadership transfers.

Failed

Number of failed leadership transfers.

  • 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-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>

--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 REDPANDA_BROKERS environment variable with the comma-separated list of broker addresses.

--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 false).