cloud: changefeed ess cloud storage by ginkgoch · Pull Request #24541 · pingcap/docs

ginkgoch · 2026-10-22T10:55:31Z

First-time contributors' checklist

I've signed the Contributor License Agreement, which is required for the repository owners to accept my contribution.

What is changed, added, or deleted? (Required)

Essential changefeed supports cloud storage, need to update the doc.

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

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

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

Related code change PR links (if applicable):
This PR is translated from:
Other reference link(s):

AI agent involvement

The changes in this PR were primarily made by an AI agent on behalf of the PR author.

Do your changes match any of the following descriptions?

Delete files
Change aliases
Need modification after applied to another branch
Might cause conflicts after applied to another branch

Summary by CodeRabbit

Documentation
- Added cloud storage changefeed links to the TiDB Cloud Essential table of contents and overview.
- Expanded the guide with Essential plan availability, changefeed limits, and Amazon S3 and Alibaba Cloud OSS setup instructions, including plan-specific permissions and connection testing.
- Updated the data pipeline guide with console-based setup instructions for an S3 changefeed, including the destination path, authentication options, starting point, and data format settings.

coderabbitai · 2026-10-22T10:56:04Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Last reviewed commit: fda8699
Latest commit, not reviewed: 2608c43

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

Walkthrough

The documentation adds TiDB Cloud Essential to cloud storage changefeed guidance. It also replaces API-based lake pipeline setup instructions with console setup steps.

Changes: TiDB Cloud Essential changefeed documentation

Layer / File(s)	Summary
Availability and documentation entry point `TOC-tidb-cloud-essential.md`, `tidb-cloud/essential-changefeed-overview.md`, `tidb-cloud/changefeed-sink-to-cloud-storage.md`	The table of contents and overview link to the cloud storage sink guide. The guide describes Essential changefeed availability and its limit of 10 changefeeds per instance.
Cloud storage destination setup `tidb-cloud/changefeed-sink-to-cloud-storage.md`	The guide adds Essential destination selection and S3 region requirements. It specifies plan-specific OSS permissions and policy examples, and includes Essential in connection testing.
Lake pipeline setup `tidb-cloud/data-pipeline-essential-sink-to-lake.md`	The guide replaces API instructions with console steps for the S3 path, authentication, snapshot TSO, and Canal-JSON settings.

Priority: Normal

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Merge Risk: Low · up to fda86

Essential users may see the wrong cloud storage setup instructions. Add the plan selector before merging if possible; the issue is localized and has a straightforward workaround.

Pre-merge checks: 4

Check name	Status	Explanation
Description check		The description states the purpose in one line: Essential changefeed supports cloud storage, so the doc needs an update. It meets the template's required section for what changed. It does not name the…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.
Title check		The title identifies the main change: adding cloud storage support documentation for Essential Changefeed. It is concise, although abbreviated.

Full details: Description check

Explanation

The description states the purpose in one line: Essential changefeed supports cloud storage, so the doc needs an update. It meets the template's required section for what changed. It does not name the affected files, describe the plan-specific changes (limits, S3 and OSS details, console steps), or give the related PR or file links. The version checkboxes are all unticked, and the template's required version field has no selection. The description is brief but gives the core intent, so it is mostly complete.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create a new PR

Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Source mode: Auto
Repository: pingcap/docs
Branch: release-8.5
File: .coderabbit.yaml
Commit: a90ebc8
Layers: Repository YAML
Review profile: ASSERTIVE
Plan: Advanced
Run ID: c2bcdc8d-1ae9-4cd8-8966-2d6c03b4bf45

📥 Commits

Reviewing files that changed from the base of the PR and between a90ebc8 and dbc50e6.

📒 Files selected for processing: 3

TOC-tidb-cloud-essential.md
tidb-cloud/changefeed-sink-to-cloud-storage.md
tidb-cloud/data-pipeline-essential-sink-to-lake.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Source mode: Auto
Repository: pingcap/docs
Branch: release-8.5
File: .coderabbit.yaml
Commit: a90ebc8
Layers: Repository YAML
Review profile: ASSERTIVE
Plan: Advanced
Run ID: c780f017-adb8-4c8b-b7d3-b394eb32bc18

📥 Commits

