Streaming

rpk cluster maintenance status

Report maintenance status.

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

For example:

NODE-ID  ENABLED  FINISHED  ERRORS  PARTITIONS  ELIGIBLE  TRANSFERRING  FAILED
1        false    false     false   0           0         0             0
Field Description

NODE-ID

The node ID.

ENABLED

true if the broker is currently in maintenance mode.

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 is available in the logs for the corresponding broker.

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

Usage

rpk cluster maintenance status [flags]

Global flags

Value Type Description

--config

string

Redpanda or rpk config file; default search paths are ~/.config/rpk/rpk.yaml, $PWD/redpanda.yaml, and /etc/redpanda/redpanda.yaml.

-X, --config-opt

stringArray

Override rpk configuration settings; -X help for detail or -X list for terser detail.

--ignore-profile

bool

Ignore rpk.yaml and redpanda.yaml; use default settings.

--profile

string

rpk profile to use.

-v, --verbose

bool

Enable verbose logging.