Skip to content

Add private endpoint management tips. - #23612

Open
ginkgoch wants to merge 2 commits into
pingcap:release-8.5from
ginkgoch:private-endpoint-recycle-policy
Open

Add private endpoint management tips.#23612
ginkgoch wants to merge 2 commits into
pingcap:release-8.5from
ginkgoch:private-endpoint-recycle-policy

Conversation

@ginkgoch

@ginkgoch ginkgoch commented Aug 26, 2026

Copy link
Copy Markdown
Collaborator

First-time contributors' checklist

What is changed, added or deleted? (Required)

The private endpoint guide missed some tips for how we manage the private endpoints, add those tips for dedicated and premium.

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.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

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

  • 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
    • Clarified that private endpoints are shared resources and may be reused by compatible instances or clusters.
    • Documented that endpoints remain available after the associated instance or cluster is deleted.
    • Added lifecycle guidance: unused endpoints are automatically removed after 30 days.
    • Clarified that endpoints cannot be deleted while they are still in use.
    • Specified the applicable resource scope for each deployment type: tenant-level or project-level.

@ti-chi-bot ti-chi-bot Bot added the contribution This PR is from a community contributor. label Aug 26, 2026
@ti-chi-bot

ti-chi-bot Bot commented Aug 26, 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 assign breezewish for approval. 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

@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 Aug 26, 2026
@coderabbitai

coderabbitai Bot commented Aug 26, 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: c3de1c63-e539-4c14-9da9-a762af04a77d

📥 Commits

Reviewing files that changed from the base of the PR and between 5c0f503 and 894b7e4.

📒 Files selected for processing (2)
  • tidb-cloud/premium/set-up-sink-private-endpoint-premium.md
  • tidb-cloud/set-up-sink-private-endpoint.md

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


📝 Walkthrough

Walkthrough

The documentation now describes private endpoint scope, sharing, persistence after resource deletion, deletion restrictions, and automatic cleanup after 30 days of inactivity.

Changes

Private endpoint lifecycle

Layer / File(s) Summary
Document endpoint lifecycle rules
tidb-cloud/set-up-sink-private-endpoint.md, tidb-cloud/premium/set-up-sink-private-endpoint-premium.md
The guides document endpoint ownership, sharing, persistence after resource deletion, deletion restrictions while in use, and automatic cleanup after 30 days of inactivity.

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

Merge Risk: ⚪ Minimal · up to 894b7

This PR adds localized management tips to two private endpoint guides without changing product behavior, so no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: qiancai

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the documentation changes and confirms the contributor agreement, but it does not select the required affected TiDB version. The PR objectives identify the release-8.5 branch. Select the applicable version checkbox, including v8.5 if this PR targets the release-8.5 branch. Add relevant reference links if available.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding private endpoint management tips.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

  • Fix all pre-merge checks with AI
✨ 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.

@ginkgoch ginkgoch self-assigned this Aug 26, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 45879bcf-66a1-40e2-905a-f8fd82d77cec

📥 Commits

Reviewing files that changed from the base of the PR and between 7e1eca1 and 5c0f503.

📒 Files selected for processing (2)
  • tidb-cloud/premium/set-up-sink-private-endpoint-premium.md
  • tidb-cloud/set-up-sink-private-endpoint.md

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

Comment thread tidb-cloud/set-up-sink-private-endpoint.md Outdated

@ideascf ideascf left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ti-chi-bot

ti-chi-bot Bot commented Aug 27, 2026

Copy link
Copy Markdown

@ideascf: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

LGTM

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.


> **Note:**
>
> A private endpoint is a tenant-level resource and is not tied to a specific instance. Private endpoints created within the same tenant and in the same region can be shared by multiple instances connecting to the same downstream service, so you do not need to create a separate endpoint for each instance. Deleting an instance does not delete its private endpoints. You can manually delete a private endpoint when it is no longer needed, or wait for it to be automatically cleaned up after 30 days of inactivity. A private endpoint cannot be deleted if it is still in use by any instance.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> A private endpoint is a tenant-level resource and is not tied to a specific instance. Private endpoints created within the same tenant and in the same region can be shared by multiple instances connecting to the same downstream service, so you do not need to create a separate endpoint for each instance. Deleting an instance does not delete its private endpoints. You can manually delete a private endpoint when it is no longer needed, or wait for it to be automatically cleaned up after 30 days of inactivity. A private endpoint cannot be deleted if it is still in use by any instance.
> A private endpoint is an organization-level resource and is not tied to a specific {{{ .premium }}} instance. Private endpoints created within the same organization and in the same region can be shared by multiple instances connecting to the same downstream service, so you do not need to create a separate endpoint for each instance. Deleting a {{{ .premium }}} instance does not delete its private endpoints. You can manually delete a private endpoint when it is no longer needed, or wait for it to be automatically cleaned up after 30 days of inactivity. A private endpoint cannot be deleted if it is still in use by any instance.

> **Note:**
>
> A private endpoint is a tenant-level resource and is not tied to a specific instance. Private endpoints created within the same tenant and in the same region can be shared by multiple instances connecting to the same downstream service, so you do not need to create a separate endpoint for each instance. Deleting an instance does not delete its private endpoints. You can manually delete a private endpoint when it is no longer needed, or wait for it to be automatically cleaned up after 30 days of inactivity. A private endpoint cannot be deleted if it is still in use by any instance.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does "wait for it to be automatically cleaned up after 30 days of inactivity” mean? Will a private endpoint be deleted if it is unused for 30 days even if the corresponding instance is still available?

@qiancai qiancai self-assigned this Aug 27, 2026
@qiancai qiancai added translation/no-need No need to translate this PR. area/tidb-cloud This PR relates to the area of TiDB Cloud. and removed missing-translation-status This PR does not have translation status info. labels Aug 27, 2026
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. contribution This PR is from a community contributor. 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.

3 participants