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

Usage

rpk cluster health [flags]

Flags

Value Type Description

-e, --exit-when-healthy

-

Exits when the cluster is back in a healthy state.

-h, --help

-

Help for health.

-w, --watch

-

Blocks and writes out all cluster health changes.

--config

string

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

-X, --config-opt

stringArray

Override rpk configuration settings. See rpk -X or execute rpk -X help for inline detail or rpk -X list for terser detail.

--profile

string

Profile to use. See rpk profile for more details.

-v, --verbose

-

Enable verbose logging.