Skip to content

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

Open
xboxeer wants to merge 2 commits into
pingcap:masterfrom
xboxeer:docs/pause-pitr-data-migration
Open

docs: block cluster pause when PITR or Data Migration is active#23402
xboxeer wants to merge 2 commits into
pingcap:masterfrom
xboxeer:docs/pause-pitr-data-migration

Conversation

@xboxeer

@xboxeer xboxeer commented Jul 31, 2026

Copy link
Copy Markdown
Collaborator

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
    • Documented limitations for pausing TiDB clusters when Point-in-Time Recovery (PITR) is enabled or a Data Migration job is running.
    • Clarified that users must disable PITR and ensure no migration job is active before pausing a cluster.

@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 31, 2026
@coderabbitai

coderabbitai Bot commented Jul 31, 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: 43cdf6e8-4c4e-4273-bb9b-622a39ddfb61

📥 Commits

Reviewing files that changed from the base of the PR and between 88402df and 7cae485.

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

📝 Walkthrough

Walkthrough

The pause and resume documentation now states that users must disable PITR or stop a running Data Migration job before pausing a TiDB cluster.

Changes

Pause Restrictions

Layer / File(s) Summary
Document pause conditions
tidb-cloud/pause-or-resume-tidb-cluster.md
Adds restrictions for clusters with PITR enabled or a running Data Migration job. It states the required remediation steps.

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

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the change but omits required version applicability, related links, and checklist sections from the repository template. Add the required version selection, related PR or file links, AI involvement, and change-impact checklist sections.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the documentation change to block cluster pauses when PITR or Data Migration is active.
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 self-assigned this Jul 31, 2026
@qiancai qiancai added for-cloud-release This PR is related to TiDB Cloud release. area/tidb-cloud This PR relates to the area of TiDB Cloud. translation/no-need No need to translate this PR. labels Jul 31, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Jul 31, 2026
@qiancai qiancai added the needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. label Jul 31, 2026
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jul 31, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jul 31, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-07-31 09:37:00.362894121 +0000 UTC m=+2175206.398989177: ☑️ agreed by qiancai.

Comment thread tidb-cloud/pause-or-resume-tidb-cluster.md Outdated
@ti-chi-bot

ti-chi-bot Bot commented Jul 31, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from qiancai. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/tidb-cloud This PR relates to the area of TiDB Cloud. for-cloud-release This PR is related to TiDB Cloud release. needs-1-more-lgtm Indicates a PR needs 1 more LGTM. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. translation/no-need No need to translate this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants