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

add two HTAP documents (#6206) #6321

Merged
Merged
Changes from 1 commit
Commits
Show all changes
129 commits
Select commit Hold shift + click to select a range
8fe89ce
Remove all aliases from release-5.1 (#5818)
TomShawn Jun 22, 2021
ff81e85
add docs for enforce mpp (#5811) (#5819)
ti-chi-bot Jun 22, 2021
ed00c06
Update tidb-configuration-file.md (#5070) (#5821)
ti-chi-bot Jun 22, 2021
b7263ce
Add Lock View documents (#5798) (#5822)
ti-chi-bot Jun 22, 2021
92ffdf7
Fix typos (#5827) (#5828)
ti-chi-bot Jun 23, 2021
a9838d9
add document about stale read transaction (#5809) (#5829)
ti-chi-bot Jun 23, 2021
10e91bf
Delete docker deployment docs (#5830) (#5832)
ti-chi-bot Jun 23, 2021
41af2b5
Fix ebnf display (#5833) (#5834)
ti-chi-bot Jun 24, 2021
a966936
tidb-configuration-file: add graceful-wait-before-shutdown (#5825) (#…
ti-chi-bot Jun 24, 2021
57be14d
lightning: fix a lightning config bug (#5820) (#5837)
ti-chi-bot Jun 24, 2021
55f61ac
change docs configs to release-5.1 (#5817)
TomShawn Jun 24, 2021
3f5cb7f
Update content about upgrade (#5813) (#5841)
ti-chi-bot Jun 24, 2021
0ccfa07
add v510 benchmark doc (#5842) (#5845)
ti-chi-bot Jun 24, 2021
fcd26c2
system variables: add tidb_analyze_version (#5824) (#5846)
ti-chi-bot Jun 24, 2021
4642cd0
Add note about stale read (#5843) (#5850)
ti-chi-bot Jun 24, 2021
cca3435
Add v5.1 mpp tpch test report (#5844) (#5851)
ti-chi-bot Jun 24, 2021
f58f3ea
Bump version for v5.1.0 (#5849) (#5852)
ti-chi-bot Jun 24, 2021
670fe11
Add the release note for TiDB v5.1 (#5840) (#5853)
ti-chi-bot Jun 24, 2021
695e8ab
Update v5.1 release notes for lint issues (#5854) (#5855)
ti-chi-bot Jun 24, 2021
af53b3e
Fix the display issues of two lists (#5857) (#5858)
ti-chi-bot Jun 24, 2021
c601037
Update TOC.md (#5862)
qiancai Jun 24, 2021
74861a1
Add a missing sentence in 5.1 rn (#5863) (#5864)
ti-chi-bot Jun 25, 2021
247b380
Overhauling TiKV RocksDB configuration file (#5746) (#5873)
ti-chi-bot Jun 28, 2021
14815c5
Not support to set Tombstone (#5878) (#5885)
ti-chi-bot Jun 29, 2021
98811bf
Update tiup-bench.md (#5880) (#5883)
ti-chi-bot Jun 29, 2021
a9c84a2
tidb-functions: extend tidb_decode_key docs (#5877) (#5887)
ti-chi-bot Jun 29, 2021
fb04272
*: upadate roadmap (#5888) (#5889)
ti-chi-bot Jun 29, 2021
b718358
system-variables: add datadir and license (#5761) (#5890)
ti-chi-bot Jun 29, 2021
af1cf83
Add v5.1.0 / release-5.1 where it is missing (#5893) (#5902)
ti-chi-bot Jul 1, 2021
9fb760c
Clarify tidb lightning backend description (#5904) (#5907)
ti-chi-bot Jul 1, 2021
f5baca7
system-variables: Add charset documentation (#5867) (#5909)
ti-chi-bot Jul 1, 2021
0849f75
fix partition table doc error (#5903) (#5912)
ti-chi-bot Jul 1, 2021
7a7da4d
releases: add 5.0.3 release notes (#5874) (#5917)
ti-chi-bot Jul 2, 2021
30e06c6
Add workaround about using Stale Read with TiFlash (#5875) (#5922)
ti-chi-bot Jul 5, 2021
0cc435a
Fix ticdc canal-json related doc (#5774) (#5925)
ti-chi-bot Jul 5, 2021
4e7dad5
release-5.1.0: update CTE description (#5918) (#5923)
ti-chi-bot Jul 5, 2021
97335d6
remove some useless configurations (#5558) (#5926)
ti-chi-bot Jul 5, 2021
8b39e57
Remove a blank line that causes display failure (#5934) (#5935)
ti-chi-bot Jul 7, 2021
94b3436
configure-memory-usage: update default value (#5913) (#5939)
ti-chi-bot Jul 8, 2021
0cae595
quick-start-with-tidb: add a note to clarify the example ip (#5865) (…
ti-chi-bot Jul 8, 2021
2dfc3fa
TiKV configuration: defaultcf.titan config should not apply to other …
ti-chi-bot Jul 8, 2021
9b6059f
added config example for s3.region (#5919) (#5949)
ti-chi-bot Jul 8, 2021
48fc0a2
partitioned-table: adding the correction to incorrect examples (#5931…
ti-chi-bot Jul 8, 2021
98989b5
fix ctc doc (#5914) (#5953)
ti-chi-bot Jul 8, 2021
55e8034
*: make the scene of stale read clearer (#5932) (#5954)
ti-chi-bot Jul 8, 2021
b508e67
clustered-index.md: nonclusterd -> nonclustered (#5956) (#5958)
ti-chi-bot Jul 8, 2021
2b43641
Add the default value description for tidb_enforce_mpp (#5955) (#5961)
ti-chi-bot Jul 9, 2021
0f67d4b
Add a note to clarify the purpose of the quick start guide (#5876) (#…
ti-chi-bot Jul 12, 2021
a8c3b4f
fix-broken-external-links (#5971) (#5977)
ti-chi-bot Jul 13, 2021
68b2ee5
Fix some default configurations for RocksDB (#5969) (#5979)
ti-chi-bot Jul 13, 2021
afe2e92
Added a note about grpc-compression-type (#5960) (#5981)
ti-chi-bot Jul 13, 2021
2ef0ca7
Updated TiUP version (#5970) (#5983)
ti-chi-bot Jul 14, 2021
4472c8f
Remove the swappiness parameter (#5987) (#5990)
ti-chi-bot Jul 16, 2021
b196fe6
Change tidb_memory_usage_alarm_ratio scope to instance (#5988) (#5994)
ti-chi-bot Jul 16, 2021
c153c26
system-variables: update for consistency (#5826) (#5991)
ti-chi-bot Jul 16, 2021
2a0f15a
index page: updated the phase of TiDB Cloud from Beta to Public Previ…
ti-chi-bot Jul 23, 2021
595dcca
TiUP cluster: update data_dir (#6009) (#6019)
ti-chi-bot Jul 23, 2021
e67c799
update docs related to partition table dynamic mode (#5997) (#6025)
ti-chi-bot Jul 23, 2021
c8bc874
partitioning: Corrected partition management (#5498) (#6027)
ti-chi-bot Jul 23, 2021
852173f
TiDB binlog: update descriptions about commit ts and passoword (#5986…
ti-chi-bot Jul 27, 2021
f1f00b1
releases: add tidb 4.0.14 release notes (#5996) (#6039)
ti-chi-bot Jul 27, 2021
b0374ce
fix a typo for sync_diff_inspector (#6041) (#6043)
ti-chi-bot Jul 28, 2021
18ff150
Update dashboard FAQ (#5895) (#6051)
ti-chi-bot Jul 29, 2021
68eb8ec
correct document of using br backup and restore system tables (#6057)…
ti-chi-bot Jul 30, 2021
01e9b66
Add TiDB Dashboard session docs (#6058) (#6063)
ti-chi-bot Jul 30, 2021
2c75adc
Update the default value of tidb_stmt_summary_max_stmt_count (#6021) …
ti-chi-bot Jul 30, 2021
f0ff847
update br faq (#6060) (#6064)
ti-chi-bot Jul 30, 2021
4d27b79
releases: add TiDB 5.1.1 release notes (#6030) (#6065)
ti-chi-bot Jul 30, 2021
bc5e698
update stale read doc for ga (#6047) (#6052)
ti-chi-bot Jul 30, 2021
8f72414
grafana-overview-dashboard: update the monitoring item for CPS (#6066…
ti-chi-bot Jul 30, 2021
e049aa2
deploy-tidb-binlog: make the expression on deployment clearer (#6073)…
ti-chi-bot Aug 2, 2021
11d7adb
Add documentation on how to modify gcttl by tiup (#6071) (#6077)
ti-chi-bot Aug 2, 2021
e204267
remove useless variable (#6076) (#6078)
ti-chi-bot Aug 2, 2021
d919ebe
deleted roadmap.md (#6079) (#6082)
ti-chi-bot Aug 2, 2021
2eadade
TiDB Monitoring Metrics: remove a line (#6081) (#6083)
ti-chi-bot Aug 2, 2021
7c80eda
chore: lock plugin versions (#6089) (#6095)
ti-chi-bot Aug 4, 2021
878e03e
cdc: add compatibility notes for sort-dir (#6086) (#6096)
ti-chi-bot Aug 4, 2021
4854222
Add gc ttl (#6102) (#6104)
ti-chi-bot Aug 5, 2021
afa6b40
5.1.0 release notes: Fix link to telemetry docs (#6106) (#6107)
ti-chi-bot Aug 5, 2021
441738e
TiCDC: update a golang demo link (#6055) (#6114)
ti-chi-bot Aug 5, 2021
affee15
br/use-br-command-line-tool: supplement br note (#6000) (#6116)
ti-chi-bot Aug 5, 2021
f11a139
pr_template: Provides tips for cherry-pick (#6042) (#6122)
ti-chi-bot Aug 5, 2021
6141cd2
ticdc: add explicit_defaults_for_timestamp compatibility troubleshoot…
ti-chi-bot Aug 6, 2021
bf74697
TiFlash: remove outdated tune advise (#6133) (#6135)
ti-chi-bot Aug 10, 2021
fa2b427
tidb-scheduling: fix typo (#6140) (#6143)
ti-chi-bot Aug 11, 2021
431277a
tiup: fix dead links (#6153) (#6155)
ti-chi-bot Aug 12, 2021
ebdda11
chore: update pdf version tag (#6150)
YiniXu9506 Aug 13, 2021
bb85ae0
high-concurrency-best-practices: fix the support info of follower rea…
ti-chi-bot Aug 13, 2021
543d588
Fix broken link in error codes doc and support doc (#6196) (#6200)
ti-chi-bot Aug 20, 2021
0c57caa
docs: fix format for TiKV and PD configuration file template invalid.…
ti-chi-bot Aug 20, 2021
a280ce8
adopters: add zhihu case study (#6207) (#6213)
ti-chi-bot Aug 23, 2021
0e94de9
add notice about scaling in pd node (#6099) (#6221)
ti-chi-bot Aug 23, 2021
51e576a
adopters: remove 404 links (#6214) (#6225)
ti-chi-bot Aug 24, 2021
05e4084
update PR template for v5.2 (#6166) (#6241)
ti-chi-bot Aug 25, 2021
c9633c0
alert rules: update some descriptions (#6250) (#6256)
ti-chi-bot Aug 25, 2021
c3da29e
Fix image display error (#6169)
TomShawn Aug 25, 2021
0cf5b85
fix typo: relaod -> reload (#6235) (#6260)
ti-chi-bot Aug 25, 2021
02e2408
br: add restore to systables (#6004) (#6271)
ti-chi-bot Aug 26, 2021
df1c98a
Require process privilege for dumpling (#6187) (#6274)
ti-chi-bot Aug 26, 2021
56ff335
statement summary: update statement summary doc (#6084) (#6270)
ti-chi-bot Aug 26, 2021
278ada5
Add description about table name/alias specifying for read_from_stora…
ti-chi-bot Aug 26, 2021
6c4befb
TiKV configuration: remove redundant instructions (#6218) (#6288)
ti-chi-bot Aug 26, 2021
69fca38
alert rules: remove some descriptions (#6223) (#6292)
ti-chi-bot Aug 26, 2021
0358567
sql: improve kill's description (#6233) (#6306)
ti-chi-bot Aug 27, 2021
97713d9
system variables.md: add a warning message (#6298) (#6312)
ti-chi-bot Aug 27, 2021
f4687a3
tiup: add notice about importing cluster (#6108) (#6316)
ti-chi-bot Aug 27, 2021
1d2f500
chore: update PDF setting for 5.1 (#6307)
TomShawn Aug 27, 2021
6343c3e
add two HTAP documents
en-jin19 Aug 22, 2021
5b781fb
fix CI error
en-jin19 Aug 22, 2021
56b9e4c
fix CI error
en-jin19 Aug 22, 2021
8c81066
fix CI error
en-jin19 Aug 22, 2021
2a30b5f
fix CI errors
en-jin19 Aug 22, 2021
0249468
Update explore-htap.md
en-jin19 Aug 23, 2021
7ede85b
Update quick-start-with-htap.md
en-jin19 Aug 23, 2021
107b808
Update quick-start-with-htap.md
en-jin19 Aug 24, 2021
b2e4842
Update quick-start-with-htap.md
en-jin19 Aug 24, 2021
c92428c
Apply suggestions from code review
en-jin19 Aug 26, 2021
aa7eb2a
Apply suggestions from code review
en-jin19 Aug 26, 2021
06d34ea
fix CI error
en-jin19 Aug 26, 2021
949da58
Update explore-htap.md
qiancai Aug 26, 2021
2181340
Apply suggestions from code review
qiancai Aug 26, 2021
c84bb42
Apply suggestions from code review
en-jin19 Aug 27, 2021
5b40ad5
Apply suggestions from code review
en-jin19 Aug 27, 2021
d6046b4
Update quick-start-with-htap.md
qiancai Aug 27, 2021
aeff6a7
Update explore-htap.md
qiancai Aug 27, 2021
cb016e4
Update explore-htap.md
qiancai Aug 27, 2021
0c7cb0e
Update explore-htap.md
qiancai Aug 27, 2021
ae5235b
Merge branch 'release-5.1' into pr/6321
qiancai Aug 27, 2021
996aacc
Merge branch 'release-5.2' into pr/6321
qiancai Aug 27, 2021
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
Prev Previous commit
Next Next commit
Update content about upgrade (#5813) (#5841)
  • Loading branch information
ti-chi-bot authored Jun 24, 2021
commit 3f5cb7f36ca3e6a5c3e72957d1ebe668809c7e9a
38 changes: 22 additions & 16 deletions upgrade-tidb-using-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,26 @@ summary: Learn how to upgrade TiDB using TiUP.

# Upgrade TiDB Using TiUP

This document is targeted for users who want to upgrade from TiDB 4.0 versions to TiDB 5.0 versions, or from TiDB 5.0 to a later version.
This document is targeted for the following upgrade paths:

If your cluster to upgrade is v3.1 or an earlier version (v3.0 or v2.1), you need to upgrade your cluster first to v4.0 and then to v5.0. You cannot upgrade your cluster across a major version or versions.
- Upgrade from TiDB 4.0 versions to TiDB 5.1 versions.
- Upgrade from TiDB 5.0 versions to TiDB 5.1 versions.

> **Note:**
>
> If your cluster to be upgraded is v3.1 or an earlier version (v3.0 or v2.1), the direct upgrade to v5.1 or its patch versions is not supported. You need to upgrade your cluster first to v4.0 and then to v5.1.

## Upgrade caveat

- After the upgrade, rolling back to 4.0 or earlier versions is not supported.
- For the v4.0 cluster managed using TiDB Ansible, you need to import the cluster to TiUP (`tiup cluster`) for new management according to [Upgrade TiDB Using TiUP (v4.0)](https://docs.pingcap.com/tidb/v4.0/upgrade-tidb-using-tiup#import-tidb-ansible-and-the-inventoryini-configuration-to-tiup). Then you can upgrade the cluster to v5.0 according to this document.
- To update versions earlier than 3.0 to 5.0:
- TiDB currently does not support version downgrade or rolling back to an earlier version after the upgrade.
- For the v4.0 cluster managed using TiDB Ansible, you need to import the cluster to TiUP (`tiup cluster`) for new management according to [Upgrade TiDB Using TiUP (v4.0)](https://docs.pingcap.com/tidb/v4.0/upgrade-tidb-using-tiup#import-tidb-ansible-and-the-inventoryini-configuration-to-tiup). Then you can upgrade the cluster to v5.1 or its patch versions according to this document.
- To update versions earlier than 3.0 to 5.1:
1. Update this version to 3.0 using [TiDB Ansible](https://docs.pingcap.com/tidb/v3.0/upgrade-tidb-using-ansible).
2. Use TiUP (`tiup cluster`) to import the TiDB Ansible configuration.
3. Update the 3.0 version to 4.0 according to [Upgrade TiDB Using TiUP (v4.0)](https://docs.pingcap.com/tidb/v4.0/upgrade-tidb-using-tiup#import-tidb-ansible-and-the-inventoryini-configuration-to-tiup).
4. Then you can upgrade the cluster to v5.0 according to this document.
4. Upgrade the cluster to v5.1 according to this document.
- Support upgrading the versions of TiDB Binlog, TiCDC, TiFlash, and other components.
- For detailed compatibility changes of different versions, see the [Release Notes](/releases/release-notes.md) of each version. Modify your cluster configuration according to the "Compatibility Changes" section of the corresponding release notes.

> **Note:**
>
Expand All @@ -38,7 +44,7 @@ Before upgrading your TiDB cluster, you first need to upgrade TiUP or TiUP mirro
>
> If the control machine of the cluster to upgrade cannot access `https://tiup-mirrors.pingcap.com`, skip this section and see [Upgrade TiUP offline mirror](#upgrade-tiup-offline-mirror).

1. Upgrade the TiUP version. It is recommended that the TiUP version is `1.4.0` or later.
1. Upgrade the TiUP version. It is recommended that the TiUP version is `1.5.0` or later.

{{< copyable "shell-regular" >}}

Expand All @@ -47,7 +53,7 @@ Before upgrading your TiDB cluster, you first need to upgrade TiUP or TiUP mirro
tiup --version
```

2. Upgrade the TiUP Cluster version. It is recommended that the TiUP Cluster version is `1.4.0` or later.
2. Upgrade the TiUP Cluster version. It is recommended that the TiUP Cluster version is `1.5.0` or later.

{{< copyable "shell-regular" >}}

Expand Down Expand Up @@ -89,7 +95,7 @@ Now, the offline mirror has been upgraded successfully. If an error occurs durin
> Skip this step if one of the following situations applies:
>
> + You have not modified the configuration parameters of the original cluster. Or you have modified the configuration parameters using `tiup cluster` but no more modification is needed.
> + After the upgrade, you want to use v5.0's default parameter values for the unmodified configuration items.
> + After the upgrade, you want to use v5.1's default parameter values for the unmodified configuration items.

1. Enter the `vi` editing mode to edit the topology file:

Expand All @@ -105,9 +111,9 @@ Now, the offline mirror has been upgraded successfully. If an error occurs durin

> **Note:**
>
> Before you upgrade the cluster to v5.0, make sure that the parameters you have modified in v4.0 are compatible in v5.0. For details, see [TiKV Configuration File](/tikv-configuration-file.md).
> Before you upgrade the cluster to v5.1, make sure that the parameters you have modified in v4.0 are compatible in v5.1. For details, see [TiKV Configuration File](/tikv-configuration-file.md).
>
> The following three TiKV parameters are obsolete in TiDB v5.0. If the following parameters have been configured in your original cluster, you need to delete these parameters through `edit-config`:
> The following three TiKV parameters are obsolete in TiDB v5.1. If the following parameters have been configured in your original cluster, you need to delete these parameters through `edit-config`:
>
> - pessimistic-txn.enabled
> - server.request-batch-enable-cross-command
Expand Down Expand Up @@ -148,12 +154,12 @@ If your application has a maintenance window for the database to be stopped for
tiup cluster upgrade <cluster-name> <version>
```

For example, if you want to upgrade the cluster to v5.0.0:
For example, if you want to upgrade the cluster to v5.1.0:

{{< copyable "shell-regular" >}}

```shell
tiup cluster upgrade <cluster-name> v5.0.0
tiup cluster upgrade <cluster-name> v5.1.0
```

> **Note:**
Expand Down Expand Up @@ -203,7 +209,7 @@ tiup cluster display <cluster-name>
```
Cluster type: tidb
Cluster name: <cluster-name>
Cluster version: v5.0.0
Cluster version: v5.1.0
```

> **Note:**
Expand Down Expand Up @@ -253,10 +259,10 @@ You can upgrade the tool version by using TiUP to install the `ctl` component of
{{< copyable "shell-regular" >}}

```shell
tiup install ctl:v5.0.0
tiup install ctl:v5.1.0
```

## TiDB 5.1 compatibility changes

- See TiDB 5.1 GA Release Notes for the compatibility changes.
- See TiDB 5.1 Release Notes for the compatibility changes.
- Try to avoid creating a new clustered index table when you apply rolling updates to the clusters using TiDB-Binlog.