Skip to content

docs: use ticdc-version variable in TiCDC examples (#23696) #23729

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.

Sign up for GitHub

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

Open
ti-chi-bot wants to merge 3 commits into
base: master
Choose a base branch
from
Open

docs: use ticdc-version variable in TiCDC examples (#23696) #23729

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eaeab10
This is an automated cherry-pick of #23696
doc-claw-bot Sep 3, 2026
b5ee302
Update variables.json
qiancai Sep 4, 2026
2acebb1
Update variables.json
qiancai Sep 4, 2026
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
12 changes: 6 additions & 6 deletions ticdc/ticdc-architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ When deploying a new TiDB cluster of v8.5.4 or later using TiDB Operator, you ca
spec:
ticdc:
baseImage: pingcap/ticdc
version: v8.5.4
version: v{{{ .ticdc-version }}}
replicas: 3
config:
newarch = true
Expand All @@ -169,10 +169,10 @@ To deploy TiCDC nodes in the new architecture using TiUP, take the following ste

The download link follows this format: `https://tiup-mirrors.pingcap.com/cdc-${version}-${os}-${arch}.tar.gz`, where `${version}` is the TiCDC version (see [TiCDC releases for the new architecture](https://github.com/pingcap/ticdc/releases) for available versions), `${os}` is your operating system, and `${arch}` is the platform the component runs on (`amd64` or `arm64`).

For example, to download the binary package of TiCDC v8.5.4-release.1 for Linux (x86-64), run the following command:
For example, to download the binary package of TiCDC v{{{ .ticdc-version }}} for Linux (x86-64), run the following command:

```shell
wget https://tiup-mirrors.pingcap.com/cdc-v8.5.4-release.1-linux-amd64.tar.gz
wget https://tiup-mirrors.pingcap.com/cdc-v{{{ .ticdc-version }}}-linux-amd64.tar.gz
```

3. If your TiDB cluster has running changefeeds, refer to [Pause a replication task](/ticdc/ticdc-manage-changefeed.md#pause-a-replication-task) to pause all replication tasks of the changefeeds.
Expand All @@ -185,7 +185,7 @@ To deploy TiCDC nodes in the new architecture using TiUP, take the following ste
4. Patch the downloaded TiCDC binary file to your TiDB cluster using the [`tiup cluster patch`](/tiup/tiup-component-cluster-patch.md) command:

```shell
tiup cluster patch <cluster-name> ./cdc-v8.5.4-release.1-linux-amd64.tar.gz -R cdc --overwrite
tiup cluster patch <cluster-name> ./cdc-v{{{ .ticdc-version }}}-linux-amd64.tar.gz -R cdc --overwrite
```

5. Update the TiCDC configuration using the [`tiup cluster edit-config`](/tiup/tiup-component-cluster-edit-config.md) command to enable the new architecture:
Expand Down Expand Up @@ -220,7 +220,7 @@ To deploy TiCDC nodes in the new architecture in an existing TiDB cluster using
spec:
ticdc:
baseImage: pingcap/ticdc
version: v8.5.4-release.1
version: v{{{ .ticdc-version }}}
replicas: 3
config:
newarch = true
Expand Down Expand Up @@ -249,7 +249,7 @@ To deploy TiCDC nodes in the new architecture in an existing TiDB cluster using
spec:
ticdc:
baseImage: pingcap/ticdc
version: v8.5.4-release.1
version: v{{{ .ticdc-version }}}
replicas: 3
```

Expand Down
1 change: 1 addition & 0 deletions variables.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"tidb": "TiDB",
"tidb-version": "v8.5.0",
"ticdc-version": "8.5.8",
"tidb-operator-version": "v1.6.4",
"self-managed": "TiDB Self-Managed",
"starter": "TiDB Cloud Starter",
Expand Down
Loading