en: add crd-based backup and restore docs by TomShawn · Pull Request #1 · pingcap/docs-tidb-operator

TomShawn · 2020-03-11T07:16:59Z

What is changed, added or deleted? (Required)

This PR is migrated from pingcap/docs#1945:

Add CRD-based backup and restoration documents for TiDB Operator v1.1.
Change the title of the original backup-and-restore document.

Which TiDB Operator version(s) do your changes apply to? (Required)

master (the latest development version, including v1.1 changes for now)
v1.0 (TiDB Operator 1.0 versions)

If you select two or more versions from above, to trigger the bot to cherry-pick this PR to your desired release version branch(es), you must add corresponding labels such as needs-cherry-pick-1.1 and needs-cherry-pick-1.0.

What is the related PR or file link(s)?

This PR is translated from:
Other reference link(s):

lilin90

Please take a look at Ran's comments and resolve them. I'll take another review after that. Thanks!

Co-Authored-By: Ran <huangran@pingcap.com>

TomShawn · 2020-03-17T13:04:49Z

@lilin90 @ran-huang Comments addressed, PTAL again, thanks!

lilin90 · 2020-03-18T07:46:48Z

  - [Maintain a Hosting Kubernetes Node](maintain-a-kubernetes-node.md)
-  - [Backup and Restore](backup-and-restore.md)
+  + Backup and Restore
+    - [Helm Charts-Based Backup and Restoration](backup-and-restore-using-helm-charts.md)


Suggested change

- [Helm Charts-Based Backup and Restoration](backup-and-restore-using-helm-charts.md)

- [Use Helm Charts](backup-and-restore-using-helm-charts.md)

lilin90 · 2020-03-18T07:47:06Z

-  - [Backup and Restore](backup-and-restore.md)
+  + Backup and Restore
+    - [Helm Charts-Based Backup and Restoration](backup-and-restore-using-helm-charts.md)
+    + CRD-Based Backup and Restoration


Suggested change

+ CRD-Based Backup and Restoration

+ Use CRDs

lilin90 · 2020-03-18T07:51:29Z

-title: Backup and Restore
-summary: Learn how to back up and restore the data of TiDB cluster in Kubernetes.
+title: Helm Charts-Based Backup and Restoration
+summary: Learn how to back up and restore the data of TiDB cluster in Kubernetes based on Helm charts.


Suggested change

summary: Learn how to back up and restore the data of TiDB cluster in Kubernetes based on Helm charts.

summary: Learn how to back up and restore data of the TiDB cluster in Kubernetes using Helm charts.

lilin90 · 2020-03-18T07:52:07Z

 ---

-# Backup and Restore
+# Helm Charts-Based Backup and Restoration


Suggested change

# Helm Charts-Based Backup and Restoration

# Backup and Restore Using Helm Charts

lilin90 · 2020-03-18T07:52:52Z

+# Helm Charts-Based Backup and Restoration

-This document describes how to back up and restore the data of a TiDB cluster in Kubernetes.
+This document describes how to back up and restore the data of a TiDB cluster in Kubernetes based on Helm charts.


Suggested change

This document describes how to back up and restore the data of a TiDB cluster in Kubernetes based on Helm charts.

This document describes how to back up and restore the data of a TiDB cluster in Kubernetes using Helm charts.

lilin90 · 2020-03-18T07:55:28Z

+* [Back up Data to S3-Compatible Storage](backup-to-s3.md)
+* [Restore Data from S3-Compatible Storage](restore-from-s3.md)
+
+TiDB in Kubernetes supports two kinds of backup strategies (based on Helm charts):


Suggested change

TiDB in Kubernetes supports two kinds of backup strategies (based on Helm charts):

TiDB in Kubernetes supports two backup strategies using Helm charts:

lilin90 · 2020-03-18T08:00:31Z

