From fe0d5e6a1708b82243bff546fb4cf3ee34537b1a Mon Sep 17 00:00:00 2001 From: Keke Yi <40977455+yikeke@users.noreply.github.com> Date: Thu, 28 May 2020 16:51:40 +0800 Subject: [PATCH] Update landing page _index.md for TiDB Operator (#349) --- zh/_index.md | 77 ++++++++++++++++++++++++++++++++++------------------ 1 file changed, 50 insertions(+), 27 deletions(-) diff --git a/zh/_index.md b/zh/_index.md index 3371f59362e..11c0efb0cbe 100644 --- a/zh/_index.md +++ b/zh/_index.md @@ -3,6 +3,8 @@ title: TiDB in Kubernetes 用户文档 summary: 了解 TiDB in Kubernetes 的用户文档。 --- + + # TiDB in Kubernetes 用户文档 [TiDB Operator](https://github.com/pingcap/tidb-operator) 是 Kubernetes 上的 TiDB 集群自动运维系统，提供包括部署、升级、扩缩容、备份恢复、配置变更的 TiDB 全生命周期管理。借助 TiDB Operator，TiDB 可以无缝运行在公有云或私有部署的 Kubernetes 集群上。 @@ -15,43 +17,64 @@ TiDB Operator 与适用的 TiDB 版本的对应关系如下： | v1.1 | v3.0, v3.1, v4.0 | | dev | v3.0, v3.1, v4.0, dev | -TiDB Operator 提供了多种方式来部署 Kubernetes 上的 TiDB 集群： + + + 关于 TiDB Operator + + - [TiDB Operator 简介](tidb-operator-overview.md) + - [v1.1 重要注意事项](notes-tidb-operator-v1.1.md) + + + + + 快速上手 + + - [kind](deploy-tidb-from-kubernetes-kind.md) + - [GKE](deploy-tidb-from-kubernetes-gke.md) + - [Minikube](deploy-tidb-from-kubernetes-minikube.md) + + -+ 测试环境： + + 部署集群 - - [kind](deploy-tidb-from-kubernetes-kind.md)：采用 [kind](https://kind.sigs.k8s.io/) 方式在本地 Kubernetes 集群上部署 TiDB 集群； - - [Minikube](deploy-tidb-from-kubernetes-minikube.md)：使用 TiDB Operator 在本地 Minikube 环境部署 TiDB 集群； - - [GKE](deploy-tidb-from-kubernetes-gke.md)：使用 TiDB Operator 在 GKE 上部署 TiDB 集群。 + - [部署到 AWS EKS](deploy-on-aws-eks.md) + - [部署到 GCP GKE](deploy-on-gcp-gke.md) + - [部署到阿里云 ACK](deploy-on-alibaba-cloud.md) + - [部署到自托管的 Kubernetes](prerequisites.md.md) + - [部署 TiFlash](deploy-tiflash.md) + - [部署 TiDB 集群监控](monitor-a-tidb-cluster.md) -+ 生产环境： + - - 公有云：参考 [AWS 部署文档](deploy-on-aws-eks.md)，[GKE 部署文档 (beta)](deploy-on-gcp-gke.md)，或[阿里云部署文档](deploy-on-alibaba-cloud.md)在对应的公有云上一键部署生产可用的 TiDB 集群并进行后续的运维管理； + + 安全 - - 现有 Kubernetes 集群：首先按照[部署 TiDB Operator](deploy-tidb-operator.md)在集群中安装 TiDB Operator，再根据[在标准 Kubernetes 集群上部署 TiDB 集群](deploy-on-general-kubernetes.md)来部署你的 TiDB 集群。对于生产级 TiDB 集群，你还需要参考 [TiDB 集群环境要求](prerequisites.md)调整 Kubernetes 集群配置并根据[本地 PV 配置](configure-storage-class.md#本地-pv-配置)为你的 Kubernetes 集群配置本地 PV，以满足 TiKV 的低延迟本地存储需求。 + - [为 MySQL 客户端开启 TLS](enable-tls-for-mysql-client.md) + - [为 TiDB 组件间开启 TLS](enable-tls-between-components.md) -在任何环境上部署前，都可以参考 [TiDB 集群配置](configure-a-tidb-cluster.md)来自定义 TiDB 配置。 + -部署完成后，你可以参考下面的文档进行 Kubernetes 上 TiDB 集群的使用和运维： + + 运维 -+ [部署 TiDB 集群](deploy-on-general-kubernetes.md) -+ [访问 TiDB 集群](access-tidb.md) -+ [TiDB 集群扩缩容](scale-a-tidb-cluster.md) -+ [TiDB 集群升级](upgrade-a-tidb-cluster.md#升级-tidb-版本) -+ [TiDB 集群配置变更](upgrade-a-tidb-cluster.md#更新-tidb-集群配置) -+ [TiDB 集群备份恢复](backup-and-restore-using-helm-charts.md) -+ [配置 TiDB 集群故障自动转移](use-auto-failover.md) -+ [监控 TiDB 集群](monitor-a-tidb-cluster.md) -+ [TiDB 集群日志收集](collect-tidb-logs.md) -+ [维护 TiDB 所在的 Kubernetes 节点](maintain-a-kubernetes-node.md) + - [升级 TiDB 集群](upgrade-a-tidb-cluster.md) + - [升级 TiDB Operator](upgrade-tidb-operator.md) + - [集群扩缩容](scale-a-tidb-cluster.md) + - [备份与恢复](backup-and-restore-using-helm-charts.md) + - [维护 TiDB 集群所在节点](maintain-a-kubernetes-node.md) + - [集群故障自动转移](use-auto-failover.md) -当集群出现问题需要进行诊断时，你可以： + -+ 查阅 [Kubernetes 上的 TiDB FAQ](faq.md) 寻找是否存在现成的解决办法； -+ 参考 [Kubernetes 上的 TiDB 故障诊断](troubleshoot.md)解决故障。 + + 参考 -Kubernetes 上的 TiDB 提供了专用的命令行工具 `tkctl` 用于集群管理和辅助诊断，同时，在 Kubernetes 上，TiDB 的部分生态工具的使用方法也有所不同，你可以： + - [架构](tidb-scheduler.md.md) + - [API 参考文档](https://github.com/pingcap/docs-tidb-operator/blob/master/zh/api-references.md) + - [工具](use-tkctl.md) + - [配置](configure-tidb-binlog-drainer.md) -+ 参考 [`tkctl` 使用指南](use-tkctl.md) 来使用 `tkctl`； -+ 参考 [Kubernetes 上的 TiDB 相关工具使用指南](tidb-toolkit.md)来了解 TiDB 生态工具在 Kubernetes 上的使用方法。 + -最后，当 TiDB Operator 发布新版本时，你可以参考[升级 TiDB Operator](upgrade-tidb-operator.md) 进行版本更新。 + \ No newline at end of file