tikv/tikv-ctl

TiKV管理客户端Docker镜像

镜像概述

本镜像提供TiKV分布式事务型键值数据库的官方管理客户端，用于简化TiKV集群的日常运维与管理工作。TiKV作为云原生分布式存储系统，需通过专用工具进行集群状态监控、节点生命周期管理、数据调度及配置调整，本镜像封装了完整的管理工具链，支持快速部署与使用。

核心功能特性

• 集群状态监控：实时查看TiKV集群拓扑、节点健康状态、数据分布及性能指标
• 节点管理：支持TiKV节点的添加、下线、重启及角色调整
• 数据运维：提供数据迁移、分片均衡、副本修复等数据管理能力
• 配置管理：动态更新集群级或节点级配置参数，无需重启服务
• 故障排查：集成日志分析、性能诊断工具，辅助定位集群异常

适用场景

• TiKV集群日常运维（启动/停止节点、扩缩容）
• 集群健康状态监控与告警触发
• 数据迁移与负载均衡调度
• 集群配置参数优化与更新
• 故障节点替换与数据恢复操作

使用方法

前提条件

• 已部署TiKV集群（需提供集群PD（Placement Driver）服务地址，PD为TiKV集群的元数据管理中心）
• 容器网络可访问TiKV集群节点及PD服务端口（默认2379）
• 若启用认证，需准备集群访问凭证（用户名/密码）

环境变量配置

Docker部署示例

基本启动命令

bash
docker run -it --rm \
  -e PD_ADDR="pd-node1:2379,pd-node2:2379" \
  -e LOG_LEVEL="info" \
  tikv-admin-client:latest

带认证的启动命令

bash
docker run -it --rm \
  -e PD_ADDR="pd-node1:2379" \
  -e TIKV_USER="admin" \
  -e TIKV_PASSWORD="secure-password" \
  tikv-admin-client:latest

常用操作示例

1. 查看集群状态

bash
# 在容器内执行
tikv-ctl cluster info

2. 列出所有TiKV节点

bash
# 在容器内执行
tikv-ctl store list

3. 下线指定节点

bash
# 在容器内执行（需替换<store-id>为实际节点ID）
tikv-ctl store remove <store-id>

4. 更新集群配置

bash
# 在容器内执行（调整Raft选举超时时间为3秒）
tikv-ctl config set cluster raft-election-timeout 3000

注意事项

• 客户端需与TiKV集群版本保持兼容，建议使用与集群相同版本的镜像
• 敏感操作（如节点下线、数据迁移）建议先备份集群元数据
• 生产环境中建议通过挂载配置文件方式管理连接参数，避免环境变量明文存储密码
• 长时间运行的管理任务可通过docker run -d启动后台模式，并挂载日志目录以便审计

版本信息

• 基础镜像：Alpine Linux
• 内置工具：tikv-ctl, pd-ctl（TiKV官方管理工具）
• 支持架构：amd64, arm64