rpk cluster config
Manage cluster configuration properties.
View current configuration status:
rpk cluster config status
Displays the current status of Redpanda configuration settings.
Set a configuration property:
rpk cluster config set redpanda.features.enable_log_shard_sync=true
Sets a specific configuration property to the specified value.
Export the cluster configuration:
rpk cluster config export > cluster_config.yaml
Exports the current cluster configuration to a YAML file.
Import a cluster configuration:
rpk cluster config import < cluster_config.yaml
Imports a cluster configuration from a YAML file.
Edit configuration interactively:
rpk cluster config edit
Opens an interactive editor for modifying the cluster configuration.
Force-reset a configuration property:
rpk cluster config force-reset redpanda.features.enable_log_shard_sync
Resets a specific configuration property to its default state.
Get a specific configuration property:
rpk cluster config get redpanda.features.enable_log_shard_sync
Retrieves the value of a specific configuration property.
Lint the cluster configuration:
rpk cluster config lint
Checks the configuration for deprecated or invalid content.
rpk cluster health
Query the health overview of the cluster.
Check cluster health status:
rpk cluster health
Displays the current health status of the cluster.
Exit when healthy:
rpk cluster health --exit-when-healthy
Exits the command only when the cluster is healthy.
Watch cluster health changes:
rpk cluster health --watch
Monitors and prints updates on cluster health in real-time.
rpk cluster license
Manage cluster licenses.
Retrieve license information:
rpk cluster license info
Shows the current license information for the cluster.
Upload a new license:
rpk cluster license set --file /path/to/license_file
Uploads a new license file to the cluster.
rpk cluster logdirs
Describe log directories on Redpanda brokers.
rpk cluster logdirs describe
rpk cluster maintenance
Interact with cluster maintenance mode.
Enable maintenance mode for a node:
rpk cluster maintenance enable --node 172.32.21.98
Activates maintenance mode for the specified node.
Disable maintenance mode for a node:
rpk cluster maintenance disable --node 172.32.21.98
Deactivates maintenance mode for the specified node.
Check maintenance status:
rpk cluster maintenance status
Displays the current maintenance status for nodes.
rpk cluster metadata
Request metadata information about brokers and topics.
Print broker, cluster, and topic metadata:
rpk cluster metadata --print-brokers --print-cluster --print-topics
Outputs metadata information for brokers, the cluster, and topics.
Print detailed topic information:
rpk cluster metadata --print-detailed-topics
Displays detailed metadata about topics.
Print internal topics only:
rpk cluster metadata --print-internal-topics
Lists only internal topics in the cluster.
rpk cluster partitions
Manage partitions within the cluster.
Check partition balancer status:
rpk cluster partitions balancer-status
Displays the status of the partition balancer.
List all partitions:
rpk cluster partitions list
Shows a list of all partitions in the cluster.
Enable a specific topic’s partitions:
rpk cluster partitions enable --topic my_topic
Enables partitions for a specified topic.
Disable a specific topic’s partitions:
rpk cluster partitions disable --topic my_topic
Disables partitions for a specified topic.
Move partition replicas:
rpk cluster partitions move --partition 1 --from-node 172.32.21.98 --to-node 172.32.21.60
Moves the replicas of a specified partition from one node to another.
Cancel an ongoing partition movement:
rpk cluster partitions move-cancel --partition 1
Stops an ongoing partition movement operation.
Check status of partition movements:
rpk cluster partitions move-status
Displays the status of partition movements.
Transfer leadership of a partition:
rpk cluster partitions transfer-leadership --partition 1 --broker 172.32.21.60
Transfers leadership of a specified partition to a different broker.
Recover a partition (unsafe operation):
rpk cluster partitions unsafe-recover --partition 1
Attempts to recover a partition that has lost majority of replicas.
rpk cluster self-test
Start, stop, and query the status of self-tests for Redpanda.
Start a self-test:
rpk cluster self-test start
Initiates a self-test for the cluster.
Query the status of the self-test:
rpk cluster self-test status
Shows the status of the current or last completed self-test.
Stop an ongoing self-test:
rpk cluster self-test stop
Stops the currently running self-test.