Merge pull request #35 from DanielZhangQD/configure

overall update for v1.1
pingcap · Mar 25, 2020 · f148dc0 · f148dc0
2 parents 6311e8d + 7f57466
commit f148dc0
Show file tree

Hide file tree

Showing 11 changed files with 251 additions and 191 deletions.
diff --git a/zh/TOC.md b/zh/TOC.md
@@ -19,33 +19,34 @@
   - [阿里云上的 TiDB 集群](deploy-on-alibaba-cloud.md)
   - [访问 Kubernetes 上的 TiDB 集群](access-tidb.md)
 + 配置
+  - [配置 Storage Class](configure-storage-class.md)
+  - [资源及容灾配置](configure-a-tidb-cluster.md)
   - [初始化集群](initialize-a-cluster.md)
-  - [配置集群](configure-a-tidb-cluster.md)
   - [通过 TidbCluster 配置集群](configure-cluster-using-tidbcluster.md)
-  - [配置备份](configure-backup.md)
-  - [配置 Storage Class](configure-storage-class.md)
   - [配置 TiDB Binlog Drainer](configure-tidb-binlog-drainer.md)
+  - [tidb-cluster chart 配置](tidb-cluster-chart-config.md)
+  - [tidb-backup chart 配置](configure-backup.md)
 + 监控
   - [监控 TiDB 集群](monitor-a-tidb-cluster.md)
   - [通过 TidbMonitor 监控 TiDB 集群](monitor-using-tidbmonitor.md)
 + 运维
   - [销毁 TiDB 集群](destroy-a-tidb-cluster.md)
   - [重启 TiDB 集群](restart-a-tidb-cluster.md)
   - [维护 TiDB 集群所在节点](maintain-a-kubernetes-node.md)
-  + 备份与恢复
-    - [基于 Helm Charts 的备份恢复](backup-and-restore-using-helm-charts.md)
-    + 基于 CRD 的备份恢复
-      - [使用 Mydumper 备份 TiDB 集群到 GCS](backup-to-gcs.md)
-      - [使用 Loader 恢复 GCS 上的备份数据](restore-from-gcs.md)
-      - [使用 Mydumper 备份 TiDB 集群到兼容 S3 的存储](backup-to-s3.md)
-      - [使用 Loader 恢复 S3 兼容存储上的备份数据](restore-from-s3.md)
-      - [使用 BR 备份 TiDB 集群到兼容 S3 的存储](backup-to-aws-s3-using-br.md)
-      - [使用 BR 恢复 S3 兼容存储上的备份数据](restore-from-aws-s3-using-br.md)
-    - [使用 TiDB Lightning 恢复集群数据](restore-data-using-tidb-lightning.md)
   - [收集日志](collect-tidb-binlogs.md)
   - [TiDB Binlog 运维](maintain-tidb-binlog.md)
   - [集群故障自动转移](use-auto-failover.md)
 - [扩缩容](scale-a-tidb-cluster.md)
++ 备份与恢复
+  - [基于 Helm Charts 的备份恢复](backup-and-restore-using-helm-charts.md)
+  + 基于 CRD 的备份恢复
+    - [使用 Mydumper 备份 TiDB 集群到 GCS](backup-to-gcs.md)
+    - [使用 Loader 恢复 GCS 上的备份数据](restore-from-gcs.md)
+    - [使用 Mydumper 备份 TiDB 集群到兼容 S3 的存储](backup-to-s3.md)
+    - [使用 Loader 恢复 S3 兼容存储上的备份数据](restore-from-s3.md)
+    - [使用 BR 备份 TiDB 集群到兼容 S3 的存储](backup-to-aws-s3-using-br.md)
+    - [使用 BR 恢复 S3 兼容存储上的备份数据](restore-from-aws-s3-using-br.md)
+  - [使用 TiDB Lightning 恢复集群数据](restore-data-using-tidb-lightning.md)
 + 升级
   - [TiDB 集群](upgrade-a-tidb-cluster.md)
   - [TiDB Operator](upgrade-tidb-operator.md)

diff --git a/zh/access-tidb.md b/zh/access-tidb.md
@@ -6,17 +6,21 @@ category: how-to
 
 # 访问 Kubernetes 上的 TiDB 集群
 
