Skip to main content
Version: 22.3

rpk cluster partitions balancer-status

Queries cluster for partition balancer status:

If continuous partition balancing is enabled, redpanda will continuously reassign partitions from both unavailable nodes and from nodes using more disk space than the configured limit.

This command can be used to monitor the partition balancer status.

Fields

FieldDescription
StatusEither off, ready, starting, in progress, or stalled.
Seconds Since Last TickThe last time the partition balancer ran.
Current Reassignments CountCurrent number of partition reassignments in progress.
Unavailable NodesThe nodes that have been unavailable after a time set by thepartition_autobalancing_node_availability_timeout_sec cluster property.
Over Disk Limit NodesThe nodes that surpassed the threshold of used disk percentage specified in the partition_autobalancing_max_disk_usage_percentcluster property.

Balancer status

Balancer statusDescription
offThe balancer is disabled.
readyThe balancer is active but there is nothing to do
startingThe balancer is starting but has not run yet.
in_progressThe balancer is active and is in the process of scheduling partition movements.
stalledViolations have been detected and the balancer cannot correct them.

Stalled Balancer

A stalled balancer can occur for a few reasons and requires a bit of manual investigation. A few areas to investigate:

  • Are there are enough healthy nodes to which to move partitions? For example, in a three node cluster, no movements are possible for partitions with three replicas. You will see a stall every time there is a violation.

  • Does the cluster have sufficient space? If all nodes in the cluster are utilizing more than 80% of their disk space, rebalancing cannot proceed.

  • Do all partitions have quorum? If the majority of a partition`s replicas are down, the partition cannot be moved.

  • Are any nodes in maintenance mode? Partitions are not moved if any node is in maintenance mode.

Usage

rpk cluster partitions balancer-status [flags]

Flags

Value Type Description
-h, --help- Help for balancer-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).