Cluster Management

MinIO KMS provides a comprehensive set of command-line tools for managing distributed KMS clusters. The minkms binary includes commands for server lifecycle operations, cluster topology management, backup and restore capabilities, and diagnostics.

Use these commands to deploy, scale, monitor, and maintain highly available MinIO KMS clusters across multiple nodes. All cluster management operations require appropriate administrative privileges and authenticate using API keys.

Server lifecycle

CommandDescription
minkms serverStart a KMS server.
minkms restartRestart cluster servers.

Cluster topology management

CommandDescription
minkms addAdd a node to a cluster.
minkms lsList cluster nodes.
minkms editEdit the cluster configuration.
minkms statPrint cluster status information.
minkms rmRemove a node from a cluster.

State management

CommandDescription
minkms backupBackup the cluster state.
minkms restoreRestore the cluster state from a backup.

Diagnostics and monitoring

CommandDescription
minkms envPrint KMS environment variables.
minkms logsPrint KMS server logs.
minkms pprofProfile KMS server performance.

For a complete list of commands while in the CLI, use minkms help.

On this page