-在 Kubernetes 集群内访问 TiDB 时，使用 TiDB service 域名 `<release-name>-tidb.<namespace>` 即可。若需要在集群外访问，则需将 TiDB 服务端口暴露出去。在 `tidb-cluster` Helm chart 中，通过 `values.yaml` 文件中的 `tidb.service` 字段进行配置：
+在 Kubernetes 集群内访问 TiDB 时，使用 TiDB service 域名 `<cluster-name>-tidb.<namespace>` 即可。
+
+若需要在集群外访问，则需将 TiDB 服务端口暴露出去。在 `TidbCluster` CR 中，通过 `spec.tidb.service` 字段进行配置：
 
 {{< copyable "" >}}
 
 ```yaml
-tidb:
+spec:
+  ...
+  tidb:
   service:
     type: NodePort
     # externalTrafficPolicy: Cluster
     # annotations:
-    # cloud.google.com/load-balancer-type: Internal
+    #   cloud.google.com/load-balancer-type: Internal
 ```
 
 ## NodePort
@@ -42,7 +46,7 @@ tidb:
 {{< copyable "shell-regular" >}}
 
 ```shell
-kubectl -n <namespace> get svc <release-name>-tidb -ojsonpath="{.spec.ports[?(@.name=='mysql-client')].nodePort}{'\n'}"
+kubectl -n <namespace> get svc <cluster-name>-tidb -ojsonpath="{.spec.ports[?(@.name=='mysql-client')].nodePort}{'\n'}"
 ```
 
 查看可通过哪些节点的 IP 访问 TiDB 服务，有两种情况：
@@ -53,7 +57,7 @@ kubectl -n <namespace> get svc <release-name>-tidb -ojsonpath="{.spec.ports[?(@.
     {{< copyable "shell-regular" >}}
 
     ```shell
-    kubectl -n <namespace> get pods -l "app.kubernetes.io/component=tidb,app.kubernetes.io/instance=<release-name>" -ojsonpath="{range .items[*]}{.spec.nodeName}{'\n'}{end}"
+    kubectl -n <namespace> get pods -l "app.kubernetes.io/component=tidb,app.kubernetes.io/instance=<cluster-name>" -ojsonpath="{range .items[*]}{.spec.nodeName}{'\n'}{end}"
     ```
 
 ## LoadBalancer

diff --git a/zh/backup-and-restore-using-helm-charts.md b/zh/backup-and-restore-using-helm-charts.md
@@ -9,12 +9,16 @@ aliases: ['/docs-cn/devmaintain/backup-and-store/']
 
 本文详细描述了如何对 Kubernetes 上的 TiDB 集群进行数据备份和数据恢复。本文使用的备份恢复方式是基于 Helm Charts 实现的。
 
-TiDB Operator 1.1 及以上版本推荐使用基于 CustomResourceDefinition (CRD) 实现的备份恢复方式实现，详情可参阅以下文档：
-
-- [备份 TiDB 集群到 GCS](backup-to-gcs.md)
-- [恢复 GCS 上的备份数据](restore-from-gcs.md)
-- [备份 TiDB 集群到兼容 S3 的存储](backup-to-s3.md)
-- [恢复 S3 兼容存储上的备份数据](restore-from-s3.md)
+TiDB Operator 1.1 及以上版本推荐使用基于 CustomResourceDefinition (CRD) 实现的备份恢复方式实现：
+
++ 如果 TiDB 集群版本 < v3.1，可以参考以下文档：
+    - [使用 Mydumper 备份 TiDB 集群到 GCS](backup-to-gcs.md)
+    - [使用 Loader 恢复 GCS 上的备份数据](restore-from-gcs.md)
+    - [使用 Mydumper 备份 TiDB 集群到兼容 S3 的存储](backup-to-s3.md)
+    - [使用 Loader 恢复 S3 兼容存储上的备份数据](restore-from-s3.md)
++ 如果 TiDB 集群版本 >= v3.1，可以参考以下文档：
+    - [使用 BR 备份 TiDB 集群到兼容 S3 的存储](backup-to-aws-s3-using-br.md)
+    - [使用 BR 恢复 S3 兼容存储上的备份数据](restore-from-aws-s3-using-br.md)
 
 Kubernetes 上的 TiDB 集群支持两种备份策略：