From 48e5ba36980d4e2235f3b1a8c022da33db30e5f0 Mon Sep 17 00:00:00 2001 From: luolibin Date: Tue, 11 Feb 2020 17:37:01 +0800 Subject: [PATCH 01/16] update backup & restore usage docs --- .../maintain/backup-and-restore/backup-gcs.md | 28 +++--- .../maintain/backup-and-restore/backup-s3.md | 50 ++++++----- .../{restore.md => restore-gcp.md} | 44 +++++----- .../maintain/backup-and-restore/restore-s3.md | 88 +++++++++++++++++++ 4 files changed, 157 insertions(+), 53 deletions(-) rename dev/tidb-in-kubernetes/maintain/backup-and-restore/{restore.md => restore-gcp.md} (52%) create mode 100644 dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md diff --git a/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md b/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md index f0133698e6fb..16c68e1bb149 100644 --- a/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md +++ b/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md @@ -36,7 +36,7 @@ Ad-hoc 全量备份通过创建一个自定义的 `Backup` custom resource (CR) {{< copyable "shell-regular" >}} ```shell - kubectl create secret generic backup-demo1-tidb-secret --from-literal=user=root --from-literal=password= --namespace=test1 + kubectl create secret generic backup-demo1-tidb-secret --from-literal=password= --namespace=test1 ``` ### 备份数据到 GCS @@ -59,6 +59,11 @@ metadata: name: demo1-backup-gcs namespace: test1 spec: + from: + host: + port: + user: + secretName: backup-demo1-tidb-secret gcs: secretName: gcs-secret projectId: @@ -66,9 +71,6 @@ spec: # storageClass: STANDARD_IA # objectAcl: private # bucketAcl: private - storageType: gcs - cluster: demo1 - tidbSecretName: backup-demo1-tidb-secret storageClassName: local-storage storageSize: 10Gi ``` @@ -118,13 +120,15 @@ GCS 支持以下几种 bucket ACL 策略： 更多 `Backup` CR 字段的详细解释： -`.spec.metadata.namespace`：备份 TiDB 集群所在的 namespace。 +`.spec.metadata.namespace`：`Backup` CR 所在的 namespace。 -`.spec.storageType`：备份的存储类型。目前主要有 S3 和 GCS 两种。 +`.spec.from.host`：需要备份的 TiDB 集群访问地址。 -`.spec.cluster`：备份 TiDB 集群的名字。 +`.spec.from.port`：需要备份的 TiDB 集群访问端口。 -`.spec.tidbSecretName`：访问 TiDB 集群所需凭证的 secret。 +`.spec.from.user`：需要备份的 TiDB 集群访问用户。 + +`.spec.from.tidbSecretName`：需要备份的 TiDB 集群所需凭证的 secret。 `.spec.storageClassName`：备份时指定所需的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值，这个值默认为 `standard`。 @@ -163,6 +167,11 @@ spec: maxReservedTime: "3h" schedule: "*/2 * * * *" backupTemplate: + from: + host: + port: + user: + secretName: backup-demo1-tidb-secret gcs: secretName: gcs-secret projectId: @@ -170,9 +179,6 @@ spec: # storageClass: STANDARD_IA # objectAcl: private # bucketAcl: private - storageType: gcs - cluster: demo1 - tidbSecretName: backup-demo1-tidb-secret storageClassName: local-storage storageSize: 10Gi ``` diff --git a/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md b/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md index 790a19c89138..76d7dd6c2034 100644 --- a/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md +++ b/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md @@ -36,7 +36,7 @@ Ad-hoc 全量备份通过创建一个自定义的 `Backup` custom resource (CR) {{< copyable "shell-regular" >}} ```shell - kubectl create secret generic backup-demo1-tidb-secret --from-literal=user=root --from-literal=password= --namespace=test1 + kubectl create secret generic backup-demo1-tidb-secret --from-literal=password= --namespace=test1 ``` ### 备份数据到兼容 S3 的存储 @@ -59,6 +59,11 @@ Ad-hoc 全量备份通过创建一个自定义的 `Backup` custom resource (CR) name: demo1-backup-s3 namespace: test1 spec: + from: + host: + port: + user: + secretName: backup-demo1-tidb-secret s3: provider: aws secretName: s3-secret @@ -66,9 +71,6 @@ Ad-hoc 全量备份通过创建一个自定义的 `Backup` custom resource (CR) # storageClass: STANDARD_IA # acl: private # endpoint: - storageType: s3 - cluster: demo1 - tidbSecretName: backup-demo1-tidb-secret storageClassName: local-storage storageSize: 10Gi ``` @@ -91,13 +93,15 @@ Ad-hoc 全量备份通过创建一个自定义的 `Backup` custom resource (CR) name: demo1-backup-s3 namespace: test1 spec: + from: + host: + port: + user: + secretName: backup-demo1-tidb-secret s3: provider: ceph secretName: s3-secret endpoint: http://10.0.0.1:30074 - storageType: s3 - cluster: demo1 - tidbSecretName: backup-demo1-tidb-secret storageClassName: local-storage storageSize: 10Gi ``` @@ -136,13 +140,15 @@ Amazon S3 支持以下几种 storageClass 类型： 更多 `Backup` CR 字段的详细解释: -`.spec.metadata.namespace`: 备份 TiDB 集群所在的 namespace。 +`.spec.metadata.namespace`：`Backup` CR 所在的 namespace。 -`.spec.storageType`: 代表备份的存储类型，目前主要有 S3 和 GCS。 +`.spec.from.host`：需要备份的 TiDB 集群访问地址。 -`.spec.cluster`: 备份 TiDB 集群的名字。 +`.spec.from.port`：需要备份的 TiDB 集群访问端口。 -`.spec.tidbSecretName`: 访问 TiDB 集群所需密码的 secret。 +`.spec.from.user`：需要备份的 TiDB 集群访问用户。 + +`.spec.from.tidbSecretName`：需要备份的 TiDB 集群所需凭证的 secret。 `.spec.storageClassName`: 备份时所需的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值，这个值默认为 `standard`。 @@ -192,6 +198,11 @@ Amazon S3 支持以下几种 storageClass 类型： maxReservedTime: "3h" schedule: "*/2 * * * *" backupTemplate: + from: + host: + port: + user: + secretName: backup-demo1-tidb-secret s3: provider: aws secretName: s3-secret @@ -199,9 +210,6 @@ Amazon S3 支持以下几种 storageClass 类型： # storageClass: STANDARD_IA # acl: private # endpoint: - storageType: s3 - cluster: demo1 - tidbSecretName: backup-demo1-tidb-secret storageClassName: local-storage storageSize: 10Gi ``` @@ -229,13 +237,15 @@ Amazon S3 支持以下几种 storageClass 类型： maxReservedTime: "3h" schedule: "*/2 * * * *" backupTemplate: + from: + host: + port: + user: + secretName: backup-demo1-tidb-secret s3: - provider: ceph - secretName: s3-secret - endpoint: http://10.0.0.1:30074 - storageType: s3 - cluster: demo1 - tidbSecretName: backup-demo1-tidb-secret + provider: ceph + secretName: s3-secret + endpoint: http://10.0.0.1:30074 storageClassName: local-storage storageSize: 10Gi ``` diff --git a/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore.md b/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcp.md similarity index 52% rename from dev/tidb-in-kubernetes/maintain/backup-and-restore/restore.md rename to dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcp.md index 9401c73e3de7..7970705956f9 100644 --- a/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore.md +++ b/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcp.md @@ -7,7 +7,7 @@ category: how-to 本文档详细描述了如何将 Kubernetes 上通过 TiDB Operator 备份的 TiDB 集群数据恢复的具体操作过程。底层通过使用 [`loader`](/dev/reference/tools/loader.md) 来进行集群恢复。 -为了更好地说明如何进行恢复，本文档提供了以下示例。示例假设备份数据来源于 Kubernetes `test1` 这个 namespace 中的 TiDB 集群 `demo1`，并将其中的一个备份数据恢复到 Kubernetes `test2` 这个 namespace 中的 TiDB 集群 `demo2`。下面是具体的操作过程： +为了更好地说明如何进行恢复，本文档提供了以下示例。示例通过指定存储在 [Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/) 上的一个 TiDB 集群备份数据路径来恢复 TiDB 集群。下面是具体的操作过程： ## 恢复备份的环境准备 @@ -47,13 +47,17 @@ category: how-to name: demo2-restore namespace: test2 spec: - cluster: demo2 - ## specify a backup CR name to represent restore tidb cluster test2/demo2 from this backup - backup: demo1-backup-schedule-2019-08-15t02-01-00 - secretName: restore-demo2-tidb-secret - backupNamespace: test1 - storageClassName: rook-ceph-block - storageSize: 10Gi + to: + host: + port: + user: + secretName: restore-demo2-tidb-secret + gcs: + projectId: + secretName: gcs-secret + path: gcs:// + storageClassName: local-storage + storageSize: 1Gi ``` 2. 创建好 `Restore` CR 后可通过以下命令查看恢复的状态： @@ -63,25 +67,21 @@ category: how-to ```shell kubectl get rt -n test2 -owide ``` + +以上示例将存储在 GCS 上特定路径 `spec.gcs.path` 的备份数据恢复到 `spec.to.host` TiDB 集群，关于 GCS 的配置项可以参考 [backup-gcs.yaml](/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md#备份数据到-gcs) 中的设置。 -`Restore` CR 各个字段的详细解释： +更多 `Restore` CR 字段的详细解释： -`.spec.metadata.namespace`： 需要恢复的目标 TiDB 集群所在的 namespace。 +`.spec.metadata.namespace`： `Restore` CR 所在的 namespace。 -`.spec.cluster`：需要恢复的目标 TiDB 集群的名字。 +`.spec.to.host`：需要恢复的 TiDB 集群访问地址。 -`.spec.backupNamespace`：备份集群所在的 namespace。因为目前需通过备份源 `Backup` CR 来获取恢复逻辑中所需的远端存储访问信息，所以恢复操作中需要备份源所在的 namespace 信息。 +`.spec.to.port`：需要恢复的 TiDB 集群访问端口。 -`.spec.backup`：备份源的一个 `Backup` CR 名字。可以通过以下命令获取备份集群下的备份条目，然后从中选择一个要恢复的 `backup` 进行恢复即可。 +`.spec.to.user`：需要恢复的 TiDB 集群访问用户。 -{{< copyable "shell-regular" >}} +`.spec.to.tidbSecretName`：需要恢复的 TiDB 集群所需凭证的 secret。 -```shell -kubectl get bk -n test1 -``` +`.spec.storageClassName`：恢复时指定所需的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值，这个值默认为 `standard`。 -`.spec.secretName`：访问需恢复的目标 TiDB 集群所需凭证的 secret。 - -`.spec.storageClassName`：恢复备份数据时需要指定使用的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 所指定的值，这个值默认为 `standard`。 - -`.spec.storageSize`：恢复集群时指定所需的 PV 大小。这个值应大于备份 TiDB 集群数据的大小。 +`.spec.storageSize`：恢复集群时指定所需的 PV 大小。这个值应大于备份 TiDB 集群数据的大小。 \ No newline at end of file diff --git a/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md b/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md new file mode 100644 index 000000000000..f051beede70b --- /dev/null +++ b/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md @@ -0,0 +1,88 @@ +--- +title: 恢复备份数据到 Kubernetes 上的 TiDB 集群 +category: how-to +--- + +# 恢复备份数据到 Kubernetes 上的 TiDB 集群 + +本文档详细描述了如何将 Kubernetes 上通过 TiDB Operator 备份的 TiDB 集群数据恢复的具体操作过程。底层通过使用 [`loader`](/dev/reference/tools/loader.md) 来进行集群恢复。 + +为了更好地说明如何进行恢复，本文档提供了以下示例。示例通过指定存储在兼容 S3 的存储上的一个 TiDB 集群备份数据路径来恢复 TiDB 集群。下面是具体的操作过程： + +## 恢复备份的环境准备 + +1. 下载文件 [`backup-rbac.yaml`](https://github.com/pingcap/tidb-operator/blob/master/manifests/backup/backup-rbac.yaml)，并执行以下命令在 `test2` 这个 namespace 中创建恢复备份所需的 RBAC 相关资源： + + {{< copyable "shell-regular" >}} + + ```shell + kubectl apply -f backup-rbac.yaml -n test2 + ``` + +2. 创建 `restore-demo2-tidb-secret` secret，该 secret 存放用来访问 TiDB 集群的 root 账号和密钥： + + {{< copyable "shell-regular" >}} + + ```shell + kubectl create secret generic restore-demo2-tidb-secret --from-literal=user=root --from-literal=password= --namespace=test2 + ``` + +## 将指定备份恢复到 TiDB 集群 + +1. 创建 restore custom resource (CR)，将指定的备份数据恢复至 TiDB 集群： + + {{< copyable "shell-regular" >}} + + ```shell + kubectl apply -f restore.yaml + ``` + + `restore.yaml` 文件内容如下： + + ```yaml + --- + apiVersion: pingcap.com/v1alpha1 + kind: Restore + metadata: + name: demo2-restore + namespace: test2 + spec: + to: + host: + port: + user: + secretName: restore-demo2-tidb-secret + s3: + provider: ceph + endpoint: http://10.233.2.161 + secretName: ceph-secret + path: s3:// + storageClassName: local-storage + storageSize: 1Gi + ``` + +2. 创建好 `Restore` CR 后可通过以下命令查看恢复的状态： + + {{< copyable "shell-regular" >}} + + ```shell + kubectl get rt -n test2 -owide + ``` + +以上示例将存储在兼容 S3 存储的特定路径 `spec.s3.path` 的备份数据恢复到 `spec.to.host` TiDB 集群，关于兼容 S3 存储的配置项可以参考 [backup-s3.yaml](/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md#备份数据到兼容-s3-的存储) 中的设置。 + +更多 `Restore` CR 字段的详细解释： + +`.spec.metadata.namespace`： `Restore` CR 所在的 namespace。 + +`.spec.to.host`：需要恢复的 TiDB 集群访问地址。 + +`.spec.to.port`：需要恢复的 TiDB 集群访问端口。 + +`.spec.to.user`：需要恢复的 TiDB 集群访问用户。 + +`.spec.to.tidbSecretName`：需要恢复的 TiDB 集群所需凭证的 secret。 + +`.spec.storageClassName`：恢复时指定所需的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值，这个值默认为 `standard`。 + +`.spec.storageSize`：恢复集群时指定所需的 PV 大小。这个值应大于备份 TiDB 集群数据的大小。 \ No newline at end of file From d8f3080fa8cf918e95bf6791a13c829fbba84c8d Mon Sep 17 00:00:00 2001 From: luolibin Date: Tue, 11 Feb 2020 17:45:57 +0800 Subject: [PATCH 02/16] format docs --- .../maintain/backup-and-restore/backup-s3.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md b/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md index 76d7dd6c2034..08414d0daba1 100644 --- a/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md +++ b/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md @@ -199,7 +199,7 @@ Amazon S3 支持以下几种 storageClass 类型： schedule: "*/2 * * * *" backupTemplate: from: - host: + host: port: user: secretName: backup-demo1-tidb-secret @@ -238,7 +238,7 @@ Amazon S3 支持以下几种 storageClass 类型： schedule: "*/2 * * * *" backupTemplate: from: - host: + host: port: user: secretName: backup-demo1-tidb-secret From f74bbcdf784339078b57d795ef81cf1b31b24f84 Mon Sep 17 00:00:00 2001 From: luolibin Date: Tue, 11 Feb 2020 17:52:12 +0800 Subject: [PATCH 03/16] fix CI --- .../maintain/backup-and-restore/restore-gcp.md | 4 ++-- .../maintain/backup-and-restore/restore-s3.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcp.md b/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcp.md index 7970705956f9..62e483ab3320 100644 --- a/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcp.md +++ b/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcp.md @@ -67,7 +67,7 @@ category: how-to ```shell kubectl get rt -n test2 -owide ``` - + 以上示例将存储在 GCS 上特定路径 `spec.gcs.path` 的备份数据恢复到 `spec.to.host` TiDB 集群，关于 GCS 的配置项可以参考 [backup-gcs.yaml](/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md#备份数据到-gcs) 中的设置。 更多 `Restore` CR 字段的详细解释： @@ -84,4 +84,4 @@ category: how-to `.spec.storageClassName`：恢复时指定所需的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值，这个值默认为 `standard`。 -`.spec.storageSize`：恢复集群时指定所需的 PV 大小。这个值应大于备份 TiDB 集群数据的大小。 \ No newline at end of file +`.spec.storageSize`：恢复集群时指定所需的 PV 大小。这个值应大于备份 TiDB 集群数据的大小。 diff --git a/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md b/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md index f051beede70b..51b6ed340f4d 100644 --- a/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md +++ b/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md @@ -68,7 +68,7 @@ category: how-to ```shell kubectl get rt -n test2 -owide ``` - + 以上示例将存储在兼容 S3 存储的特定路径 `spec.s3.path` 的备份数据恢复到 `spec.to.host` TiDB 集群，关于兼容 S3 存储的配置项可以参考 [backup-s3.yaml](/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md#备份数据到兼容-s3-的存储) 中的设置。 更多 `Restore` CR 字段的详细解释： @@ -85,4 +85,4 @@ category: how-to `.spec.storageClassName`：恢复时指定所需的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值，这个值默认为 `standard`。 -`.spec.storageSize`：恢复集群时指定所需的 PV 大小。这个值应大于备份 TiDB 集群数据的大小。 \ No newline at end of file +`.spec.storageSize`：恢复集群时指定所需的 PV 大小。这个值应大于备份 TiDB 集群数据的大小。 From 509ab293016df810e6d5c69ef1469e578794e4f1 Mon Sep 17 00:00:00 2001 From: onlymellb Date: Sat, 15 Feb 2020 11:04:59 +0800 Subject: [PATCH 04/16] Apply suggestions from code review Co-Authored-By: TomShawn <41534398+TomShawn@users.noreply.github.com> --- .../maintain/backup-and-restore/backup-gcs.md | 6 +++--- .../maintain/backup-and-restore/backup-s3.md | 6 +++--- .../backup-and-restore/restore-gcp.md | 12 +++++------ .../maintain/backup-and-restore/restore-s3.md | 20 +++++++++---------- 4 files changed, 22 insertions(+), 22 deletions(-) diff --git a/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md b/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md index 16c68e1bb149..88ebd40832d3 100644 --- a/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md +++ b/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md @@ -122,11 +122,11 @@ GCS 支持以下几种 bucket ACL 策略： `.spec.metadata.namespace`：`Backup` CR 所在的 namespace。 -`.spec.from.host`：需要备份的 TiDB 集群访问地址。 +`.spec.from.host`：需备份的 TiDB 集群的访问地址。 -`.spec.from.port`：需要备份的 TiDB 集群访问端口。 +`.spec.from.port`：需要备份的 TiDB 集群的访问端口。 -`.spec.from.user`：需要备份的 TiDB 集群访问用户。 +`.spec.from.user`：需要备份的 TiDB 集群的访问用户。 `.spec.from.tidbSecretName`：需要备份的 TiDB 集群所需凭证的 secret。 diff --git a/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md b/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md index 08414d0daba1..5ca160ada1ab 100644 --- a/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md +++ b/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md @@ -142,11 +142,11 @@ Amazon S3 支持以下几种 storageClass 类型： `.spec.metadata.namespace`：`Backup` CR 所在的 namespace。 -`.spec.from.host`：需要备份的 TiDB 集群访问地址。 +`.spec.from.host`：需要备份的 TiDB 集群的访问地址。 -`.spec.from.port`：需要备份的 TiDB 集群访问端口。 +`.spec.from.port`：需要备份的 TiDB 集群的访问端口。 -`.spec.from.user`：需要备份的 TiDB 集群访问用户。 +`.spec.from.user`：需要备份的 TiDB 集群的访问用户。 `.spec.from.tidbSecretName`：需要备份的 TiDB 集群所需凭证的 secret。 diff --git a/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcp.md b/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcp.md index 62e483ab3320..7de05f81c3ad 100644 --- a/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcp.md +++ b/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcp.md @@ -7,7 +7,7 @@ category: how-to 本文档详细描述了如何将 Kubernetes 上通过 TiDB Operator 备份的 TiDB 集群数据恢复的具体操作过程。底层通过使用 [`loader`](/dev/reference/tools/loader.md) 来进行集群恢复。 -为了更好地说明如何进行恢复，本文档提供了以下示例。示例通过指定存储在 [Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/) 上的一个 TiDB 集群备份数据路径来恢复 TiDB 集群。下面是具体的操作过程： +以下示例将存储在 [Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/) 上指定路径中的集群备份数据恢复到 TiDB 集群。 ## 恢复备份的环境准备 @@ -68,20 +68,20 @@ category: how-to kubectl get rt -n test2 -owide ``` -以上示例将存储在 GCS 上特定路径 `spec.gcs.path` 的备份数据恢复到 `spec.to.host` TiDB 集群，关于 GCS 的配置项可以参考 [backup-gcs.yaml](/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md#备份数据到-gcs) 中的设置。 +以上示例将存储在 GCS 上指定路径 `spec.gcs.path` 的备份数据恢复到 TiDB 集群 `spec.to.host`。关于 GCS 的配置项可以参考 [backup-gcs.yaml](/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md#备份数据到-gcs) 中的配置。 更多 `Restore` CR 字段的详细解释： `.spec.metadata.namespace`： `Restore` CR 所在的 namespace。 -`.spec.to.host`：需要恢复的 TiDB 集群访问地址。 +`.spec.to.host`：需要恢复的 TiDB 集群的访问地址。 -`.spec.to.port`：需要恢复的 TiDB 集群访问端口。 +`.spec.to.port`：需要恢复的 TiDB 集群访问的端口。 -`.spec.to.user`：需要恢复的 TiDB 集群访问用户。 +`.spec.to.user`：需要恢复的 TiDB 集群的访问用户。 `.spec.to.tidbSecretName`：需要恢复的 TiDB 集群所需凭证的 secret。 -`.spec.storageClassName`：恢复时指定所需的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值，这个值默认为 `standard`。 +`.spec.storageClassName`：指定恢复时所需的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值（默认为 `standard`）。 `.spec.storageSize`：恢复集群时指定所需的 PV 大小。这个值应大于备份 TiDB 集群数据的大小。 diff --git a/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md b/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md index 51b6ed340f4d..bdd5ef45ab51 100644 --- a/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md +++ b/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md @@ -5,13 +5,13 @@ category: how-to # 恢复备份数据到 Kubernetes 上的 TiDB 集群 -本文档详细描述了如何将 Kubernetes 上通过 TiDB Operator 备份的 TiDB 集群数据恢复的具体操作过程。底层通过使用 [`loader`](/dev/reference/tools/loader.md) 来进行集群恢复。 +本文档描述了如何将 Kubernetes 上通过 TiDB Operator 备份的数据恢复到 TiDB 集群的操作过程。底层通过使用 [`loader`](/dev/reference/tools/loader.md) 来恢复数据。 -为了更好地说明如何进行恢复，本文档提供了以下示例。示例通过指定存储在兼容 S3 的存储上的一个 TiDB 集群备份数据路径来恢复 TiDB 集群。下面是具体的操作过程： +以下示例将兼容 S3 的存储（指定路径）上的备份数据恢复到 TiDB 集群。 ## 恢复备份的环境准备 -1. 下载文件 [`backup-rbac.yaml`](https://github.com/pingcap/tidb-operator/blob/master/manifests/backup/backup-rbac.yaml)，并执行以下命令在 `test2` 这个 namespace 中创建恢复备份所需的 RBAC 相关资源： +1. 下载文件 [`backup-rbac.yaml`](https://github.com/pingcap/tidb-operator/blob/master/manifests/backup/backup-rbac.yaml)，并在 `test2` 这个 namespace 中创建恢复备份所需的 RBAC 资源，所需命令如下： {{< copyable "shell-regular" >}} @@ -69,20 +69,20 @@ category: how-to kubectl get rt -n test2 -owide ``` -以上示例将存储在兼容 S3 存储的特定路径 `spec.s3.path` 的备份数据恢复到 `spec.to.host` TiDB 集群，关于兼容 S3 存储的配置项可以参考 [backup-s3.yaml](/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md#备份数据到兼容-s3-的存储) 中的设置。 +以上示例将兼容 S3 的存储（`spec.s3.path` 路径下）中的备份数据恢复到 TiDB 集群 (`spec.to.host` )。有关兼容 S3 的存储的配置项，可以参考 [backup-s3.yaml](/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md#备份数据到兼容-s3-的存储)。 更多 `Restore` CR 字段的详细解释： -`.spec.metadata.namespace`： `Restore` CR 所在的 namespace。 +`.spec.metadata.namespace`：`Restore` CR 所在的 namespace。 -`.spec.to.host`：需要恢复的 TiDB 集群访问地址。 +`.spec.to.host`：需要恢复的 TiDB 集群的访问地址。 -`.spec.to.port`：需要恢复的 TiDB 集群访问端口。 +`.spec.to.port`：需要恢复的 TiDB 集群的访问端口。 -`.spec.to.user`：需要恢复的 TiDB 集群访问用户。 +`.spec.to.user`：需要恢复的 TiDB 集群的访问用户。 `.spec.to.tidbSecretName`：需要恢复的 TiDB 集群所需凭证的 secret。 -`.spec.storageClassName`：恢复时指定所需的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值，这个值默认为 `standard`。 +`.spec.storageClassName`：指定恢复时所需的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值（默认为 `standard`）。 -`.spec.storageSize`：恢复集群时指定所需的 PV 大小。这个值应大于备份 TiDB 集群数据的大小。 +`.spec.storageSize`：指定恢复集群时所需的 PV 大小。该值应大于备份 TiDB 集群的数据大小。 From e5aef9fc745d17945da862108422fc9e64ad7dfa Mon Sep 17 00:00:00 2001 From: luolibin Date: Sat, 15 Feb 2020 11:40:29 +0800 Subject: [PATCH 05/16] update TOC --- dev/TOC.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/dev/TOC.md b/dev/TOC.md index ba0914187dad..351076045607 100644 --- a/dev/TOC.md +++ b/dev/TOC.md @@ -380,7 +380,11 @@ + 运维 - [销毁 TiDB 集群](/dev/tidb-in-kubernetes/maintain/destroy-tidb-cluster.md) - [维护 TiDB 集群所在节点](/dev/tidb-in-kubernetes/maintain/kubernetes-node.md) - - [备份与恢复](/dev/tidb-in-kubernetes/maintain/backup-and-restore.md) + + [备份与恢复] + - [备份到 GCS](/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md) + - [从 GCS 上的备份数据进行恢复](/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md) + - [备份到 S3 兼容存储](/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md) + - [从 S3 兼容存储上的备份数据进行恢复](/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md) - [恢复 Kubernetes 上的 TiDB 集群数据](/dev/tidb-in-kubernetes/maintain/lightning.md) - [收集日志](/dev/tidb-in-kubernetes/maintain/log-collecting.md) - [集群故障自动转移](/dev/tidb-in-kubernetes/maintain/auto-failover.md) From 8c36f4496e614a0d693cfb5adc4bca34ded1137e Mon Sep 17 00:00:00 2001 From: yikeke Date: Sun, 23 Feb 2020 13:05:59 +0800 Subject: [PATCH 06/16] make the same changes as before --- TOC.md | 6 +- dev/TOC.md | 494 ------------------ .../maintain/backup-and-restore/restore.md | 87 --- 3 files changed, 5 insertions(+), 582 deletions(-) delete mode 100644 dev/TOC.md delete mode 100644 tidb-in-kubernetes/maintain/backup-and-restore/restore.md diff --git a/TOC.md b/TOC.md index 013f601a2131..ff17eefdbb83 100644 --- a/TOC.md +++ b/TOC.md @@ -379,7 +379,11 @@ + 运维 - [销毁 TiDB 集群](/tidb-in-kubernetes/maintain/destroy-tidb-cluster.md) - [维护 TiDB 集群所在节点](/tidb-in-kubernetes/maintain/kubernetes-node.md) - - [备份与恢复](/tidb-in-kubernetes/maintain/backup-and-restore.md) + + [备份与恢复] + - [备份到 GCS](/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md) + - [从 GCS 上的备份数据进行恢复](/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md) + - [备份到 S3 兼容存储](/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md) + - [从 S3 兼容存储上的备份数据进行恢复](/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md) - [恢复 Kubernetes 上的 TiDB 集群数据](/tidb-in-kubernetes/maintain/lightning.md) - [收集日志](/tidb-in-kubernetes/maintain/log-collecting.md) - [集群故障自动转移](/tidb-in-kubernetes/maintain/auto-failover.md) diff --git a/dev/TOC.md b/dev/TOC.md deleted file mode 100644 index 351076045607..000000000000 --- a/dev/TOC.md +++ /dev/null @@ -1,494 +0,0 @@ -# TiDB 中文用户文档 - - - - -## 目录 - -+ 关于 TiDB - - [TiDB 简介](/dev/overview.md) - + Benchmark 测试 - - [如何用 Sysbench 测试 TiDB](/dev/benchmark/how-to-run-sysbench.md) - - [如何对 TiDB 进行 TPC-C 测试](/dev/benchmark/how-to-run-tpcc.md) - - [Sysbench 性能对比 - v3.0 对比 v2.1](/dev/benchmark/sysbench-v4.md) - - [TPC-C 性能对比 - v3.0 对比 v2.1](/dev/benchmark/tpcc.md) - - [线上负载与 `Add Index` 相互影响测试](/dev/benchmark/add-index-with-load.md) - - [TiDB in Kubernetes Sysbench 性能测试](/dev/benchmark/sysbench-in-k8s.md) - - [DM 1.0-GA 性能测试](/dev/benchmark/dm-v1.0-ga.md) -+ 主要概念 - - [整体架构](/dev/architecture.md) - + 核心特性 - - [水平扩展](/dev/key-features.md#水平扩展) - - [高可用](/dev/key-features.md#高可用) -+ 操作指南 - + 快速上手 - - [使用 Docker Compose 部署 TiDB](/dev/how-to/get-started/deploy-tidb-from-docker-compose.md) - - [SQL 基本操作](/dev/how-to/get-started/explore-sql.md) - - [读取历史数据](/dev/how-to/get-started/read-historical-data.md) - - [TiDB Binlog 教程](/dev/how-to/get-started/tidb-binlog.md) - - [TiDB Data Migration 教程](/dev/how-to/get-started/data-migration.md) - - [TiDB Lightning 教程](/dev/how-to/get-started/tidb-lightning.md) - - [TiSpark 教程](/dev/how-to/get-started/tispark.md) - + 部署 - - [软硬件环境需求](/dev/how-to/deploy/hardware-recommendations.md) - + 集群部署方式 - - [使用 Ansible 部署（推荐）](/dev/how-to/deploy/orchestrated/ansible.md) - - [使用 Ansible 离线部署](/dev/how-to/deploy/orchestrated/offline-ansible.md) - - [使用 Docker 部署](/dev/how-to/deploy/orchestrated/docker.md) - + 跨地域冗余 - - [跨数据中心部署方案](/dev/how-to/deploy/geographic-redundancy/overview.md) - - [配置集群拓扑](/dev/how-to/deploy/geographic-redundancy/location-awareness.md) - - [使用 Ansible 部署 DM 集群](/dev/how-to/deploy/data-migration-with-ansible.md) - + 配置 - - [时区](/dev/how-to/configure/time-zone.md) - - [内存控制](/dev/how-to/configure/memory-control.md) - + 安全 - + 安全传输层协议 (TLS) - - [为 MySQL 客户端开启 TLS](/dev/how-to/secure/enable-tls-clients.md) - - [为 TiDB 组件间开启 TLS](/dev/how-to/secure/enable-tls-between-components.md) - - [生成自签名证书](/dev/how-to/secure/generate-self-signed-certificates.md) - + 监控 - - [概述](/dev/how-to/monitor/overview.md) - - [监控 TiDB 集群](/dev/how-to/monitor/monitor-a-cluster.md) - + 迁移 - - [概述](/dev/how-to/migrate/overview.md) - + 从 MySQL 迁移 - - [全量迁移](/dev/how-to/migrate/from-mysql.md) - - [增量复制](/dev/how-to/migrate/incrementally-from-mysql.md) - - [从 Amazon Aurora MySQL 迁移数据](/dev/how-to/migrate/from-aurora.md) - - [从 CSV 迁移](/dev/reference/tools/tidb-lightning/csv.md) - + 运维 - - [Ansible 常见运维操作](/dev/how-to/maintain/ansible-operations.md) - + 备份与恢复 - - [使用 Mydumper/Loader 进行备份与恢复](/dev/how-to/maintain/backup-and-restore/mydumper-loader.md) - - [使用 BR 进行备份与恢复](/dev/reference/tools/br/br.md) - - [BR 备份与恢复最佳实践](/dev/reference/tools/br/br-best-practices.md) - + 定位异常查询 - - [定位慢查询](/dev/how-to/maintain/identify-abnormal-queries/identify-slow-queries.md) - - [定位消耗系统资源多的查询](/dev/how-to/maintain/identify-abnormal-queries/identify-aborted-queries.md) - + 扩容缩容 - - [使用 Ansible 扩容缩容](/dev/how-to/scale/with-ansible.md) - + 升级 - - [升级至最新开发版](/dev/how-to/upgrade/from-previous-version.md) - + 故障诊断 - - [集群配置诊断](/dev/how-to/troubleshoot/cluster-setup.md) - - [TiDB Lightning 故障诊断](/dev/how-to/troubleshoot/tidb-lightning.md) -+ 参考手册 - + SQL - - [与 MySQL 兼容性对比](/dev/reference/mysql-compatibility.md) - + SQL 语言结构 - - [字面值](/dev/reference/sql/language-structure/literal-values.md) - - [Schema 对象名](/dev/reference/sql/language-structure/schema-object-names.md) - - [关键字和保留字](/dev/reference/sql/language-structure/keywords-and-reserved-words.md) - - [用户自定义变量](/dev/reference/sql/language-structure/user-defined-variables.md) - - [表达式语法](/dev/reference/sql/language-structure/expression-syntax.md) - - [注释语法](/dev/reference/sql/language-structure/comment-syntax.md) - + 数据类型 - - [概述](/dev/reference/sql/data-types/overview.md) - - [默认值](/dev/reference/sql/data-types/default-values.md) - + 数值类型 - - [`BIT`](/dev/reference/sql/data-types/numeric.md#bit-类型) - - [`BOOL|BOOLEAN`](/dev/reference/sql/data-types/numeric.md#boolean-类型) - - [`TINYINT`](/dev/reference/sql/data-types/numeric.md#tinyint-类型) - - [`SMALLINT`](/dev/reference/sql/data-types/numeric.md#smallint-类型) - - [`MEDIUMINT`](/dev/reference/sql/data-types/numeric.md#mediumint-类型) - - [`INT|INTEGER`](/dev/reference/sql/data-types/numeric.md#integer-类型) - - [`BIGINT`](/dev/reference/sql/data-types/numeric.md#bigint-类型) - - [`DECIMAL`](/dev/reference/sql/data-types/numeric.md#decimal-类型) - - [`FLOAT`](/dev/reference/sql/data-types/numeric.md#float-类型) - - [`DOUBLE`](/dev/reference/sql/data-types/numeric.md#double-类型) - + 日期和时间类型 - - [`DATE`](/dev/reference/sql/data-types/date-and-time.md#date-类型) - - [`DATETIME`](/dev/reference/sql/data-types/date-and-time.md#datetime-类型) - - [`TIMESTAMP`](/dev/reference/sql/data-types/date-and-time.md#timestamp-类型) - - [`TIME`](/dev/reference/sql/data-types/date-and-time.md#time-类型) - - [`YEAR`](/dev/reference/sql/data-types/date-and-time.md#year-类型) - + 字符串类型 - - [`CHAR`](/dev/reference/sql/data-types/string.md#char-类型) - - [`VARCHAR`](/dev/reference/sql/data-types/string.md#varchar-类型) - - [`TEXT`](/dev/reference/sql/data-types/string.md#text-类型) - - [`LONGTEXT`](/dev/reference/sql/data-types/string.md#longtext-类型) - - [`BINARY`](/dev/reference/sql/data-types/string.md#binary-类型) - - [`VARBINARY`](/dev/reference/sql/data-types/string.md#varbinary-类型) - - [`TINYBLOB`](/dev/reference/sql/data-types/string.md#tinyblob-类型) - - [`BLOB`](/dev/reference/sql/data-types/string.md#blob-类型) - - [`MEDIUMBLOB`](/dev/reference/sql/data-types/string.md#mediumblob-类型) - - [`LONGBLOB`](/dev/reference/sql/data-types/string.md#longblob-类型) - - [`ENUM`](/dev/reference/sql/data-types/string.md#enum-类型) - - [`SET`](/dev/reference/sql/data-types/string.md#set-类型) - - [JSON Type](/dev/reference/sql/data-types/json.md) - + 函数与操作符 - - [函数与操作符概述](/dev/reference/sql/functions-and-operators/reference.md) - - [表达式求值的类型转换](/dev/reference/sql/functions-and-operators/type-conversion.md) - - [操作符](/dev/reference/sql/functions-and-operators/operators.md) - - [控制流程函数](/dev/reference/sql/functions-and-operators/control-flow-functions.md) - - [字符串函数](/dev/reference/sql/functions-and-operators/string-functions.md) - - [数值函数与操作符](/dev/reference/sql/functions-and-operators/numeric-functions-and-operators.md) - - [日期和时间函数](/dev/reference/sql/functions-and-operators/date-and-time-functions.md) - - [位函数和操作符](/dev/reference/sql/functions-and-operators/bit-functions-and-operators.md) - - [Cast 函数和操作符](/dev/reference/sql/functions-and-operators/cast-functions-and-operators.md) - - [加密和压缩函数](/dev/reference/sql/functions-and-operators/encryption-and-compression-functions.md) - - [信息函数](/dev/reference/sql/functions-and-operators/information-functions.md) - - [JSON 函数](/dev/reference/sql/functions-and-operators/json-functions.md) - - [GROUP BY 聚合函数](/dev/reference/sql/functions-and-operators/aggregate-group-by-functions.md) - - [窗口函数](/dev/reference/sql/functions-and-operators/window-functions.md) - - [其它函数](/dev/reference/sql/functions-and-operators/miscellaneous-functions.md) - - [精度数学](/dev/reference/sql/functions-and-operators/precision-math.md) - - [下推到 TiKV 的表达式列表](/dev/reference/sql/functions-and-operators/expressions-pushed-down.md) - + SQL 语句 - - [`ADD COLUMN`](/dev/reference/sql/statements/add-column.md) - - [`ADD INDEX`](/dev/reference/sql/statements/add-index.md) - - [`ADMIN`](/dev/reference/sql/statements/admin.md) - - [`ALTER DATABASE`](/dev/reference/sql/statements/alter-database.md) - - [`ALTER TABLE`](/dev/reference/sql/statements/alter-table.md) - - [`ALTER USER`](/dev/reference/sql/statements/alter-user.md) - - [`ANALYZE TABLE`](/dev/reference/sql/statements/analyze-table.md) - - [`BEGIN`](/dev/reference/sql/statements/begin.md) - - [`COMMIT`](/dev/reference/sql/statements/commit.md) - - [`CREATE DATABASE`](/dev/reference/sql/statements/create-database.md) - - [`CREATE INDEX`](/dev/reference/sql/statements/create-index.md) - - [`CREATE TABLE LIKE`](/dev/reference/sql/statements/create-table-like.md) - - [`CREATE TABLE`](/dev/reference/sql/statements/create-table.md) - - [`CREATE USER`](/dev/reference/sql/statements/create-user.md) - - [`CREATE VIEW`](/dev/reference/sql/statements/create-view.md) - - [`DEALLOCATE`](/dev/reference/sql/statements/deallocate.md) - - [`DELETE`](/dev/reference/sql/statements/delete.md) - - [`DESC`](/dev/reference/sql/statements/desc.md) - - [`DESCRIBE`](/dev/reference/sql/statements/describe.md) - - [`DO`](/dev/reference/sql/statements/do.md) - - [`DROP COLUMN`](/dev/reference/sql/statements/drop-column.md) - - [`DROP DATABASE`](/dev/reference/sql/statements/drop-database.md) - - [`DROP INDEX`](/dev/reference/sql/statements/drop-index.md) - - [`DROP TABLE`](/dev/reference/sql/statements/drop-table.md) - - [`DROP USER`](/dev/reference/sql/statements/drop-user.md) - - [`DROP VIEW`](/dev/reference/sql/statements/drop-view.md) - - [`EXECUTE`](/dev/reference/sql/statements/execute.md) - - [`EXPLAIN ANALYZE`](/dev/reference/sql/statements/explain-analyze.md) - - [`EXPLAIN`](/dev/reference/sql/statements/explain.md) - - [`FLUSH PRIVILEGES`](/dev/reference/sql/statements/flush-privileges.md) - - [`FLUSH STATUS`](/dev/reference/sql/statements/flush-status.md) - - [`FLUSH TABLES`](/dev/reference/sql/statements/flush-tables.md) - - [`GRANT `](/dev/reference/sql/statements/grant-privileges.md) - - [`INSERT`](/dev/reference/sql/statements/insert.md) - - [`KILL [TIDB]`](/dev/reference/sql/statements/kill.md) - - [`LOAD DATA`](/dev/reference/sql/statements/load-data.md) - - [`MODIFY COLUMN`](/dev/reference/sql/statements/modify-column.md) - - [`PREPARE`](/dev/reference/sql/statements/prepare.md) - - [`RECOVER TABLE`](/dev/reference/sql/statements/recover-table.md) - - [`RENAME INDEX`](/dev/reference/sql/statements/rename-index.md) - - [`RENAME TABLE`](/dev/reference/sql/statements/rename-table.md) - - [`REPLACE`](/dev/reference/sql/statements/replace.md) - - [`REVOKE `](/dev/reference/sql/statements/revoke-privileges.md) - - [`ROLLBACK`](/dev/reference/sql/statements/rollback.md) - - [`SELECT`](/dev/reference/sql/statements/select.md) - - [`SET [NAMES|CHARACTER SET]`](/dev/reference/sql/statements/set-names.md) - - [`SET PASSWORD`](/dev/reference/sql/statements/set-password.md) - - [`SET TRANSACTION`](/dev/reference/sql/statements/set-transaction.md) - - [`SET [GLOBAL|SESSION] `](/dev/reference/sql/statements/set-variable.md) - - [`SHOW CHARACTER SET`](/dev/reference/sql/statements/show-character-set.md) - - [`SHOW COLLATION`](/dev/reference/sql/statements/show-collation.md) - - [`SHOW [FULL] COLUMNS FROM`](/dev/reference/sql/statements/show-columns-from.md) - - [`SHOW CREATE TABLE`](/dev/reference/sql/statements/show-create-table.md) - - [`SHOW CREATE USER`](/dev/reference/sql/statements/show-create-user.md) - - [`SHOW DATABASES`](/dev/reference/sql/statements/show-databases.md) - - [`SHOW ENGINES`](/dev/reference/sql/statements/show-engines.md) - - [`SHOW ERRORS`](/dev/reference/sql/statements/show-errors.md) - - [`SHOW [FULL] FIELDS FROM`](/dev/reference/sql/statements/show-fields-from.md) - - [`SHOW GRANTS`](/dev/reference/sql/statements/show-grants.md) - - [`SHOW INDEXES [FROM|IN]`](/dev/reference/sql/statements/show-indexes.md) - - [`SHOW INDEX [FROM|IN]`](/dev/reference/sql/statements/show-index.md) - - [`SHOW KEYS [FROM|IN]`](/dev/reference/sql/statements/show-keys.md) - - [`SHOW PRIVILEGES`](/dev/reference/sql/statements/show-privileges.md) - - [`SHOW [FULL] PROCESSSLIST`](/dev/reference/sql/statements/show-processlist.md) - - [`SHOW SCHEMAS`](/dev/reference/sql/statements/show-schemas.md) - - [`SHOW [FULL] TABLES`](/dev/reference/sql/statements/show-tables.md) - - [`SHOW TABLE REGIONS`](/dev/reference/sql/statements/show-table-regions.md) - - [`SHOW TABLE STATUS`](/dev/reference/sql/statements/show-table-status.md) - - [`SHOW [GLOBAL|SESSION] VARIABLES`](/dev/reference/sql/statements/show-variables.md) - - [`SHOW WARNINGS`](/dev/reference/sql/statements/show-warnings.md) - - [`SPLIT REGION`](/dev/reference/sql/statements/split-region.md) - - [`START TRANSACTION`](/dev/reference/sql/statements/start-transaction.md) - - [`TRACE`](/dev/reference/sql/statements/trace.md) - - [`TRUNCATE`](/dev/reference/sql/statements/truncate.md) - - [`UPDATE`](/dev/reference/sql/statements/update.md) - - [`USE`](/dev/reference/sql/statements/use.md) - - [约束](/dev/reference/sql/constraints.md) - - [生成列](/dev/reference/sql/generated-columns.md) - - [分区表](/dev/reference/sql/partitioning.md) - - [字符集](/dev/reference/sql/character-set.md) - - [SQL 模式](/dev/reference/sql/sql-mode.md) - - [视图](/dev/reference/sql/view.md) - + 配置 - + tidb-server - - [MySQL 系统变量](/dev/reference/configuration/tidb-server/mysql-variables.md) - - [TiDB 特定系统变量](/dev/reference/configuration/tidb-server/tidb-specific-variables.md) - - [配置参数](/dev/reference/configuration/tidb-server/configuration.md) - - [配置文件描述](/dev/reference/configuration/tidb-server/configuration-file.md) - + pd-server - - [配置参数](/dev/reference/configuration/pd-server/configuration.md) - - [配置文件描述](/dev/reference/configuration/pd-server/configuration-file.md) - + tikv-server - - [配置参数](/dev/reference/configuration/tikv-server/configuration.md) - - [配置文件描述](/dev/reference/configuration/tikv-server/configuration-file.md) - + 安全 - - [与 MySQL 的安全特性差异](/dev/reference/security/compatibility.md) - - [TiDB 数据库权限管理](/dev/reference/security/privilege-system.md) - - [TiDB 用户账户管理](/dev/reference/security/user-account-management.md) - - [基于角色的访问控制](/dev/reference/security/role-based-access-control.md) - - [TiDB 证书鉴权使用指南](/dev/reference/security/cert-based-authentication.md) - + 事务 - - [事务语句](/dev/reference/transactions/overview.md) - - [事务模型](/dev/reference/transactions/transaction-model.md) - - [隔离级别](/dev/reference/transactions/transaction-isolation.md) - - [悲观事务](/dev/reference/transactions/transaction-pessimistic.md) - + 系统数据库 - - [`mysql`](/dev/reference/system-databases/mysql.md) - - [`information_schema`](/dev/reference/system-databases/information-schema.md) - - [错误码](/dev/reference/error-codes.md) - - [支持的连接器和 API](/dev/reference/supported-clients.md) - + 垃圾回收 (GC) - - [GC 机制简介](/dev/reference/garbage-collection/overview.md) - - [GC 配置](/dev/reference/garbage-collection/configuration.md) - + 性能调优 - - [SQL 优化流程](/dev/reference/performance/sql-optimizer-overview.md) - - [理解 TiDB 执行计划](/dev/reference/performance/understanding-the-query-execution-plan.md) - - [执行计划绑定](/dev/reference/performance/execution-plan-bind.md) - - [统计信息概述](/dev/reference/performance/statistics.md) - - [Optimizer Hints](/dev/reference/performance/optimizer-hints.md) - - [Follower Read](/dev/reference/performance/follower-read.md) - - [使用 SQL 语句检查 TiDB 集群状态](/dev/reference/performance/check-cluster-status-using-sql-statements.md) - - [Statement Summary Table](/dev/reference/performance/statement-summary.md) - - [TiKV 调优](/dev/reference/performance/tune-tikv.md) - - [TiDB 最佳实践](https://pingcap.com/blog-cn/tidb-best-practice/) - + 监控指标 - - [Overview 面板](/dev/reference/key-monitoring-metrics/overview-dashboard.md) - - [TiDB 面板](/dev/reference/key-monitoring-metrics/tidb-dashboard.md) - - [PD 面板](/dev/reference/key-monitoring-metrics/pd-dashboard.md) - - [TiKV 面板](/dev/reference/key-monitoring-metrics/tikv-dashboard.md) - - [报警规则](/dev/reference/alert-rules.md) - + 最佳实践 - - [HAProxy 最佳实践](/dev/reference/best-practices/haproxy.md) - - [Java 应用开发最佳实践](/dev/reference/best-practices/java-app.md) - - [高并发写入场景最佳实践](/dev/reference/best-practices/high-concurrency.md) - - [Grafana 监控最佳实践](/dev/reference/best-practices/grafana-monitor.md) - - [PD 调度策略最佳实践](/dev/reference/best-practices/pd-scheduling.md) - - [海量 Region 集群调优最佳实践](/dev/reference/best-practices/massive-regions.md) - - [乐观锁事务最佳实践](/dev/reference/best-practices/optimistic-transaction.md) - + [TiSpark 使用指南](/dev/reference/tispark.md) - + TiDB Binlog - - [概述](/dev/reference/tidb-binlog/overview.md) - - [部署使用](/dev/reference/tidb-binlog/deploy.md) - - [运维管理](/dev/reference/tidb-binlog/maintain.md) - - [版本升级](/dev/reference/tidb-binlog/upgrade.md) - - [监控告警](/dev/reference/tidb-binlog/monitor.md) - - [增量恢复](/dev/reference/tidb-binlog/reparo.md) - - [Kafka 自定义开发](/dev/reference/tidb-binlog/binlog-slave-client.md) - - [术语表](/dev/reference/tidb-binlog/glossary.md) - + 故障诊断 - - [故障诊断](/dev/reference/tidb-binlog/troubleshoot/binlog.md) - - [常见错误修复](/dev/reference/tidb-binlog/troubleshoot/error-handling.md) - - [FAQ](/dev/reference/tidb-binlog/faq.md) - + 周边工具 - - [工具使用指南](/dev/reference/tools/use-guide.md) - - [Mydumper](/dev/reference/tools/mydumper.md) - - [Loader](/dev/reference/tools/loader.md) - - [Syncer](/dev/reference/tools/syncer.md) - + Data Migration - + 概述 - - [DM 架构](/dev/reference/tools/data-migration/overview.md#dm-架构) - - [同步功能介绍](/dev/reference/tools/data-migration/overview.md#同步功能介绍) - - [使用限制](/dev/reference/tools/data-migration/overview.md#使用限制) - - [DM-worker 简介](/dev/reference/tools/data-migration/dm-worker-intro.md) - - [DM Relay Log](/dev/reference/tools/data-migration/relay-log.md) - + 核心特性 - - [Table Routing](/dev/reference/tools/data-migration/features/overview.md#table-routing) - - [Black & White Lists](/dev/reference/tools/data-migration/features/overview.md#black--white-table-lists) - - [Binlog Event Filter](/dev/reference/tools/data-migration/features/overview.md#binlog-event-filter) - - [同步延迟监控](/dev/reference/tools/data-migration/features/overview.md#同步延迟监控) - + Shard Support - - [简介](/dev/reference/tools/data-migration/features/shard-merge.md) - - [使用限制](/dev/reference/tools/data-migration/features/shard-merge.md#使用限制) - - [手动处理 Sharding DDL Lock](/dev/reference/tools/data-migration/features/manually-handling-sharding-ddl-locks.md) - + 使用场景 - - [简单的从库同步场景](/dev/reference/tools/data-migration/usage-scenarios/simple-synchronization.md) - - [分库分表合并场景](/dev/reference/tools/data-migration/usage-scenarios/shard-merge.md) - - [分表合并数据迁移最佳实践](/dev/reference/tools/data-migration/usage-scenarios/best-practice-dm-shard.md) - - [DM-worker 在上游 MySQL 主从间切换](/dev/reference/tools/data-migration/usage-scenarios/master-slave-switch.md) - + [部署使用](/dev/reference/tools/data-migration/deploy.md) - + 配置 - - [概述](/dev/reference/tools/data-migration/configure/overview.md) - - [DM-master 配置](/dev/reference/tools/data-migration/configure/dm-master-configuration-file.md) - - [DM-worker 配置](/dev/reference/tools/data-migration/configure/dm-worker-configuration-file.md) - - [任务配置](/dev/reference/tools/data-migration/configure/task-configuration-file.md) - + DM 集群管理 - - [集群操作](/dev/reference/tools/data-migration/cluster-operations.md) - - [集群升级](/dev/reference/tools/data-migration/dm-upgrade.md) - + DM 同步任务管理 - - [管理数据同步任务](/dev/reference/tools/data-migration/manage-tasks.md) - - [任务前置检查](/dev/reference/tools/data-migration/precheck.md) - - [任务状态查询](/dev/reference/tools/data-migration/query-status.md) - - [跳过或替代执行异常的 SQL 语句](/dev/reference/tools/data-migration/skip-replace-sqls.md) - - [监控 DM 集群](/dev/reference/tools/data-migration/monitor.md) - + 从与 MySQL 兼容的数据库迁移数据 - - [从 Amazon Aurora MySQL 迁移数据](/dev/how-to/migrate/from-aurora.md) - - [DM Portal](/dev/reference/tools/data-migration/dm-portal.md) - + DM 故障诊断 - - [故障诊断](/dev/reference/tools/data-migration/troubleshoot/dm.md) - - [错误含义](/dev/reference/tools/data-migration/troubleshoot/error-system.md) - - [常见错误修复](/dev/reference/tools/data-migration/troubleshoot/error-handling.md) - - [DM FAQ](/dev/reference/tools/data-migration/faq.md) - + 版本发布历史 - + v1.0 - - [1.0.2](/dev/reference/tools/data-migration/releases/1.0.2.md) - - [1.0.3](/dev/reference/tools/data-migration/releases/1.0.3.md) - - [TiDB DM 术语表](/dev/reference/tools/data-migration/glossary.md) - + TiDB Lightning - - [概述](/dev/reference/tools/tidb-lightning/overview.md) - - [部署执行](/dev/reference/tools/tidb-lightning/deployment.md) - - [参数说明](/dev/reference/tools/tidb-lightning/config.md) - - [断点续传](/dev/reference/tools/tidb-lightning/checkpoints.md) - - [表库过滤](/dev/reference/tools/tidb-lightning/table-filter.md) - - [CSV 支持](/dev/reference/tools/tidb-lightning/csv.md) - - [TiDB-backend](/dev/reference/tools/tidb-lightning/tidb-backend.md) - - [Web 界面](/dev/reference/tools/tidb-lightning/web.md) - - [监控告警](/dev/reference/tools/tidb-lightning/monitor.md) - - [故障诊断](/dev/how-to/troubleshoot/tidb-lightning.md) - - [FAQ](/dev/faq/tidb-lightning.md) - - [sync-diff-inspector](/dev/reference/tools/sync-diff-inspector/overview.md) - - [PD Control](/dev/reference/tools/pd-control.md) - - [PD Recover](/dev/reference/tools/pd-recover.md) - - [TiKV Control](/dev/reference/tools/tikv-control.md) - - [TiDB Controller](/dev/reference/tools/tidb-control.md) - - [工具下载](/dev/reference/tools/download.md) -+ TiDB in Kubernetes - - [TiDB Operator 简介](/dev/tidb-in-kubernetes/tidb-operator-overview.md) - + 快速上手 - - [kind](/dev/tidb-in-kubernetes/get-started/deploy-tidb-from-kubernetes-kind.md) - - [GKE](/dev/tidb-in-kubernetes/get-started/deploy-tidb-from-kubernetes-gke.md) - - [Minikube](/dev/tidb-in-kubernetes/get-started/deploy-tidb-from-kubernetes-minikube.md) - + 部署 - - [集群环境要求](/dev/tidb-in-kubernetes/deploy/prerequisites.md) - - [部署 TiDB Operator](/dev/tidb-in-kubernetes/deploy/tidb-operator.md) - - [标准 Kubernetes 上的 TiDB 集群](/dev/tidb-in-kubernetes/deploy/general-kubernetes.md) - - [AWS EKS 上的 TiDB 集群](/dev/tidb-in-kubernetes/deploy/aws-eks.md) - - [GCP 上的 TiDB 集群](/dev/tidb-in-kubernetes/deploy/gcp-gke.md) - - [阿里云上的 TiDB 集群](/dev/tidb-in-kubernetes/deploy/alibaba-cloud.md) - - [访问 Kubernetes 上的 TiDB 集群](/dev/tidb-in-kubernetes/deploy/access-tidb.md) - + 配置 - - [初始化集群](/dev/tidb-in-kubernetes/initialize-cluster.md) - - [监控](/dev/tidb-in-kubernetes/monitor/tidb-in-kubernetes.md) - + 运维 - - [销毁 TiDB 集群](/dev/tidb-in-kubernetes/maintain/destroy-tidb-cluster.md) - - [维护 TiDB 集群所在节点](/dev/tidb-in-kubernetes/maintain/kubernetes-node.md) - + [备份与恢复] - - [备份到 GCS](/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md) - - [从 GCS 上的备份数据进行恢复](/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md) - - [备份到 S3 兼容存储](/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md) - - [从 S3 兼容存储上的备份数据进行恢复](/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md) - - [恢复 Kubernetes 上的 TiDB 集群数据](/dev/tidb-in-kubernetes/maintain/lightning.md) - - [收集日志](/dev/tidb-in-kubernetes/maintain/log-collecting.md) - - [集群故障自动转移](/dev/tidb-in-kubernetes/maintain/auto-failover.md) - - [TiDB Binlog](/dev/tidb-in-kubernetes/maintain/tidb-binlog.md) - - [重启 TiDB 集群](/dev/tidb-in-kubernetes/maintain/restart.md) - - [扩缩容](/dev/tidb-in-kubernetes/scale-in-kubernetes.md) - + 升级 - - [TiDB 集群](/dev/tidb-in-kubernetes/upgrade/tidb-cluster.md) - - [TiDB Operator](/dev/tidb-in-kubernetes/upgrade/tidb-operator.md) - + 参考信息 - + 配置 - - [集群配置](/dev/tidb-in-kubernetes/reference/configuration/tidb-cluster.md) - - [备份配置](/dev/tidb-in-kubernetes/reference/configuration/backup.md) - - [PV 配置](/dev/tidb-in-kubernetes/reference/configuration/storage-class.md) - - [TiDB Drainer](/dev/tidb-in-kubernetes/reference/configuration/tidb-drainer.md) - + 工具 - - [tkctl](/dev/tidb-in-kubernetes/reference/tools/tkctl.md) - - [相关工具使用](/dev/tidb-in-kubernetes/reference/tools/in-kubernetes.md) - - [故障诊断](/dev/tidb-in-kubernetes/troubleshoot.md) - - [常见问题](/dev/tidb-in-kubernetes/faq.md) -+ 常见问题 (FAQ) - - [TiDB FAQ](/dev/faq/tidb.md) - - [TiDB Lightning FAQ](/dev/faq/tidb-lightning.md) - - [升级 FAQ](/dev/faq/upgrade.md) -+ 技术支持 - - [支持渠道](/dev/support-resources.md) - - [反馈问题](/dev/report-issue.md) -+ [贡献](/dev/contribute.md) - - [贡献代码](/dev/contribute.md#成为-tidb-的贡献者) - - [改进文档](/dev/contribute.md#改进文档) -+ [TiDB 路线图](/dev/roadmap.md) -+ [版本发布历史](/dev/releases/rn.md) - + v4.0 - - [4.0.0-beta](/dev/releases/4.0.0-beta.md) - + v3.1 - - [3.1.0-beta.1](/dev/releases/3.1.0-beta.1.md) - - [3.1.0-beta](/dev/releases/3.1.0-beta.md) - + v3.0 - - [3.0.9](/dev/releases/3.0.9.md) - - [3.0.8](/dev/releases/3.0.8.md) - - [3.0.7](/dev/releases/3.0.7.md) - - [3.0.6](/dev/releases/3.0.6.md) - - [3.0.5](/dev/releases/3.0.5.md) - - [3.0.4](/dev/releases/3.0.4.md) - - [3.0.3](/dev/releases/3.0.3.md) - - [3.0.2](/dev/releases/3.0.2.md) - - [3.0.1](/dev/releases/3.0.1.md) - - [3.0 GA](/dev/releases/3.0-ga.md) - - [3.0.0-rc.3](/dev/releases/3.0.0-rc.3.md) - - [3.0.0-rc.2](/dev/releases/3.0.0-rc.2.md) - - [3.0.0-rc.1](/dev/releases/3.0.0-rc.1.md) - - [3.0.0-beta.1](/dev/releases/3.0.0-beta.1.md) - - [3.0.0-beta](/dev/releases/3.0beta.md) - + v2.1 - - [2.1.19](/dev/releases/2.1.19.md) - - [2.1.18](/dev/releases/2.1.18.md) - - [2.1.17](/dev/releases/2.1.17.md) - - [2.1.16](/dev/releases/2.1.16.md) - - [2.1.15](/dev/releases/2.1.15.md) - - [2.1.14](/dev/releases/2.1.14.md) - - [2.1.13](/dev/releases/2.1.13.md) - - [2.1.12](/dev/releases/2.1.12.md) - - [2.1.11](/dev/releases/2.1.11.md) - - [2.1.10](/dev/releases/2.1.10.md) - - [2.1.9](/dev/releases/2.1.9.md) - - [2.1.8](/dev/releases/2.1.8.md) - - [2.1.7](/dev/releases/2.1.7.md) - - [2.1.6](/dev/releases/2.1.6.md) - - [2.1.5](/dev/releases/2.1.5.md) - - [2.1.4](/dev/releases/2.1.4.md) - - [2.1.3](/dev/releases/2.1.3.md) - - [2.1.2](/dev/releases/2.1.2.md) - - [2.1.1](/dev/releases/2.1.1.md) - - [2.1 GA](/dev/releases/2.1ga.md) - - [2.1 RC5](/dev/releases/21rc5.md) - - [2.1 RC4](/dev/releases/21rc4.md) - - [2.1 RC3](/dev/releases/21rc3.md) - - [2.1 RC2](/dev/releases/21rc2.md) - - [2.1 RC1](/dev/releases/21rc1.md) - - [2.1 Beta](/dev/releases/21beta.md) - + v2.0 - - [2.0.11](/dev/releases/2.0.11.md) - - [2.0.10](/dev/releases/2.0.10.md) - - [2.0.9](/dev/releases/209.md) - - [2.0.8](/dev/releases/208.md) - - [2.0.7](/dev/releases/207.md) - - [2.0.6](/dev/releases/206.md) - - [2.0.5](/dev/releases/205.md) - - [2.0.4](/dev/releases/204.md) - - [2.0.3](/dev/releases/203.md) - - [2.0.2](/dev/releases/202.md) - - [2.0.1](/dev/releases/201.md) - - [2.0](/dev/releases/2.0ga.md) - - [2.0 RC5](/dev/releases/2rc5.md) - - [2.0 RC4](/dev/releases/2rc4.md) - - [2.0 RC3](/dev/releases/2rc3.md) - - [2.0 RC1](/dev/releases/2rc1.md) - - [1.1 Beta](/dev/releases/11beta.md) - - [1.1 Alpha](/dev/releases/11alpha.md) - + v1.0 - - [1.0](/dev/releases/ga.md) - - [Pre-GA](/dev/releases/prega.md) - - [RC4](/dev/releases/rc4.md) - - [RC3](/dev/releases/rc3.md) - - [RC2](/dev/releases/rc2.md) - - [RC1](/dev/releases/rc1.md) -+ [术语表](/dev/glossary.md) diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/restore.md b/tidb-in-kubernetes/maintain/backup-and-restore/restore.md deleted file mode 100644 index 59ed67b8a302..000000000000 --- a/tidb-in-kubernetes/maintain/backup-and-restore/restore.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -title: 恢复备份数据到 Kubernetes 上的 TiDB 集群 -category: how-to ---- - -# 恢复备份数据到 Kubernetes 上的 TiDB 集群 - -本文档详细描述了如何将 Kubernetes 上通过 TiDB Operator 备份的 TiDB 集群数据恢复的具体操作过程。底层通过使用 [`loader`](/reference/tools/loader.md) 来进行集群恢复。 - -以下示例将存储在 [Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/) 上指定路径中的集群备份数据恢复到 TiDB 集群。 - -## 恢复备份的环境准备 - -1. 下载文件 [`backup-rbac.yaml`](https://github.com/pingcap/tidb-operator/blob/master/manifests/backup/backup-rbac.yaml)，并执行以下命令在 `test2` 这个 namespace 中创建恢复备份所需的 RBAC 相关资源： - - {{< copyable "shell-regular" >}} - - ```shell - kubectl apply -f backup-rbac.yaml -n test2 - ``` - -2. 创建 `restore-demo2-tidb-secret` secret，该 secret 存放用来访问 TiDB 集群的 root 账号和密钥： - - {{< copyable "shell-regular" >}} - - ```shell - kubectl create secret generic restore-demo2-tidb-secret --from-literal=user=root --from-literal=password= --namespace=test2 - ``` - -## 将指定备份恢复到 TiDB 集群 - -1. 创建 restore custom resource (CR)，将指定的备份数据恢复至 TiDB 集群： - - {{< copyable "shell-regular" >}} - - ```shell - kubectl apply -f restore.yaml - ``` - - `restore.yaml` 文件内容如下： - - ```yaml - --- - apiVersion: pingcap.com/v1alpha1 - kind: Restore - metadata: - name: demo2-restore - namespace: test2 - spec: - to: - host: - port: - user: - secretName: restore-demo2-tidb-secret - gcs: - projectId: - secretName: gcs-secret - path: gcs:// - storageClassName: local-storage - storageSize: 1Gi - ``` - -2. 创建好 `Restore` CR 后可通过以下命令查看恢复的状态： - - {{< copyable "shell-regular" >}} - - ```shell - kubectl get rt -n test2 -owide - ``` - -以上示例将存储在 GCS 上指定路径 `spec.gcs.path` 的备份数据恢复到 TiDB 集群 `spec.to.host`。关于 GCS 的配置项可以参考 [backup-gcs.yaml](/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md#备份数据到-gcs) 中的配置。 - -更多 `Restore` CR 字段的详细解释： - -`.spec.metadata.namespace`： `Restore` CR 所在的 namespace。 - -`.spec.to.host`：需要恢复的 TiDB 集群的访问地址。 - -`.spec.to.port`：需要恢复的 TiDB 集群访问的端口。 - -`.spec.to.user`：需要恢复的 TiDB 集群的访问用户。 - -`.spec.to.tidbSecretName`：需要恢复的 TiDB 集群所需凭证的 secret。 - -`.spec.storageClassName`：指定恢复时所需的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值（默认为 `standard`）。 - -`.spec.storageSize`：恢复集群时指定所需的 PV 大小。这个值应大于备份 TiDB 集群数据的大小。 From d4b781e7514fbb268442f6a8c3b8db934f6c0bc5 Mon Sep 17 00:00:00 2001 From: yikeke Date: Sun, 23 Feb 2020 13:07:45 +0800 Subject: [PATCH 07/16] fix links --- TOC.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/TOC.md b/TOC.md index ff17eefdbb83..773b024ce677 100644 --- a/TOC.md +++ b/TOC.md @@ -380,10 +380,10 @@ - [销毁 TiDB 集群](/tidb-in-kubernetes/maintain/destroy-tidb-cluster.md) - [维护 TiDB 集群所在节点](/tidb-in-kubernetes/maintain/kubernetes-node.md) + [备份与恢复] - - [备份到 GCS](/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md) - - [从 GCS 上的备份数据进行恢复](/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md) - - [备份到 S3 兼容存储](/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md) - - [从 S3 兼容存储上的备份数据进行恢复](/dev/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md) + - [备份到 GCS](/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md) + - [从 GCS 上的备份数据进行恢复](/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md) + - [备份到 S3 兼容存储](/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md) + - [从 S3 兼容存储上的备份数据进行恢复](/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md) - [恢复 Kubernetes 上的 TiDB 集群数据](/tidb-in-kubernetes/maintain/lightning.md) - [收集日志](/tidb-in-kubernetes/maintain/log-collecting.md) - [集群故障自动转移](/tidb-in-kubernetes/maintain/auto-failover.md) From ebe4141f9306d3e33b92e44cf862c0e6a7c961f3 Mon Sep 17 00:00:00 2001 From: yikeke Date: Sun, 23 Feb 2020 13:09:12 +0800 Subject: [PATCH 08/16] fix links --- tidb-in-kubernetes/maintain/backup-and-restore/restore-gcp.md | 2 +- tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcp.md b/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcp.md index 59ed67b8a302..2caec6e2b630 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcp.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcp.md @@ -68,7 +68,7 @@ category: how-to kubectl get rt -n test2 -owide ``` -以上示例将存储在 GCS 上指定路径 `spec.gcs.path` 的备份数据恢复到 TiDB 集群 `spec.to.host`。关于 GCS 的配置项可以参考 [backup-gcs.yaml](/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md#备份数据到-gcs) 中的配置。 +以上示例将存储在 GCS 上指定路径 `spec.gcs.path` 的备份数据恢复到 TiDB 集群 `spec.to.host`。关于 GCS 的配置项可以参考 [backup-gcs.yaml](/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md#备份数据到-gcs) 中的配置。 更多 `Restore` CR 字段的详细解释： diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md b/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md index bdd5ef45ab51..6422b7abd42b 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md @@ -5,7 +5,7 @@ category: how-to # 恢复备份数据到 Kubernetes 上的 TiDB 集群 -本文档描述了如何将 Kubernetes 上通过 TiDB Operator 备份的数据恢复到 TiDB 集群的操作过程。底层通过使用 [`loader`](/dev/reference/tools/loader.md) 来恢复数据。 +本文档描述了如何将 Kubernetes 上通过 TiDB Operator 备份的数据恢复到 TiDB 集群的操作过程。底层通过使用 [`loader`](/reference/tools/loader.md) 来恢复数据。 以下示例将兼容 S3 的存储（指定路径）上的备份数据恢复到 TiDB 集群。 @@ -69,7 +69,7 @@ category: how-to kubectl get rt -n test2 -owide ``` -以上示例将兼容 S3 的存储（`spec.s3.path` 路径下）中的备份数据恢复到 TiDB 集群 (`spec.to.host` )。有关兼容 S3 的存储的配置项，可以参考 [backup-s3.yaml](/dev/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md#备份数据到兼容-s3-的存储)。 +以上示例将兼容 S3 的存储（`spec.s3.path` 路径下）中的备份数据恢复到 TiDB 集群 (`spec.to.host` )。有关兼容 S3 的存储的配置项，可以参考 [backup-s3.yaml](/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md#备份数据到兼容-s3-的存储)。 更多 `Restore` CR 字段的详细解释： From 0ff3f9bc2683b3afbc22ec999dfc11843abcf7e7 Mon Sep 17 00:00:00 2001 From: luolibin Date: Thu, 27 Feb 2020 12:30:29 +0800 Subject: [PATCH 09/16] address comments --- TOC.md | 3 ++- tidb-in-kubernetes/maintain/backup-and-restore.md | 2 +- tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md | 2 +- tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md | 2 +- .../backup-and-restore/{restore-gcp.md => restore-gcs.md} | 4 ++-- tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md | 4 ++-- 6 files changed, 9 insertions(+), 8 deletions(-) rename tidb-in-kubernetes/maintain/backup-and-restore/{restore-gcp.md => restore-gcs.md} (91%) diff --git a/TOC.md b/TOC.md index fc828cf6a0e9..d9d415266c51 100644 --- a/TOC.md +++ b/TOC.md @@ -381,7 +381,8 @@ + 运维 - [销毁 TiDB 集群](/tidb-in-kubernetes/maintain/destroy-tidb-cluster.md) - [维护 TiDB 集群所在节点](/tidb-in-kubernetes/maintain/kubernetes-node.md) - + [备份与恢复] + - [基于 charts 的备份恢复](/tidb-in-kubernetes/maintain/backup-and-restore.md) + + [基于 CRD 的备份与恢复] - [备份到 GCS](/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md) - [从 GCS 上的备份数据进行恢复](/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md) - [备份到 S3 兼容存储](/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md) diff --git a/tidb-in-kubernetes/maintain/backup-and-restore.md b/tidb-in-kubernetes/maintain/backup-and-restore.md index 15b797efac0c..8c5d6764305d 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore.md @@ -5,7 +5,7 @@ category: how-to # Kubernetes 上的 TiDB 集群备份与恢复 -这篇文档详细描述了如何对 Kubernetes 上的 TiDB 集群进行数据备份和数据恢复。 +这篇文档详细描述了如何对 Kubernetes 上的 TiDB 集群进行数据备份和数据恢复。这里使用的备份恢复方式是基于 charts 实现，新版基于 CRD 的备份恢复方式参考 [这里](/tidb-in-kubernetes/maintain/backup-and-restore) Kubernetes 上的 TiDB 集群支持两种备份策略： diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md b/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md index b77fc9ec538e..c15ee858b3ef 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md @@ -5,7 +5,7 @@ category: how-to # 在 Kubernetes 上备份 TiDB 集群到 GCS -本文档详细描述了如何将 Kubernetes 上 TiDB 集群的数据备份到 [Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/) 上。本文档中的“备份”，均是指全量备份（Ad-hoc 全量备份和定时全量备份），底层通过使用 [`mydumper`](/reference/tools/mydumper.md) 获取集群的逻辑备份，然后再将备份数据上传到远端 GCS。 +本文档详细描述了如何将 Kubernetes 上 TiDB 集群的数据备份到 [Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/) 上。本文档中的“备份”，均是指全量备份（Ad-hoc 全量备份和定时全量备份），底层通过使用 [`mydumper`](/reference/tools/mydumper.md) 获取集群的逻辑备份，然后再将备份数据上传到远端 GCS。这里使用的备份恢复方式基于 TiDB Operator 新版 (大于等于 v1.1) 的 CRD 实现，基于 charts 的备份恢复方式参考 [这里](/tidb-in-kubernetes/maintain/backup-and-restore.md)。 ## Ad-hoc 全量备份 diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md b/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md index 46509a100eee..423158d6880e 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md @@ -5,7 +5,7 @@ category: how-to # 在 Kubernetes 上备份 TiDB 集群到兼容 S3 的存储 -这篇文档详细描述了如何将 Kubernetes 上的 TiDB 集群数据备份到兼容 S3 的存储上。本文档中的“备份”，均是指全量备份（Ad-hoc 全量备份和定时全量备份）。底层通过使用 [`mydumper`](/reference/tools/mydumper.md) 获取集群的逻辑备份，然后在将备份数据上传到兼容 S3 的存储上。 +这篇文档详细描述了如何将 Kubernetes 上的 TiDB 集群数据备份到兼容 S3 的存储上。本文档中的“备份”，均是指全量备份（Ad-hoc 全量备份和定时全量备份）。底层通过使用 [`mydumper`](/reference/tools/mydumper.md) 获取集群的逻辑备份，然后在将备份数据上传到兼容 S3 的存储上。这里使用的备份恢复方式基于 TiDB Operator 新版 (大于等于 v1.1) 的 CRD 实现，基于 charts 备份恢复方式参考 [这里](/tidb-in-kubernetes/maintain/backup-and-restore.md)。 ## Ad-hoc 全量备份 diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcp.md b/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md similarity index 91% rename from tidb-in-kubernetes/maintain/backup-and-restore/restore-gcp.md rename to tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md index 2caec6e2b630..d9cad353273f 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcp.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md @@ -1,11 +1,11 @@ --- -title: 恢复备份数据到 Kubernetes 上的 TiDB 集群 +title: 恢复 GCS 上的备份数据到 Kubernetes 上的 TiDB 集群 category: how-to --- # 恢复备份数据到 Kubernetes 上的 TiDB 集群 -本文档详细描述了如何将 Kubernetes 上通过 TiDB Operator 备份的 TiDB 集群数据恢复的具体操作过程。底层通过使用 [`loader`](/reference/tools/loader.md) 来进行集群恢复。 +本文档详细描述了如何将 Kubernetes 上通过 TiDB Operator 备份的 TiDB 集群数据恢复的具体操作过程。底层通过使用 [`loader`](/reference/tools/loader.md) 来进行集群恢复。这里使用的备份方式基于 TiDB Operator 新版 (大于等于 v1.1) 的 CRD 实现，基于 charts 的备份恢复方式参考 [这里](/tidb-in-kubernetes/maintain/backup-and-restore.md)。 以下示例将存储在 [Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/) 上指定路径中的集群备份数据恢复到 TiDB 集群。 diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md b/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md index 6422b7abd42b..7d3f8e2fcb25 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md @@ -1,11 +1,11 @@ --- -title: 恢复备份数据到 Kubernetes 上的 TiDB 集群 +title: 恢复 S3 兼容存储上的备份数据到 Kubernetes 上的 TiDB 集群 category: how-to --- # 恢复备份数据到 Kubernetes 上的 TiDB 集群 -本文档描述了如何将 Kubernetes 上通过 TiDB Operator 备份的数据恢复到 TiDB 集群的操作过程。底层通过使用 [`loader`](/reference/tools/loader.md) 来恢复数据。 +本文档描述了如何将 Kubernetes 上通过 TiDB Operator 备份的数据恢复到 TiDB 集群的操作过程。底层通过使用 [`loader`](/reference/tools/loader.md) 来恢复数据。这里使用的备份方式基于 TiDB Operator 新版 (大于等于 v1.1) 的 CRD 实现，基于 charts 的备份恢复方式参考 [这里](/tidb-in-kubernetes/maintain/backup-and-restore.md)。 以下示例将兼容 S3 的存储（指定路径）上的备份数据恢复到 TiDB 集群。 From a455df00a9fcefb2febfa529d06a2659f1609aaa Mon Sep 17 00:00:00 2001 From: yikeke Date: Thu, 27 Feb 2020 12:40:02 +0800 Subject: [PATCH 10/16] Update TOC.md --- TOC.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/TOC.md b/TOC.md index d9d415266c51..49a93e5eb697 100644 --- a/TOC.md +++ b/TOC.md @@ -381,12 +381,13 @@ + 运维 - [销毁 TiDB 集群](/tidb-in-kubernetes/maintain/destroy-tidb-cluster.md) - [维护 TiDB 集群所在节点](/tidb-in-kubernetes/maintain/kubernetes-node.md) - - [基于 charts 的备份恢复](/tidb-in-kubernetes/maintain/backup-and-restore.md) - + [基于 CRD 的备份与恢复] - - [备份到 GCS](/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md) - - [从 GCS 上的备份数据进行恢复](/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md) - - [备份到 S3 兼容存储](/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md) - - [从 S3 兼容存储上的备份数据进行恢复](/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md) + + 备份与恢复 + - [基于 charts 的备份恢复](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md) + + 基于 CRD 的备份恢复 + - [备份到 GCS](/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md) + - [从 GCS 上的备份数据进行恢复](/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md) + - [备份到 S3 兼容存储](/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md) + - [从 S3 兼容存储上的备份数据进行恢复](/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md) - [恢复 Kubernetes 上的 TiDB 集群数据](/tidb-in-kubernetes/maintain/lightning.md) - [收集日志](/tidb-in-kubernetes/maintain/log-collecting.md) - [集群故障自动转移](/tidb-in-kubernetes/maintain/auto-failover.md) From 729ffd2fa0e06cb280a3376e33e7482bf7249b10 Mon Sep 17 00:00:00 2001 From: luolibin Date: Thu, 27 Feb 2020 12:43:10 +0800 Subject: [PATCH 11/16] tiny fix --- TOC.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TOC.md b/TOC.md index 49a93e5eb697..bb4d60e0999f 100644 --- a/TOC.md +++ b/TOC.md @@ -382,7 +382,7 @@ - [销毁 TiDB 集群](/tidb-in-kubernetes/maintain/destroy-tidb-cluster.md) - [维护 TiDB 集群所在节点](/tidb-in-kubernetes/maintain/kubernetes-node.md) + 备份与恢复 - - [基于 charts 的备份恢复](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md) + - [基于 charts 的备份恢复](/tidb-in-kubernetes/maintain/backup-and-restore.md) + 基于 CRD 的备份恢复 - [备份到 GCS](/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md) - [从 GCS 上的备份数据进行恢复](/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md) From cd8dc8bbb1c8ad43aba1bdc4ca0e6ca735fc0412 Mon Sep 17 00:00:00 2001 From: yikeke Date: Thu, 27 Feb 2020 12:51:30 +0800 Subject: [PATCH 12/16] relocate charts file --- TOC.md | 2 +- .../{backup-and-restore.md => backup-and-restore/charts.md} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename tidb-in-kubernetes/maintain/{backup-and-restore.md => backup-and-restore/charts.md} (100%) diff --git a/TOC.md b/TOC.md index bb4d60e0999f..49a93e5eb697 100644 --- a/TOC.md +++ b/TOC.md @@ -382,7 +382,7 @@ - [销毁 TiDB 集群](/tidb-in-kubernetes/maintain/destroy-tidb-cluster.md) - [维护 TiDB 集群所在节点](/tidb-in-kubernetes/maintain/kubernetes-node.md) + 备份与恢复 - - [基于 charts 的备份恢复](/tidb-in-kubernetes/maintain/backup-and-restore.md) + - [基于 charts 的备份恢复](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md) + 基于 CRD 的备份恢复 - [备份到 GCS](/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md) - [从 GCS 上的备份数据进行恢复](/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md) diff --git a/tidb-in-kubernetes/maintain/backup-and-restore.md b/tidb-in-kubernetes/maintain/backup-and-restore/charts.md similarity index 100% rename from tidb-in-kubernetes/maintain/backup-and-restore.md rename to tidb-in-kubernetes/maintain/backup-and-restore/charts.md From c911d169125263c1c898ce440670bdee4613ab02 Mon Sep 17 00:00:00 2001 From: yikeke Date: Thu, 27 Feb 2020 13:06:11 +0800 Subject: [PATCH 13/16] refine and unity titles in TOC and docs; fix links --- TOC.md | 4 ++-- .../maintain/backup-and-restore/backup-gcs.md | 8 +++++--- .../maintain/backup-and-restore/backup-s3.md | 8 +++++--- .../maintain/backup-and-restore/charts.md | 13 ++++++++++--- .../maintain/backup-and-restore/restore-gcs.md | 8 +++++--- .../maintain/backup-and-restore/restore-s3.md | 8 +++++--- 6 files changed, 32 insertions(+), 17 deletions(-) diff --git a/TOC.md b/TOC.md index 49a93e5eb697..7871dfbe2598 100644 --- a/TOC.md +++ b/TOC.md @@ -384,9 +384,9 @@ + 备份与恢复 - [基于 charts 的备份恢复](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md) + 基于 CRD 的备份恢复 - - [备份到 GCS](/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md) + - [备份 TiDB 集群到 GCS](/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md) - [从 GCS 上的备份数据进行恢复](/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md) - - [备份到 S3 兼容存储](/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md) + - [备份 TiDB 集群到兼容 S3 的存储](/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md) - [从 S3 兼容存储上的备份数据进行恢复](/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md) - [恢复 Kubernetes 上的 TiDB 集群数据](/tidb-in-kubernetes/maintain/lightning.md) - [收集日志](/tidb-in-kubernetes/maintain/log-collecting.md) diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md b/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md index c15ee858b3ef..38b4b5175f26 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md @@ -1,11 +1,13 @@ --- -title: 在 Kubernetes 上备份 TiDB 集群到 GCS +title: 备份 TiDB 集群到 GCS category: how-to --- -# 在 Kubernetes 上备份 TiDB 集群到 GCS +# 备份 TiDB 集群到 GCS -本文档详细描述了如何将 Kubernetes 上 TiDB 集群的数据备份到 [Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/) 上。本文档中的“备份”，均是指全量备份（Ad-hoc 全量备份和定时全量备份），底层通过使用 [`mydumper`](/reference/tools/mydumper.md) 获取集群的逻辑备份，然后再将备份数据上传到远端 GCS。这里使用的备份恢复方式基于 TiDB Operator 新版 (大于等于 v1.1) 的 CRD 实现，基于 charts 的备份恢复方式参考 [这里](/tidb-in-kubernetes/maintain/backup-and-restore.md)。 +本文档详细描述了如何将 Kubernetes 上 TiDB 集群的数据备份到 [Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/) 上。本文档中的“备份”，均是指全量备份（Ad-hoc 全量备份和定时全量备份），底层通过使用 [`mydumper`](/reference/tools/mydumper.md) 获取集群的逻辑备份，然后再将备份数据上传到远端 GCS。 + +本文使用的备份恢复方式基于 TiDB Operator 新版（大于等于 v1.1）的 CRD 实现，基于 charts 的备份恢复方式参考[这里](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md)。 ## Ad-hoc 全量备份 diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md b/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md index 423158d6880e..7a1f22610b94 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md @@ -1,11 +1,13 @@ --- -title: 在 Kubernetes 上备份 TiDB 集群到兼容 S3 的存储 +title: 备份 TiDB 集群到兼容 S3 的存储 category: how-to --- -# 在 Kubernetes 上备份 TiDB 集群到兼容 S3 的存储 +# 备份 TiDB 集群到兼容 S3 的存储 -这篇文档详细描述了如何将 Kubernetes 上的 TiDB 集群数据备份到兼容 S3 的存储上。本文档中的“备份”，均是指全量备份（Ad-hoc 全量备份和定时全量备份）。底层通过使用 [`mydumper`](/reference/tools/mydumper.md) 获取集群的逻辑备份，然后在将备份数据上传到兼容 S3 的存储上。这里使用的备份恢复方式基于 TiDB Operator 新版 (大于等于 v1.1) 的 CRD 实现，基于 charts 备份恢复方式参考 [这里](/tidb-in-kubernetes/maintain/backup-and-restore.md)。 +本文详细描述了如何将 Kubernetes 上的 TiDB 集群数据备份到兼容 S3 的存储上。本文档中的“备份”，均是指全量备份（Ad-hoc 全量备份和定时全量备份）。底层通过使用 [`mydumper`](/reference/tools/mydumper.md) 获取集群的逻辑备份，然后在将备份数据上传到兼容 S3 的存储上。 + +本文使用的备份恢复方式基于 TiDB Operator 新版（大于等于 v1.1）的 CRD 实现，基于 charts 备份恢复方式参考[这里](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md)。 ## Ad-hoc 全量备份 diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/charts.md b/tidb-in-kubernetes/maintain/backup-and-restore/charts.md index 8c5d6764305d..e1debd2f1a3c 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore/charts.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore/charts.md @@ -1,11 +1,18 @@ --- -title: Kubernetes 上的 TiDB 集群备份恢复 +title: 基于 charts 实现的 TiDB 集群备份恢复 category: how-to --- -# Kubernetes 上的 TiDB 集群备份与恢复 +# 基于 charts 实现的 TiDB 集群备份与恢复 -这篇文档详细描述了如何对 Kubernetes 上的 TiDB 集群进行数据备份和数据恢复。这里使用的备份恢复方式是基于 charts 实现，新版基于 CRD 的备份恢复方式参考 [这里](/tidb-in-kubernetes/maintain/backup-and-restore) +本文详细描述了如何对 Kubernetes 上的 TiDB 集群进行数据备份和数据恢复。本文使用的备份恢复方式是基于 charts 实现。 + +新版基于 CRD 的备份恢复方式参考： + +- [备份 TiDB 集群到 GCS](/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md) +- [从 GCS 上的备份数据进行恢复](/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md) +- [备份 TiDB 集群到兼容 S3 的存储](/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md) +- [从 S3 兼容存储上的备份数据进行恢复](/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md) Kubernetes 上的 TiDB 集群支持两种备份策略： diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md b/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md index d9cad353273f..18fbd04f6e66 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md @@ -1,11 +1,13 @@ --- -title: 恢复 GCS 上的备份数据到 Kubernetes 上的 TiDB 集群 +title: 从 GCS 上的备份数据进行恢复 category: how-to --- -# 恢复备份数据到 Kubernetes 上的 TiDB 集群 +# 从 GCS 上的备份数据进行恢复 -本文档详细描述了如何将 Kubernetes 上通过 TiDB Operator 备份的 TiDB 集群数据恢复的具体操作过程。底层通过使用 [`loader`](/reference/tools/loader.md) 来进行集群恢复。这里使用的备份方式基于 TiDB Operator 新版 (大于等于 v1.1) 的 CRD 实现，基于 charts 的备份恢复方式参考 [这里](/tidb-in-kubernetes/maintain/backup-and-restore.md)。 +本文详细描述了如何将 Kubernetes 上通过 TiDB Operator 备份的 TiDB 集群数据恢复的具体操作过程。底层通过使用 [`loader`](/reference/tools/loader.md) 来进行集群恢复。 + +本文使用的备份方式基于 TiDB Operator 新版（大于等于 v1.1）的 CRD 实现，基于 charts 的备份恢复方式参考 [这里](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md)。 以下示例将存储在 [Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/) 上指定路径中的集群备份数据恢复到 TiDB 集群。 diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md b/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md index 7d3f8e2fcb25..30f32163cd64 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md @@ -1,11 +1,13 @@ --- -title: 恢复 S3 兼容存储上的备份数据到 Kubernetes 上的 TiDB 集群 +title: 从 S3 兼容存储上的备份数据进行恢复 category: how-to --- -# 恢复备份数据到 Kubernetes 上的 TiDB 集群 +# 从 S3 兼容存储上的备份数据进行恢复 -本文档描述了如何将 Kubernetes 上通过 TiDB Operator 备份的数据恢复到 TiDB 集群的操作过程。底层通过使用 [`loader`](/reference/tools/loader.md) 来恢复数据。这里使用的备份方式基于 TiDB Operator 新版 (大于等于 v1.1) 的 CRD 实现，基于 charts 的备份恢复方式参考 [这里](/tidb-in-kubernetes/maintain/backup-and-restore.md)。 +本文描述了如何将 Kubernetes 上通过 TiDB Operator 备份的数据恢复到 TiDB 集群的操作过程。底层通过使用 [`loader`](/reference/tools/loader.md) 来恢复数据。 + +本文使用的备份方式基于 TiDB Operator 新版（大于等于 v1.1）的 CRD 实现，基于 charts 的备份恢复方式参考[这里](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md)。 以下示例将兼容 S3 的存储（指定路径）上的备份数据恢复到 TiDB 集群。 From aca9d7bf16bddde3c8d2d19c9a5d9e6e7d9a514c Mon Sep 17 00:00:00 2001 From: TomShawn <1135243111@qq.com> Date: Thu, 27 Feb 2020 14:48:49 +0800 Subject: [PATCH 14/16] *: add an alias, fix dead links, refine format & language --- TOC.md | 6 ++-- reference/tools/user-guide.md | 4 +-- .../maintain/backup-and-restore/backup-gcs.md | 22 +++++--------- .../maintain/backup-and-restore/backup-s3.md | 22 +++++--------- .../maintain/backup-and-restore/charts.md | 13 ++++---- .../backup-and-restore/restore-gcs.md | 30 ++++++++----------- .../maintain/backup-and-restore/restore-s3.md | 30 ++++++++----------- .../reference/configuration/storage-class.md | 2 +- tidb-in-kubernetes/tidb-operator-overview.md | 2 +- 9 files changed, 54 insertions(+), 77 deletions(-) diff --git a/TOC.md b/TOC.md index 7871dfbe2598..1c80b19a8d43 100644 --- a/TOC.md +++ b/TOC.md @@ -382,12 +382,12 @@ - [销毁 TiDB 集群](/tidb-in-kubernetes/maintain/destroy-tidb-cluster.md) - [维护 TiDB 集群所在节点](/tidb-in-kubernetes/maintain/kubernetes-node.md) + 备份与恢复 - - [基于 charts 的备份恢复](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md) + - [基于 Helm Charts 的备份恢复](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md) + 基于 CRD 的备份恢复 - [备份 TiDB 集群到 GCS](/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md) - - [从 GCS 上的备份数据进行恢复](/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md) + - [恢复 GCS 上的备份数据](/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md) - [备份 TiDB 集群到兼容 S3 的存储](/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md) - - [从 S3 兼容存储上的备份数据进行恢复](/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md) + - [恢复 S3 兼容存储上的备份数据](/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md) - [恢复 Kubernetes 上的 TiDB 集群数据](/tidb-in-kubernetes/maintain/lightning.md) - [收集日志](/tidb-in-kubernetes/maintain/log-collecting.md) - [集群故障自动转移](/tidb-in-kubernetes/maintain/auto-failover.md) diff --git a/reference/tools/user-guide.md b/reference/tools/user-guide.md index d7627ffb5afe..56ac3cc9d3de 100644 --- a/reference/tools/user-guide.md +++ b/reference/tools/user-guide.md @@ -28,7 +28,7 @@ TiDB 生态工具可以分为几种： - Loader 的输入：Mydumper 输出的文件 - Loader 的输出：以 SQL 形式写入 TiDB - 适用 TiDB 版本：所有版本 -- Kubernetes 支持：[备份与恢复](/tidb-in-kubernetes/maintain/backup-and-restore.md) +- Kubernetes 支持：[备份与恢复](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md) #### 全量导入工具 TiDB Lightning @@ -90,7 +90,7 @@ TiDB 生态工具可以分为几种： - Mydumper 的输入：MySQL/TiDB 集群 - Mydumper 的输出：SQL 文件 - 适用 TiDB 版本：所有版本 -- Kubernetes 支持：[备份与恢复](/tidb-in-kubernetes/maintain/backup-and-restore.md) +- Kubernetes 支持：[备份与恢复](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md) #### 增量导出工具 TiDB Binlog diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md b/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md index 38b4b5175f26..28dc2e1b48cb 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md @@ -7,7 +7,7 @@ category: how-to 本文档详细描述了如何将 Kubernetes 上 TiDB 集群的数据备份到 [Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/) 上。本文档中的“备份”，均是指全量备份（Ad-hoc 全量备份和定时全量备份），底层通过使用 [`mydumper`](/reference/tools/mydumper.md) 获取集群的逻辑备份，然后再将备份数据上传到远端 GCS。 -本文使用的备份恢复方式基于 TiDB Operator 新版（大于等于 v1.1）的 CRD 实现，基于 charts 的备份恢复方式参考[这里](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md)。 +本文使用的备份恢复方式基于 TiDB Operator 新版（v1.1 及以上）的 CRD 实现的。基于 Helm Charts 的备份恢复方式可参考[基于 Helm Charts 实现的 TiDB 集群备份与恢复](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md)。 ## Ad-hoc 全量备份 @@ -122,19 +122,13 @@ GCS 支持以下几种 bucket ACL 策略： 更多 `Backup` CR 字段的详细解释： -`.spec.metadata.namespace`：`Backup` CR 所在的 namespace。 - -`.spec.from.host`：需备份的 TiDB 集群的访问地址。 - -`.spec.from.port`：需要备份的 TiDB 集群的访问端口。 - -`.spec.from.user`：需要备份的 TiDB 集群的访问用户。 - -`.spec.from.tidbSecretName`：需要备份的 TiDB 集群所需凭证的 secret。 - -`.spec.storageClassName`：备份时指定所需的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值，这个值默认为 `standard`。 - -`.spec.storageSize`：备份时指定所需的 PV 大小。该值应大于备份 TiDB 集群数据的大小。 +* `.spec.metadata.namespace`：`Backup` CR 所在的 namespace。 +* `.spec.from.host`：待备份 TiDB 集群的访问地址。 +* `.spec.from.port`：待备份 TiDB 集群的访问端口。 +* `.spec.from.user`：待备份 TiDB 集群的访问用户。 +* `.spec.from.tidbSecretName`：待备份 TiDB 集群所需凭证的 secret。 +* `.spec.storageClassName`：备份时指定所需的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值，该值默认为 `standard`。 +* `.spec.storageSize`：备份时指定所需的 PV 大小。该值应大于备份 TiDB 集群数据的大小。 ## 定时全量备份 diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md b/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md index 7a1f22610b94..6a780b81aa05 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md @@ -7,7 +7,7 @@ category: how-to 本文详细描述了如何将 Kubernetes 上的 TiDB 集群数据备份到兼容 S3 的存储上。本文档中的“备份”，均是指全量备份（Ad-hoc 全量备份和定时全量备份）。底层通过使用 [`mydumper`](/reference/tools/mydumper.md) 获取集群的逻辑备份，然后在将备份数据上传到兼容 S3 的存储上。 -本文使用的备份恢复方式基于 TiDB Operator 新版（大于等于 v1.1）的 CRD 实现，基于 charts 备份恢复方式参考[这里](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md)。 +本文使用的备份恢复方式基于 TiDB Operator 新版（v1.1 及以上）的 CRD 实现。基于 Helm Charts 实现的备份恢复方式可参考[基于 Helm Charts 实现的 TiDB 集群备份与恢复](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md)。 ## Ad-hoc 全量备份 @@ -142,19 +142,13 @@ Amazon S3 支持以下几种 storageClass 类型： 更多 `Backup` CR 字段的详细解释: -`.spec.metadata.namespace`：`Backup` CR 所在的 namespace。 - -`.spec.from.host`：需要备份的 TiDB 集群的访问地址。 - -`.spec.from.port`：需要备份的 TiDB 集群的访问端口。 - -`.spec.from.user`：需要备份的 TiDB 集群的访问用户。 - -`.spec.from.tidbSecretName`：需要备份的 TiDB 集群所需凭证的 secret。 - -`.spec.storageClassName`: 备份时所需的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值，这个值默认为 `standard`。 - -`.spec.storageSize`: 备份时指定所需的 PV 大小。这个值要大于备份 TiDB 集群的数据大小。 +* `.spec.metadata.namespace`：`Backup` CR 所在的 namespace。 +* `.spec.from.host`：待备份 TiDB 集群的访问地址。 +* `.spec.from.port`：待备份 TiDB 集群的访问端口。 +* `.spec.from.user`：待备份 TiDB 集群的访问用户。 +* `.spec.from.tidbSecretName`：待备份 TiDB 集群所需凭证的 secret。 +* `.spec.storageClassName`: 备份时所需的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值，该值默认为 `standard`。 +* `.spec.storageSize`: 备份时指定所需的 PV 大小。该值须大于备份 TiDB 集群的数据大小。 更多支持的兼容 S3 的 `provider` 如下： diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/charts.md b/tidb-in-kubernetes/maintain/backup-and-restore/charts.md index e1debd2f1a3c..a743cdb54628 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore/charts.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore/charts.md @@ -1,18 +1,19 @@ --- -title: 基于 charts 实现的 TiDB 集群备份恢复 +title: 基于 Helm Charts 实现的 TiDB 集群备份恢复 category: how-to +aliases: ['/docs-cn/dev/tidb-in-kubernetes/maintain/backup-and-store/'] --- -# 基于 charts 实现的 TiDB 集群备份与恢复 +# 基于 Helm Charts 实现的 TiDB 集群备份与恢复 -本文详细描述了如何对 Kubernetes 上的 TiDB 集群进行数据备份和数据恢复。本文使用的备份恢复方式是基于 charts 实现。 +本文详细描述了如何对 Kubernetes 上的 TiDB 集群进行数据备份和数据恢复。本文使用的备份恢复方式是基于 Helm Charts 实现的。 -新版基于 CRD 的备份恢复方式参考： +新版则基于 CRD 的备份恢复方式实现，详情可参阅以下文档： - [备份 TiDB 集群到 GCS](/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md) -- [从 GCS 上的备份数据进行恢复](/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md) +- [恢复 GCS 上的备份数据](/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md) - [备份 TiDB 集群到兼容 S3 的存储](/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md) -- [从 S3 兼容存储上的备份数据进行恢复](/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md) +- [恢复 S3 兼容存储上的备份数据](/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md) Kubernetes 上的 TiDB 集群支持两种备份策略： diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md b/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md index 18fbd04f6e66..2a2050cb9bd7 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md @@ -1,13 +1,13 @@ --- -title: 从 GCS 上的备份数据进行恢复 +title: 恢复 GCS 上的备份数据 category: how-to --- -# 从 GCS 上的备份数据进行恢复 +# 恢复 GCS 上的备份数据 -本文详细描述了如何将 Kubernetes 上通过 TiDB Operator 备份的 TiDB 集群数据恢复的具体操作过程。底层通过使用 [`loader`](/reference/tools/loader.md) 来进行集群恢复。 +本文详细描述了将 Kubernetes 上通过 TiDB Operator 备份的 TiDB 集群数据恢复的具体操作过程。底层通过使用 [`loader`](/reference/tools/loader.md) 来进行集群恢复。 -本文使用的备份方式基于 TiDB Operator 新版（大于等于 v1.1）的 CRD 实现，基于 charts 的备份恢复方式参考 [这里](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md)。 +本文使用的备份方式基于 TiDB Operator 新版（v1.1 及以上）的 CRD 实现的。基于 Helm Charts 实现的备份恢复方式可参考[基于 Helm Charts 实现的 TiDB 集群备份与恢复](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md)。 以下示例将存储在 [Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/) 上指定路径中的集群备份数据恢复到 TiDB 集群。 @@ -72,18 +72,12 @@ category: how-to 以上示例将存储在 GCS 上指定路径 `spec.gcs.path` 的备份数据恢复到 TiDB 集群 `spec.to.host`。关于 GCS 的配置项可以参考 [backup-gcs.yaml](/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md#备份数据到-gcs) 中的配置。 -更多 `Restore` CR 字段的详细解释： +更多 `Restore` CR 字段的详细解释如下： -`.spec.metadata.namespace`： `Restore` CR 所在的 namespace。 - -`.spec.to.host`：需要恢复的 TiDB 集群的访问地址。 - -`.spec.to.port`：需要恢复的 TiDB 集群访问的端口。 - -`.spec.to.user`：需要恢复的 TiDB 集群的访问用户。 - -`.spec.to.tidbSecretName`：需要恢复的 TiDB 集群所需凭证的 secret。 - -`.spec.storageClassName`：指定恢复时所需的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值（默认为 `standard`）。 - -`.spec.storageSize`：恢复集群时指定所需的 PV 大小。这个值应大于备份 TiDB 集群数据的大小。 +* `.spec.metadata.namespace`： `Restore` CR 所在的 namespace。 +* `.spec.to.host`：待恢复 TiDB 集群的访问地址。 +* `.spec.to.port`：待恢复 TiDB 集群访问的端口。 +* `.spec.to.user`：待恢复 TiDB 集群的访问用户。 +* `.spec.to.tidbSecretName`：待恢复 TiDB 集群所需凭证的 secret。 +* `.spec.storageClassName`：指定恢复时所需的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值（默认为 `standard`）。 +* `.spec.storageSize`：恢复集群时指定所需的 PV 大小。该值应大于备份 TiDB 集群数据的大小。 diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md b/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md index 30f32163cd64..35cd814d7050 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md @@ -1,13 +1,13 @@ --- -title: 从 S3 兼容存储上的备份数据进行恢复 +title: 恢复 S3 兼容存储上的备份数据 category: how-to --- -# 从 S3 兼容存储上的备份数据进行恢复 +# 恢复 S3 兼容存储上的备份数据 -本文描述了如何将 Kubernetes 上通过 TiDB Operator 备份的数据恢复到 TiDB 集群的操作过程。底层通过使用 [`loader`](/reference/tools/loader.md) 来恢复数据。 +本文描述了将 Kubernetes 上通过 TiDB Operator 备份的数据恢复到 TiDB 集群的操作过程。底层通过使用 [`loader`](/reference/tools/loader.md) 来恢复数据。 -本文使用的备份方式基于 TiDB Operator 新版（大于等于 v1.1）的 CRD 实现，基于 charts 的备份恢复方式参考[这里](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md)。 +本文使用的备份方式基于 TiDB Operator 新版（v1.1 及以上）的 CRD 实现。基于 Helm Charts 实现的备份恢复方式可参考[基于 Helm Charts 实现的 TiDB 集群备份恢复](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md)。 以下示例将兼容 S3 的存储（指定路径）上的备份数据恢复到 TiDB 集群。 @@ -71,20 +71,14 @@ category: how-to kubectl get rt -n test2 -owide ``` -以上示例将兼容 S3 的存储（`spec.s3.path` 路径下）中的备份数据恢复到 TiDB 集群 (`spec.to.host` )。有关兼容 S3 的存储的配置项，可以参考 [backup-s3.yaml](/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md#备份数据到兼容-s3-的存储)。 +以上示例将兼容 S3 的存储（`spec.s3.path` 路径下）中的备份数据恢复到 TiDB 集群 (`spec.to.host`)。有关兼容 S3 的存储的配置项，可以参考 [backup-s3.yaml](/tidb-in-kubernetes/maintain/backup-and-restore/backup-s3.md#备份数据到兼容-s3-的存储)。 更多 `Restore` CR 字段的详细解释： -`.spec.metadata.namespace`：`Restore` CR 所在的 namespace。 - -`.spec.to.host`：需要恢复的 TiDB 集群的访问地址。 - -`.spec.to.port`：需要恢复的 TiDB 集群的访问端口。 - -`.spec.to.user`：需要恢复的 TiDB 集群的访问用户。 - -`.spec.to.tidbSecretName`：需要恢复的 TiDB 集群所需凭证的 secret。 - -`.spec.storageClassName`：指定恢复时所需的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值（默认为 `standard`）。 - -`.spec.storageSize`：指定恢复集群时所需的 PV 大小。该值应大于备份 TiDB 集群的数据大小。 +* `.spec.metadata.namespace`：`Restore` CR 所在的 namespace。 +* `.spec.to.host`：待恢复 TiDB 集群的访问地址。 +* `.spec.to.port`：待恢复 TiDB 集群的访问端口。 +* `.spec.to.user`：待恢复 TiDB 集群的访问用户。 +* `.spec.to.tidbSecretName`：待恢复 TiDB 集群所需凭证的 secret。 +* `.spec.storageClassName`：指定恢复时所需的 PV 类型。如果不指定该项，则默认使用 TiDB Operator 启动参数中 `default-backup-storage-class-name` 指定的值（默认为 `standard`）。 +* `.spec.storageSize`：指定恢复集群时所需的 PV 大小。该值应大于备份 TiDB 集群的数据大小。 diff --git a/tidb-in-kubernetes/reference/configuration/storage-class.md b/tidb-in-kubernetes/reference/configuration/storage-class.md index 3f4f8d8cd845..8fd6db3d49c5 100644 --- a/tidb-in-kubernetes/reference/configuration/storage-class.md +++ b/tidb-in-kubernetes/reference/configuration/storage-class.md @@ -113,7 +113,7 @@ Kubernetes 当前支持静态分配的本地存储。可使用 [local-static-pro > **注意：** > - > 该步骤中创建的目录个数取决于规划的 TiDB 集群数量、每个集群内的 Pump 数量及备份方式。1 个目录会对应创建 1 个 PV。每个 Pump 会使用 1 个 PV，每个 drainer 会使用 1 个 PV，每次 [Ad-hoc 全量备份](/tidb-in-kubernetes/maintain/backup-and-restore.md#ad-hoc-全量备份)会使用 1 个 PV，所有[定时全量备份](/tidb-in-kubernetes/maintain/backup-and-restore.md#定时全量备份)会共用 1 个 PV。 + > 该步骤中创建的目录个数取决于规划的 TiDB 集群数量、每个集群内的 Pump 数量及备份方式。1 个目录会对应创建 1 个 PV。每个 Pump 会使用 1 个 PV，每个 drainer 会使用 1 个 PV，每次 [Ad-hoc 全量备份](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md#ad-hoc-全量备份)会使用 1 个 PV，所有[定时全量备份](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md#定时全量备份)会共用 1 个 PV。 - 给 PD 数据使用的盘，可以参考[步骤](https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner/blob/master/docs/operations.md#sharing-a-disk-filesystem-by-multiple-filesystem-pvs)挂载盘，创建目录，并将新建的目录以 bind mount 方式挂载到 `/mnt/sharedssd` 目录，后续创建 `shared-ssd-storage` `StorageClass`。 diff --git a/tidb-in-kubernetes/tidb-operator-overview.md b/tidb-in-kubernetes/tidb-operator-overview.md index 56e94a4f8061..911235dac9bb 100644 --- a/tidb-in-kubernetes/tidb-operator-overview.md +++ b/tidb-in-kubernetes/tidb-operator-overview.md @@ -57,7 +57,7 @@ TiDB Operator 提供了多种方式来部署 Kubernetes 上的 TiDB 集群： + [TiDB 集群扩缩容](/tidb-in-kubernetes/scale-in-kubernetes.md) + [TiDB 集群升级](/tidb-in-kubernetes/upgrade/tidb-cluster.md#升级-tidb-版本) + [TiDB 集群配置变更](/tidb-in-kubernetes/upgrade/tidb-cluster.md#更新-tidb-集群配置) -+ [TiDB 集群备份恢复](/tidb-in-kubernetes/maintain/backup-and-restore.md) ++ [TiDB 集群备份恢复](/tidb-in-kubernetes/maintain/backup-and-restore/charts.md) + [配置 TiDB 集群故障自动转移](/tidb-in-kubernetes/maintain/auto-failover.md) + [监控 TiDB 集群](/tidb-in-kubernetes/monitor/tidb-in-kubernetes.md) + [TiDB 集群日志收集](/tidb-in-kubernetes/maintain/log-collecting.md) From 97cda8f41da98ebd7bfc5abb932c6b5d8cc19bbd Mon Sep 17 00:00:00 2001 From: onlymellb Date: Fri, 28 Feb 2020 10:09:04 +0800 Subject: [PATCH 15/16] Update tidb-in-kubernetes/maintain/backup-and-restore/charts.md Co-Authored-By: Tennix --- tidb-in-kubernetes/maintain/backup-and-restore/charts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/charts.md b/tidb-in-kubernetes/maintain/backup-and-restore/charts.md index a743cdb54628..094ee59f79b4 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore/charts.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore/charts.md @@ -8,7 +8,7 @@ aliases: ['/docs-cn/dev/tidb-in-kubernetes/maintain/backup-and-store/'] 本文详细描述了如何对 Kubernetes 上的 TiDB 集群进行数据备份和数据恢复。本文使用的备份恢复方式是基于 Helm Charts 实现的。 -新版则基于 CRD 的备份恢复方式实现，详情可参阅以下文档： +TiDB Operator 1.1 及以上版本推荐使用基于 CRD 的备份恢复方式实现，详情可参阅以下文档： - [备份 TiDB 集群到 GCS](/tidb-in-kubernetes/maintain/backup-and-restore/backup-gcs.md) - [恢复 GCS 上的备份数据](/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md) From 1222cb28d468811a2b22864dcb86f97fc4b4c625 Mon Sep 17 00:00:00 2001 From: TomShawn <1135243111@qq.com> Date: Fri, 28 Feb 2020 11:36:36 +0800 Subject: [PATCH 16/16] fix typos --- tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md | 2 +- tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md b/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md index 2a2050cb9bd7..fe064398945f 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore/restore-gcs.md @@ -11,7 +11,7 @@ category: how-to 以下示例将存储在 [Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/) 上指定路径中的集群备份数据恢复到 TiDB 集群。 -## 恢复备份的环境准备 +## 环境准备 1. 下载文件 [`backup-rbac.yaml`](https://github.com/pingcap/tidb-operator/blob/master/manifests/backup/backup-rbac.yaml)，并执行以下命令在 `test2` 这个 namespace 中创建恢复备份所需的 RBAC 相关资源： diff --git a/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md b/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md index 35cd814d7050..1f0caed29447 100644 --- a/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md +++ b/tidb-in-kubernetes/maintain/backup-and-restore/restore-s3.md @@ -11,7 +11,7 @@ category: how-to 以下示例将兼容 S3 的存储（指定路径）上的备份数据恢复到 TiDB 集群。 -## 恢复备份的环境准备 +## 环境准备 1. 下载文件 [`backup-rbac.yaml`](https://github.com/pingcap/tidb-operator/blob/master/manifests/backup/backup-rbac.yaml)，并在 `test2` 这个 namespace 中创建恢复备份所需的 RBAC 资源，所需命令如下：