Reviewing files that changed from the base of the PR and between dbc50e6 and 727cb20.

📒 Files selected for processing: 2

tidb-cloud/changefeed-sink-to-cloud-storage.md
tidb-cloud/data-pipeline-essential-sink-to-lake.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Source mode: Auto
Repository: pingcap/docs
Branch: release-8.5
File: .coderabbit.yaml
Commit: a90ebc8
Layers: Repository YAML
Review profile: ASSERTIVE
Plan: Advanced
Run ID: 6ad1fb5f-0ba0-4173-a630-c6673692462c

📥 Commits

Reviewing files that changed from the base of the PR and between 727cb20 and fda8699.

📒 Files selected for processing: 1

tidb-cloud/essential-changefeed-overview.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 2 remain after this review.

ti-chi-bot · 2026-10-28T00:40:04Z

[LGTM Timeline notifier]

Timeline:

2026-10-28 00:40:03.96084713 +0000 UTC m=+22328.585997413: ☑️ agreed by qiancai.

qiancai · 2026-10-28T02:54:03Z

/approve

ti-chi-bot · 2026-10-28T02:54:09Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [qiancai]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

qiancai · 2026-10-28T03:06:05Z

/retest

ginkgoch added 3 commits October 22, 2026 17:01

Add essential cf cloud storage doc.

0d8ec52

Add TOC.

781b41f

Replace the API solution to console UI.

dbc50e6

ti-chi-bot Bot added contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 22, 2026

coderabbitai Bot reviewed Oct 22, 2026

View reviewed changes

Comment thread tidb-cloud/changefeed-sink-to-cloud-storage.md

qiancai reviewed Oct 23, 2026

View reviewed changes

Comment thread tidb-cloud/data-pipeline-essential-sink-to-lake.md Outdated

Comment thread tidb-cloud/changefeed-sink-to-cloud-storage.md Outdated

Comment thread tidb-cloud/changefeed-sink-to-cloud-storage.md Outdated

minor wording updates

727cb20

coderabbitai Bot reviewed Oct 23, 2026

View reviewed changes

Comment thread tidb-cloud/data-pipeline-essential-sink-to-lake.md

Update essential-changefeed-overview.md

fda8699

coderabbitai Bot reviewed Oct 23, 2026

View reviewed changes

Comment thread tidb-cloud/essential-changefeed-overview.md

Update data-pipeline-essential-sink-to-lake.md

2608c43

qiancai approved these changes Oct 28, 2026

View reviewed changes

ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Oct 28, 2026

qiancai self-assigned this Oct 28, 2026

qiancai added translation/no-need No need to translate this PR. area/tidb-cloud This PR relates to the area of TiDB Cloud. labels Oct 28, 2026

ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Oct 28, 2026

qiancai changed the title ~~Changefeed ess cloud storage~~ cloud: changefeed ess cloud storage Oct 28, 2026

qiancai added the lgtm label Oct 28, 2026

ti-chi-bot Bot added the approved label Oct 28, 2026

qiancai merged commit aae0e91 into pingcap:release-8.5 Oct 28, 2026
12 checks passed

Navigation Menu

Repository navigation

cloud: changefeed ess cloud storage - #24541

cloud: changefeed ess cloud storage#24541
qiancai merged 6 commits into
pingcap:release-8.5from
ginkgoch:changefeed-ess-cloud-storage

ginkgoch commented Oct 22, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Oct 22, 2026 •

edited

Loading

Reviews paused

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

ti-chi-bot Bot commented Oct 28, 2026

Uh oh!

qiancai commented Oct 28, 2026

Uh oh!

ti-chi-bot Bot commented Oct 28, 2026

Uh oh!

qiancai commented Oct 28, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

ginkgoch commented Oct 22, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

First-time contributors' checklist

What is changed, added, or deleted? (Required)

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

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

AI agent involvement

Do your changes match any of the following descriptions?

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Oct 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ti-chi-bot Bot commented Oct 28, 2026

[LGTM Timeline notifier]

Uh oh!

qiancai commented Oct 28, 2026

Uh oh!

ti-chi-bot Bot commented Oct 28, 2026

Uh oh!

qiancai commented Oct 28, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ginkgoch commented Oct 22, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Oct 22, 2026 •

edited

Loading