Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

en: add doc about volume snapshot backup/restore across multiple kubernetes (#2406) #2446

Merged
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
7bf3316
br: add doc about deploy and use br federation
WangLe1321 Jul 7, 2023
b842c09
br: add doc about backup schedule
WangLe1321 Jul 7, 2023
81a62e5
br: modify docs about kubeconfig and br-federation-manager deployment
WangLe1321 Jul 28, 2023
a14cb6c
br: remove some content
WangLe1321 Jul 28, 2023
c4e4dba
en: split docs about EBS snapshot BR to multiple pages
WangLe1321 Aug 2, 2023
e36c2c9
en: remove unused symbols and add comments
WangLe1321 Aug 2, 2023
969c73e
br: modify doc content by comment
WangLe1321 Aug 3, 2023
25f2d3f
optimize deploy-br-federation-manager.md
ran-huang Aug 3, 2023
edfc311
optimize backup-by-ebs-snapshot-across-multiple-kubernetes.md
ran-huang Aug 3, 2023
30944fd
optimize restore-by-ebs-snapshot-across-multiple-kubernetes.md
ran-huang Aug 3, 2023
524f13b
Update en/restore-by-ebs-snapshot-across-multiple-kubernetes.md
WangLe1321 Aug 7, 2023
b619ab2
Apply suggestions from code review
ran-huang Aug 7, 2023
6db3206
en: remove extra spaces in code block indentation
lilin90 Aug 7, 2023
48bccba
br: add architecture doc and modify contents
WangLe1321 Aug 7, 2023
40ac62e
en: rename file name
WangLe1321 Aug 7, 2023
0d44be1
en: modify wrong links
WangLe1321 Aug 7, 2023
4d90ac3
Address comments that were ignored by commit 7eb44f2
lilin90 Aug 7, 2023
d003057
Apply suggestions from code review
ran-huang Aug 7, 2023
89bebb1
Apply suggestions from code review
ran-huang Aug 7, 2023
2e695e6
en: update note format
lilin90 Aug 8, 2023
5f41072
Apply suggestions from code review
WangLe1321 Aug 17, 2023
6d2492c
en: add doc about backup schedule and faq
WangLe1321 Aug 18, 2023
ebabe47
en: modify contents
WangLe1321 Aug 18, 2023
dd86ea1
Update en/backup-by-ebs-snapshot-across-multiple-kubernetes.md
BornChanger Aug 19, 2023
f08ba21
Update en/backup-by-ebs-snapshot-across-multiple-kubernetes.md
BornChanger Aug 19, 2023
1028fdc
Update en/backup-by-ebs-snapshot-across-multiple-kubernetes.md
BornChanger Aug 19, 2023
c7ec4bc
Update en/backup-by-ebs-snapshot-across-multiple-kubernetes.md
BornChanger Aug 19, 2023
a358949
Update en/backup-by-ebs-snapshot-across-multiple-kubernetes.md
BornChanger Aug 19, 2023
7561c91
Update en/backup-by-ebs-snapshot-across-multiple-kubernetes.md
BornChanger Aug 19, 2023
7abaf93
Update en/backup-restore-by-ebs-snapshot-faq.md
BornChanger Aug 19, 2023
96ad31d
Update en/backup-restore-by-ebs-snapshot-faq.md
BornChanger Aug 19, 2023
449157c
br: modify br federation supported minimal version of tidb and operator
WangLe1321 Aug 21, 2023
a2456e5
Apply suggestions from code review
ran-huang Aug 23, 2023
3d7648e
Apply suggestions from code review
WangLe1321 Aug 23, 2023
c12d7db
en: update docs by comment
WangLe1321 Aug 23, 2023
d68cc48
Apply suggestions from code review
WangLe1321 Aug 24, 2023
87c8e6c
Update en/deploy-br-federation.md
WangLe1321 Aug 24, 2023
0439c5d
Apply suggestions from code review
WangLe1321 Aug 24, 2023
07125a7
Update en/backup-by-ebs-snapshot-across-multiple-kubernetes.md
WangLe1321 Aug 25, 2023
e6a97a6
Apply suggestions from code review
WangLe1321 Sep 1, 2023
78c12ee
Update en/restore-from-ebs-snapshot-across-multiple-kubernetes.md
BornChanger Oct 27, 2023
22f5bb8
Update en/restore-from-ebs-snapshot-across-multiple-kubernetes.md
BornChanger Oct 27, 2023
de23415
Update en/restore-from-ebs-snapshot-across-multiple-kubernetes.md
BornChanger Oct 27, 2023
f3551fc
Update en/restore-from-ebs-snapshot-across-multiple-kubernetes.md
BornChanger Oct 27, 2023
bcb468f
Update en/restore-from-ebs-snapshot-across-multiple-kubernetes.md
BornChanger Nov 20, 2023
64d3d3e
Update en/backup-restore-by-ebs-snapshot-faq.md
BornChanger Jan 16, 2024
5e71d36
Update en/restore-from-ebs-snapshot-across-multiple-kubernetes.md
BornChanger Jan 16, 2024
53b23e7
Update en/deploy-br-federation.md
BornChanger Jan 16, 2024
a680534
Update en/deploy-br-federation.md
BornChanger Jan 16, 2024
0412ea0
Update en/backup-by-ebs-snapshot-across-multiple-kubernetes.md
BornChanger Jan 16, 2024
80776a0
Update en/deploy-br-federation.md
BornChanger Jan 16, 2024
557456b
Update en/deploy-br-federation.md
BornChanger Jan 16, 2024
139702c
Update en/backup-restore-by-ebs-snapshot-faq.md
BornChanger Jan 17, 2024
9c3fd73
Update en/backup-restore-by-ebs-snapshot-faq.md
BornChanger Jan 17, 2024
c8cd94d
Update en/backup-restore-by-ebs-snapshot-faq.md
BornChanger Jan 17, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion en/backup-by-ebs-snapshot-across-multiple-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ To initialize the restored volume more efficiently, it is recommended to **separ

## Limitations

- Snapshot backup is applicable to TiDB Operator v1.5.1 or later versions, and TiDB v6.5.4 or later versions.
- Snapshot backup is applicable to TiDB Operator v1.5.2 or later versions, and TiDB v6.5.8 or later versions.
- For TiKV configuration, do not set `resolved-ts.enable` to `false`, and do not set `raftstore.report-min-resolved-ts-interval` to `"0s"`. Otherwise, it can lead to backup failure.
- For PD configuration, do not set `pd-server.min-resolved-ts-persistence-interval` to `"0s"`. Otherwise, it can lead to backup failure.
- To use this backup method, the TiDB cluster must be deployed on AWS EC2 and use AWS EBS volumes.
Expand Down
8 changes: 8 additions & 0 deletions en/backup-restore-by-ebs-snapshot-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,11 @@ This document addresses common questions and solutions related to EBS snapshot b
**Symptom:** Scheduled backup can't be completed in the expected window due to the cost of snapshot size calculation.

**Solution:** By default, both full size and incremental size are calculated by calling the AWS service, which might take several minutes. You can set `spec.template.calcSizeLevel` to `full` to skip incremental size calculation, set it to `incremental` to skip full size calculation, and set it to `none` to skip both calculations.
BornChanger marked this conversation as resolved.
Show resolved Hide resolved

## How to configure the TTL for the backup init job

Backup init job will do backup preparation work including pause GC, some PD schedulers and also suspend lightning. Default TTL of 10 minutes is associated with the init job in case it could stuck. You can change the TTL by setting `spec.template.volumeBackupInitJobMaxActiveSeconds` attribute of spec of volumebackup.
BornChanger marked this conversation as resolved.
Show resolved Hide resolved

## How to flow control to snapshots deletion

EBS snapshot backup GC is done one volumebackup each time. For larger clusters EBS snapshot backup, number of snapshots for a single volumebackup could still be very large, so, flow control to the snapshot deletion is still needed. You can control expected ration in a single data plane by setting the paramter `spec.template.snapshotsDeleteRatio` of the backup schedule CRD. Its default value is 1.0, which means no more than 1 snapshot deletion in a second.
BornChanger marked this conversation as resolved.
Show resolved Hide resolved
8 changes: 4 additions & 4 deletions en/deploy-br-federation.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ To deploy the BR Federation, you need to select one Kubernetes cluster as the co
The BR Federation uses [Custom Resource Definition (CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) to extend Kubernetes. Before using the BR Federation, you must create the CRD in your Kubernetes cluster. After using the BR Federation Manager, you only need to perform the operation once.

```shell
kubectl create -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.5.1/manifests/federation-crd.yaml
kubectl create -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.5.2/manifests/federation-crd.yaml
```

### Step 2.2: Prepare the kubeconfig secret
Expand Down Expand Up @@ -190,7 +190,7 @@ This section describes how to install the BR Federation using [Helm 3](https://h
4. Install the BR Federation:

```shell
helm install --namespace br-fed-admin br-federation pingcap/br-federation --version v1.5.1
helm install --namespace br-fed-admin br-federation pingcap/br-federation --version v1.5.2
```

</div>
Expand Down Expand Up @@ -218,15 +218,15 @@ This section describes how to install the BR Federation using [Helm 3](https://h

```shell
mkdir -p ${HOME}/br-federation && \
helm inspect values pingcap/br-federation --version=v1.5.1 > ${HOME}/br-federation/values.yaml
helm inspect values pingcap/br-federation --version=v1.5.2 > ${HOME}/br-federation/values.yaml
```

5. Configure the BR Federation by modifying fields such as `image`, `limits`, `requests`, and `replicas` according to your needs.

6. Deploy the BR Federation.

```shell
helm install --namespace br-fed-admin br-federation pingcap/br-federation --version v1.5.1 -f ${HOME}/br-federation/values.yaml && \
helm install --namespace br-fed-admin br-federation pingcap/br-federation --version v1.5.2 -f ${HOME}/br-federation/values.yaml && \
kubectl get po -n br-fed-admin -l app.kubernetes.io/instance=br-federation
```

Expand Down
2 changes: 1 addition & 1 deletion en/restore-from-ebs-snapshot-across-multiple-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The restore method described in this document is implemented based on CustomReso

## Limitations

- Snapshot restore is applicable to TiDB Operator v1.5.1 or later versions and TiDB v6.5.4 or later versions.
- Snapshot restore is applicable to TiDB Operator v1.5.2 or later versions and TiDB v6.5.8 or later versions.
- You can use snapshot restore only to restore data to a cluster with the same number of TiKV nodes and volumes configuration. That is, the number of TiKV nodes and volume configurations of TiKV nodes are identical between the restore cluster and backup cluster.
- Snapshot restore is currently not supported for TiFlash, TiCDC, DM, and TiDB Binlog nodes.

Expand Down
Loading