rpk cluster maintenance enable

Enable maintenance mode for a node.

This command enables maintenance mode for the node with the specified ID. If a node exists that is already in maintenance mode then an error will be returned.

Use this command before performing broker upgrades or hardware maintenance. After maintenance is complete, run rpk cluster maintenance disable <broker-id> to restore normal operation.

Usage

rpk cluster maintenance enable <broker-id> [flags]

Flags

Value Type Description

-w, --wait

bool

Wait for the node to finish draining before returning. Useful for scripted rolling operations.

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.