+TiDB in Kubernetes supports two kinds of backup strategies (based on Helm charts):

 * [Full backup](#full-backup) (scheduled or ad-hoc): use [`mydumper`](https://pingcap.com/docs/stable/reference/tools/mydumper) to take a logical backup of the TiDB cluster.
 * [Incremental backup](#incremental-backup): use [`TiDB Binlog`](https://pingcap.com/docs/stable/reference/tidb-binlog/overview) to replicate data in the TiDB cluster to another database or take a real-time backup of the data.


Suggested change

* [Incremental backup](#incremental-backup): use [`TiDB Binlog`](https://pingcap.com/docs/stable/reference/tidb-binlog/overview) to replicate data in the TiDB cluster to another database or take a real-time backup of the data.

* [Incremental backup](#incremental-backup): use [TiDB Binlog](https://pingcap.com/docs/stable/reference/tidb-binlog/overview) to replicate data from the TiDB cluster to another database or execute a real-time backup of the data.

lilin90 · 2020-03-18T08:05:27Z

+
+# Back up TiDB Cluster Data to GCS
+
+This document describes how to back up the data of the TiDB cluster in Kubernetes to [Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/). "Backup" in this document refers to full backup (ad-hoc full backup and scheduled full backup). For the underlying implementation, [`mydumper`](https://pingcap.com/docs/stable/reference/tools/mydumper) is used to get the logic backup of the TiDB cluster, and then this backup data is sent to the remote GCS.


IMO, this phrase is not necessary.

Suggested change

This document describes how to back up the data of the TiDB cluster in Kubernetes to [Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/). "Backup" in this document refers to full backup (ad-hoc full backup and scheduled full backup). For the underlying implementation, [`mydumper`](https://pingcap.com/docs/stable/reference/tools/mydumper) is used to get the logic backup of the TiDB cluster, and then this backup data is sent to the remote GCS.

This document describes how to back up the data of the TiDB cluster in Kubernetes to [Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/). "Backup" in this document refers to full backup (ad-hoc full backup and scheduled full backup). [`mydumper`](https://pingcap.com/docs/stable/reference/tools/mydumper) is used to get the logic backup of the TiDB cluster, and then this backup data is sent to the remote GCS.

lilin90 · 2020-03-18T08:08:12Z

+
+This document describes how to back up the data of the TiDB cluster in Kubernetes to [Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/). "Backup" in this document refers to full backup (ad-hoc full backup and scheduled full backup). For the underlying implementation, [`mydumper`](https://pingcap.com/docs/stable/reference/tools/mydumper) is used to get the logic backup of the TiDB cluster, and then this backup data is sent to the remote GCS.
+
+The backup method described in this document is implemented based on CustomResourceDefinition (CRD) in TiDB Operator v1.1 or later versions. For the backup method implemented based on Helm Charts, refer to [Back up and Restore TiDB Cluster Data Based on Helm Charts](backup-and-restore-using-helm-charts.md).


Suggested change

The backup method described in this document is implemented based on CustomResourceDefinition (CRD) in TiDB Operator v1.1 or later versions. For the backup method implemented based on Helm Charts, refer to [Back up and Restore TiDB Cluster Data Based on Helm Charts](backup-and-restore-using-helm-charts.md).

The backup method described in this document is implemented using CustomResourceDefinition (CRD) in TiDB Operator v1.1 or later versions. For the backup method implemented using Helm Charts, refer to [Back up and Restore TiDB Cluster Data Using Helm Charts](backup-and-restore-using-helm-charts.md).

lilin90 · 2020-03-18T08:35:53Z

+
+### Ad-hoc backup process
+
+Create the `Backup` CR and back up data to GSC:


Suggesting using an ordered list for this section.

lilin90 · 2020-03-18T08:39:19Z

+kubectl apply -f backup-gcs.yaml
+```
+
+The `backup-gcs.yaml` file has the following content:


Move this step to the 1st step.

Update description.

Suggested change

The `backup-gcs.yaml` file has the following content:

1. In the `backup-gcs.yaml` file, edit `host`, `port`, `user`, `projectId` and save your changes.

lilin90 · 2020-03-18T08:40:54Z

+kubectl apply -f backup-schedule-gcs.yaml
+```
+
+The `backup-gcs.yaml` file has the following content:


Suggested change

The `backup-gcs.yaml` file has the following content:

The `backup-schedule-gcs.yaml` file has the following content:

lilin90 · 2020-03-18T08:41:04Z

+
+### Scheduled backup process
+
+Create the `BackupSchedule` CR to enable the scheduled full backup to GCS:


ditto for this section.

lilin90 · 2020-03-18T09:46:38Z

+
+### Ad-hoc backup process
+
+ Create the `Backup` CR and back up data to Amazon S3:


Process should organized in an ordered list.

lilin90 · 2020-03-18T09:47:59Z

@TomShawn I added comments in three batches and will have another review after they are addressed.

TomShawn · 2020-03-18T12:51:22Z

@lilin90 Comments addressed, PTAL again, thanks!

backup: add backup to aws s3 doc

lilin90

LGTM

en: add crd-based backup and restore docs

34b0a66

TomShawn added size/large Changes of a large size. translation/from-zh This PR is translated from a PR in docs-tidb-operator/zh. labels Mar 11, 2020

TomShawn requested review from lilin90 and onlymellb March 11, 2020 07:17

TomShawn added 5 commits March 11, 2020 15:21

en: change two links

39c7ec1

en: shorten toc titles

24b0016

en: minor edits

f1fe063

en: add an alias

e33e8cc

en: fix aliases

b7acc2c

kennytm reviewed Mar 11, 2020

View reviewed changes

Comment thread en/TOC.md Outdated

en: change aliases and change "From" to "from" in title

91a5196

ran-huang self-requested a review March 16, 2020 09:47

ran-huang reviewed Mar 16, 2020

View reviewed changes

lilin90 reviewed Mar 17, 2020

View reviewed changes

TomShawn and others added 2 commits March 17, 2020 20:55

address comments from ran

643554c

en: fix a typo

7a43fa5

Co-Authored-By: Ran <huangran@pingcap.com>

Merge branch 'master' into crd-back-restore

bf46f4e

lilin90 reviewed Mar 18, 2020

View reviewed changes

TomShawn added 2 commits March 18, 2020 20:30

address comments from lilian

c0bf23b

en: change title

a8b8545

TomShawn commented Mar 18, 2020

View reviewed changes

Comment thread en/backup-to-s3.md

Comment thread en/backup-to-s3.md

ran-huang reviewed Mar 19, 2020

View reviewed changes

Comment thread en/backup-to-gcs.md

TomShawn mentioned this pull request Mar 23, 2020

tidb-kubernetes: add backup and restore usage docs pingcap/docs#1945

Closed

4 tasks

DanielZhangQD pushed a commit that referenced this pull request Mar 26, 2020

Merge pull request #1 from shuijing198799/yinliang/add-backup-aws-br-doc

7442b1c

backup: add backup to aws s3 doc

Merge branch 'master' into crd-back-restore

dffea47

lilin90 approved these changes Mar 26, 2020

View reviewed changes

lilin90 merged commit 165e468 into pingcap:master Mar 26, 2020

lilin90 added the v1.1 This PR/issue applies to TiDB Operator v1.1. label Mar 26, 2020

ran-huang mentioned this pull request Mar 27, 2020

en: add docs for backup and restore aws using BR #45

Merged

2 tasks

TomShawn deleted the crd-back-restore branch March 30, 2020 07:07

	- [Helm Charts-Based Backup and Restoration](backup-and-restore-using-helm-charts.md)
	- [Use Helm Charts](backup-and-restore-using-helm-charts.md)

	summary: Learn how to back up and restore the data of TiDB cluster in Kubernetes based on Helm charts.
	summary: Learn how to back up and restore data of the TiDB cluster in Kubernetes using Helm charts.

	# Helm Charts-Based Backup and Restoration
	# Backup and Restore Using Helm Charts

	This document describes how to back up and restore the data of a TiDB cluster in Kubernetes based on Helm charts.
	This document describes how to back up and restore the data of a TiDB cluster in Kubernetes using Helm charts.

	TiDB in Kubernetes supports two kinds of backup strategies (based on Helm charts):
	TiDB in Kubernetes supports two backup strategies using Helm charts:

	* [Incremental backup](#incremental-backup): use [`TiDB Binlog`](https://pingcap.com/docs/stable/reference/tidb-binlog/overview) to replicate data in the TiDB cluster to another database or take a real-time backup of the data.
	* [Incremental backup](#incremental-backup): use [TiDB Binlog](https://pingcap.com/docs/stable/reference/tidb-binlog/overview) to replicate data from the TiDB cluster to another database or execute a real-time backup of the data.


		# Back up TiDB Cluster Data to GCS

		This document describes how to back up the data of the TiDB cluster in Kubernetes to [Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/). "Backup" in this document refers to full backup (ad-hoc full backup and scheduled full backup). For the underlying implementation, [`mydumper`](https://pingcap.com/docs/stable/reference/tools/mydumper) is used to get the logic backup of the TiDB cluster, and then this backup data is sent to the remote GCS.


		This document describes how to back up the data of the TiDB cluster in Kubernetes to [Google Cloud Storage (GCS)](https://cloud.google.com/storage/docs/). "Backup" in this document refers to full backup (ad-hoc full backup and scheduled full backup). For the underlying implementation, [`mydumper`](https://pingcap.com/docs/stable/reference/tools/mydumper) is used to get the logic backup of the TiDB cluster, and then this backup data is sent to the remote GCS.

		The backup method described in this document is implemented based on CustomResourceDefinition (CRD) in TiDB Operator v1.1 or later versions. For the backup method implemented based on Helm Charts, refer to [Back up and Restore TiDB Cluster Data Based on Helm Charts](backup-and-restore-using-helm-charts.md).


		### Ad-hoc backup process

		Create the `Backup` CR and back up data to GSC:

	The `backup-gcs.yaml` file has the following content:
	1. In the `backup-gcs.yaml` file, edit `host`, `port`, `user`, `projectId` and save your changes.

	The `backup-gcs.yaml` file has the following content:
	The `backup-schedule-gcs.yaml` file has the following content:


		### Scheduled backup process

		Create the `BackupSchedule` CR to enable the scheduled full backup to GCS:


		### Ad-hoc backup process

		+ Create the `Backup` CR and back up data to Amazon S3:

Conversation

TomShawn commented Mar 11, 2020 • edited by lilin90 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is changed, added or deleted? (Required)

Which TiDB Operator version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lilin90 left a comment

Choose a reason for hiding this comment

Uh oh!

TomShawn commented Mar 17, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lilin90 commented Mar 18, 2020

Uh oh!

Uh oh!

Uh oh!

TomShawn commented Mar 18, 2020

Uh oh!

Uh oh!

lilin90 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

TomShawn commented Mar 11, 2020 •

edited by lilin90

Loading