Skip to content

docs: block cluster pause when PITR or Data Migration is active (#23402) - #23433

Merged
ti-chi-bot[bot] merged 2 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-23402-to-release-8.5
Aug 5, 2026
Merged

docs: block cluster pause when PITR or Data Migration is active (#23402)#23433
ti-chi-bot[bot] merged 2 commits into
pingcap:release-8.5from
ti-chi-bot:cherry-pick-23402-to-release-8.5

Conversation

@ti-chi-bot

@ti-chi-bot ti-chi-bot commented Aug 5, 2026

Copy link
Copy Markdown
Member

This is an automated cherry-pick of #23402

What's changed

Clusters with Point-in-Time Restore (PITR) enabled or a Data Migration job running can no longer be paused directly. The pause request is rejected with a clear error until users explicitly disable PITR / stop the migration job.

Documentation changes

Adds two new bullets to the Limitations section of tidb-cloud/pause-or-resume-tidb-cluster.md.

Summary by CodeRabbit

  • Documentation
    • Added limitations for pausing TiDB clusters.
    • Clusters cannot be paused while Point-in-Time Recovery (PITR) is enabled or a Data Migration job is running.

@ti-chi-bot ti-chi-bot added area/tidb-cloud This PR relates to the area of TiDB Cloud. for-cloud-release This PR is related to TiDB Cloud release. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. labels Aug 5, 2026
@coderabbitai

coderabbitai Bot commented Aug 5, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 59f486cf-6f81-47eb-a27c-a748de66f0a2

📥 Commits

Reviewing files that changed from the base of the PR and between 43b5a62 and f64b7a0.

📒 Files selected for processing (1)
  • tidb-cloud/pause-or-resume-tidb-cluster.md

📝 Walkthrough

Walkthrough

The pause and resume documentation now states that clusters cannot be paused when PITR is enabled or when a Data Migration job is running.

Changes

Pause restrictions

Layer / File(s) Summary
Document pause limitations
tidb-cloud/pause-or-resume-tidb-cluster.md
Adds pause restrictions for clusters with PITR enabled or an active Data Migration job.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

Suggested reviewers: qiancai

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the documentation change that blocks cluster pauses when PITR or Data Migration is active.
Description check ✅ Passed The description explains the behavior change and identifies the documentation update, but it omits the affected version and related-link sections.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@qiancai

qiancai commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator

/approve

@ti-chi-bot

ti-chi-bot Bot commented Aug 5, 2026

Copy link
Copy Markdown

[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:

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

@ti-chi-bot ti-chi-bot Bot added the approved label Aug 5, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit caedeb5 into pingcap:release-8.5 Aug 5, 2026
12 checks passed
@ti-chi-bot
ti-chi-bot Bot deleted the cherry-pick-23402-to-release-8.5 branch August 5, 2026 06:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/tidb-cloud This PR relates to the area of TiDB Cloud. for-cloud-release This PR is related to TiDB Cloud release. lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants