TiDB in Kubernetes 用户文档

TiDB Operator 是 Kubernetes 上的 TiDB 集群自动运维系统，提供包括部署、升级、扩缩容、备份恢复、配置变更的 TiDB 全生命周期管理。借助 TiDB Operator，TiDB 可以无缝运行在公有云或私有部署的 Kubernetes 集群上。

TiDB Operator 与适用的 TiDB 版本的对应关系如下：

TiDB Operator 提供了多种方式来部署 Kubernetes 上的 TiDB 集群：

• 测试环境：

  • kind：采用 kind 方式在本地 Kubernetes 集群上部署 TiDB 集群；
  • Minikube：使用 TiDB Operator 在本地 Minikube 环境部署 TiDB 集群；
  • GKE：使用 TiDB Operator 在 GKE 上部署 TiDB 集群。

• 生产环境：

  • 公有云：参考 AWS 部署文档，GKE 部署文档 (beta)，或阿里云部署文档在对应的公有云上一键部署生产可用的 TiDB 集群并进行后续的运维管理；

  • 现有 Kubernetes 集群：首先按照部署 TiDB Operator在集群中安装 TiDB Operator，再根据在标准 Kubernetes 集群上部署 TiDB 集群来部署你的 TiDB 集群。对于生产级 TiDB 集群，你还需要参考 TiDB 集群环境要求调整 Kubernetes 集群配置并根据本地 PV 配置为你的 Kubernetes 集群配置本地 PV，以满足 TiKV 的低延迟本地存储需求。

在任何环境上部署前，都可以参考 TiDB 集群配置来自定义 TiDB 配置。

部署完成后，你可以参考下面的文档进行 Kubernetes 上 TiDB 集群的使用和运维：

• 部署 TiDB 集群
• 访问 TiDB 集群
• TiDB 集群扩缩容
• TiDB 集群升级
• TiDB 集群配置变更
• TiDB 集群备份恢复
• 配置 TiDB 集群故障自动转移
• 监控 TiDB 集群
• TiDB 集群日志收集
• 维护 TiDB 所在的 Kubernetes 节点

当集群出现问题需要进行诊断时，你可以：

• 查阅 Kubernetes 上的 TiDB FAQ 寻找是否存在现成的解决办法；
• 参考 Kubernetes 上的 TiDB 故障诊断解决故障。

Kubernetes 上的 TiDB 提供了专用的命令行工具 tkctl 用于集群管理和辅助诊断，同时，在 Kubernetes 上，TiDB 的部分生态工具的使用方法也有所不同，你可以：

• 参考 tkctl 使用指南 来使用 tkctl；
• 参考 Kubernetes 上的 TiDB 相关工具使用指南来了解 TiDB 生态工具在 Kubernetes 上的使用方法。

最后，当 TiDB Operator 发布新版本时，你可以参考升级 TiDB Operator 进行版本更新。