rpk cluster maintenance

Interact with cluster maintenance mode.

Maintenance mode is a state that a node may be placed into in which the node may be shutdown or restarted with minimal disruption to client workloads. The primary use of maintenance mode is to perform a rolling upgrade in which each node is placed into maintenance mode prior to upgrading the node.

Use the enable and disable subcommands to place a node into maintenance mode or remove it, respectively. Only one node at a time may be in maintenance mode.

When a node is placed into maintenance mode the following occurs:

Leadership draining. All raft leadership is transferred to another eligible node, and the node in maintenance mode rejects new leadership requests. By transferring leadership off of the node in maintenance mode all client traffic and requests are directed to other nodes minimizing disruption to client workloads when the node is shutdown.

Currently leadership is not transferred for partitions with one replica.

Usage

rpk cluster maintenance [flags]

Subcommands

Command Description

rpk cluster maintenance disable

Disable maintenance mode on a broker, allowing it to resume normal operations and accept partition assignments.

rpk cluster maintenance enable

Enable maintenance mode for a node. This command enables maintenance mode for the node with the specified ID.

rpk cluster maintenance status

Report maintenance status. This command reports maintenance status for each node in the cluster.

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.